PageSetupBaseImpl Class

Summary description for PageSetupBaseImpl.

Inheritance

System.Object

CommonObject

PageSetupBaseImpl

ChartPageSetupImpl

PageSetupImpl

Implements

System.IDisposable

IPageSetupBase

IParentApplication

Inherited Members

CommonObject.AddReference()

CommonObject.AppImplementation

CommonObject.Application

CommonObject.CheckDisposed()

CommonObject.Finalize()

CommonObject.FindParent(Object, Type)

CommonObject.FindParent(Object, Type, Boolean)

CommonObject.FindParent(Type)

CommonObject.FindParent(Type, Boolean)

CommonObject.FindParent(Type[])

CommonObject.FindParents(Type[])

CommonObject.m_bIsDisposed

CommonObject.OnDispose()

CommonObject.Parent

CommonObject.ReferenceCount

CommonObject.ReleaseReference()

CommonObject.SetParent(Object)

Namespace: Syncfusion.XlsIO.Implementation

Assembly: Syncfusion.XlsIO.Base.dll

Syntax

public class PageSetupBaseImpl : CommonObject, IDisposable, IPageSetupBase, IParentApplication, IBiffStorage

Constructors

PageSetupBaseImpl(IApplication, Object)

Sets application and parent fields.

Declaration

public PageSetupBaseImpl(IApplication application, object parent)

Parameters

Type	Name	Description
IApplication	application	Application object for the page setup.
System.Object	parent	Parent object for the page setup.

Fields

DEFAULT_BOTTOMMARGIN

Value of the bottom margin by default.

Declaration

public const double DEFAULT_BOTTOMMARGIN = 1

Field Value

Type
System.Double

DEFAULT_LEFTMARGIN

Value of the left margin by default.

Declaration

public const double DEFAULT_LEFTMARGIN = 0.75

Field Value

Type
System.Double

DEFAULT_RIGHTMARGIN

Value of the right margin by default.

Declaration

public const double DEFAULT_RIGHTMARGIN = 0.75

Field Value

Type
System.Double

DEFAULT_TOPMARGIN

Value of the top margin by default.

Declaration

public const double DEFAULT_TOPMARGIN = 1

Field Value

Type
System.Double

m_arrFooters

Array of footers: 0 - left footer, 1 - center footer, 2 - right footer.

Declaration

protected string[] m_arrFooters

Field Value

Type
System.String[]

m_arrHeaders

Array of headers: 0 - left header, 1 - center header, 2 - right header.

Declaration

protected string[] m_arrHeaders

Field Value

Type
System.String[]

m_backgroundImage

Contains background image.

Declaration

protected BitmapRecord m_backgroundImage

Field Value

Type
Syncfusion.XlsIO.Parser.Biff_Records.BitmapRecord

m_bHCenter

Whether to center between horizontal margins.

Declaration

protected bool m_bHCenter

Field Value

Type
System.Boolean

m_bVCenter

Whether to center between vertical margins.

Declaration

protected bool m_bVCenter

Field Value

Type
System.Boolean

m_dBottomMargin

This record contains information about worksheet bottom margin.

Declaration

protected double m_dBottomMargin

Field Value

Type
System.Double

m_dLeftMargin

This record contains information about worksheet left margin.

Declaration

protected double m_dLeftMargin

Field Value

Type
System.Double

m_dRightMargin

This record contains information about worksheet right margin.

Declaration

protected double m_dRightMargin

Field Value

Type
System.Double

m_dTopMargin

This record contains information about worksheet top margin.

Declaration

protected double m_dTopMargin

Field Value

Type
System.Double

m_headerFooter

Stores print setup options.

Declaration

protected HeaderAndFooterRecord m_headerFooter

Field Value

Type
Syncfusion.XlsIO.Parser.Biff_Records.HeaderAndFooterRecord

m_setup

Stores print setup options.

Declaration

protected PrintSetupRecord m_setup

Field Value

Type
Syncfusion.XlsIO.Parser.Biff_Records.PrintSetupRecord

m_unknown

Unknown record. This record contains additional information about system printer. If such record is found, it is stored, otherwise we is skipped.

Declaration

protected PrinterSettingsRecord m_unknown

Field Value

Type
Syncfusion.XlsIO.Parser.Biff_Records.PrinterSettingsRecord

Properties

AlignHFWithPageMargins

Indicates whether the header and footer margins are aligned with page margins. Read/Write Boolean.

Declaration

public bool AlignHFWithPageMargins { get; set; }

Property Value

Type
System.Boolean

AutoFirstPageNumber

Indicates whether FirstPageNumber is set to Auto or not.

Declaration

public bool AutoFirstPageNumber { get; set; }

Property Value

Type
System.Boolean

BackgoundImage

Gets / sets background image.

Declaration

public Bitmap BackgoundImage { get; set; }

Property Value

Type
System.Drawing.Bitmap

BlackAndWhite

True if elements of the document will be printed in black and white. Read/write Boolean.

Declaration

public bool BlackAndWhite { get; set; }

Property Value

Type
System.Boolean

BottomMargin

Gets or sets the size of the bottom margin, in inches. Read / write Double.

Declaration

public double BottomMargin { get; set; }

Property Value

Type
System.Double

CenterFooter

Gets or sets the center part of the footer. Read / write String. Special Formatting symbols: &P Current page number &N Page count &D Current date &T Current time &A Sheet name (BIFF5-BIFF8) &F File name without path &Z File path without file name (BIFF8X) &G Picture (BIFF8X) &B Bold on/off (BIFF2-BIFF4) &I Italic on/off (BIFF2-BIFF4) &U Underlining on/off &E Double underlining on/off (BIFF5-BIFF8) &S Strikeout on/off &X Superscript on/off (BIFF5-BIFF8) &Y Subscript on/off (BIFF5-BIFF8) &"[FONTNAME]" Set new font [FONTNAME] &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. The style [fontstyle] is in most cases one of Regular, Bold, Italic, or Bold Italic. But this setting is dependent on the used font, it may differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). If this command is followed by a plain number to be printed in the header, it will be separated from the font height with a space character.

Declaration

public string CenterFooter { get; set; }

Property Value

Type
System.String

CenterFooterImage

Gets / set image for center part of the footer.

Declaration

public Image CenterFooterImage { get; set; }

Property Value

Type
System.Drawing.Image

CenterHeader

Gets or sets the center part of the header. Read/write String. Special Formatting symbols: &P Current page number &N Page count &D Current date &T Current time &A Sheet name (BIFF5-BIFF8) &F File name without path &Z File path without file name (BIFF8X) &G Picture (BIFF8X) &B Bold on/off (BIFF2-BIFF4) &I Italic on/off (BIFF2-BIFF4) &U Underlining on/off &E Double underlining on/off (BIFF5-BIFF8) &S Strikeout on/off &X Superscript on/off (BIFF5-BIFF8) &Y Subscript on/off (BIFF5-BIFF8) &"[FONTNAME]" Set new font [FONTNAME] &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. The style [fontstyle] is in most cases one of Regular, Bold, Italic, or Bold Italic. But this setting is dependent on the used font, it may differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). If this command is followed by a plain number to be printed in the header, it will be separated from the font height with a space character.

Declaration

public string CenterHeader { get; set; }

Property Value

Type
System.String

CenterHeaderImage

Gets / set image for center part of the header.

Declaration

public Image CenterHeaderImage { get; set; }

Property Value

Type
System.Drawing.Image

CenterHorizontally

True if the sheet is centered horizontally on the page when it is printed. Read/write Boolean.

Declaration

public bool CenterHorizontally { get; set; }

Property Value

Type
System.Boolean

CenterVertically

True if the sheet is centered vertically on the page when it is printed. Read/write Boolean.

Declaration

public bool CenterVertically { get; set; }

Property Value

Type
System.Boolean

Copies

Number of copies to print.

Declaration

public int Copies { get; set; }

Property Value

Type
System.Int32

DifferentFirstPageHF

True - The header / footer of the first page is different with other pages.False otherwise.

Declaration

public bool DifferentFirstPageHF { get; set; }

Property Value

Type
System.Boolean

DifferentOddAndEvenPagesHF

True - The header/footer odd pages are differed with even page. False otherwise.

Declaration

public bool DifferentOddAndEvenPagesHF { get; set; }

Property Value

Type
System.Boolean

Draft

True if the sheet will be printed without graphics. Read/write Boolean.

Declaration

public bool Draft { get; set; }

Property Value

Type
System.Boolean

EvenPage

Gets values for even page

Declaration

public IPage EvenPage { get; }

Property Value

Type
IPage

FirstPage

Gets values for first page

Declaration

public IPage FirstPage { get; }

Property Value

Type
IPage

FirstPageNumber

Gets or sets the first page number that will be used when this sheet is printed.

Declaration

public short FirstPageNumber { get; set; }

Property Value

Type
System.Int16

FitToPagesTall

Returns or sets the height of the pages that the worksheet will be scaled to when it is printed. Applies only to worksheets. Read/write Boolean.

Declaration

public int FitToPagesTall { get; set; }

Property Value

Type
System.Int32

FitToPagesWide

Returns or sets the width of the pages the worksheet will be scaled to when it is printed. Applies only to worksheets. Read/write Boolean.

Declaration

public int FitToPagesWide { get; set; }

Property Value

Type
System.Int32

FooterMargin

Gets or sets the distance from the bottom of the page to the footer, in inches. Read/write Double.

Declaration

public double FooterMargin { get; set; }

Property Value

Type
System.Double

FullFooterString

Gets footer full string. Read/write.

Declaration

public string FullFooterString { get; set; }

Property Value

Type
System.String

FullHeaderString

Represents full header string. Read/write.

Declaration

public string FullHeaderString { get; set; }

Property Value

Type
System.String

HeaderMargin

Gets or sets the distance from the top of the page to the header, in inches. Read/write Double.

Declaration

public double HeaderMargin { get; set; }

Property Value

Type
System.Double

HFScaleWithDoc

Indicates whether the header and footer are scaled with document scaling.Read/Write Boolean.

Declaration

public bool HFScaleWithDoc { get; set; }

Property Value

Type
System.Boolean

HResolution

Gets / sets horizontal resolution in dpi.

Declaration

public int HResolution { get; set; }

Property Value

Type
System.Int32

IsFitToPage

Indicates whether fit to page mode is selected.

Declaration

public virtual bool IsFitToPage { 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; }

Property Value

Type
System.Boolean

LeftFooter

Gets or sets the left part of the footer. Read/write String.

Declaration

public string LeftFooter { get; set; }

Property Value

Type
System.String

Remarks

Special Formatting symbols: &P Current page number &N Page count &D Current date &T Current time &A Sheet name (BIFF5-BIFF8) &F File name without path &Z File path without file name (BIFF8X) &G Picture (BIFF8X) &B Bold on/off (BIFF2-BIFF4) &I Italic on/off (BIFF2-BIFF4) &U Underlining on/off &E Double underlining on/off (BIFF5-BIFF8) &S Strikeout on/off &X Superscript on/off (BIFF5-BIFF8) &Y Subscript on/off (BIFF5-BIFF8) &"[FONTNAME]" Set new font [FONTNAME] &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. The style [fontstyle] is in most cases one of Regular, Bold, Italic, or Bold Italic. But this setting is dependent on the used font, it may differ (localized style names, or Standard, Oblique, ...). (BIFF5-BIFF8) &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). If this command is followed by a plain number to be printed in the header, it will be separated from the font height with a space character.

LeftFooterImage

Gets / set image for left part of the footer.

Declaration

public Image LeftFooterImage { get; set; }

Property Value

Type
System.Drawing.Image

LeftHeader

Gets or sets the left part of the header. Read/write String.

Declaration

public string LeftHeader { get; set; }

Property Value

Type
System.String

Remarks

Special Formatting symbols: &P Current page number &N Page count &D Current date &T Current time &A Sheet name (BIFF5-BIFF8) &F File name without path &Z File path without file name (BIFF8X) &G Picture (BIFF8X) &B Bold on/off (BIFF2-BIFF4) &I Italic on/off (BIFF2-BIFF4) &U Underlining on/off &E Double underlining on/off (BIFF5-BIFF8) &S Strikeout on/off &X Superscript on/off (BIFF5-BIFF8) &Y Subscript on/off (BIFF5-BIFF8) &"[FONTNAME]" Set new font [FONTNAME] &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. The style [fontstyle] is in most cases one of Regular, Bold, Italic, or Bold Italic. But this setting is dependent on the used font, it may differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). If this command is followed by a plain number to be printed in the header, it will be separated from the font height with a space character.

LeftHeaderImage

Gets / set image for left part of the header.

Declaration

public Image LeftHeaderImage { get; set; }

Property Value

Type
System.Drawing.Image

LeftMargin

Gets or sets the size of the left margin, in inches. Read/write Double.

Declaration

public double LeftMargin { get; set; }

Property Value

Type
System.Double

NeedDataArray

Indicates whether data array is required by this record.

Declaration

public bool NeedDataArray { get; }

Property Value

Type
System.Boolean

Order

Gets or sets the order that Microsoft Excel uses to number pages when printing a large worksheet. Read / write ExcelOrder.

Declaration

public ExcelOrder Order { get; set; }

Property Value

Type
ExcelOrder

Orientation

Portrait or landscape printing mode. Read/write ExcelPageOrientation.

Declaration

public ExcelPageOrientation Orientation { get; set; }

Property Value

Type
ExcelPageOrientation

PageHeight

Returns page width in points. Read-only.

Declaration

public double PageHeight { get; }

Property Value

Type
System.Double

PageWidth

Returns page width in points. Read-only.

Declaration

public double PageWidth { get; }

Property Value

Type
System.Double

PaperSize

Gets or sets the size of the paper. Read / write ExcelPaperSize.

Declaration

public ExcelPaperSize PaperSize { get; set; }

Property Value

Type
ExcelPaperSize

PrintComments

Gets or sets the way comments are printed with the sheet. Read/write ExcelPrintLocation.

Declaration

public ExcelPrintLocation PrintComments { get; set; }

Property Value

Type
ExcelPrintLocation

PrintErrors

Sets or returns an ExcelPrintErrors constant specifying the type of print error displayed. This feature allows users to suppress the display of error values when printing a worksheet. Read/write.

Declaration

public ExcelPrintErrors PrintErrors { get; set; }

Property Value

Type
ExcelPrintErrors

PrintNotes

True if cell notes are printed as end notes with the sheet. Applies only to worksheets. Read/write Boolean.

Declaration

public bool PrintNotes { get; set; }

Property Value

Type
System.Boolean

PrintQuality

Gets or sets the print quality. Read / write ushort.

Declaration

public int PrintQuality { get; set; }

Property Value

Type
System.Int32

RecordCode

Returns code of the biff storage. Read-only.

Declaration

public int RecordCode { get; }

Property Value

Type
System.Int32

RightFooter

Gets or sets the right part of the footer. Read / write String.

Declaration

public string RightFooter { get; set; }

Property Value

Type
System.String

Remarks

Special Formatting symbols: &P Current page number &N Page count &D Current date &T Current time &A Sheet name (BIFF5-BIFF8) &F File name without path &Z File path without file name (BIFF8X) &G Picture (BIFF8X) &B Bold on/off (BIFF2-BIFF4) &I Italic on/off (BIFF2-BIFF4) &U Underlining on/off &E Double underlining on/off (BIFF5-BIFF8) &S Strikeout on/off &X Superscript on/off (BIFF5-BIFF8) &Y Subscript on/off (BIFF5-BIFF8) &"[FONTNAME]" Set new font [FONTNAME] &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. The style [fontstyle] is in most cases one of Regular, Bold, Italic, or Bold Italic. But this setting is dependent on the used font, it may differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). If this command is followed by a plain number to be printed in the header, it will be separated from the font height with a space character.

RightFooterImage

Gets / set image for right part of the footer.

Declaration

public Image RightFooterImage { get; set; }

Property Value

Type
System.Drawing.Image

RightHeader

Gets or sets the right part of the header. Read / write String. Special Formatting symbols: &P Current page number &N Page count &D Current date &T Current time &A Sheet name (BIFF5-BIFF8) &F File name without path &Z File path without file name (BIFF8X) &G Picture (BIFF8X) &B Bold on/off (BIFF2-BIFF4) &I Italic on/off (BIFF2-BIFF4) &U Underlining on/off &E Double underlining on/off (BIFF5-BIFF8) &S Strikeout on/off &X Superscript on/off (BIFF5-BIFF8) &Y Subscript on/off (BIFF5-BIFF8) &"[FONTNAME]" Set new font [FONTNAME] &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. The style [fontstyle] is in most cases one of Regular, Bold, Italic, or Bold Italic. But this setting is dependent on the used font, it may differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). If this command is followed by a plain number to be printed in the header, it will be separated from the font height with a space character.

Declaration

public string RightHeader { get; set; }

Property Value

Type
System.String

RightHeaderImage

Gets / set image for right part of the header.

Declaration

public Image RightHeaderImage { get; set; }

Property Value

Type
System.Drawing.Image

RightMargin

Returns or sets the size of the right margin, in inches. Read/write Double.

Declaration

public double RightMargin { get; set; }

Property Value

Type
System.Double

StreamPos

Indicates record position in stream. This is a utility member of class and is used only in the serialization process. Does not influence the data.

Declaration

public long StreamPos { get; set; }

Property Value

Type
System.Int64

TopMargin

Gets or sets the size of the top margin, in points. Read/write Double.

Declaration

public double TopMargin { get; set; }

Property Value

Type
System.Double

TypeCode

Returns type code of the biff storage. Read-only.

Declaration

public TBIFFRecord TypeCode { get; }

Property Value

Type
Syncfusion.XlsIO.Parser.Biff_Records.TBIFFRecord

VResolution

Gets / sets vertical resolution in dpi.

Declaration

public int VResolution { get; set; }

Property Value

Type
System.Int32

Zoom

Gets or sets a percentage (between 10 and 400 percent) by which Microsoft Excel will scale the worksheet for printing. Applies only to worksheets. Read/write ushort.

Declaration

public int Zoom { get; set; }

Property Value

Type
System.Int32

Methods

CreateHeaderFooterString(String[])

Function combines header or footer strings array to one format string.

Declaration

protected string CreateHeaderFooterString(string[] parts)

Parameters

Type	Name	Description
System.String[]	parts	Array which must contain only 3 elements.

Returns

Type	Description
System.String	Combined format string.

Exceptions

Type	Condition
System.ArgumentNullException	When parameter is null.
System.ArgumentException	When number of strings in parts is not 3.

Dispose()

Dispose Page Setup Base

Declaration

public override void Dispose()

Overrides

CommonObject.Dispose()

FindParents()

Find parent Worksheet.

Declaration

protected virtual void FindParents()

Exceptions

Type	Condition
System.ArgumentException	Can't find parent worksheet.

GetRecordUpdatePos(IList, ref Int32)

Returns current record from the Biff records array and updates its position by 1.

Declaration

protected BiffRecordRaw GetRecordUpdatePos(IList data, ref int pos)

Parameters

Type	Name	Description
System.Collections.IList	data	Array of Biff records.
System.Int32	pos	Position of the record in the array that will be returned.

Returns

Type	Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	Current record from array.

GetStoreSize(ExcelVersion)

Size of the required storage space. Read-only.

Declaration

public virtual int GetStoreSize(ExcelVersion version)

Parameters

Type	Name	Description
ExcelVersion	version

Returns

Type
System.Int32

ParseHeaderFooterString(String)

This function splits header or footer into three parts left, center, and right.

Declaration

protected string[] ParseHeaderFooterString(string strToSplit)

Parameters

Type	Name	Description
System.String	strToSplit	Header (footer) string that will be split into parts: left, center, right.

Returns

Type	Description
System.String[]	Array of split strings.

SetChanged()

This method is called after changes to the page setup. Sets Saved property of the parent workbook to the False state.

Declaration

protected void SetChanged()

Implements

System.IDisposable

IPageSetupBase

IParentApplication