Class HLinkRecord

The record represents an empty cell. It contains the cell address and formatting information.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
BiffRecordRawWithArray
HLinkRecord
Implements
System.ICloneable
System.IDisposable
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.HLink)]
[CLSCompliant(false)]
public class HLinkRecord : BiffRecordRawWithArray, ICloneable, IBiffStorage, IDisposable

Constructors

HLinkRecord()

Default constructor fills all data with default values.

Declaration
public HLinkRecord()

HLinkRecord(Int32)

Reserved for record's internal data array.

Declaration
public HLinkRecord(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.

HLinkRecord(Stream, out Int32)

Read / initialize constructor.

Declaration
public HLinkRecord(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

FILE_UNKNOWN

Unknown block in the file link.

Declaration
public static byte[] FILE_UNKNOWN
Field Value
Type Description
System.Byte[]

FILE_UNKNOWN2

Another unknown block in the file link.

Declaration
public static byte[] FILE_UNKNOWN2
Field Value
Type Description
System.Byte[]

FILEMONIKER_START_BYTE

Start byte of the file moniker GUID.

Declaration
public const int FILEMONIKER_START_BYTE = 0
Field Value
Type Description
System.Int32

GUID_FILEMONIKER

File moniker GUID.

Declaration
public static readonly Guid GUID_FILEMONIKER
Field Value
Type Description
System.Guid

GUID_FILEMONIKER_BYTES

File moniker GUID bytes.

Declaration
public static byte[] GUID_FILEMONIKER_BYTES
Field Value
Type Description
System.Byte[]

GUID_LENGTH

GUID size.

Declaration
public const int GUID_LENGTH = 16
Field Value
Type Description
System.Int32

Standard link GUID.

Declaration
public static readonly Guid GUID_STDLINK
Field Value
Type Description
System.Guid

Standard link GUID bytes.

Declaration
public static byte[] GUID_STDLINK_BYTES
Field Value
Type Description
System.Byte[]

GUID_URLMONIKER

URL moniker GUID.

Declaration
public static readonly Guid GUID_URLMONIKER
Field Value
Type Description
System.Guid

GUID_URLMONIKER_BYTES

URL moniker GUID bytes.

Declaration
public static byte[] GUID_URLMONIKER_BYTES
Field Value
Type Description
System.Byte[]

Start byte of the standard link GUID.

Declaration
public const int STDLINK_START_BYTE = 8
Field Value
Type Description
System.Int32

URLMONIKER_START_BYTE

Start byte of the URL moniker GUID.

Declaration
public const int URLMONIKER_START_BYTE = 0
Field Value
Type Description
System.Int32

Properties

CanBeFile

Declaration
public bool CanBeFile { get; set; }
Property Value
Type Description
System.Boolean

CanBeUnc

Declaration
public bool CanBeUnc { get; set; }
Property Value
Type Description
System.Boolean

CanBeUrl

Declaration
public bool CanBeUrl { get; set; }
Property Value
Type Description
System.Boolean

CanBeWorkbook

Declaration
public bool CanBeWorkbook { get; set; }
Property Value
Type Description
System.Boolean

Description

(optional, see option flags) Character array of description text, no Unicode string header, always 16-bit characters, zero-terminated.

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String

DescriptionLen

(optional, see option flags) Character count of description text, including trailing zero word. Read-only.

Declaration
public uint DescriptionLen { get; }
Property Value
Type Description
System.UInt32

DirUpLevel

Declaration
public ushort DirUpLevel { get; set; }
Property Value
Type Description
System.UInt16

FileName

Declaration
public string FileName { get; set; }
Property Value
Type Description
System.String

FileNameLen

Declaration
public uint FileNameLen { get; }
Property Value
Type Description
System.UInt32

FirstColumn

Index to first column.

Declaration
public uint FirstColumn { get; set; }
Property Value
Type Description
System.UInt32

FirstRow

Index to first row.

Declaration
public uint FirstRow { get; set; }
Property Value
Type Description
System.UInt32

FollowSize

Declaration
public uint FollowSize { get; }
Property Value
Type Description
System.UInt32

IsAbsolutePathOrUrl

True if absolute path or URL. False if relative file path.

Declaration
public bool IsAbsolutePathOrUrl { get; set; }
Property Value
Type Description
System.Boolean

IsDescription

True if there is description. False if there is no description.

Declaration
public bool IsDescription { get; set; }
Property Value
Type Description
System.Boolean

IsFileName

Declaration
public bool IsFileName { get; set; }
Property Value
Type Description
System.Boolean

IsFileOrUrl

True if file link or URL. False if no link.

Declaration
public bool IsFileOrUrl { get; set; }
Property Value
Type Description
System.Boolean

IsTargetFrame

True if there is a target frame. False if there is no target frame.

Declaration
public bool IsTargetFrame { get; set; }
Property Value
Type Description
System.Boolean

IsTextMark

True if there is a text mark. False if there is no text mark.

Declaration
public bool IsTextMark { get; set; }
Property Value
Type Description
System.Boolean

IsUncPath

True if UNC path (incl. server name). False if file link or URL.

Declaration
public bool IsUncPath { get; set; }
Property Value
Type Description
System.Boolean

IsUrl

Declaration
public bool IsUrl { get; set; }
Property Value
Type Description
System.Boolean

LastColumn

Index to last column.

Declaration
public uint LastColumn { get; set; }
Property Value
Type Description
System.UInt32

LastRow

Index to last row.

Declaration
public uint LastRow { get; set; }
Property Value
Type Description
System.UInt32

LinkType

Declaration
public ExcelHyperLinkType LinkType { get; set; }
Property Value
Type Description
ExcelHyperLinkType

Options

Option flags. Read-only.

Declaration
public uint Options { get; }
Property Value
Type Description
System.UInt32

TargetFrame

(optional, see option flags) Character array of target frame, no Unicode string header, always 16-bit characters, zero-terminated.

Declaration
public string TargetFrame { get; set; }
Property Value
Type Description
System.String

TargetFrameLen

(optional, see option flags) Character count of target frame, including trailing zero word. Read-only.

Declaration
public uint TargetFrameLen { get; }
Property Value
Type Description
System.UInt32

TextMark

(optional, see option flags) Character array of the text mark without the "#" sign, no Unicode string header, always 16-bit characters, zero-terminated.

Declaration
public string TextMark { get; set; }
Property Value
Type Description
System.String

TextMarkLen

(optional, see option flags) Character count of the text mark, including trailing zero word.

Declaration
public uint TextMarkLen { get; }
Property Value
Type Description
System.UInt32

UncLen

Read-only.

Declaration
public uint UncLen { get; }
Property Value
Type Description
System.UInt32

UncPath

Declaration
public string UncPath { get; set; }
Property Value
Type Description
System.String

Unknown

Unknown value: 00000002H. Read-only.

Declaration
public uint Unknown { get; }
Property Value
Type Description
System.UInt32

Url

Declaration
public string Url { get; set; }
Property Value
Type Description
System.String

UrlLen

Declaration
public uint UrlLen { get; }
Property Value
Type Description
System.UInt32

XFilePath

Declaration
public string XFilePath { get; set; }
Property Value
Type Description
System.String

XFilePathLen

Declaration
public uint XFilePathLen { get; }
Property Value
Type Description
System.UInt32

Methods

ParseStructure()

Parse structure of record. Converts data buffer to special values according to record specification.

Declaration
public override void ParseStructure()
Overrides

Implements

System.ICloneable
System.IDisposable