Version

ICalculationReference Interface Members

The following tables list the members exposed by ICalculationReference.

Public Properties
 NameDescription
 PropertyAbsoluteNameThe fully qualified unique name for the referenced element. Read Only.  
 PropertyContextReturns a context for the Reference.  
 PropertyElementNameThe unqualified name of this referenced element. Read Only.  
 PropertyFormulaThe ICalculationFormula, if any, associated with this Reference. If this reference can not contain a formula then null is returned.  
 PropertyHasAbsoluteIndexTrue indicates that the reference was constructed with an absolute index. Read Only.  
 PropertyHasRelativeIndexTrue indicates that the reference was constructed with a relative index. Read Only.  
 PropertyHasScopeAllTrue indicates that the reference was constructed with an "*" scope index. Read Only.  
 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.  
 PropertyIsDisposedReferenceTrue indicates that the reference has been disposed. Read Only.  
 PropertyIsEnumerableReturns true if this reference is enumerable.  
 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.  
 PropertyParentThe Parent reference of this referenced element. Used to navigate the element hierarchy. If this referenced element is the root element, Parent returns null. Read Only.  
 PropertyRecalcDeferredTrue indicates that recalculating reference's formula can deferred until it become visible.  
 PropertyRecalcVisibleFlag used by the calculation engine to manage the recalculation network. Denotes the reference is visible.  
 PropertyReferencesReturn a collection of references if this Reference is enumerable. An exception is thrown if this reference is not enumerable.  
 PropertyValueThe CalculationValue, if any, associated with this Reference. If this reference does not contain a Value then a CalculationErrorValue is returned.  
Public Methods
 NameDescription
 MethodContainsReferenceReturns true if this reference contains inReference  
 MethodCreateRangeCreate a Range reference relative to this reference.  
 MethodCreateReferenceCreate a new reference relative to this reference.  
 MethodGetChildReferencesReturns the child references of the reference. This method can return null.  
 MethodIsSiblingReferenceDetermines whether the given reference is a sibling of this reference  
 MethodIsSubsetReferenceReturns true if inReference is a proper subset of this reference  
 MethodMarkRelativeIndicesFor each reference tuple in this reference that has a relative index, mark the corresponding tuple in inReference.  
 MethodResolveReferenceResolves a reference relative to this reference.  
See Also