These options control the behavior of the endorsements that can be stamped on the output created by Document Conversion Service.

Endorsements are the placing of additional header and footer information at the top and bottom of each page. See also Watermark Stamping to add watermarks to the page content.

Header and footers can contain text such titles and page numbers. The default height of both the header and the footer is 12 points; this can be adjusted individually as needed.

Both the header and footer can be made up of three separate sections - a left section, a center section and a right section. The width of each section can be set individually to allow for text wrapping within each section. The default width for each section is the width of the page. Text in the top left and bottom left section is always left justified, text in the top center and bottom center section is always centered and text in top right and bottom right sections is always right justified.

The data displayed in each part of the header or footer can be formatted using the Endorsement Formatting Codes to add page number and total page count information to your header and footer text, as well as to display the text in different fonts, font sizes, colors and other text attributes such as bold, italic and underline. The default font used is Arial at 12 points.

 

 

Code Sample - C#

 

PNDocConvQueueServiceLib.PNDocConvQueueItem item = null;

 

// Create the conversion item

item = new PNDocConvQueueServiceLib.PNDocConvQueueItem();

 

// Set conversion settings

item.Set("Endorsements;HeaderHeightInPoints", "20");

item.Set("Endorsements;HeaderLeftFormat",

         "&KFF0000&BInternal Use&B");

item.Set("Endorsements;HeaderRightFormat",

         "Confidential\r\nDO NOT COPY");

 

item.Set("Endorsements;FooterHeightInPoints", "20");

item.Set("Endorsements;FooterCenterFormat",

         "&'Courier'&P of &N");

...

// convert the file

item.Convert("Microsoft Word",

             @"C:\Test\Report.docx",

             @"C:\Test\Out\ConvertedReport");

 

Code Sample - VB.NET

 

Dim item As PNDocConvQueueServiceLib.IPNDocConvQueueItem

 

 ' Create the conversion item

item = New PNDocConvQueueServiceLib.PNDocConvQueueItem()

 

' Set conversion settings

item.Set("Endorsements;Enable", "1")

 

item.Set("Endorsements;HeaderHeightInPoints", "20")

item.Set("Endorsements;HeaderLeftFormat", _

         "&KFF0000&BInternal Use&B")

item.Set("Endorsements;HeaderRightFormat", _

         "Confidential\r\nDO NOT COPY")

 

item.Set("Endorsements;FooterHeightInPoints", "20")

item.Set("Endorsements;FooterCenterFormat", _

         "&'Courier'&P of &N")

...

' convert the file

item.Convert("Microsoft Word", _

             "C:\Test\Report.docx", _

             "C:\Test\Out\ConvertedReport")

 

 

Conversion Settings - Endorsements Header and Footer Options

Name:

Endorsements;Enable

 

Values:

0 - Do not add endorsements

1 - Add specified endorsements to each page

 

Name:

Endorsements;HeaderHeightInPoints

 

Values:

The height of the header area in points. The default is 12 points.

 

Name:

Endorsements;HeaderLeftWidthInPoints

 

Values:

The width of the left section of the header area in points. The default is the width of the page.

 

Name:

Endorsements;HeaderCenterWidthInPoints

 

Values:

The width of the center section of the header area in points. The default is the width of the page.

 

 

Name:

Endorsements;HeaderRightWidthInPoints

 

Values:

The width of the right section of the header area in points. The default is the width of the page.

 

Name:

Endorsements;HeaderLeftFormat

 

Values:

The text, with Endorsement Formatting Codes as needed, to put in the left section of the header.

 

Name:

Endorsements;HeaderCenterFormat

 

Values:

The text, with Endorsement Formatting Codes as needed, to put in the center section of the header.

 

Name:

Endorsements;HeaderRightFormat

 

Values:

The text, with Endorsement Formatting Codes as needed, to put in the right section of the header.

 

Name:

Endorsements;FooterHeightInPoints

 

Values:

The height of the footer area in points. The default is 12 points.

 

Name:

Endorsements;FooterLeftWidthInPoints

 

Values:

The width of the left section of the footer area in points. The default is the width of the page.

 

Name:

Endorsements;FooterCenterWidthInPoints

 

Values:

The width of the center section of the footer area in points. The default is the width of the page.

 

Name:

Endorsements;FooterRightWidthInPoints

 

Values:

The width of the right section of the footer area in points. The default is the width of the page.

 

Name:

Endorsements;FooterLeftFormat

 

Values:

The text, with Endorsement Formatting Codes as needed, to put in the left section of the footer.

 

Name:

Endorsements;FooterCenterFormat

 

Values:

The text, with Endorsement Formatting Codes as needed, to put in the center section of the footer.

 

Name:

Endorsements;FooterRightFormat

 

Values:

The text, with Endorsement Formatting Codes as needed, to put in the right section of the header.