Skip to main content

TdxSpreadSheetDefinedName Class

A defined name in a spreadsheet document.

Declaration

TdxSpreadSheetDefinedName = class(
    TdxSpreadSheetObjectListItem
)

Remarks

Defined names allow you to address specific cells, cell ranges, formula expressions, and constants by simple, meaningful names.

The TdxSpreadSheetDefinedName class members allow you to do the following:

  • Specify the defined name’s display name, reference, and scope (Caption, Reference, and Scope).

  • Add a comment to the defined name (Comment).

  • Obtain the target area and scope from the defined name if it refers to a cell or cell range (EnumReferences).

  • Identify if the defined name refers to a cell or cell range (IsCellReference).

  • Identify the defined name’s index in the collection (Index).

  • Access the collection to which the defined name belongs (Owner).

  • Obtain the defined name’s caption and scope as a string (ToString).

  • Access the Spreadsheet or Report Designer control to which the defined name belongs (SpreadSheet).

A spreadsheet control’s DefinedNames.Items property references a TdxSpreadSheetDefinedName object.

Refer to the following topic for detailed information on defined name management in spreadsheet documents: How to Work with Defined Names.

Inheritance

TObject
TdxSpreadSheetObjectListItem
TdxSpreadSheetDefinedName
See Also