Version 24.2 (latest)

RefRange Class Methods

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

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.Calculations.Engine.RefBase)
Public MethodCreateReferenceCreate a new reference relative to this reference. (Inherited from Infragistics.Calculations.Engine.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.Calculations.Engine.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.Calculations.Engine.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.Calculations.Engine.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.Calculations.Engine.RefBase)
Public MethodIsSiblingReferenceDetermines whether the given reference is a sibling of this reference (Inherited from Infragistics.Calculations.Engine.RefBase)
Public MethodIsSubsetReferenceReturns true if inReference is a proper subset of this reference (Inherited from Infragistics.Calculations.Engine.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 ICalculationReferenceCollection 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.Calculations.Engine.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.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)
Protected MethodValidateValidates the Range. This implementation requires that a Range is constrained to the last tuple in the Reference Path.  
See Also