Version

UCReference Class Members

The following tables list the members exposed by UCReference.

Public Constructors
 NameDescription
Public ConstructorUCReference ConstructorOverloaded.   
Public Properties
 NameDescription
Public PropertyAbsoluteNameReturns the absolute name for the reference  
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 IUltraCalcFormula, if any, associated with this Reference. If this reference can not contain a formula then null is returned.  
Public PropertyHasAbsoluteIndexIndicates if the underlying reference has an absolute index.  
Public PropertyHasRelativeIndexIndicates if the underlying reference has a relative index.  
Public PropertyHasScopeAllIndicates if the underlying reference was constructed with a scope all index.  
Public PropertyIsConnectedIndicates if the UCReference is currently connected to an underlying IUltraCalcReference  
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 PropertyNormalizedAbsoluteNameReturns the normalized absolute name. UltraCalcEngine 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 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 PropertyRecalcDeferredFlag used by the UltraCalcEngine to manage the recalculation network. Denotes the reference is visible.  
Public PropertyRecalcVisibleFlag used by the UltraCalcEngine to manage the recalculation network. Denotes the reference is visible.  
Public PropertyReferenceReturns the underlying reference or this instance if the object is not connected.  
Public PropertyReferencesReturn a collection of references if this Reference is enumerable. An exception is thrown if this reference is not enumerable.  
Public PropertyRootNameReturns the root name for the reference  
Public PropertyValueThe UltraCalcValue, if any, associated with this Reference. If this reference does not contain a Value then a UltraCalcErrorValue is returned.  
Public Methods
 NameDescription
Public MethodConnectAssociates the UCReference with the specified IUltraCalcReference  
Public MethodContainsReferenceReturns true if this reference contains inReference  
Public MethodCreateRangeCreate a Range reference relative to this reference.  
Public MethodCreateReferenceCreate a new reference relative to this reference.  
Public MethodDisconnectDisconnects the UCReference from the underlying IUltraCalcReference  
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.  
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.  
Public MethodIsSiblingReferenceDetermines whether the given reference is a sibling of this reference  
Public MethodIsSubsetReferenceReturns 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.  
Public MethodReconnectDisconnects from the previous reference and connects to the specified IUltraCalcReference  
Public MethodResolveReferenceResolves 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.  
See Also