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.

Inheritance

System.Object

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw

NameRecord

Implements

System.ICloneable

IBiffStorage

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.XlsIO.Parser.Biff_Records

Assembly: Syncfusion.XlsIO.Base.dll

Syntax

[Biff(TBIFFRecord.Name)]
[CLSCompliant(false)]
public class NameRecord : BiffRecordRaw, ICloneable, IBiffStorage

Constructors

NameRecord()

Default constructor

Declaration

public NameRecord()

NameRecord(Int32)

Reserved for record's internal data array.

Declaration

public NameRecord(int iReserve)

Parameters

Type	Name	Description
System.Int32	iReserve	Amount of bytes for data array.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	If amount of bytes requested is less than zero.

NameRecord(Stream, out Int32)

Read / initialize constructor.

Declaration

public NameRecord(Stream stream, out int itemSize)

Parameters

Type	Name	Description
System.IO.Stream	stream	Stream from which record data should be read.
System.Int32	itemSize	Size of read item.

Exceptions

Type	Condition
System.ArgumentNullException	If stream is not specified.
System.ApplicationException	If stream does not support read or seek operations.

Fields

FunctionGroupBitMask

Bit mask of the Function group.

Declaration

public const ushort FunctionGroupBitMask = 4032

Field Value

Type	Description
System.UInt16

PREDEFINED_NAMES

Predefined names:

Declaration

public static string[] PREDEFINED_NAMES

Field Value

Type	Description
System.String[]

Properties

Description

Optional. Description text (Unicode string without length field).

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

DescriptionLength

Read-only. Length of description text.

Declaration

public byte DescriptionLength { get; }

Property Value

Type	Description
System.Byte

FormulaDataSize

Read-only. Size of the formula data.

Declaration

public ushort FormulaDataSize { get; }

Property Value

Type	Description
System.UInt16

FormulaTokens

Formula data (RPN token array without size field).

Declaration

public Ptg[] FormulaTokens { get; set; }

Property Value

Type	Description
Ptg[]

FunctionGroupIndex

Index to function group. Changes bits of m_usOptions member.

Declaration

public ushort FunctionGroupIndex { get; set; }

Property Value

Type	Description
System.UInt16

HasBinaryData

True if name contains binary data.

Declaration

public bool HasBinaryData { get; set; }

Property Value

Type	Description
System.Boolean

HelpText

Optional. Help topic text (Unicode string without length field).

Declaration

public string HelpText { get; set; }

Property Value

Type	Description
System.String

HelpTextLength

Read-only. Length of help topic text.

Declaration

public byte HelpTextLength { get; }

Property Value

Type	Description
System.Byte

IndexOrGlobal

0 if global name; otherwise index to sheet (one-based).

Declaration

public ushort IndexOrGlobal { get; set; }

Property Value

Type	Description
System.UInt16

IsBuinldInName

True if built-in name.

Declaration

public bool IsBuinldInName { get; set; }

Property Value

Type	Description
System.Boolean

IsComplexFunction

True if complex function (array formula or user defined).

Declaration

public bool IsComplexFunction { get; set; }

Property Value

Type	Description
System.Boolean

IsFunctionOrCommandMacro

True if function macro or command macro.

Declaration

public bool IsFunctionOrCommandMacro { get; set; }

Property Value

Type	Description
System.Boolean

IsNameCommand

True if name is a command.

Declaration

public bool IsNameCommand { get; set; }

Property Value

Type	Description
System.Boolean

IsNameFunction

True if name is a function.

Declaration

public bool IsNameFunction { get; set; }

Property Value

Type	Description
System.Boolean

IsNameHidden

True if name is hidden.

Declaration

public bool IsNameHidden { get; set; }

Property Value

Type	Description
System.Boolean

KeyboardShortcut

Keyboard shortcut.

Declaration

public byte KeyboardShortcut { get; set; }

Property Value

Type	Description
System.Byte

MenuText

Optional. Menu text (Unicode string without length field).

Declaration

public string MenuText { get; set; }

Property Value

Type	Description
System.String

MenuTextLength

Read-only. Length of menu text.

Declaration

public byte MenuTextLength { get; }

Property Value

Type	Description
System.Byte

MinimumRecordSize

Read-only. Minimum possible size of the record.

Declaration

public override int MinimumRecordSize { get; }

Property Value

Type	Description
System.Int32

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MinimumRecordSize

Name

Name (Unicode string without length field).

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

NameLength

Read-only. Length of the name.

Declaration

public byte NameLength { get; }

Property Value

Type	Description
System.Byte

Reserved

Read-only. Reserved (not used).

Declaration

public ushort Reserved { get; }

Property Value

Type	Description
System.UInt16

StatusText

Optional. Status bar text (Unicode string without length field).

Declaration

public string StatusText { get; set; }

Property Value

Type	Description
System.String

StatusTextLength

Read-only. Length of status bar text.

Declaration

public byte StatusTextLength { get; }

Property Value

Type	Description
System.Byte

Methods

ClearData()

Clear Data

Declaration

public override void ClearData()

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.ClearData()

Clone()

Declaration

public override object Clone()

Returns

Type	Description
System.Object

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.Clone()

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	Description
System.Int32

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.GetStoreSize(Syncfusion.XlsIO.ExcelVersion)

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
System.String	value	Name to check.

Returns

Type	Description
System.Boolean	True if name is Predefined name; otherwise False.

ParseStructure(DataProvider, Int32, Int32, 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.
System.Int32	iOffset	Offset to the record's data.
System.Int32	iLength	Length of the record's data.
ExcelVersion	version	Excel version used for infill.

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.ParseStructure(Syncfusion.XlsIO.Parser.Biff_Records.DataProvider, System.Int32, System.Int32, Syncfusion.XlsIO.ExcelVersion)

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
System.String	value	Value to look for.

Returns

Type	Description
System.Int32	Index in the predefined names array.

Implements

System.ICloneable

IBiffStorage