Functions and Formulas  

Properties & Access  

Properties & Access

getProperty

Retrieves the attribute of a given scalar, vector or matrix.

Object getProperty(Object src, String name, boolean handle_enumerations=false, Object def=nothing)

Parameters
src : the object that has got the attribute
name : the name of the attribute
handle_enumerations : set to true if the function should retrieve the attribute of a enumeration value rather than the attribute of a cell
def :

isPrimary

Checks if a cell is marked as the primary cell of a matrix

Collection isPrimary(Object obj)

Parameters
obj : the source object, usually a matrix with some cells marked as primary

isState

Checks if a cell is marked with a specified user defined state.

Collection isState(Object obj, Object state=nothing)

Parameters
obj : the source object, usually a matrix or table column
state : the state to be checked. Valid constants are stNotConfirmed, stInProgress, stConfirmed, stUser1, stUser2, stUser3, stUser4, stPrimary, stCritical

setCondFormat

Used for conditional formatting. Using this function creates one of the 4 available conditional format states. For each state, individual format settings can be set.

Collection setCondFormat(integer mode, Collection src, Object val1=nothing, Object val2=nothing, Object val3=nothing, Object val4=nothing, Object val5=nothing, Object val6=nothing)

Parameters
mode : comparison mode. decides how src, val1 and val2 have to be compared to create the result.
src : source parameter for the comparison operation
val1 : second parameter for the comparison operation
val2 : third parameter for the comparison operation
val3 : third parameter for the comparison operation
val4 : third parameter for the comparison operation
val5 : third parameter for the comparison operation
val6 : third parameter for the comparison operation

Feedback

Did you find what you needed?

If you have any further questions or suggestions to improve this page, please let us know:

=