Class NameRecord
The begin record defines the start of a block of records for a (Graphing) data object. This record is matched with a corresponding EndRecord.
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.NET.dll
Syntax
[Biff(TBIFFRecord.Name)]
[CLSCompliant(false)]
public class NameRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
NameRecord()
Default constructor
Declaration
public NameRecord()
NameRecord(Stream, out int)
Read / initialize constructor.
Declaration
public NameRecord(Stream stream, out int itemSize)
Parameters
| Type | Name | Description |
|---|---|---|
| Stream | stream | Stream from which record data should be read. |
| int | itemSize | Size of read item. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | If stream is not specified. |
| ApplicationException | If stream does not support read or seek operations. |
NameRecord(int)
Reserved for record's internal data array.
Declaration
public NameRecord(int iReserve)
Parameters
| Type | Name | Description |
|---|---|---|
| int | iReserve | Amount of bytes for data array. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentOutOfRangeException | If amount of bytes requested is less than zero. |
Fields
FunctionGroupBitMask
Bit mask of the Function group.
Declaration
public const ushort FunctionGroupBitMask = 4032
Field Value
| Type |
|---|
| ushort |
PREDEFINED_NAMES
Predefined names:
Declaration
public static string[] PREDEFINED_NAMES
Field Value
| Type |
|---|
| string[] |
Properties
Description
Optional. Description text (Unicode string without length field).
Declaration
public string Description { get; set; }
Property Value
| Type |
|---|
| string |
DescriptionLength
Read-only. Length of description text.
Declaration
public byte DescriptionLength { get; }
Property Value
| Type |
|---|
| byte |
FormulaDataSize
Read-only. Size of the formula data.
Declaration
public ushort FormulaDataSize { get; }
Property Value
| Type |
|---|
| ushort |
FormulaTokens
Formula data (RPN token array without size field).
Declaration
public Ptg[] FormulaTokens { get; set; }
Property Value
| Type |
|---|
| Ptg[] |
FunctionGroupIndex
Index to function group. Changes bits of m_usOptions member.
Declaration
public ushort FunctionGroupIndex { get; set; }
Property Value
| Type |
|---|
| ushort |
HasBinaryData
True if name contains binary data.
Declaration
public bool HasBinaryData { get; set; }
Property Value
| Type |
|---|
| bool |
HelpText
Optional. Help topic text (Unicode string without length field).
Declaration
public string HelpText { get; set; }
Property Value
| Type |
|---|
| string |
HelpTextLength
Read-only. Length of help topic text.
Declaration
public byte HelpTextLength { get; }
Property Value
| Type |
|---|
| byte |
IndexOrGlobal
0 if global name; otherwise index to sheet (one-based).
Declaration
public ushort IndexOrGlobal { get; set; }
Property Value
| Type |
|---|
| ushort |
IsBuinldInName
True if built-in name.
Declaration
public bool IsBuinldInName { get; set; }
Property Value
| Type |
|---|
| bool |
IsComplexFunction
True if complex function (array formula or user defined).
Declaration
public bool IsComplexFunction { get; set; }
Property Value
| Type |
|---|
| bool |
IsFunctionOrCommandMacro
True if function macro or command macro.
Declaration
public bool IsFunctionOrCommandMacro { get; set; }
Property Value
| Type |
|---|
| bool |
IsNameCommand
True if name is a command.
Declaration
public bool IsNameCommand { get; set; }
Property Value
| Type |
|---|
| bool |
IsNameFunction
True if name is a function.
Declaration
public bool IsNameFunction { get; set; }
Property Value
| Type |
|---|
| bool |
IsNameHidden
True if name is hidden.
Declaration
public bool IsNameHidden { get; set; }
Property Value
| Type |
|---|
| bool |
KeyboardShortcut
Keyboard shortcut.
Declaration
public byte KeyboardShortcut { get; set; }
Property Value
| Type |
|---|
| byte |
MenuText
Optional. Menu text (Unicode string without length field).
Declaration
public string MenuText { get; set; }
Property Value
| Type |
|---|
| string |
MenuTextLength
Read-only. Length of menu text.
Declaration
public byte MenuTextLength { get; }
Property Value
| Type |
|---|
| byte |
MinimumRecordSize
Read-only. Minimum possible size of the record.
Declaration
public override int MinimumRecordSize { get; }
Property Value
| Type |
|---|
| int |
Overrides
Name
Name (Unicode string without length field).
Declaration
public string Name { get; set; }
Property Value
| Type |
|---|
| string |
NameLength
Read-only. Length of the name.
Declaration
public byte NameLength { get; }
Property Value
| Type |
|---|
| byte |
Reserved
Read-only. Reserved (not used).
Declaration
public ushort Reserved { get; }
Property Value
| Type |
|---|
| ushort |
StatusText
Optional. Status bar text (Unicode string without length field).
Declaration
public string StatusText { get; set; }
Property Value
| Type |
|---|
| string |
StatusTextLength
Read-only. Length of status bar text.
Declaration
public byte StatusTextLength { get; }
Property Value
| Type |
|---|
| byte |
Methods
ClearData()
Clear Data
Declaration
public override void ClearData()
Overrides
Clone()
Declaration
public override object Clone()
Returns
| Type |
|---|
| object |
Overrides
GetStoreSize(ExcelVersion)
Size of the required storage space. Read-only.
Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
| Type | Name | Description |
|---|---|---|
| ExcelVersion | version |
Returns
| Type |
|---|
| int |
Overrides
IsPredefinedName(string)
Method checks name of NameRecord and determines whether it is a default or not.
Declaration
public static bool IsPredefinedName(string value)
Parameters
| Type | Name | Description |
|---|---|---|
| string | value | Name to check. |
Returns
| Type | Description |
|---|---|
| bool | True if name is Predefined name; otherwise False. |
ParseStructure(DataProvider, int, int, ExcelVersion)
Parse structure of record. Converts data buffer to special values according to record specification.
Declaration
public override void ParseStructure(DataProvider provider, int iOffset, int iLength, ExcelVersion version)
Parameters
| Type | Name | Description |
|---|---|---|
| DataProvider | provider | Object that provides access to the data. |
| int | iOffset | Offset to the record's data. |
| int | iLength | Length of the record's data. |
| ExcelVersion | version | Excel version used for infill. |
Overrides
Exceptions
| Type | Condition |
|---|---|
| WrongBiffRecordDataException | If there is any internal error. |
PredefinedIndex(string)
Looks for name in the predefined names table.
Declaration
public static int PredefinedIndex(string value)
Parameters
| Type | Name | Description |
|---|---|---|
| string | value | Value to look for. |
Returns
| Type | Description |
|---|---|
| int | Index in the predefined names array. |