Class PrintSetupRecord

Stores print setup options.

Inheritance

System.Object

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw

PrintSetupRecord

Implements

System.ICloneable

IBiffStorage

Inherited Members

System.Object.Equals(System.Object)

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

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

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

System.Object.ToString()

Namespace: Syncfusion.XlsIO.Parser.Biff_Records

Assembly: Syncfusion.XlsIO.Base.dll

Syntax

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

Constructors

PrintSetupRecord()

Default constructor

Declaration

public PrintSetupRecord()

PrintSetupRecord(Int32)

Reserved for record's internal data array.

Declaration

public PrintSetupRecord(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.

PrintSetupRecord(Stream, out Int32)

Read / initialize constructor.

Declaration

public PrintSetupRecord(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

ErrorBitMask

Bit mask for error print options.

Declaration

public const ushort ErrorBitMask = 3072

Field Value

Type
System.UInt16

ErrorStartBit

Start bit of error print options in m_usOptions.

Declaration

public const int ErrorStartBit = 10

Field Value

Type
System.Int32

Properties

Copies

Number of copies to print.

Declaration

public ushort Copies { get; set; }

Property Value

Type
System.UInt16

FitHeight

Fit worksheet height to this number of pages (0 = use as many as needed).

Declaration

public ushort FitHeight { get; set; }

Property Value

Type
System.UInt16

FitWidth

Fit worksheet width to this number of pages (0 = use as many as needed).

Declaration

public ushort FitWidth { get; set; }

Property Value

Type
System.UInt16

FooterMargin

Footer margin (IEEE floating-point value).

Declaration

public double FooterMargin { get; set; }

Property Value

Type
System.Double

HeaderMargin

Header margin (IEEE floating-point value).

Declaration

public double HeaderMargin { get; set; }

Property Value

Type
System.Double

HResolution

Print resolution in dpi.

Declaration

public ushort HResolution { get; set; }

Property Value

Type
System.UInt16

IsDraft

False for default print quality; True for draft quality.

Declaration

public bool IsDraft { get; set; }

Property Value

Type
System.Boolean

IsLeftToRight

False to print pages in columns; True to print pages in rows.

Declaration

public bool IsLeftToRight { get; set; }

Property Value

Type
System.Boolean

IsNoColor

False to print in color; True to print in black and white.

Declaration

public bool IsNoColor { get; set; }

Property Value

Type
System.Boolean

IsNoOrientation

False if paper orientation setting is valid; True if paper orientation setting is not initialized.

Declaration

public bool IsNoOrientation { get; set; }

Property Value

Type
System.Boolean

IsNotes

Indicates whether to print cell notes.

Declaration

public bool IsNotes { get; set; }

Property Value

Type
System.Boolean

IsNotLandscape

False if landscape; True if portrait.

Declaration

public bool IsNotLandscape { get; set; }

Property Value

Type
System.Boolean

IsNotValidSettings

True if paper size, scaling factor, paper orientation (portrait / landscape), print resolution, and number of copies are not initialized.

Declaration

public bool IsNotValidSettings { get; set; }

Property Value

Type
System.Boolean

IsPrintNotesAsDisplayed

False if print notes as displayed; True if print notes are at the end of sheet.

Declaration

public bool IsPrintNotesAsDisplayed { get; set; }

Property Value

Type
System.Boolean

IsUsePage

False for automatic page numbers; True to use starting page number.

Declaration

public bool IsUsePage { get; set; }

Property Value

Type
System.Boolean

MaximumRecordSize

Read-only. Returns maximum possible size of record's internal data array.

Declaration

public override int MaximumRecordSize { get; }

Property Value

Type
System.Int32

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MaximumRecordSize

MinimumRecordSize

Read-only. Returns minimum possible size of record's internal data array.

Declaration

public override int MinimumRecordSize { get; }

Property Value

Type
System.Int32

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MinimumRecordSize

PageStart

Start page number.

Declaration

public short PageStart { get; set; }

Property Value

Type
System.Int16

PaperSize

Paper size.

Declaration

public ushort PaperSize { get; set; }

Property Value

Type
System.UInt16

PrintErrors

Indicates how to print errors.

Declaration

public ExcelPrintErrors PrintErrors { get; set; }

Property Value

Type
ExcelPrintErrors

Scale

Scaling factor in percent.

Declaration

public ushort Scale { get; set; }

Property Value

Type
System.UInt16

VResolution

Vertical print resolution in dpi.

Declaration

public ushort VResolution { get; set; }

Property Value

Type
System.UInt16

Methods

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

Overrides

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

ParseStructure(DataProvider, Int32, Int32, ExcelVersion)

Parse structure of record. Convert 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)

Implements

System.ICloneable

IBiffStorage