Item Property Routines

function ItemProperty(ItemID, Property)

Note: This does not return the calculated value (result).  If you are trying to retrieve the result, use ItemPropertyResult.

This is the ID of the item you are accessing the properties of, such as CurrentItem, CurrentTab.

This is a string of the name of the property you wish to read, such as "Qty", "Price Each", "Price Total". Some "system" values can be "Name", "Color",  "Item #." The value returned is the formula of the property. Use ItemPropertyResult to retrieve the calculated result.

This example would return the value (formula) of the Qty property.

function ItemPropertyResult(ItemID, Property)

This is the ID of the item you are accessing the property of, such as CurrentItem, CurrentTab.

This is a string of the name of the property you wish to read, such as "Qty", "Price Each", "Price Total". Some "system" values can be "SEGMENT COUNT", "LINEAR TOTAL", "POINT COUNT", "SECTION COUNT". The value to be read is the units of the property.

This example would display a message with the result of the property Qty for the currently selected item.

function SetItemProperty(ItemID, Property, Value)

Sets the value of a property (formula).  This is equivalent to opening the item in the "Edit Estimating Item" window and typing in a value or formula for a specific property.

This is the ID of the item you are setting the property of, such as CurrentItem, CurrentTab.

Note: Item routines can be used on tabs.

This is a string of the name of the property you wish to set, such as "Qty", "Price Each", "Price Total". Some "system" values can be "Name", "Color",  "Item #." The value to be set is the formula of the property.

This is a string or number value to be set in the formula of the specified property, such as "[Qty] * [Price Each]" or "[Linear Total] / 1.333".

SetItemProperty(CurrentItem, "Cubic Yards of Concrete", "([Area] * [Thickness]) / 27")

This example would create, or edit if property already exists, the property called Cubic Yards of Concrete and set its value (formula) to ([Area] * [Thickness]) / 27.

function ItemPropertyUnits(ItemID, Property)

This is the ID of the item you are accessing the property of, such as CurrentItem, CurrentTab.

Property
This is a string of the name of the property you wish to read, such as "Qty", "Price Each", "Price Total". Some "system" values can be "SEGMENT COUNT", "LINEAR TOTAL", "POINT COUNT", "SECTION COUNT". The value to be read is the units of the property.

This example would display a message of what the units for the Qty property are currently set to.

function SetItemPropertyUnits(ItemID, Property, Units)

This is the ID of the item you are setting the property of, such as CurrentItem, CurrentTab.

This is a string of the name of the property you wish to set, such as "Qty", "Price Each", "Price Total". Some "system" values can be "SEGMENT COUNT", "LINEAR TOTAL", "POINT COUNT", "SECTION COUNT". The value to be set is the units of the property.

This is a integer value of the number of decimal places to be displayed on the result of the specified property.

This example would set the units for the Qty property to SQ FT.

function GetPropertyFromColumn(ItemID, Column)

Returns the name of the property with that column (or blank).  This would typically be used in conjunction with a GetProperty method, since this routine does not return the value or result, only the name of the matching property.

This is the ID of the item you are accessing the property of, such as CurrentItem, CurrentTab.

This is a string of the name of the column you wish to access from the specified property, such as "Qty", "Price Each", "Price Total".

The example will display a message of the result of the property that is designated for the Price Total column.

function SetItemPropertyColumn(ItemID, Property, Column)

Sets the column of the property.  When you set the column of a property, it determines which column that property will show in, in the estimating window.

This is the ID of the item you are setting the property of, such as CurrentItem, CurrentTab.

This is a string of the name of the property you wish to set, such as "Qty", "Price Each", "Price Total". Some "system" values can be "SEGMENT COUNT", "LINEAR TOTAL", "POINT COUNT", "SECTION COUNT". The value to be set is the column name of the property.

This is a string of the name of the column you wish to set the specified property to report to in the estimate, such as "Qty", "Price Each", "Price Total".

If you created a property called "Qty of Yards" with a formula for calculating yards of concrete, you could set the column to "Qty", so that the calculated result will show in the "Qty" column on the estimate.

function DeleteItemProperty(ItemID, Property)

This is the ID of the item you are deleting the property of, such as CurrentItem, CurrentTab.

This is a string of the name of the property you wish to delete, such as "Qty", "Price Each", "Price Total". "System" values cannot be deleted.

This example would delete the Qty property from the currently selected item.

function GetItemPropertyDigits(ItemID, Property)

Returns number of digits to the right of the decimal for a property.

This is the ID of the item you are accessing the property of, such as CurrentItem, CurrentTab.

This is a string of the name of the property you wish to read, such as "Qty", "Price Each", "Price Total". Some "system" values can be "SEGMENT COUNT", "LINEAR TOTAL", "POINT COUNT", "SECTION COUNT". The value to be read is the digits the of the property.

NumOfDigits = GetItemPropertyDigits(CurrentItem, "Price Each")

This example would return how many digits are assigned to the Price Each property of the currently selected item.

procedure SetItemPropertyDigits(ItemID, Property, Value)

This is the ID of the item you are setting the property of, such as CurrentItem, CurrentTab.

This is a string of the name of the property you wish to set, such as "Qty", "Price Each", "Price Total". Some "system" values can be "SEGMENT COUNT", "LINEAR TOTAL", "POINT COUNT", "SECTION COUNT". The value to be set is the digits the of the property.

Integer value of how may digits to display to the right of the decimal.

This example would set the decimal places of the Price Each property for the currently selected item to 2 decimal places.

function ItemPropertyLocked(ItemID, Property)

This is the ID of the item you are accessing the property of, such as CurrentItem, CurrentTab.

This is a string of the name of the property you wish to check if locked, such as "Qty", "Price Each", "Price Total". "System" values cannot be unlocked.

This example would show the message "Property is locked" if property was locked, and if the property is unlocked it would show the message "Property is not locked".

procedure LockItemProperty(ItemID, Property, Locked)

This is the ID of the item you are accessing the property of, such as CurrentItem, CurrentTab.

This is a string of the name of the property you wish to lock or unlock, such as "Qty", "Price Each", "Price Total". "System" values cannot be unlocked.

This example would lock the Qty property of the currently selected item.

function HasProperty(ItemID, Property)

Returns true if property exists or false if property does not exist.

This is the ID of the item you are accessing the property of, such as CurrentItem, CurrentTab.

This is a string of the name of the property you wish to check if exists, such as "Qty", "Price Each", "Price Total". Some "system" values can be "SEGMENT COUNT", "LINEAR TOTAL", "POINT COUNT", "SECTION COUNT". The value to be check is the name of the property.

This example would show the message "Property Qty does exists!") if the property existed or "Property Qty does not exist!" if the property does not exist.