aspose.diagram
Class HeaderFooter

Contains elements for a document's header and footer.

Example:

var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");

diagram = new aspose.diagram.Diagram("ManageHeadersandFooters.vsdx");

// add page number at the right corner of header
diagram.getHeaderFooter().setHeaderRight("&p");

// set text at the center
diagram.getHeaderFooter().setHeaderCenter("Center of the header");

// set text at the left side
diagram.getHeaderFooter().setHeaderLeft("Left of the header");

// add text at the right corner of footer
diagram.getHeaderFooter().setFooterRight("Right of the footer");

// set text at the center
diagram.getHeaderFooter().setFooterCenter("Center of the footer");

// set text at the left side
diagram.getHeaderFooter().setFooterLeft("Left of the footer");

// set header & footer color
diagram.getHeaderFooter().setHeaderFooterColor(aspose.diagram.Color.getRed());

// set text font properties
diagram.getHeaderFooter().getHeaderFooterFont().setItalic(aspose.diagram.BOOL.TRUE);
diagram.getHeaderFooter().getHeaderFooterFont().setUnderline(aspose.diagram.BOOL.FALSE);

diagram.save("out-ManageHeadersandFooters.vsdx", aspose.diagram.SaveFileFormat.VSDX);

Field Summary
MarginHeaderMargin
           Specifies the margin of a document's header.
MarginFooterMargin
           Specifies the margin of a document's footer.
 
Property Getters/Setters Summary
functiongetFooterCenter()
functionsetFooterCenter(value)
           Contains the text string that appears in the center portion of a document's footer.
functiongetFooterLeft()
functionsetFooterLeft(value)
           Contains the text string that appears in the left portion of a document's footer.
functiongetFooterRight()
functionsetFooterRight(value)
           Contains the text string that appears in the right portion of a document's footer.
functiongetHeaderCenter()
functionsetHeaderCenter(value)
           Contains the text string that appears in the center portion of a document's header.
functiongetHeaderFooterColor()
           The RGB value of the text color for the header and footer.
functiongetHeaderFooterFont()
           Specifies the font used for the header and footer text.
functiongetHeaderLeft()
functionsetHeaderLeft(value)
           Contains the text string that appears in the left portion of a document's header.
functiongetHeaderRight()
functionsetHeaderRight(value)
           Contains the text string that appears in the right portion of a document's header.
 

Field Detail

HeaderMargin

Margin HeaderMargin
Specifies the margin of a document's header.

FooterMargin

Margin FooterMargin
Specifies the margin of a document's footer.

Property Getters/Setters Detail

getHeaderFooterColor : Color 

function getHeaderFooterColor()
The RGB value of the text color for the header and footer.

getHeaderLeft/setHeaderLeft : String 

function getHeaderLeft() / function setHeaderLeft(value)
Contains the text string that appears in the left portion of a document's header.

getHeaderCenter/setHeaderCenter : String 

function getHeaderCenter() / function setHeaderCenter(value)
Contains the text string that appears in the center portion of a document's header.

getHeaderRight/setHeaderRight : String 

function getHeaderRight() / function setHeaderRight(value)
Contains the text string that appears in the right portion of a document's header.

getFooterLeft/setFooterLeft : String 

function getFooterLeft() / function setFooterLeft(value)
Contains the text string that appears in the left portion of a document's footer.

getFooterCenter/setFooterCenter : String 

function getFooterCenter() / function setFooterCenter(value)
Contains the text string that appears in the center portion of a document's footer.

getFooterRight/setFooterRight : String 

function getFooterRight() / function setFooterRight(value)
Contains the text string that appears in the right portion of a document's footer.

getHeaderFooterFont : HeaderFooterFont 

function getHeaderFooterFont()
Specifies the font used for the header and footer text.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.