Chapter 2

Corel^® WordPerfect^® Product Commands
S

SGMLFindNextTable

Purpose

Position the insertion point in the next table. Can be used only with a document type that allows table tagging. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLFindNextTable ()

SGMLFindStartTag

Purpose

Find the start of an element. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLFindStartTag (Name: string; Direction: enumeration; AttributeEditFind: enumeration)

Parameters

Name

string (optional)

Direction

enumeration (optional)

Either! Searches backward first, then forward for the start tag.

Next!

Previous!

AttributeEditFind

enumeration (optional)

No!

Yes! Limits the find to start tags with attributes present or start tags with attributes declared in the document type.

SGMLGetAttributeData

Purpose

Assign information to a variable about the attributes of the current element. The macro uses the variable with other commands to retrieve information or to determine whether to perform specified actions. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLGetAttributeData (Variable: variable; Item: enumeration; Type: enumeration; Element: enumeration; ItemNum: numeric)

Parameters

Variable

variable

Item

enumeration

Count! Returns a count of all the attributes of a given type.

DefaultValue! Returns the default value for the attribute specified in the document type. The string returned can be CONREF, CURRENT, IMPLIED, REQUIRED, or a string up to 1000 characters.

ErrorType! Returns one of the following values, representing the type of error for the attribute:

0 No error

1 Unknown attribute

2 Invalid character in NAME attribute

3 Invalid character in NMTOKEN attribute

4 Invalid character in NUMBER attribute

5 Invalid character in NUTOKEN attribute

6 An attribute value exceeds NAMELEN

7 Only one value is allowed

8 Attribute length exceeds LITLEN

9 No mapping for an attribute extended character

10 Attribute has no value assigned

11 Entity open (&...) in the attribute is not validated

12 Char Ref (&#...) in the attribute is not validated

13 An attribute value is not in the declared list

14 Attribute is not the declared FIXED value

15 Attribute is not a declared entity

16 Attribute is not a data or SUBDOC entity

17 More than one attribute has the same name

Name! Returns the name of the attribute specified by ItemNum.

Status! Returns one of the following values, representing the statue of the attribute:

0 Does not have a value currently specified

1 Has a value

2 Has a value but is in error

Type! Returns one of the following values:

0 Unknown

1 FIXED

2 The declared type was a list

3 CDATA

4 ENTITIES

5 ENTITY

6 ID

7 IDREF

8 IDREFS

9 NAME

10 NAMES

11 NMTOKEN

12 NMTOKENS

13 NOTATION

14 NUMBER

15 NUMBERS

16 NUTOKEN

17 NUTOKENS

Value! Returns the value of an attribute specified in the tag. (Value! always returns an error if the attribute has not been given a value.)

Type

enumeration Specify the type of attribute a variable belongs to.

All! Returns information about all attributes available in the open or previous element, relative to the insertion point.

InTag! Returns information about the attributes that have been given a value in the open or previous element, relative to the insertion point.

Invalid! Returns information about the attributes that have been given an invalid value in the open or previous element, relative to the insertion point.

NotInTag! Returns information about the attributes that have not been given a value in the open or previous element, relative to the insertion point.

Element

enumeration Specify which element to act on. Previous elements are used for empty elements.

Open!

Previous!

ItemNum

numeric (optional) Specify the number of the item from which the Item parameter extracts information.

SGMLGetElementData

Purpose

Assign information to a variable about the elements available in a Corel WordPerfect document. The macro uses the variable with other commands to retrieve information or to determine whether to perform specified actions. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLGetElementData (Variable: variable; Item: enumeration; Type: enumeration; ItemNum: numeric)

Parameters

Variable

variable

Item

enumeration

Count! Returns a count of all the elements of a given type.

LSIType! Returns one of the following values:

0 Watermark B

1 Endnote

2 Header A

3 Header B

4 Footer A

5 Footer B

6 Footnote

7 Image Box

8 Watermark A

9 Table

10 Text Box

11 Equation Box

12 Normal (unspecified)

Name! Returns the name of the element specified by ItemNum.

Type

enumeration

All! Returns information about all elements available in the document.

Open! Returns information about all elements that are open at the insertion point.

Previous!

Valid! Returns information about elements that are valid to insert at the insertion point (with the exception of inclusions).

ItemNum

numeric (optional) Specify the number of the item from which the Item parameter extracts information.

SGMLGetFileRefData

Purpose

Assign information to a variable about the external file references available in a Corel WordPerfect document. The macro uses the variable with other commands to retrieve information or to determine whether to perform specified actions. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLGetFileRefData (Variable: variable; Item: enumeration; Type: enumeration; ItemNum: numeric)

Parameters

Variable

variable

Item

enumeration

Count! Returns a count of all the file references of a given type.

DataType! Returns one of the following values:

0 None

1 CDATA

2 NDATA

3 SDATA

4 SUBDOC

FilePath! Returns the file path of the file reference.

Name! Returns the name of the file reference.

Notation! Returns the notation type of the file reference.

PublicID! Returns the public identifier of the file reference.

Type

enumeration

DTD! Returns information about all file references declared in the document type.

User! Returns information about all file references the user has defined in the document.

ItemNum

numeric (optional) Specify the number of the item from which the Item parameter extracts information.

SGMLIDIDREFListDlg

Purpose

Display the list of ID and IDREF attributes. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLIDIDREFListDlg ()

SGMLIgnore

Purpose

Insert SGML IGNORE codes. If you insert IGNORE codes around selected text that includes start and end tags, other SGML IGNORE codes, or subdocument marker codes, be sure the selection includes both the beginning and end tag or code. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLIgnore ()

SGMLInsertElement

Purpose

Insert an element. If you insert an element around selected text that includes start and end tags, SGML IGNORE codes, or subdocument marker codes, be sure the selection includes both the beginning and end tag or code. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLInsertElement (Name: string)

Parameters

Name

string

SGMLLoadDocType

Purpose

Select a document type for the current document. The document type includes at least a document type name and logic file (.LGC), but may also include a layout file (.LSI) and an alias file (.LNM). This command is valid only if the Corel WordPerfect program component is installed.

Syntax

SGMLLoadDocType (DocTypeName: string)

Parameters

DocTypeName

string

SGMLLogicErrorDlg

Purpose

Display the Logic Errors dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLLogicErrorDlg ()

SGMLNewAttribute

Purpose

Create an attribute value. The name of the attribute must be different from any attribute in the previous start tag. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLNewAttribute (Name: string; Value: string)

Parameters

Name

string

Value

string

See Also

SGMLReplaceAttribute, SGMLBoxAttribute

SGMLOpenFileDlg

Purpose

Display the Open SGML File dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLOpenFileDlg ()

See Also

SGMLOpenFileOptions

SGMLOpenFileOptions

Purpose

Specify the document type and options for retrieving an SGML document. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLOpenFileOptions (WhiteSpaceConvert: enumeration; OmitTags: enumeration; DocTypeName: string)

Parameters

WhiteSpaceConvert

enumeration (optional) This parameter is obsolete, but it has been left in the program for compatibility with previous versions of Corel WordPerfect.

No!

Yes!

OmitTags

enumeration

No!

Yes!

DocTypeName

string

See Also

SGMLOpenFileDlg

SGMLPrefDlg

Purpose

Display the SGML Settings dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLPrefDlg ()

SGMLPreferences

Purpose

Specify a default directory for the document type files and the display settings for tags in the document and in Reveal Codes. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLPreferences (DocTypeDir: string; Show: enumeration; RevealCode: enumeration; Red: numeric; Green: numeric; Blue: numeric; FontSize: measurement)

Parameters

DocTypeDir

string (optional)

Show

enumeration (optional)

Hide!

Show!

ShowAsMarkers!

RevealCode

enumeration (optional)

ShowAttributes!

ShowLayout!

Red

numeric (optional) Value: 0-255.

Green

numeric (optional) Value: 0-255.

Blue

numeric (optional) Value: 0-255.

FontSize

measurement (optional)

SGMLRenameElement

Purpose

Rename the element previous to the insertion point. Does not change the element attributes. This command is valid only if the Corel WordPerfect SGML program component is installed. Not recordable.

Syntax

SGMLRenameElement (Name: string)

Parameters

Name

string

SGMLReplaceAttribute

Purpose

Replace the current attribute value. The attribute must be present in the previous start tag. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLReplaceAttribute (Name: string; Value: string)

Parameters

Name

string

Value

string

See Also

SGMLAddToAttrList, SGMLNewAttribute, SGMLBoxAttribute

SGMLRootElement

Purpose

Change the root element of the current document type. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLRootElement (Element: string)

Parameters

Element

string

SGMLRootElementDlg

Purpose

Display the Select Root Element dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLRootElementDlg ()

SGMLSaveAsOptions

Purpose

Set options for saving a document in SGML format. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLSaveAsOptions (DocTypeDeclaration: enumeration; SGMLDeclaration: enumeration; ConvertSRT: enumeration)

Parameters

DocTypeDeclaration

enumeration Include the Document Type Declaration in the saved SGML document. Default: Yes!

No!

Yes!

SGMLDeclarationIenumeration (optional) Include the SGML declaration at the beginning of the file. Default: No!

No!

Yes!

ConvertSRT

enumeration (optional) Convert soft returns in the document to hard returns in the saved SGML document. This command is obsolete in version 8; it has been left in the program for backwards compatibility.

No!

Yes!

SGMLSelectElement

Purpose

Select the open element at the insertion point. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLSelectElement ()

SGMLSelectLayout

Purpose

Change the layout of the SGML elements. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLSelectLayout (LayoutFile: string)

Parameters

LayoutFile

string (optional)

See Also

SGMLSelectLayoutDlg

SGMLSelectLayoutDlg

Purpose

Display the Select Layouts dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLSelectLayoutDlg ()

See Also

SGMLSelectLayout

SGMLSetValidation

Purpose

Specify the types of errors to find during validation. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLSetValidation ({Options: enumeration; })

Parameters

Options

enumeration (optional)

CharMap!

Entity!

EntityDecl!

IdIdref!

Logic!

TextSeq!

SGMLSplitElement

Purpose

Split the current SGML element into two separate elements of the same type. The attribute values will be duplicated for each element created. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLSplitElement ()

SGMLTagAllTables

Purpose

Tag all tables in a document. Can be used only with a document type that allows table tagging. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLTagAllTables ()

SGMLTagBox

Purpose

Tag the selected box based on the mappings specified in the layout (.LSI) file. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLTagBox ()

SGMLTagCurrentTable

Purpose

Tag the current table. Your document type must use one of the table methods supported by the SGML edition of Corel WordPerfect. For more information about the supported table methods, see Tag Tables in the main Help file. Any elements that are not part of the basic table structure (see below) must start and end within a single table cell. Any elements that are part of the basic table structure must start within the table.

Basic Table Structure:

For CALS: colspec, entry, row, spanspec, table, tbody, tgroup, thead, and title.

For AAP: ctbf, ctbl, ctby, ctc, cte, cth, cthd, cthr, ctr, ctsb1, ctsb2, ctsb3, ctsb4, and ctsh.

For HTML: table, tr, td, th.For WP6: table, cell, colinf, and row.

For WP6MIN: table, cell, and row.

For WP: wpcell, wprow, and wptable.

This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLTagCurrentTable ()

SGMLTagTablesDlg

Purpose

Display the Tag Tables dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLTagTablesDlg ()

SGMLTextRefDlg

Purpose

Display the Text References dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed. Not recordable.

Syntax

SGMLTextRefDlg ()

SGMLUnloadDocType

Purpose

Deselect a document type for the current document. The document type includes at least a document type name and logic file (.LGC), but may also include a layout file (.LSI) and an alias file (.LNM). This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLUnloadDocType ()

SGMLValidate

Purpose

Find the next validation error. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLValidate ()

SGMLValidationDlg

Purpose

Display the Validation dialog box. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

SGMLValidationDlg ()

ShadowCursorOptions

Purpose

Set the shape, type, and color of the shadow cursor.

Syntax

ShadowCursorOptions (State: enumeration; Snap: enumeration; Shape: enumeration; ColorRed: numeric; ColorGreen: numeric; ColorBlue: numeric)

Parameters

State

enumeration (optional)

Text!

TextAndWhiteSpace!

WhiteSpace!

Snap

enumeration (optional)

Indents!

Margins!

Spaces!

Tabs!

Shape

enumeration (optional)

Arrows!

BottomArrow!

BrokenCaret!

Caret!

DottedCaret!

IBeam!

ColorRed

numeric (optional)

ColorGreen

numeric (optional)

ColorBlue

numeric (optional)

ShadowCursorShow

Purpose

Turn the shadow cursor on or off. Omitting the parameter toggles the state. This command also changes the display settings for the shadow cursor.

Syntax

boolean := ShadowCursorShow (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!

See Also

PrefDisplaySet

ShiftTabKey

Purpose

Insert a [Hd Back Tab] code at the insertion point. If the insertion point is in a table, it will go to the previous table cell. If the insertion point is in an outline, it will go to the previous outline level.

Syntax

ShiftTabKey ()

ShowBoxes

Purpose

Display graphics boxes.

Syntax

ShowBoxes (State: enumeration)

Parameters

State

enumeration

Off!

On!

See Also

?ShowBoxes

ShowGraphics

Purpose

Toggle Graphics.

Syntax

ShowGraphics ()

ShowHiddenText

Purpose

Toggle Hidden Text.

Syntax

ShowHiddenText ()

ShowSGMLTree

Purpose

Display or hide the SGML Tree. The tree will be displayed only if an SGML document is being edited. Switching to a non-SGML document does not close the tree. As soon as all SGML documents are closed, the tree will be hidden. This command is valid only if the Corel WordPerfect SGML program component is installed.

Syntax

ShowSGMLTree (State: enumeration)

Parameters

State

enumeration (optional)

Off!

On!

ShowSymbols

Purpose

Toggle display of document symbols for codes such as [HRt], [Indent], and [Tab].

Syntax

ShowSymbols ()

SingleSmartQuote

Purpose

Turn Single SmartQuotes on or off and specify a quote character.

Syntax

SingleSmartQuote (State: enumeration; OpenSingleQuote: numeric; CloseSingleQuote: numeric)

Parameters

State

enumeration (optional)

Off!

On!

OpenSingleQuote

numeric (optional) The numeric equivalent of the quote character.

CloseSingleQuote

numeric (optional) The numeric equivalent of the quote character.

See Also

DoubleSmartQuote, UseRegQuotesWithNumbers

SingleSpaceInSentence

Purpose

Change double spaces in a sentence to single spaces.

Syntax

SingleSpaceInSentence (State: enumeration)

Parameters

State

enumeration

Off!

On!

SoftHyphen

Purpose

Insert a soft hyphen at the insertion point. If the word needs to be hyphenated, it will break at the soft hyphen.

Syntax

SoftHyphen ()

SoftSpace

Purpose

Insert a space at the insertion point.

Syntax

SoftSpace ()

See Also

HardSpace

Sort

Purpose

Specify a file to sort and a file to which the changes are written.

Syntax

Sort (InFile: string; OutFile: string; State: enumeration)

Parameters

InFile

string (optional) Default: current document.

OutFile

string (optional) Default: current document.

State

enumeration (optional)

NoUndo!

Undo!

See Also

SortAction, SortCaseOrder, SortDlg, SortKeys, SortSelectString, SortType, SortUndo

SortAction

Purpose

Sort a file or selected records.

Syntax

SortAction (SortAction: enumeration)

Parameters

SortAction

enumeration

SelectOnly!

Sort!

See Also

?SortGetAction, ?SortGetCase, Sort, SortCaseOrder, SortKeys, SortSelectString, SortType, SortUndo

SortCaseOrder

Purpose

Specify the case priority in a sort.

Syntax

SortCaseOrder (Case: enumeration)

Parameters

Case

enumeration

LowercaseFirst!

UppercaseFirst!

See Also

?SortGetAction, ?SortGetCase, Sort, SortAction, SortKeys, SortType

SortDlg

Purpose

Display the Sort (Source and Destination) dialog box.

Syntax

SortDlg ()

SortKeys

Purpose

Specify the sort key options.

Syntax

SortKeys ({Field: numeric; Line: numeric; Word: numeric; SortType: enumeration; SortOrder: enumeration; })

Parameters

Field

numeric (optional)

Line

numeric (optional) The line to sort within a specified field. This parameter is always 1 if the sort type is Line.

Word

numeric (optional) The word to sort within a specified line and field.

SortType

enumeration (optional)

Alphanumeric!

Numeric!

SortOrder

enumeration (optional) Specify an ascending (a-z and 0-9) or descending (z-a and 9-0) sort.

Ascending!

Descending!

See Also

Sort, SortCaseOrder

SortSelectString

Purpose

Insert a character string into the Select Records text box of the Sort dialog box.

Syntax

SortSelectString (SelectString: string)

Parameters

SelectString

string

See Also

Sort

SortType

Purpose

Specify a source file format. ParagraphSort! sorts files leaving paragraphs intact. ColumnSort! sorts parallel columns. TableSort! sorts tables (rows = lines, cells = fields). MergeSort! sorts data files.

Syntax

SortType (SortType: enumeration)

Parameters

SortType

enumeration

ColumnSort!

LineSort!

MergeSort!

ParagraphSort!

TableSort!

See Also

Sort

SortUndo

Purpose

Enable or disable Undo in Sort.

Syntax

SortUndo (State: enumeration)

Parameters

State

enumeration

NoUndo!

Undo!

See Also

?SortGetUndo, Sort, SortAction

SoundClipAddInstance

Purpose

Add another reference to a sound clip already in the document.

Syntax

SoundClipAddInstance (Description: string)

Parameters

Description

string The sound clip name.

SoundClipCreate

Purpose

Insert a sound clip from a file into the Sound Clips in the Document dialog box.

Syntax

SoundClipCreate (Description: string; Filename: string; SoundFileType: enumeration; ClipType: enumeration; LeftVolume: numeric; RightVolume: numeric)

Parameters

Description

string

Filename

string

SoundFileType

enumeration

InDoc!

OnDisk!

ClipType

enumeration

DigitalAudio!

MIDI!

LeftVolume

numeric

RightVolume

numeric

SoundClipDelete

Purpose

Delete a sound clip.

Syntax

SoundClipDelete (Description: string)

Parameters

Description

string

SoundClipDlg

Purpose

Display the Sound Clips dialog box.

Syntax

SoundClipDlg ()

SoundClipPlayNext

Purpose

Play the next sound clip in the document.

Syntax

SoundClipPlayNext (Description: string; StartPos: numeric; EndPos: numeric)

Parameters

Description

string (optional)

StartPos

numeric (optional) The sound clip starting point in seconds.

EndPos

numeric (optional) The sound clip ending point in seconds.

SoundClipSetAttributes

Purpose

Specify sound clip attributes.

Syntax

SoundClipSetAttributes (Description: string; Type: enumeration; LeftVolume: numeric; RightVolume: numeric)

Parameters

Description

string

Type

enumeration

DigitalAudio!

MIDI!

LeftVolume

numeric (optional)

RightVolume

numeric (optional)

SoundClipSetDescription

Purpose

Assign a new description to a sound clip.

Syntax

SoundClipSetDescription (OldDescription: string; NewDescription: string)

Parameters

OldDescription

string

NewDescription

string

SoundClipSetFilename

Purpose

Change a sound clip to point to a different sound file on disk.

Syntax

SoundClipSetFilename (Description: string; Filename: string; Location: enumeration)

Parameters

Description

string

Filename

string

Location

enumeration

InDoc!

OnDisk!

SpecificDeleteStringBegin

Purpose

Delete specific codes. Follow with a command that specifies the specific code to delete, then SpecificStringEnd. Use with commands such as ReplaceBackward and ReplaceForward.

Syntax

SpecificDeleteStringBegin ()

See Also

MatchSelection, ReplaceBackward, ReplaceForward, SpecificReplaceStringBegin, SpecificSearchStringBegin, SpecificStringEnd

SpecificReplaceStringBegin

Purpose

Specify a specific code replacement. Follow with a command corresponding to a specific replacement code. Use with commands such as ReplaceBackward, ReplaceForward, SpecificSearchStringBegin, and SpecificStringEnd.

Syntax

SpecificReplaceStringBegin ()

See Also

ReplaceBackward, ReplaceForward, SpecificSearchStringBegin, SpecificStringEnd

SpecificSearchStringBegin

Purpose

Find a specific code. Follow with the macro command corresponding to the specific code to be found. Use with SpecificStringEnd.

Syntax

SpecificSearchStringBegin ()

See Also

SearchNext, SearchPrevious, SpecificDeleteStringBegin, SpecificReplaceStringBegin, SpecificStringEnd

SpecificStringEnd

Purpose

End a specific code search. Precede with SpecificSearchStringBegin, SpecificReplaceStringBegin, or SpecificDeleteStringBegin, and a command which specifies the specific code to search.

Syntax

SpecificStringEnd ()

See Also

SpecificDeleteStringBegin, SpecificReplaceStringBegin, SpecificSearchStringBegin

SpellAsYouGo

Purpose

Turn or toggle Spell-As-You-Go on or off, and return the original state. If the macro toolbar is active in the current document, this command causes a run-time error.

Syntax

boolean := SpellAsYouGo (State: enumeration)

Parameters

State

enumeration (optional) Omitting this parameter toggles Spell-As-You-Go on or off.

Off!

On!

See Also

IsTokenValid

SpreadsheetShowLinkCode

Purpose

Display or hide spreadsheet link codes.

Syntax

SpreadsheetShowLinkCode (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

ImportOptionsDlg

SpreadsheetUpdateOnRetrieve

Purpose

Turn the Update on retrieve option on or off for spreadsheet/database links.

Syntax

SpreadsheetUpdateOnRetrieve (State: enumeration)

Parameters

State

enumeration

No!

Yes!

See Also

?AutoUpdate, ImportOptionsDlg

StatusBarShow

Purpose

Display or hide the status bar.

Syntax

StatusBarShow (State: enumeration)

Parameters

State

enumeration (optional) Default: toggle.

Off!

On!

See Also

?StatusBarActive, ViewToolbarsDlg

StyleCodes

Purpose

Edit style codes. Use with commands such as StyleEditBegin, StyleEditEnd, and SubstructureExit.

Syntax

StyleCodes (State: enumeration; Library: enumeration)

Parameters

State

enumeration (optional) Include codes that take effect when the style is off.

WithOffCodes!

WithoutOffCodes!

Library

enumeration (optional) The styles codes location.

CurrentDoc!

PersonalLibrary!

SharedLibrary!

See Also

StyleEditBegin, StyleEditEnd

StyleCopy

Purpose

Copy a style between the current document, the personal library, and the shared library.

Syntax

StyleCopy (Style: any; FromLibrary: enumeration; ToLibrary: enumeration; NewName: string)

Parameters

Style

any Use a string to specify a user-defined style.

FromLibrary

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

ToLibrary

enumeration (optional)

CurrentDoc!

PersonalLibrary!

SharedLibrary!

NewName

string (optional) The new style name.

See Also

StyleCreate, StyleDelete