Class BitmapRecord

This record is part of the Page Settings Block. It stores the background bitmap of a worksheet.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
BiffRecordRawWithArray
BiffContinueRecordRaw
BitmapRecord
Implements
System.ICloneable
System.IDisposable
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Portable.dll
Syntax
[Biff]
public class BitmapRecord : BiffContinueRecordRaw, ICloneable, IBiffStorage, IDisposable

Constructors

BitmapRecord()

Default Constructor

Declaration
public BitmapRecord()

BitmapRecord(Int32)

Reserved for the record's internal data array.

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

BitmapRecord(Stream, out Int32)

Read / initialize Constructor.

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

When stream is not specified.
System.ApplicationException

When stream does not support read or seek operations.

Properties

ColorDepth

Color depth, must be 24 bit true-color.

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

HeaderSize

Header structure size.

Declaration
public int HeaderSize { get; set; }
Property Value
Type
System.Int32

Height

Height of the picture, in pixel.

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

Picture

Image.

Declaration
public Image Picture { get; set; }
Property Value
Type
Image

Planes

Number of planes, must be 1.

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

TotalSize

Total size of the following record data, without this field (including CONTINUE records).

Declaration
public int TotalSize { get; set; }
Property Value
Type
System.Int32

Unknown

Unknown value.

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

Unknown2

Unknown value.

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

Width

Width of the picture, in pixel.

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

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