TXTextControl.PageBorder Object

An instance of the PageBorder class represents the attributes of a border, which is drawn in the margin area of a page.

Introduced: 26.0.

Syntax

[JavaScript]
{
getBottomDistance: <function>,
getBottomLineColor: <function>,
getBottomLineWidth: <function>,
getFirstPageOnly: <function>,
getLeftDistance: <function>,
getLeftLineColor: <function>,
getLeftLineWidth: <function>,
getTopDistance: <function>,
getTopLineColor: <function>,
getTopLineWidth: <function>,
getRightDistance: <function>,
getRightLineColor: <function>,
getRightLineWidth: <function>,
getMeasureFromText: <function>,
getOmitFirstPage: <function>,
getSurroundFooter: <function>,
getSurroundHeader: <function>,
setBottomDistance: <function>,
setBottomLineColor: <function>,
setBottomLineWidth: <function>,
setFirstPageOnly: <function>,
setLeftDistance: <function>,
setLeftLineColor: <function>,
setLeftLineWidth: <function>,
setTopDistance: <function>,
setTopLineColor: <function>,
setTopLineWidth: <function>,
setRightDistance: <function>,
setRightLineColor: <function>,
setRightLineWidth: <function>,
setMeasureFromText: <function>,
setOmitFirstPage: <function>,
setSurroundFooter: <function>,
setSurroundHeader: <function>,
}

Methods

Method Description
getBottomDistance Gets the distance, in twips, of the bottom border line either from the edge of the page or from the text, depending on the MeasureFromText property.
getBottomLineColor Gets the color of the bottom border line.
getBottomLineWidth Gets the width of the bottom border line.
getFirstPageOnly Gets a value indicating whether the page border is drawn only on the first page of the section.
getLeftDistance Gets the distance, in twips, of the left border line either from the edge of the page or from the text, depending on the MeasureFromText property.
getLeftLineColor Gets the color of the left border line.
getLeftLineWidth Gets the width of the left border line.
getMeasureFromText Gets a value indicating whether the page border's distances are measured from the text.
getOmitFirstPage Gets a value indicating whether the page border is not drawn on the first page of the section.
getRightDistance Gets the distance, in twips, of the right border line either from the edge of the page or from the text, depending on the MeasureFromText property.
getRightLineColor Gets the color of the right border line.
getRightLineWidth Gets the width of the right border line.
getSurroundFooter Gets a value indicating whether the page border surrounds the section's footer.
getSurroundHeader Gets a value indicating whether the page border surrounds the section's header.
getTopDistance Gets the distance, in twips, of the top border line either from the edge of the page or from the text, depending on the MeasureFromText property.
getTopLineColor Gets the color of the top border line.
getTopLineWidth Gets the width of the top border line.
setBottomDistance Sets the distance, in twips, of the bottom border line either from the edge of the page or from the text, depending on the MeasureFromText property.
setBottomLineColor Sets the color of the bottom border line.
setBottomLineWidth Sets the width of the bottom border line.
setFirstPageOnly Sets a value indicating whether the page border is drawn only on the first page of the section.
setLeftDistance Sets the distance, in twips, of the left border line either from the edge of the page or from the text, depending on the MeasureFromText property.
setLeftLineColor Sets the color of the left border line.
setLeftLineWidth Sets the width of the left border line.
setMeasureFromText Sets a value indicating whether the page border's distances are measured from the text.
setOmitFirstPage Sets a value indicating whether the page border is not drawn on the first page of the section.
setRightDistance Sets the distance, in twips, of the right border line either from the edge of the page or from the text, depending on the MeasureFromText property.
setRightLineColor Sets the color of the right border line.
setRightLineWidth Sets the width of the right border line.
setSurroundFooter Sets a value indicating whether the page border surrounds the section's footer.
setSurroundHeader Sets a value indicating whether the page border surrounds the section's header.
setTopDistance Sets the distance, in twips, of the top border line either from the edge of the page or from the text, depending on the MeasureFromText property.
setTopLineColor Sets the color of the top border line.
setTopLineWidth Sets the width of the top border line.

See Also