Version 24.2 (latest)

RefBase Class Properties

For a list of all members of this type, see RefBase members.

Public Properties
 NameDescription
Public PropertyAbsoluteNameThe fully qualified unique name for the referenced element. Read Only.  
Public PropertyBaseParentThe RefBase Parent reference of this referenced element. Used to navigate the element hierarchy. If this referenced element is the root element, BaseParent returns null. Read Only.  
Public PropertyContextReturns a context for the Reference.  
Public PropertyElementNameThe unqualified name of this referenced element. Used to construct the fully qualified name by the AbsoluteName method. Read Only.  
Public PropertyFormulaThe ICalculationFormula, if any, associated with this Reference. If this reference can not contain a formula then null is returned.  
Public PropertyHasAbsoluteIndexTrue indicates that the reference was constructed with a relative index. Read Only.  
Public PropertyHasRelativeIndexTrue indicates that the reference was constructed with a relative index. Read Only.  
Public PropertyHasScopeAllTrue indicates that the reference was constructed with a scope all index. Read Only.  
Public PropertyIsAnchoredReturns true if this reference is anchored. An anchored reference is a direct reference to an element. An unanchored reference is an indirect reference. An indirect reference stores context dependent properties such as the relative name used to create the reference. Read Only.  
Public PropertyIsDataReferenceReturns true if this reference is a data reference. A data reference contains a value, such as a Grid Cell or a Grid SummaryValue. Many referenced elements, such as a Grid Column or a Grid Band, do not reference a value. Read Only.  
Public PropertyIsDisposedReferenceTrue indicates that the reference was disposed. Read Only.  
Public PropertyIsEnumerableReturns true if this reference is enumerable.  
Public PropertyIsRangeReturns true if this reference is a Range Reference. Read Only.  
Public PropertyNormalizedAbsoluteNameReturns the normalized absolute name. Calculation engine makes use of normalized absolute names of references to compare two references and search for references. This property should return the absolute name with case insensitive parts of the absolute names converted to lower case.  
Public PropertyParentThe RefBase Parent reference of this referenced element. Used to navigate the element hierarchy. If this referenced element is the root element, BaseParent returns null. Read Only.  
Public PropertyParsedReferenceGets or Sets the parsed representation of this reference. This returns the absolute reference name. Use RelativeReference to get the parsed representation of the string used to create this reference if this reference is UnAnchored.  
Public PropertyRecalcDeferredFlag used by the calculation engine to manage the recalculation network. Denotes the reference is visible.  
Public PropertyRecalcVisibleFlag used by the calculation engine to manage the recalculation network. Denotes the reference is visible.  
Public PropertyReferencesReturn a collection of references if this Reference is enumerable. An exception is thrown if this reference is not enumerable.  
Public PropertyRelativeReferenceGets or Sets the parsed representation of the string used to create this reference if this reference is UnAnchored. Use AbsoluteReference to get the parsed representation of the anchored reference.  
Public PropertyShouldFormulaEditorIncludeIndexGets the value indicating whether the formula editor should include default indexes after this reference's address when enumerable references are used where a single value is expected.  
Public PropertyValueThe CalculationValue, if any, associated with this Reference. If this reference does not contain a Value then a CalculationErrorValue is returned.  
Public PropertyWrappedReferenceReturns the indirect reference of an UnAnchored reference. Read only.  
See Also