Section Class
Defines a section in the document.
#Declaration
export class Section
#Properties
#columnCount Property
Specifies the number of columns in the section’s main document.
#Declaration
get columnCount(): number
set columnCount(columnCount: number)
#Property Value
Type | Description |
---|---|
number | The number of columns. |
#Remarks
var sectionColumnCount = richEdit.document.sections.getByIndex(0).columnCount;
#footerOffset Property
Specifies the footer offset.
#Declaration
get footerOffset(): number
set footerOffset(offset: number)
#Property Value
Type | Description |
---|---|
number | The offset in twips. |
#headerOffset Property
Specifies the header offset.
#Declaration
get headerOffset(): number
set headerOffset(offset: number)
#Property Value
Type | Description |
---|---|
number | The offset in twips. |
#index Property
Returns the zero-based index of the section in the sections collection.
#Declaration
get index(): number
#Property Value
Type | Description |
---|---|
number | The section index. |
#Remarks
You can use the getByIndex(index) method to find a section by its index in the SectionCollection object.
var firstSection = richEdit.document.sections.getByIndex(0);
#interval Property
Gets the text buffer interval occupied by the current section.
#Declaration
get interval(): Interval
#Property Value
Type | Description |
---|---|
Interval | An object that contains the interval settings. |
#landscape Property
Specifies whether the section’s page orientation is landscape.
#Declaration
get landscape(): boolean
set landscape(landscape: boolean)
#Property Value
Type | Description |
---|---|
boolean |
|
#margins Property
Specifies the margins of the section’s pages.
#Declaration
#Property Value
Type | Description |
---|---|
Margins | An object that contains margin settings in twips. |
#Remarks
var marginSize = richEdit.unitConverter.centimetersToTwips(1);
var margins = new DevExpress.RichEdit.Margins(
marginSize, marginSize, marginSize, marginSize);
richEdit.document.sections.getByIndex(0).margins = margins;
#pageSize Property
Specifies the size of the section’s pages.
#Declaration
#Property Value
Type | Description |
---|---|
Size | An object that contains a page size in twips. |
#Remarks
var size = new DevExpress.RichEdit.Size(
richEdit.unitConverter.centimetersToTwips(24),
richEdit.unitConverter.centimetersToTwips(18));
richEdit.document.sections.getByIndex(0).pageSize = size;
#paperSize Property
Specifies the size of the section’s pages.
#Declaration
#Property Value
Type | Description |
---|---|
Paper |
The paper size. |
#Methods
#getFooter Method
Returns a sub-document that is the section’s footer.
#Declaration
getFooter(
type?: HeaderFooterType,
createIfNotExist?: boolean
): SubDocument | null
#Parameters
Name | Type | Description |
---|---|---|
type | Header |
The type of footer to return. |
create |
boolean | true, to create a footer if it does not exist; false to not create a footer. |
#Returns
Type | Description |
---|---|
Sub |
The section’s footer (existing or newly created). |
#Remarks
var section = richEdit.document.sections.getByIndex(0);
var subDocument = section.getFooter(DevExpress.RichEdit.HeaderFooterType.Primary, true);
#getHeader Method
Returns a sub-document that is the section’s header.
#Declaration
getHeader(
type?: HeaderFooterType,
createIfNotExist?: boolean
): SubDocument | null
#Parameters
Name | Type | Description |
---|---|---|
type | Header |
The type of header to return. |
create |
boolean | true, to create a header if it does not exist; false to not create a header. |
#Returns
Type | Description |
---|---|
Sub |
The section’s header (existing or newly created). |
#Remarks
var section = richEdit.document.sections.getByIndex(0);
var subDocument = section.getHeader(DevExpress.RichEdit.HeaderFooterType.Primary, true);