TdxSpreadSheetDefinedNames.IndexOf(string,TdxSpreadSheetCustomView) Method

Returns an index of the specified defined name in the collection.

Declaration

function IndexOf(const ACaption: string; AScope: TdxSpreadSheetCustomView): Integer; overload;

Parameters

Name	Type	Description
ACaption	string	A defined name caption.
AScope	TdxSpreadSheetCustomView	A defined name scope.

Returns

Type	Description
Integer	A defined name index.

Remarks

If the AScope parameter accepts nil (in Delphi) or nullptr (in C++Builder), the defined name’s scope is the entire document opened in a spreadsheet control.

Note

If the collection does not contain a defined name with the specified caption and scope, an IndexOf function call returns -1.