Version

RefRange Class Members

The following tables list the members exposed by RefRange.

Public Constructors
 NameDescription
Public ConstructorRefRange ConstructorInitializes a new RefRange  
Protected Fields
 NameDescription
Protected FieldfromThe start of the range, not normalized, inclusive.  
Protected FieldnormalizedFromThe normalized start of the range, inclusive.  
Protected FieldnormalizedToThe normalized end of the range, inclusive.  
Protected FieldtoThe end of the range, not normalized, inclusive.  
Public Properties
 NameDescription
Public PropertyAbsoluteNameOverridden. The fully qualified unique name for the referenced element. Read Only.

The AbsoluteName for a Range is from.AbsoluteName + ":" + to.AbsoluteName

 
Public PropertyBaseParentOverridden. The 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.

The Parent of a Range is this.from

 
Public PropertyContextReturns a context for the Reference. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public PropertyElementNameOverridden. The unqualified name of this referenced element. Used to construct the fully qualified name by the AbsoluteName method. Read Only.

The ElementName for a Range is from.ElementName + ":" + to.ElementName

 
Public PropertyFormulaThe IUltraCalcFormula, if any, associated with this Reference. If this reference can not contain a formula then null is returned. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public PropertyFromBaseReturn the From reference as a Refbase.  
Public PropertyFromRefReturn the From reference as a IUltraCalcReference.  
Public PropertyHasAbsoluteIndexTrue indicates that the reference was constructed with a relative index. Read Only. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public PropertyHasRelativeIndexOverridden. True indicates that the reference was constructed with a relative index. Read Only.

The HasRelativeIndex for a Range is from.HasRelativeIndex

 
Public PropertyHasScopeAllTrue indicates that the reference was constructed with a scope all index. Read Only. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
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. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
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.

A Range is always a Data Reference.

 
Public PropertyIsDisposedReferenceTrue indicates that the reference was disposed. Read Only. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public PropertyIsEnumerableOverridden. Returns true. A range is enumerable.  
Public PropertyIsRangeOverridden. Returns true. This reference is a Range Reference. Read Only.  
Public PropertyNormalizedAbsoluteNameOverridden. Returns the normalized absolute name. Calculation engine makes use 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 PropertyNormalizedFromBaseReturn the Normalized From reference as a Refbase.  
Public PropertyNormalizedFromRefReturn the normalized From reference as a IUltraCalcReference.  
Public PropertyNormalizedToBaseReturn the normalized To reference as a RefBase.  
Public PropertyNormalizedToRefReturn the normalized To reference as a IUltraCalcReference.  
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.WebUI.CalcEngine.RefBase)
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. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public PropertyRecalcDeferredFlag used by the calculation engine to manage the recalculation network. Denotes the reference is visible. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public PropertyRecalcVisibleFlag used by the calculation engine to manage the recalculation network. Denotes the reference is visible. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public PropertyReferencesOverridden. Return a collection of references if this Reference is enumerable. An exception is thrown if this reference is not enumerable.

A Range returns a RefRangeCollection.

 
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. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public PropertyToBaseReturn the To reference as a Refbase.  
Public PropertyToRefReturn the To reference as a IUltraCalcReference.  
Public PropertyValueThe UltraCalcValue, if any, associated with this Reference. If this reference does not contain a Value then a UltraCalcErrorValue is returned. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public PropertyWrappedReferenceReturns the indirect reference of an UnAnchored reference. Read only. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public Methods
 NameDescription
Public MethodContainsReturns true if targetRP is contained in this Range.  
Public MethodContainsReferenceOverridden. Returns true if this Range contains inReference  
Public MethodCreateRangeCreate a Range reference relative to this reference. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public MethodCreateReferenceCreate a new reference relative to this reference. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public MethodEqualsOverriden. Default implementation returns true if the normalized absolute names of this reference and the passed in reference match. These objects are going to be added to data structure that make use of GetHashCode and Equals methods. What this means is that the normalized absolute name must not change throughout the lifetime of this instance. If it does change then the overriding class must override this method and return a hash code based on some other immutable property of the instance. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public MethodFindAllOverridden. Returns the named reference relative to this reference with scope "All"

This always throws an exception. This method should never be called on a Range because a Range is never created by BuildReference

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

This always throws an exception. This method should never be called on a Range because a Range is never created by BuildReference

 
Public MethodFindParentReturns a reference to this elements Parent. Some Reference implementations (RefColumn) override this to return something different than BaseParent when handling ".." (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public MethodFindSummaryItemOverridden. Returns the named SummaryItem reference relative to this reference.

This always throws an exception. This method should never be called on a Range because a Range is never created by BuildReference

 
Public MethodGetChildReferencesReturns the child references of the reference. This method can return null. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public MethodGetEnumeratorReturns an Enumerator over the Range.  
Public MethodGetHashCodeOverridden. Default implementation returns the hash code of the normalized absolute name. These objects are going to be added to data structure that make use of GetHashCode and Equals methods. What this means is that the normalized absolute name must not change throughout the lifetime of this instance. If it does change then the overriding class must override this method and return a hash code based on some other immutable property of the instance. (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public MethodIsSiblingReferenceDetermines whether the given reference is a sibling of this reference (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public MethodIsSubsetReferenceReturns true if inReference is a proper subset of this reference (Inherited from Infragistics.WebUI.CalcEngine.RefBase)
Public MethodMarkRelativeIndicesOverridden. For each reference tuple in this reference that has a relative index, mark the corresponding tuple in inReference.  
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.

ResolveReference for a Range is from.ResolveReference

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

A Range returns a RefRangeCollection.

 
Public MethodToStringReturns a string representation of the range including the class type as well as the to and from reference.  
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.WebUI.CalcEngine.RefBase)
Protected MethodCreateParsedReferenceOverridden. Used to create a new RefParser for the reference.  
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.WebUI.CalcEngine.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.WebUI.CalcEngine.RefBase)
Protected MethodValidateValidates the Range. This implementation requires that a Range is constrained to the last tuple in the Reference Path.  
See Also