Section (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.Node
- - com.aspose.words.CompositeNode
  - - com.aspose.words.Section

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable
```
public final class Section
extends CompositeNode
```
Represents a single section in a document.
Section can have one getBody() and maximum one HeaderFooter of each HeaderFooterType. Body and HeaderFooter nodes can be in any order inside Section.

A minimal valid section needs to have Body with one Paragraph.

Each section has its own set of properties that specify page size, orientation, margins etc.

You can create a copy of a section using Node.deepClone(boolean). The copy can be inserted into the same or different document.

To add, insert or remove a whole section including section break and section properties use methods of the Sections object.

To copy and insert just content of the section excluding the section break and section properties use AppendContent and PrependContent methods.

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`Section(DocumentBase doc)` Initializes a new instance of the Section class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accept(DocumentVisitor visitor)` Accepts a visitor.
`void`	`appendContent(Section sourceSection)` Inserts a copy of content of the source section at the end of this section.
`void`	`clearContent()` Clears the section.
`void`	`clearHeadersFooters()` Clears the headers and footers of this section.
`void`	`clearSectionAttrs()`
`Section`	`deepClone()` Creates a duplicate of this section.
`void`	`deleteHeaderFooterShapes()` Deletes all shapes (drawing objects) from the headers and footers of this section.
`void`	`ensureMinimum()` Ensures that the section has Body with one Paragraph.
`java.lang.Object`	`fetchInheritedSectionAttr(int key)`
`java.lang.Object`	`fetchSectionAttr(int key)`
`Body`	`getBody()` Returns the Body child node of the section.
`java.lang.Object`	`getDirectSectionAttr(int key)`
`HeaderFooterCollection`	`getHeadersFooters()` Provides access to the headers and footers nodes of the section.
`int`	`getNodeType()` Returns NodeType.Section.
`PageSetup`	`getPageSetup()` Returns an object that represents page setup and section properties.
`boolean`	`getProtectedForForms()` True if the section is protected for forms.
`void`	`prependContent(Section sourceSection)` Inserts a copy of content of the source section at the beginning of this section.
`void`	`setProtectedForForms(boolean value)` True if the section is protected for forms.
`void`	`setSectionAttr(int key, java.lang.Object value)`
`java.lang.String`	`toString()`

Methods inherited from class com.aspose.words.CompositeNode
acceptChildren, acceptCore, appendChild, coreRemoveSelfOnly, getChild, getChildNodes, getChildNodes, getContainer, getCount, getCurrentNode, getFirstChild, getLastChild, getNextMatchingNode, getText, hasChildNodes, indexOf, insertAfter, insertBefore, isComposite, iterator, prependChild, removeAllChildren, removeChild, removeSmartTags, selectNodes, selectSingleNode

Methods inherited from class com.aspose.words.Node
dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getDocument, getNextSibling, getParentNode, getPreviousSibling, getRange, memberwiseClone, nextPreOrder, nodeTypeToString, previousPreOrder, remove, setCustomNodeId, toString, toString, visitorActionToBool

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Section
```
public Section(DocumentBase doc)
```
    Initializes a new instance of the Section class.
    When the section is created, it belongs to the specified document, but is not yet part of the document and ParentNode is null.
    
    To include Section into a document use Document.InsertAfter, Document.InsertBefore or Sections.Add and Section.Insert methods.
    
    Parameters:
    
    doc - The owner document.
- Method Detail
  - getNodeType
```
public final int getNodeType()
```
    Returns NodeType.Section.
    
    Specified by:
    
    getNodeType in class Node
    
    Returns:
    
    NodeType.Section. The returned value is one of NodeType constants.
  - getBody
```
public final Body getBody()
```
    Returns the Body child node of the section.
    Body contains main text of the section.
    
    Returns null if the section does not have a Body node among its children.
    
    Returns:
    
    The Body child node of the section.
  - getHeadersFooters
```
public final HeaderFooterCollection getHeadersFooters()
```
    Provides access to the headers and footers nodes of the section.
    
    Returns:
    
    The corresponding HeaderFooterCollection value.
  - getPageSetup
```
public final PageSetup getPageSetup()
```
    Returns an object that represents page setup and section properties.
    
    Returns:
    
    An object that represents page setup and section properties.
  - getProtectedForForms
```
public final boolean getProtectedForForms()
```
    True if the section is protected for forms. When a section is protected for forms, users can select and modify text only in form fields in Microsoft Word.
    
    Returns:
    
    The corresponding boolean value.
  - setProtectedForForms
```
public final void setProtectedForForms(boolean value)
```
    True if the section is protected for forms. When a section is protected for forms, users can select and modify text only in form fields in Microsoft Word.
    
    Parameters:
    
    value - The corresponding boolean value.
  - deepClone
```
public final Section deepClone()
```
    Creates a duplicate of this section.
  - accept
```
public final boolean accept(DocumentVisitor visitor)
                     throws java.lang.Exception
```
    Accepts a visitor.
    Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.
    
    For more info see the Visitor design pattern.
    
    Specified by:
    
    accept in class Node
    
    Parameters:
    
    visitor - The visitor that will visit the nodes.
    
    Returns:
    
    True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.
    
    Throws:
    
    java.lang.Exception
  - prependContent
```
public final void prependContent(Section sourceSection)
```
    Inserts a copy of content of the source section at the beginning of this section.
    Only content of getBody() of the source section is copied, page setup, headers and footers are not copied.
    
    The nodes are automatically imported if the source section belongs to a different document.
    
    No new section is created in the destination document.
    
    Parameters:
    
    sourceSection - The section to copy content from.
  - appendContent
```
public final void appendContent(Section sourceSection)
```
    Inserts a copy of content of the source section at the end of this section.
    Only content of getBody() of the source section is copied, page setup, headers and footers are not copied.
    
    The nodes are automatically imported if the source section belongs to a different document.
    
    No new section is created in the destination document.
    
    Parameters:
    
    sourceSection - The section to copy content from.
  - clearContent
```
public final void clearContent()
```
    Clears the section.
    The text of getBody() is cleared, only one empty paragraph is left that represents the section break.
    
    The text of all headers and footers is cleared, but HeaderFooter objects themselves are not removed.
  - clearHeadersFooters
```
public final void clearHeadersFooters()
```
    Clears the headers and footers of this section.
    The text of all headers and footers is cleared, but HeaderFooter objects themselves are not removed.
    
    This makes headers and footers of this section linked to headers and footers of the previous section.
  - deleteHeaderFooterShapes
```
public final void deleteHeaderFooterShapes()
```
    Deletes all shapes (drawing objects) from the headers and footers of this section.
  - ensureMinimum
```
public final void ensureMinimum()
```
    Ensures that the section has Body with one Paragraph.
  - getDirectSectionAttr
```
public final java.lang.Object getDirectSectionAttr(int key)
```
  - fetchInheritedSectionAttr
```
public final java.lang.Object fetchInheritedSectionAttr(int key)
```
  - fetchSectionAttr
```
public final java.lang.Object fetchSectionAttr(int key)
```
  - setSectionAttr
```
public final void setSectionAttr(int key,
                                 java.lang.Object value)
```
  - clearSectionAttrs
```
public final void clearSectionAttrs()
```
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class Node

Class Section

Constructor Summary

Method Summary

Methods inherited from class com.aspose.words.CompositeNode

Methods inherited from class com.aspose.words.Node

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Section

Method Detail

getNodeType

getBody

getHeadersFooters

getPageSetup

getProtectedForForms

setProtectedForForms

deepClone

accept

prependContent

appendContent

clearContent

clearHeadersFooters

deleteHeaderFooterShapes

ensureMinimum

getDirectSectionAttr

fetchInheritedSectionAttr

fetchSectionAttr

setSectionAttr

clearSectionAttrs

toString