- rng_collapse
- rng_copy
- rng_cut
- rng_go_to
- rng_go_to_next
- rng_go_to_previous
- rng_insert_after
- rng_insert_before
- rng_insert_break
- rng_insert_date_time
- rng_insert_file
- rng_insert_paragraph
- rng_insert_paragraph_after
- rng_insert_paragraph_before
- rng_insert_space
- rng_insert_space_after
- rng_insert_space_before
- rng_insert_tabulation
- rng_insert_tabulation_after
- rng_insert_tabulation_before
- rng_move
- rng_move_end
- rng_move_start
- rng_next
- rng_paste
- rng_previous
- rng_set_story
- rng_set_style
- rng_set_text
- prefwordclient
Collapses the current range in the specified direction. Once the range has been reduced, the start and end positions will be in the same place.
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 RNG_COLLAPSE Direction ReturnCode |
|||||
Parameters |
|||||
Direction |
NUM_BIN_4 type (input parameter) Possible values:
|
||||
ReturnCode |
NUM_BIN_4 type (output parameter) |
Copies the contents of the current range to the clipboard. The current range is not changed.
Syntax | |||||
CALL_METHOD NameWordClientObject RNG_COPY ReturnCode |
|||||
Parameters |
|||||
ReturnCode |
NUM_BIN_4 type (output parameter) Possible values:
|
Deletes the contents of the current range and places them in the clipboard. The range is shortened.
Syntax | |||||
CALL_METHOD NameWordClientObject RNG_CUT ReturnCode |
|||||
Parameters |
|||||
ReturnCode |
NUM_BIN_4 type (output parameter) Possible values:
|
Positions and collapses the current range to the start of the specified element, on the basis of the following parameters:
Type |
type of the element to which the range is to be moved, |
MovementType |
type of movement to be performed, |
Number |
number (always positive) of the element in the document, |
Name |
element name, in the case of bookmarks, notes and fields. |
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 RNG_GO_TO Type MovementType Number Name ReturnCode |
|||||||||||||||||||||||||||||
Parameters |
|||||||||||||||||||||||||||||
Type |
NUM_BIN_4 type (input parameter)
Possible values:
|
||||||||||||||||||||||||||||
MovementType |
NUM_BIN_4 type (input parameter)
Possible values:
|
||||||||||||||||||||||||||||
Number |
NUM_BIN_4 type (input parameter) |
||||||||||||||||||||||||||||
Name |
ALPHA(50) type (input parameter) |
||||||||||||||||||||||||||||
ReturnCode |
NUM_BIN_4 type (output parameter) |
Positions (and collapses) the range to the start of the following element specified by Type .
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 RNG_GO_TO_NEXT Type ReturnCode |
|||||||||||||||||||||||||||
Parameters |
|||||||||||||||||||||||||||
Type |
NUM_BIN_4 type (input parameter)
Possible values:
|
||||||||||||||||||||||||||
ReturnCode |
NUM_BIN_4 type (output parameter) |
Positions (and collapses) the range to the start of the previous element specified by Type .
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 RNG_GO_TO_PREVIOUS Type ReturnCode |
|||||||||||||||||||||||||||
Parameters |
|||||||||||||||||||||||||||
Type |
NUM_BIN_4 type (input parameter)
Possible values:
|
||||||||||||||||||||||||||
ReturnCode |
NUM_BIN_4 type (output parameter) |
Inserts text at the end of the current range. After insertion, the range will be extended to include the new text.
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 RNG_INSERT_AFTER Text ReturnCode |
|
Parameters |
|
Text |
ALPHA(any n) type (input parameter) |
ReturnCode |
NUM_BIN_4 type (output parameter) |
Inserts text at the start of the current range. After insertion, the range will be extended to include the new text.
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 RNG_INSERT_BEFORE Text ReturnCode |
|
Parameters |
|
Text |
ALPHA(any n) type (input parameter) |
ReturnCode |
NUM_BIN_4 type (output parameter) |
Inserts a page, column or section break. When a page or column break is inserted, the range's contents will be replaced by the break. When a section break is inserted, it will appear immediately before the range.
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 RNG_INSERT_BREAK BreakType ReturnCode |
|||||||||||||||
Parameters |
|||||||||||||||
BreakType |
NUM_BIN_4 type (input parameter)
Possible values:
|
||||||||||||||
ReturnCode |
NUM_BIN_4 type (output parameter) |
Inserts the current date and/or time in text form or as a TIME field. If the Format field has not been completed, the date will be inserted in the abbreviated format used in the Windows Control Panel. The range will be collapsed and positioned at the start of the newly added text.
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 RNG_INSERT_DATE_TIME Format TimeField ReturnCode |
|
Parameters |
|
Format |
ALPHA(50) type (input parameter) |
TimeField |
BOOL type (input parameter) |
ReturnCode |
NUM_BIN_4 type (output parameter) |
Inserts a file or a portion of a file to replace the contents of the current range.
If the file inserted is a Microsoft Word file, it is possible to insert only the text contained in a bookmark, as well as the bookmark itself. If the file inserted is a Microsoft Excel file, it is possible to insert only one range of a sheet of the file, in the form of a table.
FullFileName |
Directory and name of the file to be inserted. |
Portion |
Bookmark name for a Word file, or range for an Excel file. |
Confirmation |
Tells Word to request the user to confirm file conversion via a dialog box when inserting a file in a format other than Microsoft Word. |
InsertLink |
Enables the file to be inserted using the INCLUDETEXT field. |
Attachment |
Used to insert the file as an attachment to an electronic message. |
ReturnCode |
Informs as to the result of the method. |
Syntax | |||||
CALL_METHOD NameWordClientObject RNG_INSERT_FILE FullFileName Portion Confirmation InsertLink Attachment ReturnCode |
|||||
Parameters |
|||||
FileNamePath |
ALPHA(260) type (input parameter) |
||||
Portion |
ALPHA(50) type (input parameter) |
||||
Confirmation |
BOOL type (input parameter) |
||||
InsertLink |
BOOL type (input parameter) |
||||
Attachment |
BOOL type (input parameter) |
||||
ReturnCode |
NUM_BIN_4 type (output parameter) Possible values:
|
Replaces the current range's contents with paragraph marks.
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 RNG_INSERT_PARAGRAPH NbParagraphs ReturnCode |
|
Parameters |
|
NbParagraphs |
NUM_BIN_4 type (input parameter) |
ReturnCode |
NUM_BIN_4 type (output parameter) |
Inserts paragraph marks at the end of the current range. The range will be enlarged to contain the new marks.
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 RNG_INSERT_PARAGRAPH_AFTER NbParagraphs ReturnCode |
|
Parameters |
|
NbParagraphs |
NUM_BIN_4 type (input parameter) |
ReturnCode |
NUM_BIN_4 type (output parameter) |
Inserts paragraph marks at the start of the current range. The range will be enlarged to contain the new marks.
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 RNG_INSERT_PARAGRAPH_BEFORE NbParagraphs ReturnCode |
|
Parameters |
|
NbParagraphs |
NUM_BIN_4 type (input parameter) |
ReturnCode |
NUM_BIN_4 type (output parameter) |
Replaces the current range's contents with space marks.
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 RNG_INSERT_SPACE NbSpaces ReturnCode |
|
Parameters |
|
NbSpaces |
NUM_BIN_4 type (input parameter) |
ReturnCode |
NUM_BIN_4 type (output parameter) |
Inserts spaces at the end of the current range. The range will be enlarged to contain the new space marks.
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 RNG_INSERT_SPACE_AFTER NbSpaces ReturnCode |
|
Parameters |
|
NbSpaces |
NUM_BIN_4 type (input parameter) |
ReturnCode |
NUM_BIN_4 type (output parameter) |
Inserts space marks at the start of the current range. The range will be enlarged to contain the new space marks.
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 RNG_INSERT_SPACE_BEFORE NbSpaces ReturnCode |
|
Parameters |
|
NbSpaces |
NUM_BIN_4 type (input parameter) |
ReturnCode |
NUM_BIN_4 type (output parameter) |
Replaces the current range's contents with tabulation marks.
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 RNG_INSERT_TABULATION NbTabulations ReturnCode |
|
Parameters |
|
NbTabulations |
NUM_BIN_4 type (input parameter) |
ReturnCode |
NUM_BIN_4 type (output parameter) |
Inserts tabulations at the end of the current range. The range will be enlarged to contain the new tabulation marks.
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 RNG_INSERT_TABULATION_AFTER NbTabulations ReturnCode |
|
Parameters |
|
NbTabulations |
NUM_BIN_4 type (input parameter) |
ReturnCode |
NUM_BIN_4 type (output parameter) |
Inserts tabulation marks at the start of the current range. The range will be enlarged to contain the new tabulation marks.
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 RNG_INSERT_TABULATION_BEFORE NbTabulations ReturnCode |
|
Parameters |
|
NbTabulations |
NUM_BIN_4 type (input parameter) |
ReturnCode |
NUM_BIN_4 type (output parameter) |
Collapses the range to its start or end position, then moves the range by the specified number of units. This method returns the number of movement units, which will be "0" if the movement fails:
Unit |
unit representing the distance moved. |
Number |
number of movement units. If this number is positive, the range will be collapsed to its end position, then moved the specified number of units toward the bottom of the document. If this number is negative, the range will be collapsed to its start position, then moved the specified number of units backward. |
NbMovtMade |
number of units that the range has been moved. |
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. The method will not necessarily fail if the movement operation fails.
Syntax | |||||||||||||||||||||
CALL_METHOD NameWordClientObject RNG_MOVE Unit Number NbMovtMade ReturnCode |
|||||||||||||||||||||
Parameters |
|||||||||||||||||||||
Unit |
NUM_BIN_4 type (input parameter)
Possible values:
|
||||||||||||||||||||
Number |
NUM_BIN_4 type (input parameter) |
||||||||||||||||||||
NbMovtMade |
NUM_BIN_4 type (output parameter) |
||||||||||||||||||||
ReturnCode |
NUM_BIN_4 type (output parameter) |
Moves the range's end position by the specified number of units. This method returns the number of movement units, which will be "0" if the movement fails:
Unit |
unit representing the distance moved. |
Number |
number of units that the end of the range is moved. If this number is positive, the end of the range will be moved by the specified number of units toward the bottom of the document. If this number is negative, the end of the range will be moved backward by the specified number of units. If the end position is moved backward beyond the start position, the range will be collapsed and the start and end positions moved together. |
NbMovtMade |
number of units that the range has been moved. |
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. The method will not necessarily fail if the movement operation fails.
Syntax | |||||||||||||||||||||
CALL_METHOD NameWordClientObject RNG_MOVE_END Unit Number NbMovtMade ReturnCode |
|||||||||||||||||||||
Parameters |
|||||||||||||||||||||
Unit |
NUM_BIN_4 type (input parameter)
Possible values:
|
||||||||||||||||||||
Number |
NUM_BIN_4 type (input parameter) |
||||||||||||||||||||
NbMovtMade |
NUM_BIN_4 type (output parameter) |
||||||||||||||||||||
ReturnCode |
NUM_BIN_4 type (output parameter) |
Moves the range's start position by the specified number of units. This method returns the number of movement units, which will be "0" if the movement fails:
Unit |
unit representing the distance moved. |
Number |
number of units that the start of the range is moved. If this number is positive, the start of the range will be moved by the specified number of units toward the bottom of the document. If this number is negative, the start of the range will be moved backward by the specified number of units. If the start position is moved forward beyond the end position, the range will be collapsed and the start and end positions moved together. |
NbMovtMade |
number of units that the range has been moved. |
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. The method will not necessarily fail if the movement operation fails.
Syntax | |||||||||||||||||||||
CALL_METHOD NameWordClientObject RNG_MOVE_START Unit Number NbMovtMade ReturnCode |
|||||||||||||||||||||
Parameters |
|||||||||||||||||||||
Unit |
NUM_BIN_4 type (input parameter)
Possible values:
|
||||||||||||||||||||
Number |
NUM_BIN_4 type (input parameter) |
||||||||||||||||||||
NbMovtMade |
NUM_BIN_4 type (output parameter) |
||||||||||||||||||||
ReturnCode |
NUM_BIN_4 type (output parameter) |
Collapses the range to its end position, then moves the range forward the specified number of units:
Unit |
unit representing the distance moved, |
Number |
number of units moved forward. This number must be positive. |
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 RNG_NEXT Unit Number ReturnCode |
|||||||||||||||||||||
Parameters |
|||||||||||||||||||||
Unit |
NUM_BIN_4 type (input parameter)
Possible values:
|
||||||||||||||||||||
Number |
NUM_BIN_4 type (input parameter) |
||||||||||||||||||||
ReturnCode |
NUM_BIN_4 type (output parameter) |
Replaces the contents of the current range with the clipboard contents.
Syntax | |||||
CALL_METHOD NameWordClientObject RNG_PASTE ReturnCode |
|||||
Parameters |
|||||
ReturnCode |
NUM_BIN_4 type (output parameter) Possible values:
|
Collapses the range to its start position, then moves the range backward the specified number of units:
Unit |
unit representing the distance moved, |
Number |
number of units moved backward; this number must be positive. |
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 RNG_PREVIOUS Unit Number ReturnCode |
|||||||||||||||||||||||||||||||
Parameters |
|||||||||||||||||||||||||||||||
Unit |
NUM_BIN_4 type (input parameter)
Possible values:
|
||||||||||||||||||||||||||||||
Number |
NUM_BIN_4 type (input parameter) |
||||||||||||||||||||||||||||||
ReturnCode |
NUM_BIN_4 type (output parameter) |
Specifies the story and section of the document in which the current range is located. Once this method has been run, the current range will contain the story's entire contents.
Story |
story used to define the new current range, |
Section |
number of the section in the document. |
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 RNG_SET_STORY Story Section ReturnCode |
|||||||||||||||
Parameters |
|||||||||||||||
Story |
NUM_BIN_2 type (input parameter) Possible values:
|
||||||||||||||
Section |
NUM_BIN_4 type (input parameter) |
||||||||||||||
ReturnCode |
NUM_BIN_4 type (output parameter) |
Sets the range's style.
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 RNG_SET_STYLE Style ReturnCode |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameters |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Style |
NUM_BIN_4 type (input parameter)
Possible values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReturnCode |
NUM_BIN_4 type (output parameter) |
Sets the text in the current range. Provided the range has not been collapsed, its contents will be replaced by the specified text.
Once this method has been run, the range will include the new text.
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 RNG_SET_TEXT Text ReturnCode |
|
Parameters |
|
Text |
ALPHA(any n) type (input parameter) |
ReturnCode |
NUM_BIN_4 type (output parameter) |
-
Page:
-
Page:
-
Page:
-
Page:
-
Page:
-
Page:
-
Page:
-
Page:
-
Page:
-
Page:
-
Page:
-
Page:
-
Page: