SetHeaderDistance
Specifies the distance from the top edge of the page to the top edge of the header.
Syntax
expression.SetHeaderDistance(nDistance);
expression - A variable that represents a ApiSection class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| nDistance | Required | twips | The distance from the top edge of the page to the top edge of the header measured in twentieths of a point (1/1440 of an inch). |
Returns
boolean
Example
This example specifies the distance from the top edge of the page to the top edge of the header.
- Code
- Result
// How to set header distance of the section.
// Specify the distance between the page end and the header.
let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
paragraph.AddText("This is a page with a header. ");
paragraph.AddText("Scroll down the page to see it.");
let section = doc.GetFinalSection();
let header = section.GetHeader("default", true);
section.SetHeaderDistance(1440);
paragraph = header.GetElement(0);
paragraph.AddText("This is a page header. ");
paragraph.AddText("The distance from the page top to the header is 1 inch (1440 twentieths of a point).");