DS Server › Reference › JavaScript API SectionFormat Object Object | Introduced in 26.0
Description Represents the formatting attributes of a section.
Examples The following example demonstrates SectionFormat in a practical document-editing workflow. It represents the formatting attributes of a section.
function onTxError (error ) console .error("TX Text Control error:" , error.msg);
error.handled = true ;
}
function inspectSectionFormat (sectionFormat ) function (breakKind ) if (!breakKind) {
console .warn("No section break kind was returned." );
return ;
}
console .log("get break kind result:" , breakKind);
},
onTxError
);
}Members Properties Property Description pageBorder Gets the attributes of a section's page border. pageMargins Gets the section's page margins. pageSize Gets the section's page size.
Methods Method Description getBreakKind Gets the kind of the section break the section starts with. getColumnDistances Gets the distances, in twips, between the columns on a page. getColumnLineColor Gets the color of a dividing line between two columns. getColumnLineWidth Gets the width of a dividing line between two columns. If this property's value is zero there is no dividing line. Otherwise it is a value in twips. getColumns Gets the number of columns on a page. getColumnWidths Gets the widths, in twips, of the columns on a page. getEqualColumnWidth Gets a value indicating whether the columns on a page have all the same width and the same distance between them. If this property is set to true, the width of the columns are automatically calculated from the page size. getLandscape Gets a value indicating whether the section's page size is in landscape orientation. getRestartPageNumbering Gets a value indicating whether page numbering is restarted at the section's beginning. setBreakKind Sets the kind of the section break the section starts with. setColumnLineColor Sets the color of a dividing line between two columns. setColumnLineWidth Sets the width of a dividing line between two columns. If this property's value is zero there is no dividing line. Otherwise it is a value in twips. setColumns Sets the number of columns on a page. setColumnWidths Sets the widths, in twips, of the columns on a page. setEqualColumnWidth Sets a value indicating whether the columns on a page have all the same width and the same distance between them. If this property is set to true, the width of the columns are automatically calculated from the page size. setLandscape Sets a value indicating whether the section's page size is in landscape orientation. setRestartPageNumbering Sets a value indicating whether page numbering is restarted at the section's beginning.
Enumerations Enumeration Description Attribute Determines a certain section format attribute.
