AlignCenter ( ) ,byte,proc
MyWord.AlignCenter ()
TempByte = MyWord.AlignCenter ()

• Centers the currently selected text on the page
• Returns true (1) if no problems were experienced

• Justifies the currently selected text
• Returns true (1) if no problems were experienced

• Aligns the currently selected text to the left.
• Returns true (1) if no problems were experienced

• Aligns the currently selected text to the right.
• Returns true (1) if no problems were experienced

• Makes text bold / not bold
• pOption can be one of the following equates:
  • oiw:BoldOn
  • oiw:BoldOff
  • oiw:BoldToggle
• Returns true (1) if no problems were experienced

• Converts from centimetres to points.  1 cm = 28.35 points.  The pCentimetres parameter and the return parameter are both strings however, as we figured this would make your life easier to code (see examples above).
• See also InchesToPoints, LinesToPoints, MillimetersToPoints, PicasToPoints, PixelsToPoints, PointsToCentimeters, PointsToInches, PointsToLines, PointsToMillimeters, PointsToPicas, and PointsToPixels.

• Checks the grammar in the text passed as pText.
• Returns true (1) if there were no grammar errors, false (0) if there were errors, and a value greater than 1 if an internal error occurred.
• ( Current limitation of 1000 characters )

if MyWord.CheckSpelling (loc:Var1, false, false) = true
  loc:Var1 = MyWord1.TempCString
  ...

• Checks the spelling in the text passed as pText.
• Returns true (1) if there were no spelling errors, false (0) if there were errors, and a value greater than 1 if an internal error occurred.
• When you call this method, the queue (property) called self.WordsQ is populated with any spelling suggestions.
• ( Current limitation of 1000 characters )
• ( This documentation must be redone )

• Used by the templates when spell checking.  Adds the word passed as pText to a list of words to be ignored when spell checking.

• Used by the templates when spell checking
• Returns true (1) if the word pass as pText is in the list of words to be ignored

• Closes the currently open document
• Returns true (1) if no problems were experienced

• Used after you have called the OpenFooter method to make the footer section of the document "inactive", so that you can continue working on the document.
• Returns true (1) if no problems were experienced

• Used after you have called the OpenHeader method to make the header section of the document "inactive", so that you can continue working on the document.
• Returns true (1) if no problems were experienced

• Copies the current selection to the clipboard
• Returns true (1) if no problems were experienced

• Returns the number of characters in the document, or a negative value if an error occurred.

• Returns the number of currently open documents
• Returns a value less than 0 if an error occurred

• Returns the number of tables in the current document, or a negative value if an error occurred.

• Cuts the current selection to the clipboard
• Returns true (1) if no problems were experienced

Searches the document for the passed strings and returns 1 and selects the string if found, or returns zero and does not change current selection if the string does not exist in the document. This can be called multiple times to find each instance of the string in the document (for example to make each instance of the string bold - see the example below).

Parameters

string pText: The string to search for in the document

Return Values

Returns 1 if successful and selects the string that was found, or if the string cannot be found it returns zero.

Examples

! Find all instances of the word 'Hello' and make them bold.
loop while myWord.FindText('Hello')
    myWord.Bold(oiw:BoldOn)
end

ErrorTrap( string pErrorString, string pFunctionName )

MyWord1.ErrorTrap PROCEDURE (string pErrorString, string pFunctionName) 
  code
    parent.ErrorTrap(pErrorString, pFunctionName)
    if pErrorString = 'Init Failed'
        Message('Could not initialise Word! Please ensure that MS Word is installed.')
    end

• This method is called when an error occurs.  Office Inside provides embed points for this method (before parent call, and after parent call) where you can put code to deal with any errors Office Inside experiences (see the example code above - note the grey text indicates code generated by the Office Inside template, the black text is what you would add).
• By default any errors that Office Inside encounters will be dealt with as follows:
  • First, this ErrorTrap method is called, where you can act on the error message as shown in the example code above.
  • Second, Outlook might display a message of its own.  You can suppress all messages by ticking the Suppress Error Messages check box in the procedure extension template.
• Note 1 : Even if you suppress error messages the ErrorTrap method will still be called.
• Note 2 : The Suppress Error Messages checkbox simply generates a line of code that sets the SuppressErrorMessages property to true.  You can set this property manually if you prefer.

• Returns the color (value) of the currently selected text.
• If the color value (long) matches any of the standard Clarion color equates, the method will return that equate (e.g. COLOR:Green), or it will simply return a long (color).

• Returns the font name (font) for the currently selected text.

• Returns true (1) if no problems were encountered.
• Populates a queue (property) called self.FontNamesQ with a list of all available fonts.

• Returns the current font size
• Returns a negative value if an error occurred

• This is a wrapper method which can be used to get various information, and read various properties, depending on the parameters which you pass.
• The pOption parameter can be one of the GetInfo/Update Equates.
• The string which is returned contains the information pertaining to the parameter you requested information about.

• Returns the name (and full path) of the dictionary currently being used (to check spelling)

• Returns the position of the last selected character within the document.
• Returns a negative value if an error occurred.

• Returns the position of the first selected character within the document.
• Returns a negative value if an error occurred.

• This method updates an Office Inside property called self.TempCString (*cstring) with the text found in the currently loaded document.  Use the pScope parameter to tell this method which text you want, passing one of the following values / equates:
  • oiw:GetText_CurrentSelection  - returns currently selected text
  • oiw:GetText_All  - returns all text in document
• This method returns a byte indicating whether the method worked successfully (in which case "1" is returned), or whether an error occurred (in which case "0" is returned).
• NOTE:  The self.TempCString property should be treated as read-only...

GotoEndOfDoc ( ), byte, proc

Moves the cursor to the end of the current document.

Return Values

Returns true (1) if no problems were experienced.

Examples

MyWord.GotoEndOfDoc()
if not MyWord.GotoEndOfDoc()
    Message('Could not go to the end of the document, an error occured.')
end

See Also

GotoItem

Moves the cursor to a location within the document, based on the parameters which you pass. Can be used to navigate to a position in the document based on a line, paragraph, bookmark, character position etc. The pItem parameter is used to specify which item to go to, and the pDirection parameter specifies which one of those items to go to (the first, last etc.). You can set the pDirection to oiw:GotoAbsolute and then use the pCount parameter to specify the number of the item to go to (for example the 4th line in a document).

Note: If the pItem parameter is oiw:GoToBookmark, oiw:GoToComment, oiw:GoToField, or oiw:GoToObject, this parameter specifies a name and the pName field must be passed to specify which item is referred to.

Parameters

long pItem: The item to go to. Can be one of the GoTo equates:

• oiw:GoToBookmark - goes to the bookmark specified by the pName.
• oiw:GoToSection - goes to the section specified by the pDirection and pCount parameters.
• oiw:GoToPage - goes to the page specified by the pDirection and pCount parameters.
• oiw:GoToTable - goes to the table specified by the pDirection and pCount parameters.
• oiw:GoToLine - goes to the line specified by the pDirection and pCount parameters.
• oiw:GoToFootnote - goes to the footnote specified by the pDirection and pCount parameters.
• oiw:GoToEndnote- goes to the endnote specified by the pDirection and pCount parameters.
• oiw:GoToComment - goes to the comment specified by the pName.
• oiw:GoToField - goes to the field specified by the pName parameter.
• oiw:GoToGraphic  - goes to the comment specified by the pDirection and pCount parameters.
• oiw:GoToObject  - goes to the comment specified by the pName parameters.
• oiw:GoToEquation  - goes to the comment specified by the pDirection and pCount parameters.
• oiw:GoToHeading  - goes to the comment specified by the pDirection and pCount parameters.
• oiw:GoToSpellingError  - goes to the comment specified by the pDirection and pCount parameters.
• oiw:GoToGrammaticalError  - goes to the comment specified by the pDirection and pCount parameters.
• oiw:GoToPercent  - goes to the comment specified by the pDirection and pCount parameters.
• oiw:GoToProofreadingError - goes to the comment specified by the pDirection and pCount parameters.
  

long pDirection: Specifies which items to go to, can be used in combination with the pCount parameter. For example if pDirection is set to oiw:GoToPrevious, then the count parameter can specify how many previous to go to (setting it to 4 will go to 4 items previous to the current one). May be one of the following values:

• oiw:GoToAbsolute - goes to a specific item, for example the 2nd table or 12th line in a document. Use the pCount parameter to specify which instance of the item to go to.
• oiw:GoToFirst - goes to the first occurrence of the item specified by the pItem parameter (table, line, paragraph etc.)
• oiw:GoToLast - goes to the last occurrence of the item specified by the pItem parameter (table, line, paragraph etc.)
• oiw:GoToNext - goes to the next occurrence of the item specified by the pItem parameter (table, line, paragraph etc.). Can be use in conjunction with the pCount parameter to move that number of the specified items.
• oiw:GoToPrevious - goes to the previous occurrence of the item specified by the pItem parameter (table, line, paragraph etc.). Can be use in conjunction with the pCount parameter to move that number of the specified items.
• oiw:GoToRelative - moves the number of pItems indicated by the pCount parameter relative to the current item. For example can be used to go four lines down from the current one.

Returns Values

Returns true (1) if no problems were experienced and false (0) if an error occurs. In the case of an error the ErrorTrap method will be called with a string indicating what error occurred.

Examples

! Go to the last line in the document
MyWord.GotoItem(oiw:GoToLine, oiw:GoToLast)
! Go to a named bookmark
MyWord1.GotoItem(oiw:GoToBookmark, , 'FirstName')
! Go to the first footnote in the document
MyWord1.GotoItem(oiw:GoToFootnote, oiw:GotoFirst)
! Move down 4 lines
MyWord1.GotoItem(oiw:GoToLine, oiw:GotoRelative, , 4)
! move back two pages
MyWord1.GotoItem(oiw:GoToPage, oiw:GotoPrevious, , 2)
! Move the insertion point just before the fifth endnote reference in the document
MyWord1.GotoItem(oiw:GoToEndNote, oiw:GotToAbsolute, , 5)
! Move the selection to the first cell in the next table
MyWord1.GotoItem(oiw:GoToTable, oiw:GotoNext)
! Select the Date field (assumes that there is a field in the document with the name Date)
MyWord1.GotoItem(oiw:GoToField, , 'Date')

• Sets a MS Word toolbar to be hidden.  For a list of valid equates which can be used, click here.
• Returns true (1) if no problems were experienced.

• Converts from inches to points.  1 inch = 72 points.  The pInches parameter and the return parameter are both strings however, as we figured this would make your life easier to code (see examples above).
• See also CentimetersToPoints, LinesToPoints, MillimetersToPoints, PicasToPoints, PixelsToPoints, PointsToCentimeters, PointsToInches, PointsToLines, PointsToMillimeters, PointsToPicas, and PointsToPixels.

• This method does several things, which can be summed us as "Getting everything ready so you can call the other methods in this class".  This involves...   ( To do )
• Returns true (1) if no problems were experienced.
• Note:  The first time you initialize an oiWord object (after starting your app), it might take a second or two to start an instance (process) of MS Word, which it then uses.  Any subsequent objects that you initialize will first check to see whether they can use that existing instance of MS Word before they start their own instance.  This speeds up the method significantly, especially for doing things like using the Spell Checker.  This is all taken care of for you by the dll, and is mentioned here purely for those who are interested.  When your app closes, any instances (processes) of MS Word that the dll started will be closed for you automatically.   ( Must redo this... )
• Note: You can also set whether Word is visible after you have called the Init method by using the Update method, passing oiw:ApplicationVisible.

• Inserts a break into the current document.  See the Break-Types Equates which you can pass as the
• Returns true (1) if no problems were experienced.

• Inserts a picture (image) into the current document, at the current selection.
• Before calling this method, you can set the ImageProperties property to control how the image will be inserted.  For example:
    MyWord.ImageProperties.ScaleWidth = 80 ! 80 percent of original width
    MyWord.ImageProperties.ScaleHeight = 80 ! 80 percent of original height
    MyWord.InsertPicture ('c:\mypic.bmp')
• Returns true (1) if no problems were experienced.

• Inserts a table into the current document, at the current selection / position.
• Returns 0 if a problem occurred, or the number of tables ( the table you just inserted will be the last table in the document / i.e. the highest number / i.e. the table number that is returned ) if the table was inserted successfully.
• TIP :  If you have for example three tables in a document, and add a fourth table, this method would return the value "4".  If you then deleted a table (say the second table that you inserted), then insert another table, this method would again return "4".  What was table 3 before you deleted table 2 would now become table 2, the "old" table 4 would become table 3, and the new table will be table 4.  In other words, tables don't keep their table numbers if you start deleting tables.

• Inserts text into the current document.
• pOption can be one of the following values:
  • 0  - default value.  text is inserted at or over the current selection
  • 1  - text is inserted before the current selection
  • 2  - text is inserted after the current selection
• Returns true (1) if no problems were experienced.

InsertTextbox ( string pText ) ,byte,proc

Inserts a textbox into the current document. A Word textbox can be used to create complex layouts, and position blocks of text anywhere on the document.

Before calling this method, you need to set up several properties, as shown in the example code above.  This lets you set up exactly how the TextBox will be drawn when you finally call the InsertTextbox method.

The self.Textbox.TextOrientation property can be set to any equate listed here.
The self.Textbox.ZOrder property can be set to any equate listed here.

• NOTE:  The self.Textbox.BorderColor and self.Textbox.TextColor properties can either be standard clarion color equates (as shown above), or RGB color values, e.g. 0D7D7D7H.
• NOTE:  You must either set the self.Textbox.XPos property or the self.Textbox.BoxAlignment property.  There is no point in setting both.
• NOTE:  Once this method has completed drawing the textbox, focus returns to your document, at the line immediately above where the textbox was drawn.  If there is no line in your document above the textbox, focus will stay on / in the textbox.  Call the NextLine method before calling this method to ensure that focus returns to your "document" once InsertTextbox completes, e.g.
  MyWord.NextLine ( )
  ! set up properties, as shown above
  MyWord.InsertTextbox ('Hello World')

Return Values

Returns true (1) if no problems were experienced.

Example:

MyWord.Textbox.BoxAlignment = oiw:ShapeCenter
MyWord.Textbox.YPos = 153
MyWord.Textbox.Width = 200
MyWord.Textbox.Height = 50
MyWord.Textbox.ShowBorders = true
MyWord.Textbox.BorderColor = color:yellow
MyWord.Textbox.BorderWidth = '5'
MyWord.Textbox.TextFont = 'Arial'
MyWord.Textbox.TextSize = 20
MyWord.Textbox.TextColor = color:red
MyWord.Textbox.TextOrientation = oiw:TextOrientationHorizontal
MyWord.Textbox.TextAlignment = oiw:AlignParagraphRight
MyWord.Textbox.ZOrder = oiw:SendBehindText
MyWord.Textbox.MoveWithText = false
! once the properties are set we can now call the method...
MyWord.InsertTextbox ('Hello world!')

• Makes the selected text italicized / not italicized.
• Returns true (1) if no problems were experienced.
• pOption can be one of the following equates:
  • oiw:ItalicOn
  • oiw:ItalicOff
  • oiw:ItalicToggle

• Closes any currently open documents (using the CloseDoc method)
• Closes MS Word
• Kills the oiWord object and handles any cleaning up.
• Returns true (1) if no problems were experienced.

• Converts from lines to points.  1 lines = 12 points.  The pLines parameter and the return parameter are both strings however, as we figured this would make your life easier to code (see examples above).
• See also CentimetersToPoints, InchesToPoints, MillimetersToPoints, PicasToPoints, PixelsToPoints, PointsToCentimeters, PointsToInches, PointsToLines, PointsToMillimeters, PointsToPicas, and PointsToPixels.

•  ( Please do not use this method yet... )

• Starts a Mail Merge process.
• This method calls the MailMergeUpdate method before the actual merge begins.
• Returns true (1) is no problems were reported.

• When you create and save a Mail Merge document, it stores the path to its Data Source.  If this path changes (e.g. when you ship) the Word document will no longer be able to open the Data Source.  This method enables you to set the Data Source path at run-time, which enables you to get around this problem (as shown in the example above).
• A valid Mail Merge document must already be open before calling this method.
• Returns true (1) is no problems were reported.

• Converts from millimeters to points.  1 mm = 2.85 points.  The pMillimeters parameter and the return parameter are both strings however, as we figured this would make your life easier to code (see examples above).
• See also CentimetersToPoints, InchesToPoints, LinesToPoints, PicasToPoints, PixelsToPoints, PointsToCentimeters, PointsToInches, PointsToLines, PointsToMillimeters, PointsToPicas, and PointsToPixels.

• Has the same effect on your document as if you pressed the "down arrow" key on the keyboard.
• The pExtend parameter can be either oiw:Move or oiw:Extend
• Returns true (1) is no problems were reported.

• Has the same effect on your document as if you pressed the "left arrow" key on the keyboard.
• The pExtend parameter can be either oiw:Move or oiw:Extend
• Returns true (1) is no problems were reported.

• Has the same effect on your document as if you pressed the "right arrow" key on the keyboard.
• The pExtend parameter can be either oiw:Move or oiw:Extend
• Returns true (1) is no problems were reported.

• Has the same effect on your document as if you pressed the "up arrow" key on the keyboard.
• The pExtend parameter can be either oiw:Move or oiw:Extend
• Returns true (1) is no problems were reported.

• Creates a new document
• Returns true (1) if no problems were experienced.
• If you don't pass a TemplateName parameter, MS Word will use the "normal.dot" template, which is standard behaviour.  If you do pass a template name, the full path to the ".dot" file must be passed, unless the ".dot" file is in the default template directory.

• Moves to the next line within the document.  Same as pressing the "Enter" button from within MS Word.
• Returns true (1) if no problems were experienced.

• Opens an existing document
• Returns true (1) if no problems were experienced.
•  ( Seems to be a problem under Win XP / Office XP if the datasource is not in the original folder... )

• Makes the footer section of the currently open document "active", so that you can work on / in it.
• Returns true (1) if no problems were experienced.

• Makes the header section of the currently open document "active", so that you can work on / in it.
• Returns true (1) if no problems were experienced.

• Pastes from the clipboard to the current selection / cursor position within a Word document.
• Returns true (1) if no problems were experienced.

• Converts from picas to points.  1 pica = 12 points.  The pPicas parameter and the return parameter are both strings however, as we figured this would make your life easier to code (see examples above).
• See also CentimetersToPoints, InchesToPoints, LinesToPoints, MillimetersToPoints, PixelsToPoints, PointsToCentimeters, PointsToInches, PointsToLines, PointsToMillimeters, PointsToPicas, and PointsToPixels.

• Converts from pixels to points.  The pPixels parameter and the return parameter are both strings however, as we figured this would make your life easier to code (see examples above).
• The pVertical parameter can be used to specify whether you want to convert vertical pixels (if passed as true) or horizontal pixels (if omitted or passed as false).
• See also CentimetersToPoints, InchesToPoints, LinesToPoints, MillimetersToPoints, PicasToPoints, PointsToCentimeters, PointsToInches, PointsToLines, PointsToMillimeters, PointsToPicas, and PointsToPixels.

• Converts from points to centimetres.  1 cm = 28.35 points.  The pPoints parameter and the return parameter are both strings however, as we figured this would make your life easier to code (see examples above).
• See also CentimetersToPoints, InchesToPoints, LinesToPoints, MillimetersToPoints, PicasToPoints, PixelsToPoints, PointsToInches, PointsToLines, PointsToMillimeters, PointsToPicas, and PointsToPixels.

• Converts from points to inches.  1 inch = 72 points.  The pPoints parameter and the return parameter are both strings however, as we figured this would make your life easier to code (see examples above).
• See also CentimetersToPoints, InchesToPoints, LinesToPoints, MillimetersToPoints, PicasToPoints, PixelsToPoints, PointsToCentimeters, PointsToLines, PointsToMillimeters, PointsToPicas, and PointsToPixels.

• Converts from points to lines.  1 lines = 12 points.  The pPoints parameter and the return parameter are both strings however, as we figured this would make your life easier to code (see examples above).
• See also CentimetersToPoints, InchesToPoints, LinesToPoints, MillimetersToPoints, PicasToPoints, PixelsToPoints, PointsToCentimeters, PointsToInches, PointsToMillimeters, PointsToPicas, and PointsToPixels.

• Converts from points to millimeters.  1 mm = 2.835 points.  The pPoints parameter and the return parameter are both strings however, as we figured this would make your life easier to code (see examples above).
• See also CentimetersToPoints, InchesToPoints, LinesToPoints, MillimetersToPoints, PicasToPoints, PixelsToPoints, PointsToCentimeters, PointsToInches, PointsToLines, PointsToPicas, and PointsToPixels.

• Converts from points to picas.  1 pica = 12 points.  The pPoints parameter and the return parameter are both strings however, as we figured this would make your life easier to code (see examples above).
• See also CentimetersToPoints, InchesToPoints, LinesToPoints, MillimetersToPoints, PicasToPoints, PixelsToPoints, PointsToCentimeters, PointsToInches, PointsToLines, PointsToMillimeters, and PointsToPixels.

• Converts from points to pixels.  The pPoints parameter and the return parameter are both strings however, as we figured this would make your life easier to code (see examples above).
• The pVertical parameter can be used to specify whether you want to convert vertical pixels (if passed as true) or horizontal pixels (if omitted or passed as false).
• See also CentimetersToPoints, InchesToPoints, LinesToPoints, MillimetersToPoints, PicasToPoints, PixelsToPoints, PointsToCentimeters, PointsToInches, PointsToLines, PointsToMillimeters, and PointsToPicas.

• ( Not yet implemented... )
• Returns true (1) if no problems were experienced.

PrintMe     (<string pPages>, byte pRange=oiw:PrintAllDocument, long pCopies=1, byte pPageType=oiw:PrintAllPages, byte pBackground=false, <string pPrinterName>) ,byte,proc

Prints the currently loaded document. This method has been replaced by the PrintOut(), which expands the supported options and is currently in Beta (see below).

Parameters

• The pPages parameter holds the page numbers / ranges to be printed.  If you do not pass a value in this parameter, a value of "print everything" is implied, but not passed.  (See "notes" below).  Valid examples for this parameter include:
  • '5, 6, 12'
  • '3, 5, 8-15'
• The pRange parameter can be one of the following values:
  • oiw:PrintAllDocument (default)
  • oiw:PrintSelection
  • oiw:PrintCurrentPage
  • oiw:PrintFromTo  (not supported, use pPages instead)
  • oiw:PrintRangeOfPages (see notes below)
• The pCopies parameter is not supported by this method, use PrintOut() instead.
• The pPageType parameter can be one of the following values:
  • oiw:PrintAllPages  (default)
  • oiw:PrintOddPagesOnly
  • oiw:PrintEvenPagesOnly
• The pBackground parameter determines whether this method returns before or after the document has actually been sent to the printer.  This is very useful.  Passing this parameter as "true" (1) will make the method return faster (as it does not wait for confirmation that the document has been sent to the printer), but you need to consider the implications of this.  One implication is that calling MyWord.Kill might cause MS Word to show the "Word is currently printing.  Quitting Word will cancel all pending jobs" warning.  Passing this parameter as "false" (0) guarantees that the document has been sent to the printer before the PrintMe method returns, solving the problem (at the cost of a slight delay when you call the method).
• The pPrinterName parameter can be used to specify a printer other than the default printer, for example:
  MyWord.PrintMe ('1',,,,,'PDF-XChange 3.0')

Notes

In order for the pPages parameter to work, pRange needs to be oiw:PrintRangeOfPages.  If you pass a value in pPages, and also pass anything other than oiw:PrintRangeOfPages in pRange, we will simply ignore what you pass in pRange.  We do this so that the following code will work, even though pRange is going to default to oiw:PrintAllDocument, which wouldn't ordinarily work:
MyWord.PrintMe ( '3,4,7-8' )

If you're wanting to print a document to a printer other than the system default printer, the "safest" way to do this seems to be it is done in the "Two Printers" example.  Notes can be found in that example.

Examples

TempByte = MyWord.PrintMe ()
MyWord.PrintMe ('2,4,5-8') ! oiw:PrintRangeOfPages implied (see "Notes")
MyWord.PrintMe ('2,4', oiw:PrintRangeOfPages)
MyWord.PrintMe ( ,oiw:PrintCurrentPage)
MyWord.PrintMe ( ,oiw:PrintSelection)
MyWord.PrintMe ( ,,,oiw:PrintOddPagesOnly)
MyWord.PrintMe ( ,,2)
MyWord.PrintMe ('1',,,,,'Lexmark 3200')

PrintOut (*oiwPrintProperties printSettings, string printerName)

The PrintOut method expand on the simple PrintMe() method and exposes all the properties supports by Word. The oiwPrintProperties group type is provided to allow the setting to be easily set and passed.

Parameters

*oiwPrintProperties printSettings

A oiwPrintProperties group that contains the settings to be used for printing. See below for a description of the group type and fields. This is a TYPE'd group and can be used to create your own PrintSettings groups as follows:

myPrintSettings   group(oiwPrintProperties)
                  end

string printName

The name of the printer to use for printing.

Return Values

Returns 1 for success and zero if the COM interface encountered an error.

Data Types

• Print Previews the current document, or establishes whether the current document is being previewed.

Enables document protection. This limits what changes may be made to the document unless document protection is turned off. If a password is specified then that password must be used to turn document protection off. Once you enabled document protection the same limits that apply to the end user also apply to other methods called. For example if you enabled document protection and set the document to Read Only, you will not be able to modify the document by calling any of the oiWord methods until oiWord.Unprotect is called to remove the protection.

Parameters

long protectionType: Type of protection to enabled. Can be one of the following values:

• oiw:AllowOnlyComments - Only comments can be added or edited
• oiw:AllowOnlyFormFields - Only form fields may be have their values edited.
• oiw:AllowOnlyReading - Document is read only, no changes may be made
• oiw:AllowOnlyRevisions - Only revisions may be made
• oiw:NoProtection - No protection (the same as calling Unprotect()).

string pPassword: The password used to protect the document. This password will be needed to remove the protection. A blank string may be specified, which means that the protection can be removed without setting any password.

Return Values

Returns 1 for success and zero for failure.

Examples

MyWord1.Protect(oiw:AllowOnlyComments, 'capesoft')
MyWord1.Protect(oiw:AllowOnlyFormFields, 'capesoft')
MyWord1.Protect(oiw:AllowOnlyReading, 'capesoft')
MyWord1.Protect(oiw:AllowOnlyRevisions, 'capesoft')
MyWord1.Unprotect('capesoft')

• Opposite to the "Undo" method.
• Returns true (1) if no problems were experienced.

ReplaceText (string pFindText, string pReplaceText, byte pReplaceAll=false), byte, proc

Search and replace method, locates a string in the document and replaces it with the specified string. This method searches the currently loaded document for the text you pass as the pFindText parameter, and then replaces that text with the text which you pass as the pReplaceText parameter. The pReplaceAll parameter determines whether the first instance the word / text is replace, or whether all instances are replaced.

Important: Word limits the size of the strings being replaced and the replacement text to 256 characters. There are two ways of replacing strings larger than 256 characters:

1. If your replacement string contains more than 256 characters use the FindText method to find the string and the call the InsertText method to replace it with your own string. You can to replace all instances by looping and calling FindText and replacing each instance until the FindText method it fails (returns zero), indicating that the string no longer exists in the document.

2. Simply put your LargeString on the clipboard and call the ReplaceText method with the pRelaceText set to '^c':
     MyWord.ReplaceText('LookFor', '^c', True)
   
   The 2-character string '^c' will be interpreted by Word as the Paste command. This also has the advantage of supporting inserting RTF formatting text into Word (the Paste command is the only way to insert RTF formatting text directly into a Word document)

Note: Replacement text inherits the formatting of the text it replaces in the document. For example, if you replace the string "abc" with "xyz," occurrences of "abc" with bold formatting are replaced with the string "xyz" with bold formatting.  This also applies to case, in that if you replace "acb" with "xyz" you will get "xyz", but if you replace "ABC" with "xyz" you will in fact get "XYZ".  This is actually pretty useful once you understand how it works, in that you can lay out the same search string in a document, multiple times, and each string can have its own formatting (case, bold, underlined etc) which is preserved when you replace.

Parameters

string pFindText: The text to find in the document. This will be replace by the pReplaceText string if it is found.

string pReplaceText: The text to replace the pFindText string with

byte pReplaceAll: An optional parameter specifying that all instances of the pFindText string in the document should be replaced by the pReplaceTextString. The default is false (only replace the first occurrence). Setting this to true (1) will replace all occurrences.

Return Values

Returns true (1) if no problems were experienced (Note: A return value of true does not indicate that any text was actually replaced. In other words, if the text you are searching for is not found, the method can still return true).

 Examples

MyWord1.Rep