ig.excel.IExcelCalcReference

The Primary Reference Inteface.

Dependencies

jquery-1.4.4.js
infragistics.util.js
The current widget has no options.
The current widget has no events.

  • absoluteName

    .absoluteName( );

    Gets the fully qualified unique name for the referenced element. Read Only.

  • containsReference

    .containsReference( inReference:ig.excel.IExcelCalcReference );
    Return Type:
    boolean
    Return Type Description:
    true if inReference is contained by this reference.

    Returns true if this reference contains inReference

    • inReference
    • Type:ig.excel.IExcelCalcReference
    • The contained candidate.

    Remarks

    This method is used by the calculation engine to determine if the passed in reference is either a child of this reference or a more fully scoped version of this reference. Each element in this reference is compared with the corresponding element in the input reference. If the identifiers are the same, and if this scope contains the input scope, then the input reference is contained by this reference. If the input reference is longer than this reference and the common element are contained, then the input reference is contained.

  • context

    .context( );

    Returns a context for the Reference.

    Remarks

    Returns a meaningful object context for the reference. This could be an UltraGridCell, UltraGridColumn, NamedReference, Control, etc.

  • createReference

    .createReference( referenceString:string );
    Return Type:
    ig.excel.IExcelCalcReference
    Return Type Description:
    The new reference.

    Create a new reference relative to this reference.

    • referenceString
    • Type:string
    • The reference string.

    Remarks

    A reference string may be external or internal.

    A external reference has the form "//object_name/object_specific_part". The control identified by object_name must implement IExcelCalcReference and be able to parse object_specific_part.

    An internal reference is a reference within the same control that implements this instance of the interface. An internal reference can be absolute or relative. Absolute references must begin with the "/" character. Such references must be created relative to the root object in the control. Relative references are created relative to this reference.

    Note that in complex reference models, multiple reference strings may point to the same underlying object. The reference string used to create the reference must be available to other methods such as ResolveReference, References and MarkRelativeIndicies. Consequently, if the reference string is relative, a proxy reference object should be returned that retains the relative reference string.

  • elementName

    .elementName( );

    Gets the unqualified name of this referenced element. Read Only.

  • formula

    .formula( );

    Gets the IExcelCalcFormula, if any, associated with this Reference. If this reference can not contain a formula then null is returned.

  • isEnumerable

    .isEnumerable( );

    Returns true if this reference is enumerable.

  • isSubsetReference

    .isSubsetReference( inReference:ig.excel.IExcelCalcReference );
    Return Type:
    boolean
    Return Type Description:
    true if inReference is contained by this reference.

    Returns true if inReference is a proper subset of this reference

    • inReference
    • Type:ig.excel.IExcelCalcReference
    • The subset candidate.

    Remarks

    This method is used by the calculation engine to determine if the passed in reference is fully contained by this reference. Each element in this reference is compared with the corresponding element in the input reference. If the identifiers are the same, and if this scope entirely contains the input scope, then the input reference is a proper subset this reference.

  • normalizedAbsoluteName

    .normalizedAbsoluteName( );

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

  • references

    .references( );
    Return Type:
    ig.excel.IExcelCalcReferenceCollection
    Return Type Description:
    A Reference collection.

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

    Remarks

    The collection returned by this method must be constrained to the scope specified by the original string used to create the reference. For example, if the original reference string was [Customers(State="MA")/Total], then the collection should be constrained to the Total cells for all customers that have State = "MA".

  • value

    .value( );

    Gets the ExcelCalcValue, if any, associated with this Reference. If this reference does not contain a Value then a ExcelCalcErrorValue is returned.

  • value

    .value( value:ig.excel.ExcelCalcValue );

    Sets the ExcelCalcValue, if any, associated with this Reference. If this reference does not contain a Value then a ExcelCalcErrorValue is returned.

    • value
    • Type:ig.excel.ExcelCalcValue

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.