com.spire.doc
Class Section

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.DocumentObject
              com.spire.doc.DocumentBase
                  com.spire.doc.DocumentContainer
                      com.spire.doc.Section

All Implemented Interfaces:

ICompositeObject, IDocumentObject, IDocumentSerializable, ISection

public class Section
extends DocumentContainer
implements ISection

Constructor Summary

Section(IDocument doc)
Initializes a new instance of the class.

Method Summary

Column	addColumn(float width, float spacing) Adds new column to the section.
Paragraph	addParagraph() Adds the paragraph.
Table	addTable() Adds the table.
Table	addTable(boolean showBorder) Adds the table.
void	cloneSectionPropertiesTo(Section destSection) Clones the properties of the current to the destination section.
Section	deepClone() Clones it self.
Body	getBody() Gets the section body.
SectionBreakType	getBreakCode() Returns or sets break code.
DocumentObjectCollection	getChildObjects() Gets the child objects.
ColumnCollection	getColumns() Get collection of columns which logically divide page on many.
DocumentObjectType	getDocumentObjectType() Gets the type of the document object.
FootEndnoteOptions	getEndnoteOptions() Gets or sets options that control numbering and positioning of endnotes in current section.
FootEndnoteOptions	getFootnoteOptions() Gets or sets options that control numbering and positioning of footnote in current section.
HeadersFooters	getHeadersFooters() Gets headers/footers of current section.
PageSetup	getPageSetup() Gets page Setup of current section.
ParagraphCollection	getParagraphs() Gets the paragraphs.
boolean	getProtectForm() Gets or sets a value indicating whether [protect form].
TableCollection	getTables() Gets the tables.
TextDirection	getTextDirection() Gets or sets the text direction.
void	makeColumnsSameWidth() Makes all columns in current section to be of equal width.
void	setBreakCode(SectionBreakType value) Returns or sets break code.
void	setProtectForm(boolean value) Gets or sets a value indicating whether [protect form].
void	setTextDirection(TextDirection value) Gets or sets the text direction.

Methods inherited from class com.spire.doc.DocumentContainer

getCount, getIndex

Methods inherited from class com.spire.doc.DocumentObject

getFirstChild, getLastChild, getNextSibling, getNextWidgetSibling, getOwner, getPreviousSibling, getPreviousWidgetSibling, isComposite, prependChild, toString

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Methods inherited from interface com.spire.doc.interfaces.IDocumentObject

getDocument, getNextSibling, getOwner, getPreviousSibling, isComposite

Constructor Detail

Section

public Section(IDocument doc)

Initializes a new instance of the class.

Parameters:

doc - The doc.

Method Detail

getBody

public Body getBody()

Description copied from interface: ISection

Gets the section body.

Specified by:

getBody in interface ISection

Returns:

the body.

getEndnoteOptions

public FootEndnoteOptions getEndnoteOptions()

Gets or sets options that control numbering and positioning of endnotes in current section.

getFootnoteOptions

public FootEndnoteOptions getFootnoteOptions()

Gets or sets options that control numbering and positioning of footnote in current section.

getHeadersFooters

public HeadersFooters getHeadersFooters()

Gets headers/footers of current section.

Specified by:

getHeadersFooters in interface ISection

Returns:

The headers/footers

getPageSetup

public PageSetup getPageSetup()

Gets page Setup of current section.

Specified by:

getPageSetup in interface ISection

Returns:

The PageSetup

getColumns

public ColumnCollection getColumns()

Get collection of columns which logically divide page on many. printing/publishing areas

Specified by:

getColumns in interface ISection

Returns:

The collection of the columns

getBreakCode

public SectionBreakType getBreakCode()

Returns or sets break code.

Specified by:

getBreakCode in interface ISection

Returns:

The break code

setBreakCode

public void setBreakCode(SectionBreakType value)

Returns or sets break code.

Specified by:

setBreakCode in interface ISection

Parameters:

value - The break code

getDocumentObjectType

public DocumentObjectType getDocumentObjectType()

Gets the type of the document object.

Specified by:

getDocumentObjectType in interface IDocumentObject

Specified by:

getDocumentObjectType in class DocumentObject

Returns:

The type of the document object.

getChildObjects

public DocumentObjectCollection getChildObjects()

Gets the child objects.

Specified by:

getChildObjects in interface ICompositeObject

Specified by:

getChildObjects in class DocumentObject

Returns:

The child objects.

getParagraphs

public ParagraphCollection getParagraphs()

Gets the paragraphs.

Specified by:

getParagraphs in interface ISection

Returns:

The paragraphs.

getTables

public TableCollection getTables()

Gets the tables.

Specified by:

getTables in interface ISection

Returns:

The tables.

getTextDirection

public TextDirection getTextDirection()

Gets or sets the text direction.

setTextDirection

public void setTextDirection(TextDirection value)

Gets or sets the text direction.

getProtectForm

public boolean getProtectForm()

Gets or sets a value indicating whether [protect form].

Specified by:

getProtectForm in interface ISection

Returns:

true if [protect form]; otherwise, false

setProtectForm

public void setProtectForm(boolean value)

Gets or sets a value indicating whether [protect form].

Specified by:

setProtectForm in interface ISection

Parameters:

value - true if [protect form]; otherwise, false

addColumn

public Column addColumn(float width,
                        float spacing)

Adds new column to the section.

Specified by:

addColumn in interface ISection

Parameters:

width - The width.

spacing - The spacing.

Returns:

makeColumnsSameWidth

public void makeColumnsSameWidth()

Makes all columns in current section to be of equal width.

Specified by:

makeColumnsSameWidth in interface ISection

deepClone

public Section deepClone()

Clones it self.

Specified by:

deepClone in interface IDocumentObject

Specified by:

deepClone in interface ISection

Overrides:

deepClone in class DocumentObject

Returns:

cloneSectionPropertiesTo

public void cloneSectionPropertiesTo(Section destSection)

Clones the properties of the current to the destination section.

Parameters:

destSection - The destination section.

addParagraph

public Paragraph addParagraph()

Adds the paragraph.

Specified by:

addParagraph in interface ISection

Returns:

addTable

public Table addTable()

Adds the table.

Specified by:

addTable in interface ISection

Returns:

addTable

public Table addTable(boolean showBorder)

Adds the table.

Parameters:

showBorder - Display table borders.True to display;False does not display.

Returns: