Methods of the WORD CLIENT Object - Prefix PAGSTP

PAGSTP_GET_PAPER_FEED

Retrieves the type of paper feed used while printing the document for a document section or for the whole document.

The first page and the other pages of the document or section can have a different type of paper feed.

Section	number of the section in the document.
FeedFirstPage	paper feed type for the first page.
FeedOtherPages	paper feed type for the other pages.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax

CALL_METHOD NameWordClientObject PAGSTP_GET_PAPER_FEED Section FeedFirstPage FeedOtherPages ReturnCode

Parameters

Section

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_WHOLE_DOCUMENT	the page setup will apply to the whole document,
a strictly positive number less than or equal to the number of sections in the document.

FeedFirstPage

NUM_BIN_4 type (output parameter)

FeedOtherPages

NUM_BIN_4 type (output parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

Possible values for FeedFirstPage and FeedOtherPages :

_WRD_DEFAULT_BIN

_WRD_UPPER_BIN

_WRD_LOWER_BIN

_WRD_MIDDLE_BIN

_WRD_MANUAL_FEED

_WRD_ENVELOPE_FEED

_WRD_MANUAL_ENVELOPE_FEED

_WRD_AUTOMATIC_SHEET_FEED

_WRD_TRACTOR_FEED

_WRD_SMALL_FORMAT_BIN

_WRD_LARGE_FORMAT_BIN

_WRD_LARGE_CAPACITY_BIN

_WRD_PAPER_CASSETTE

_WRD_FORM_SOURCE

PAGSTP_SET_GUTTER

Sets the space to be added to the margin for the binding gutter, either for a section of the document or the whole document. If mirror margins are disabled, this space will be added to the left margin, otherwise it will be added to the inner margin. The unit of measurement used is the centimeter.

Section	number of the section in the document.
GutterMargin	space set aside for document binding.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax

CALL_METHOD NameWordClientObject PAGSTP_SET_GUTTER Section GutterMargin ReturnCode

Parameters

Section

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_WHOLE_DOCUMENT	the page setup will apply to the whole document
A strictly positive number less than or equal to the number of sections in the document.

GutterMargin

NUM_E(15,9) type (input parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

PAGSTP_SET_HEADER_FOOTER

Specifies whether or not page headers and footers are to be different on odd and even pages, or vary between the first page and the others, either for a given section of the document or for the whole document.

Section	number of the section in the document.
OddEvenDifferent	specifies whether or not the odd and even pages are to have different page headers and footers.
FirstPageDifferent	specifies whether or not the first page is to have a separate page header and footer.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax

CALL_METHOD NameWordClientObject PAGSTP_SET_HEADER_FOOTER OddEvenDifferent FirstPageDifferent ReturnCode

Parameters

Section

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_WHOLE_DOCUMENT	the page setup will apply to the whole document
A strictly positive number less than or equal to the number of sections in the document.

OddEvenDifferent

BOOL type (input parameter)

FirstPageDifferent

BOOL type (input parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

PAGSTP_SET_HEADER_FOOTER_DISTANCE

Sets the distance between the top edge of the sheet of paper and the top of the header, and the distance between the bottom edge of the paper and the bottom of the page footer, either for a document section or for the whole document. The unit of measurement used is the centimeter.

Section	number of the section in the document.
HeaderMargin	header margin.
FooterMargin	footer margin.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax

CALL_METHOD NameWordClientObject PAGSTP_SET_HEADER_FOOTER_DISTANCE Section HeaderMargin FooterMargin ReturnCode

Parameters

Section

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_WHOLE_DOCUMENT	the page setup will apply to the whole document
A strictly positive number less than or equal to the number of sections in the document.

HeaderMargin

NUM_E(15,9) type (input parameter)

FooterMargin

NUM_E(15,9) type (input parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

PAGSTP_SET_MARGINS

Sets the top, bottom left and right margins for a document section or the whole document. The unit of measurement used is the centimeter.

Section	number of the section in the document.
TopMargin	margin between the top edge of the page and the top of the first line.
BottomMargin	margin between the bottom edge of the page and the bottom of the last line.
LeftMargin	margin between the left edge of the page and the left-hand edge of non-indented lines.
RigthMargin	margin between the right edge of the page and the right-hand edge of non-indented lines.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax

CALL_METHOD NameWordClientObject PAGSTP_SET_MARGINS Section TopMargin BottomMargin LeftMargin RightMargin ReturnCode

Parameters

Section

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_WHOLE_DOCUMENT	the page setup will apply to the whole document
A strictly positive number less than or equal to the number of sections in the document.

TopMargin

NUM_E(15,9) type (input parameter)

BottomMargin

NUM_E(15,9) type (input parameter)

LeftMargin

NUM_E(15,9) type (input parameter)

RigthMargin

NUM_E(15,9) type (input parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

PAGSTP_SET_MIRROR_MARGINS

Adjusts the left and right margins so that the inner and outer margins of facing pages are the same width, either for a given section of the document or for the whole document.

Section	number of the section in the document.
Mirror	specifies whether pages must be facing each other.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax

CALL_METHOD NameWordClientObject PAGSTP_SET_MIRROR_MARGINS Section Mirror ReturnCode

Parameters

Section

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_WHOLE_DOCUMENT	the page setup will apply to the whole document
A strictly positive number less than or equal to the number of sections in the document.

Mirror

BOOL type (input parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

PAGSTP_SET_ORIENTATION

Sets the page orientation to portrait or landscape, either for a given section of the document or for the whole document.

Section	number of the section in the document.
Orientation	required orientation.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax

CALL_METHOD NameWordClientObject PAGSTP_SET_ORIENTATION Section Orientation ReturnCode

Parameters

Section

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_WHOLE_DOCUMENT	the page setup will apply to the whole document
A strictly positive number less than or equal to the number of sections in the document.

Orientation

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_ORIENTATION_PORTRAIT	the specified part of the document will be in portrait orientation,
_WRD_ORIENTATION_LANDSCAPE	the specified part of the document will be in landscape orientation.

ReturnCode

NUM_BIN_4 type (output parameter)

PAGSTP_SET_PAGE_SIZE

Sets the width and height of the sheets of paper used to print a section of the document or the whole document. The unit of measurement used is the centimeter. In practice, this method is rarely used, as the PAGSTP_PAPER_SIZE method can be used to specify a standard format.

Section	number of the section in the document.
Width	paper width.
Height	paper height.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax

CALL_METHOD NameWordClientObject PAGSTP_SET_PAGE_SIZE Section Width Height ReturnCode

Parameters

Section

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_WHOLE_DOCUMENT	the page setup will apply to the whole document
A strictly positive number less than or equal to the number of sections in the document.

Width

NUM_E(15,9) type (input parameter)

Height

NUM_E(15,9) type (input parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

PAGSTP_SET_PAPER_FEED

Sets the paper feed type for a document section or for the whole document. This paper feed is used while printing the document. The first page and the other pages of the document or section can have a different type of paper feed.

Section	number of the section in the document.
FeedFirstPage	paper feed type for the first page.
FeedOtherPages	paper feed type for the other pages.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax

CALL_METHOD NameWordClientObject PAGSTP_SET_PAPER_FEED Section FeedFirstPage FeedOtherPages ReturnCode

Section

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_WHOLE_DOCUMENT	the page setup will apply to the whole document
A strictly positive number less than or equal to the number of sections in the document.

FeedFirstPage

NUM_BIN_4 type (input parameter)

FeedOtherPages

NUM_BIN_4 type (input parameter)

ReturnCode

NUM_BIN_4 type (output parameter)

Possible values for FeedFirstPage and FeedOtherPages:

_WRD_DEFAULT_BIN

_WRD_UPPER_BIN

_WRD_LOWER_BIN

_WRD_MIDDLE_BIN

_WRD_MANUAL_FEED

_WRD_ENVELOPE_FEED

_WRD_MANUAL_ENVELOPE_FEED

_WRD_AUTOMATIC_SHEET_FEED

_WRD_TRACTOR_FEED

_WRD_SMALL_FORMAT_BIN

_WRD_LARGE_FORMAT_BIN

_WRD_LARGE_CAPACITY_BIN

_WRD_PAPER_CASSETTE

_WRD_FORM_SOURCE

Important Note: Printers may not support all of the values listed above. In addition, some printers may support other types of paper feed, or types the values of which are different from the constants above.

In order to know the valid values for the paper feed supported by a given printer, do one of the following:

Use the PAGSTP_GET_PAPER_FEED method,
Create a Word macro that will contain the values.
To do so: in the Tools menu, select the Macro, then the Record New Macro option. Click the OK button. Modify the values via the interface by using the File menu, Page Setup option, then modifying the parameters in the Paper Source tab. To stop recording the macro, use the Tools menu, Macros, then the Stop Recording option. You can edit the macro's source code using the Tools menu, Macro, then the Macros option: in the dialog, select the macro you created and click Edit. The macro will contain the values to be used in a numeric format or in the form of a Word constant. If the value is a constant, you should use the corresponding Adelia constant.

PAGSTP_SET_PAPER_SIZE

Sets the paper size for a document section or for the whole document.

Section	number of the section in the document.
Format	paper size.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax

CALL_METHOD NameWordClientObject PAGSTP_SET_PAPER_SIZE Section Format ReturnCode

Parameters

Section

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_WHOLE_DOCUMENT	the page setup will apply to the whole document
A strictly positive number less than or equal to the number of sections in the document.

Format

NUM_BIN_4 type (input parameter)

Possible values:

_WRD_PAPER_10_14

_WRD_PAPER_11_17

_WRD_PAPER_A3

_WRD_PAPER_A4

_WRD_PAPER_A4_SMALL

_WRD_PAPER_A5

_WRD_PAPER_B4

_WRD_PAPER_B5

_WRD_PAPER_C_SHEET

_WRD_PAPER_D_SHEET

_WRD_PAPER_E_SHEET

_WRD_PAPER_ENVELOPE_9

_WRD_PAPER_ENVELOPE_10

_WRD_PAPER_ENVELOPE_11

_WRD_PAPER_ENVELOPE_12

_WRD_PAPER_ENVELOPE_14

_WRD_PAPER_ENVELOPE_B4

_WRD_PAPER_ENVELOPE_B5

_WRD_PAPER_ENVELOPE_B6

_WRD_PAPER_ENVELOPE_C3

_WRD_PAPER_ENVELOPE_C4

_WRD_PAPER_ENVELOPE_C5

_WRD_PAPER_ENVELOPE_C6

_WRD_PAPER_ENVELOPE_C65

_WRD_PAPER_ENVELOPE_DL

_WRD_PAPER_ENVELOPE_ITALY

_WRD_PAPER_ENVELOPE_MONARCH

_WRD_PAPER_ENVELOPE_PERSONAL

_WRD_PAPER_EXECUTIVE

_WRD_PAPER_FANFOLD_LEGAL_GERMAN

_WRD_PAPER_FANFOLD_STD_GERMAN

_WRD_PAPER_FANFOLD_US

_WRD_PAPER_FOLIO

_WRD_PAPER_LEDGER

_WRD_PAPER_LEGAL

_WRD_PAPER_LETTER

_WRD_PAPER_LETTER_SMALL

_WRD_PAPER_NOTE

_WRD_PAPER_QUARTO

_WRD_PAPER_STATEMENT

_WRD_PAPER_TABLOID

ReturnCode

NUM_BIN_4 type (output parameter)