Solid Framework SDK 10.0.12602
SDK for converting and extracting value from PDFs
Public Member Functions | Static Public Member Functions | Properties | List of all members
SolidFramework.Model.Plumbing.Section Class Reference

A section is a part of a document that contains its own page formatting. It can be a single page or a range of pages, or a section can comprise the entire document. Sections affect only page formatting. They are entirely unrelated to text and paragraph formatting. Sections are also used to define an area of the document that contains text columns. If you wish to change the number of columns then a new section is required. More...

Inheritance diagram for SolidFramework.Model.Plumbing.Section:
SolidFramework.Model.Plumbing.SolidCollection SolidFramework.Model.Plumbing.SolidObject

Public Member Functions

override void Dispose ()
 
int GetOriginalPageNumber ()
 Gets the page number that this section originally came from. More...
 
SolidFramework.Model.Plumbing.SolidObjectsCollection GetSolidObjects ()
 
override string ToString ()
 
int GetID ()
 
SolidFramework.Model.Plumbing.SolidObjectType GetObjectType ()
 
bool Equals (SolidFramework.Model.Plumbing.SolidObject other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Static Public Member Functions

static bool operator== (SolidFramework.Model.Plumbing.SolidObject obj1, SolidFramework.Model.Plumbing.SolidObject obj2)
 
static bool operator!= (SolidFramework.Model.Plumbing.SolidObject obj1, SolidFramework.Model.Plumbing.SolidObject obj2)
 

Properties

SolidFramework.Model.Plumbing.Margins Margins [get]
 Gets the margins. More...
 
SolidFramework.Model.Plumbing.Columns Columns [get]
 Gets the columns used in the section. More...
 
global::System.Drawing.Color PageBackgroundColor [get]
 Gets the color used for the page background in this section. More...
 
SolidFramework.Model.Plumbing.LineStyle PageBorder [get]
 Gets the page border or null if it doesn't have one. More...
 
SolidFramework.Model.Plumbing.Margins PageBorderMargins [get]
 Gets the margins between the edge of the page and the page border. More...
 
double PageWidth [get]
 Gets the width of the page in points. More...
 
double PageHeight [get]
 Gets the height of the page in points. More...
 
bool IsSoftPageBreak [get]
 Gets whether this section should connect with the section on the previous page More...
 
bool HasDifferentHeaderFooterForEvenPages [get]
 Gets whether the document has separate headers and footers for odd and even pages or not More...
 
SolidFramework.Model.Plumbing.SlideLayout SlideLayout [get]
 Gets the type of slide layout for a PowerPoint presentation. More...
 
SolidFramework.Model.Plumbing.SectionBreak SectionBreak [get]
 Gets the type of section break that terminates this section. More...
 
SolidFramework.Model.Plumbing.TextDirection TextDirection [get]
 Gets the text direction. More...
 
bool HasPageBackgroundColor [get]
 Gets whether or not a color has been specified for the background in this section. More...
 
SolidFramework.Model.Plumbing.SolidObject this[int index] [getset]
 
int Count [get]
 

Detailed Description

A section is a part of a document that contains its own page formatting. It can be a single page or a range of pages, or a section can comprise the entire document. Sections affect only page formatting. They are entirely unrelated to text and paragraph formatting. Sections are also used to define an area of the document that contains text columns. If you wish to change the number of columns then a new section is required.

Member Function Documentation

◆ Dispose()

override void SolidFramework.Model.Plumbing.Section.Dispose ( )
virtual

◆ GetOriginalPageNumber()

int SolidFramework.Model.Plumbing.Section.GetOriginalPageNumber ( )

Gets the page number that this section originally came from.

Returns
The page number this section originally came from.

Property Documentation

◆ Columns

SolidFramework.Model.Plumbing.Columns SolidFramework.Model.Plumbing.Section.Columns
get

Gets the columns used in the section.

Returns
The collection of Column objects that are used in the section.

◆ HasDifferentHeaderFooterForEvenPages

bool SolidFramework.Model.Plumbing.Section.HasDifferentHeaderFooterForEvenPages
get

Gets whether the document has separate headers and footers for odd and even pages or not

Returns
true if the document has separate headers and footers for odd and even pages; otherwise false

◆ HasPageBackgroundColor

bool SolidFramework.Model.Plumbing.Section.HasPageBackgroundColor
get

Gets whether or not a color has been specified for the background in this section.

Returns
true if a color has been defined for the background in this section, otherwise false.

◆ IsSoftPageBreak

bool SolidFramework.Model.Plumbing.Section.IsSoftPageBreak
get

Gets whether this section should connect with the section on the previous page

Returns
Whether this section should connect with the section on the previous page

◆ Margins

SolidFramework.Model.Plumbing.Margins SolidFramework.Model.Plumbing.Section.Margins
get

Gets the margins.

Returns
The margins.

◆ PageBackgroundColor

global.System.Drawing.Color SolidFramework.Model.Plumbing.Section.PageBackgroundColor
get

Gets the color used for the page background in this section.

Returns
The color used for the page background in this section.

◆ PageBorder

SolidFramework.Model.Plumbing.LineStyle SolidFramework.Model.Plumbing.Section.PageBorder
get

Gets the page border or null if it doesn't have one.

Returns
The page border or null if it doesn't have one.

◆ PageBorderMargins

SolidFramework.Model.Plumbing.Margins SolidFramework.Model.Plumbing.Section.PageBorderMargins
get

Gets the margins between the edge of the page and the page border.

Returns
The page border margins.

◆ PageHeight

double SolidFramework.Model.Plumbing.Section.PageHeight
get

Gets the height of the page in points.

Returns
The height of the page in points.

◆ PageWidth

double SolidFramework.Model.Plumbing.Section.PageWidth
get

Gets the width of the page in points.

Returns
The width of the page in points.

◆ SectionBreak

SolidFramework.Model.Plumbing.SectionBreak SolidFramework.Model.Plumbing.Section.SectionBreak
get

Gets the type of section break that terminates this section.

Returns
A SectionBreak that describes the section break.

◆ SlideLayout

SolidFramework.Model.Plumbing.SlideLayout SolidFramework.Model.Plumbing.Section.SlideLayout
get

Gets the type of slide layout for a PowerPoint presentation.

Returns
A SlideLayout that describes the slide layout.

◆ TextDirection

SolidFramework.Model.Plumbing.TextDirection SolidFramework.Model.Plumbing.Section.TextDirection
get

Gets the text direction.

Returns
A TextDirection that describes the text direction.