Version

RefUnAnchored Class Members

The following tables list the members exposed by RefUnAnchored.

Public Constructors
 NameDescription
Public ConstructorRefUnAnchored ConstructorConstructor takes a base reference.  
Protected Fields
 NameDescription
Protected FieldbaseRefThe RefBase being wrapped.  
Protected FieldrelativeRPThe parsed form of the reference string used to create the reference.  
Public Properties
 NameDescription
Public PropertyAbsoluteNameOverridden. The fully qualified unique name for the referenced element. Read Only.  
Public PropertyBaseParentOverridden. The 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 PropertyContextOverridden. Returns a context for the Reference.  
Public PropertyElementNameOverridden. The unqualified name of this referenced element. Used to construct the fully qualified name by the AbsoluteName method. Read Only.

RefUnAnchored forwards this to the base reference.

 
Public PropertyFormulaOverridden. The ICalculationFormula, if any, associated with this Reference. If this reference can not contain a formula then null is returned.

RefUnAnchored forwards this to the base reference.

 
Public PropertyHasAbsoluteIndexOverridden. True indicates that the reference was constructed with a absolute index. Read Only.

RefUnAnchored uses the relative rp.

 
Public PropertyHasRelativeIndexOverridden. True indicates that the reference was constructed with a relative index. Read Only.

RefUnAnchored uses the relative rp.

 
Public PropertyHasScopeAllOverridden. True indicates that the reference was constructed with a scope all index. Read Only.  
Public PropertyIsAnchoredOverridden. Returns 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.

RefUnAnchored always returns false.

 
Public PropertyIsDataReferenceOverridden. Returns 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.

RefUnAnchored forwards this to the base reference.

 
Public PropertyIsDisposedReferenceOverridden. True indicates that the reference was disposed. Read Only.  
Public PropertyIsEnumerableOverridden. Returns true if this reference is enumerable.

RefUnAnchored forwards this to the base reference.

 
Public PropertyIsRangeOverridden. Returns true if this reference is a Range Reference. Read Only.

RefUnAnchored forwards this to the base reference.

 
Public PropertyIsUnQualifiedReferenceReturns true if the relative reference is unqualified. 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. (Inherited from Infragistics.Calculations.Engine.RefBase)
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. (Inherited from Infragistics.Calculations.Engine.RefBase)
Public PropertyParsedReferenceOverridden. Gets 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.

RefUnAnchored returns a reference constructed from merging the relative reference into the base reference.

 
Public PropertyRecalcDeferredOverridden. True indicates that recalculating reference's formula can deferred until it become visible.  
Public PropertyRecalcVisibleOverridden. Flag used by the calculation engine to manage the recalculation network. Denotes the reference is visible.

RefUnAnchored forwards this to the base reference.

 
Public PropertyReferencesOverridden. Return a collection of references if this Reference is enumerable. An exception is thrown if this reference is not enumerable.

RefUnAnchored returns the baseRef enumeration scoped to the merged reference.

 
Public PropertyRelativeReferenceOverridden. Gets 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.

RefUnAnchored returns the relative reference. When setting the relative reference, the merge reference is constructed by merging the relative reference into the base reference.

 
Public PropertyShouldFormulaEditorIncludeIndexOverridden. Gets 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 PropertyValueOverridden. The CalculationValue, if any, associated with this Reference. If this reference does not contain a Value then a CalculationErrorValue is returned.

RefUnAnchored forwards this to the base reference.

 
Public PropertyWrappedReferenceOverridden. Returns the indirect reference of an UnAnchored reference. Read only.

RefUnAnchored forwards this to the base reference.

 
Public Methods
 NameDescription
Public MethodContainsReferenceOverridden. Returns true if this reference contains inReference

RefUnAnchored forwards this to the base reference.

 
Public MethodCreateRangeCreate a Range reference relative to this reference. (Inherited from Infragistics.Calculations.Engine.RefBase)
Public MethodCreateReferenceCreate a new reference relative to this reference. (Inherited from Infragistics.Calculations.Engine.RefBase)
Public MethodEqualsOverriden.  
Public MethodFindAllOverridden. Returns the named reference relative to this reference with scope "ALL".

RefUnAnchored forwards this to the base reference.

 
Public MethodFindItemOverloaded. Overridden. Returns the named reference relative to this reference.

RefUnAnchored forwards this to the base reference.

 
Public MethodFindParentOverridden. Returns a reference to this elements Parent.

RefUnAnchored forwards this to the base reference.

 
Public MethodFindSummaryItemOverridden. Returns the named SummaryItem reference relative to this reference.

RefUnAnchored forwards this to the base reference.

 
Public MethodGetChildReferencesReturns the child references of the reference. This method can return null. (Inherited from Infragistics.Calculations.Engine.RefBase)
Public MethodGetHashCodeOverridden.  
Public MethodIsSiblingReferenceOverridden. Determines whether the given reference is a sibling of this reference  
Public MethodIsSubsetReferenceOverridden. Returns true if inReference is a proper subset of this reference  
Public MethodMarkRelativeIndicesFor each reference tuple in this reference that has a relative index, mark the corresponding tuple in inReference. (Inherited from Infragistics.Calculations.Engine.RefBase)
Public MethodResolveReferenceOverridden. Resolves a reference relative to this reference. For example, if this reference is a reference to a row, and inReference is a reference to a column, the resolved reference is the cell reference that is the intersection of this row and the input column.

RefUnAnchored forwards this to the base reference.

 
Public MethodScopedReferencesOverridden. Returns a ICalculationReferenceCollection for enumerable references constrained to the specified reference.

RefUnAnchored forwards this to the base reference.

 
Public MethodToStringReturns a string representation of the object.  
Protected Methods
 NameDescription
Protected MethodBuildReferenceConstructs a reference relative to this reference by walking all the elements of the specified parsed reference. If forceDataRef is true, then any IsDataReference references are forced to resolve to a specific data item when an incomplete identifier is specified. RefLoop is used to iterate over the specified parsed reference.

This method must be overridden by the Root reference object to deal with external or root references. The Root referece object must advance past the optional control name in a Fully Qualified Reference before calling RefLoop

(Inherited from Infragistics.Calculations.Engine.RefBase)
Protected MethodCreateParsedReferenceUsed to create a new RefParser for the reference. (Inherited from Infragistics.Calculations.Engine.RefBase)
Protected MethodFindRootReturns the Root reference of a reference hierarchy. The root reference is used to resolve the fully qualifed form of a reference. Note: Must be overridden by the Root reference to return "this". (Inherited from Infragistics.Calculations.Engine.RefBase)
Protected MethodRefLoopConstructs a reference relative to the specified starting reference by walking the specified RefTuple enumerator. For each RefTuple, the next "current" reference is constucted by calling the Find method based on the scope of the RefTuple. If forceDataRef is true, then any IsDataReference references are forced to resolve to a specific data item when an incomplete identifier is specified. (Inherited from Infragistics.Calculations.Engine.RefBase)
See Also