Chapter 14
Corel® Presentations™ Product Commands
Ab to As
The macro commands in Corel Presentations help you automate your slide show and drawing tasks, from adding slides to a slide show to drawing shapes automatically.
The system variables in Corel Presentations all begin with "Env...."
AboutDlg
Purpose
Display the About Corel Presentations dialog box, which displays product and license information.
Syntax
AboutDlg ()
AcquireImage
Purpose
Insert a bitmap image generated by a scanner into the current drawing or slide show. The computer must have a TWAIN driver installed to use this command.
Syntax
AcquireImage (Scale: enumeration; Left: numeric; Bottom: numeric; Right: numeric; Top: numeric)
Parameters
Scale
enumeration (optional) The scaling option.
AreaBounded!
FixedSize!
PageBounded!
Left
numeric (optional) The left coordinate of bounding rectangle.
Bottom
numeric (optional) The bottom coordinate of a bounding rectangle.
Right
numeric (optional) The right coordinate of a bounding rectangle.
Top
numeric (optional) The top coordinate of bounding rectangle.
See Also
AcquireImageDlg, AcquireImageSelect, BeginAcquireImageArea, BeginAcquireImageFixedSize
AcquireImageDlg
Purpose
Display the Acquire Image dialog box, which is used to insert a bitmap image from a TWAIN source.
Syntax
AcquireImageDlg ()
See Also
AcquireImage, AcquireImageSelect
AcquireImageSelect
Purpose
Display the Image Source dialog box, which is used to specify a scanner from which to acquire an image. The computer must have a TWAIN driver installed to use this command.
Syntax
AcquireImageSelect ()
See Also
AcquireImage, AcquireImageDlg
ActionKeyDelete
Purpose
Delete a QuickKey.
Syntax
ActionKeyDelete (Key: numeric; Default: enumeration)
Parameters
Key
numeric A key on the keyboard. The ASCII numeric equivalent is required.
Default
enumeration Specify whether the key is a default key.
No!
Yes!
See Also
ActionKeyDlg, ActionKeyProperties
ActionKeyDlg
Purpose
Display the Slide Properties dialog box with the QuickKeys tab displayed, which is used to create and edit QuickKeys.
Syntax
ActionKeyDlg ()
See Also
ActionKeyDelete, ActionKeyProperties
ActionKeyProperties
Purpose
Specify the action a QuickKey performs.
Syntax
ActionKeyProperties (Key: numeric; Default: enumeration; Type: enumeration; Data: any; MidiOnDisk: enumeration; MidiLoop: enumeration; MidiMT32: enumeration; MIDIVolume: numeric; DigiFilename: string; DigiOnDisk: enumeration; DigiLoop: enumeration; DigiVolume: numeric; CDTrackName: string; CDLoop: enumeration; CDVolume: numeric; CDBeginTrack: numeric; CDBeginMinute: numeric; CDBeginSecond: numeric; CDBeginFrame: numeric; CDEndTrack: numeric; CDEndMinute: numeric; CDEndSecond: numeric; CDEndFrame: numeric)
Parameters
Key
numeric A key on the keyboard.
Default
enumeration Add the QuickKey to the default list.
No!
Yes!
Type
enumeration The type of action the key performs.
FirstSlide!
LastSlide!
LaunchFile!
NextSlide!
PreviousSlide!
QuitShow!
SpecificSlide!
StopSound!
Data
any (optional) The data associated with the action. Can be a slide number, filename, or file location.
MidiOnDisk
enumeration (optional) Store the current MIDI file on disk, rather than in the slide show file.
No!
Yes!
MidiLoop
enumeration (optional) Play the current MIDI file continuously during a slide show until another file begins.
No!
Yes!
MidiMT32
enumeration (optional) Ensure consistency among MIDI files written according to the MT32 standard.
No!
Yes!
MIDIVolume
numeric (optional) The MIDI volume.
DigiFilename
string (optional) The WAV filename.
DigiOnDisk
enumeration (optional) Indicate whether the WAV file is on disk.
No!
Yes!
DigiLoop
enumeration (optional) The Loop WAV.
No!
Yes!
DigiVolume
numeric (optional) The WAV volume.
CDTrackName
string (optional) The CD track name.
CDLoop
enumeration (optional) The loop CD track.
No!
Yes!
CDVolume
numeric (optional) The CD volume.
CDBeginTrack
numeric (optional)
CDBeginMinute
numeric (optional)
CDBeginSecond
numeric (optional)
CDBeginFrame
numeric (optional)
CDEndTrack
numeric (optional)
CDEndMinute
numeric (optional)
CDEndSecond
numeric (optional)
CDEndFrame
numeric (optional)
See Also
ActionKeyDelete, ActionKeyDlg
ActionLinkDelete
Purpose
Delete a QuickLink.
Syntax
ActionLinkDelete (ObjectNumber: numeric)
Parameters
ObjectNumber
numeric (optional) Specify a QuickLink to delete.
See Also
ActionLinkDlg, ActionLinkListDlg, ActionLinkProperties
ActionLinkListDlg
Purpose
Display the QuickLink List dialog box, which is used to view and edit QuickLinks.
Syntax
ActionLinkListDlg ()
See Also
ActionLinkDelete, ActionLinkDlg, ActionLinkProperties
ActionLinkProperties
Purpose
Set QuickLink properties.
Syntax
ActionLinkProperties (ObjectNumber: numeric; ButtonName: string; Key: numeric; Hidden: enumeration; Type: enumeration; Data: any; MidiOnDisk: enumeration; MidiLoop: enumeration; MidiMT32: enumeration; MidiVolume: numeric; DigiFilename: string; DigiOnDisk: enumeration; DigiLoop: enumeration; DigiVolume: numeric; CDTrackName: string; CDLoop: enumeration; CDVolume: numeric; CDBeginTrack: numeric; CDBeginMinute: numeric; CDBeginSecond: numeric; CDBeginFrame: numeric; CDEndTrack: numeric; CDEndMinute: numeric; CDEndSecond: numeric; CDEndFrame: numeric)
Parameters
ObjectNumber
numeric The QuickLink number.
ButtonName
string The name of the ActionLink.
Key
numeric The keystroke associated with the QuickLink. The ASCII numeric equivalent is required.
Hidden
enumeration Specify whether the QuickLink is hidden. The default is No!.
No!
Yes!
Type
enumeration The type of action.
FirstSlide!
LastSlide!
LaunchFile!
NextSlide!
PreviousSlide!
QuitShow!
SpecificSlide!
StopSound!
Data
any (optional) The slide number (numeric), or filename or location (string).
MidiOnDisk
enumeration (optional) Store the current MIDI file on disk, rather than in the slide show file.
No!
Yes!
MidiLoop
enumeration (optional) Play the current MIDI file continuously during a slide show until another file begins.
No!
Yes!
MidiMT32
enumeration (optional) Ensure consistency among MIDI files written according to the MT32 standard.
No!
Yes!
MidiVolume
numeric (optional) The MIDI volume.
DigiFilename
string (optional) The WAV filename.
DigiOnDisk
enumeration (optional) Indicate whether the WAV file is on disk.
No!
Yes!
DigiLoop
enumeration (optional) The Loop WAV.
No!
Yes!
DigiVolume
numeric (optional) The WAV volume.
CDTrackName
string (optional) The CD track name.
CDLoop
enumeration (optional) The loop CD track.
No!
Yes!
CDVolume
numeric (optional) The CD volume.
CDBeginTrack
numeric (optional)
CDBeginMinute
numeric (optional)
CDBeginSecond
numeric (optional)
CDBeginFrame
numeric (optional)
CDEndTrack
numeric (optional)
CDEndMinute
numeric (optional)
CDEndSecond
numeric (optional)
CDEndFrame
numeric (optional)
See Also
ActionLinkDelete, ActionLinkDlg, ActionLinkListDlg
ActivateBoxField
Purpose
Activate a field in an organization chart box to edit it.
Syntax
ActivateBoxField (FieldName: string)
Parameters
FieldName
string The field name of the box field to be activated and edited.
See Also
ChartCreateOrg, OrgTextEditExit
AddArc
Purpose
Draw an arc or a circle using the Circle, Circular Arc, Ellipse, or Elliptical Arc drawing tool.
Syntax
AddArc (FillAndFrame: enumeration; XCenter: measurement; YCenter: measurement; HorizontalRadius: measurement; VerticalRadius: measurement; XInitial: measurement; YInitial: measurement; XTerminal: measurement; YTerminal: measurement; ArcFlags: enumeration)
Parameters
FillAndFrame
enumeration Specify whether the arc object is open or closed, whether the object outline is on or off, and whether the object fill is on or off.
Both!
ClosedFrame!
Filled!
OpenFrame!
XCenter
measurement The horizontal coordinate for the center of the arc, in WordPerfect units (1200ths of an inch).
YCenter
measurement The vertical coordinate for the center of the arc, in WordPerfect units.
HorizontalRadius
measurement The horizontal coordinate for the radius of an elliptical arc, in Corel WordPerfect units.
VerticalRadius
measurement The vertical coordinate for the radius of an elliptical arc in WordPerfect units.
XInitial
measurement The horizontal coordinate for the point which indicates the starting angle of an arc, in WordPerfect units.
YInitial
measurement The vertical coordinate for the initial point of an arc, in WordPerfect units.
XTerminal
measurement The horizontal coordinate for the point that indicates the ending angle of an arc, in WordPerfect units.
YTerminal
measurement The vertical coordinate for the point that indicates the ending angle of an arc, in WordPerfect units.
ArcFlags
enumeration Indicate how the endpoints of an arc connect.
Center_Connect!
End2End_Connect!
No_Connect!
See Also
BeginCircle, BeginCircularArc, BeginEllipse, BeginEllipticalArc
AddBackground
Purpose
Create a new background.
Syntax
AddBackground (BackgroundName: string)
Parameters
BackgroundName
string (optional) The new background name.
See Also
AddBackgroundDlg, DeleteBackground
AddBackgroundDlg
Purpose
Display the New Background dialog box, which is used to create a new background.
Syntax
AddBackgroundDlg ()
See Also
AddBackground
AddLayout
Purpose
Add a new layout to the current slide show master.
Syntax
AddLayout (LayoutName: string)
Parameters
LayoutName
string (optional) The new layout name.
See Also
AddLayoutDlg
AddLayoutDlg
Purpose
Display the New Layout dialog box, which is used to add a new layout to the current slide show master.
Syntax
AddLayoutDlg ()
See Also
AddLayout
AddPolyCurve
Purpose
Draw a curve using the Curve, Closed Curve, Bezier, Freehand, or Arrow drawing tool.
Syntax
AddPolyCurve (FillAndFrame: enumeration; BasePointCount: numeric; {XControl1: measurement; YControl1: measurement; XBase: measurement; YBase: measurement; XControl2: measurement; YControl2: measurement; })
Parameters
FillAndFrame
enumeration Specify whether the curve object is open or closed, whether the object outline is on or off, and whether the object fill is on or off.
Both!
ClosedFrame!
Filled!
OpenFrame!
BasePointCount
numeric The number of base points in the curve. Repeat the next six parameters for each base point, and enclose repeating parameters in braces {}.
XControl1
measurement (optional) The horizontal coordinate of the first control point for a base point of the curve, in WordPerfect units (1200ths of an inch).
YControl1
measurement (optional) The vertical coordinate of the first control point for a base point of the curve, in WordPerfect units.
XBase
measurement (optional) The horizontal coordinate of a base point of the curve, in WordPerfect units.
YBase
measurement (optional) The vertical coordinate of the base point of the curve, in WordPerfect units.
XControl2
measurement (optional) The horizontal coordinate for the second control point for a base point of the curve, in WordPerfect units.
YControl2
measurement (optional) The vertical coordinate of the second control point for a base point of the curve, in WordPerfect units.
See Also
BeginArrow, BeginBezier, BeginClosedCurve, BeginCurve, BeginFreehand
AddPolyLine
Purpose
Draw a line or a polygon using the Line, Polygon, Rectangle, or Regular Polygon drawing tool.
Syntax
AddPolyLine (FillAndFrame: enumeration; PointCount: numeric; {PointX: measurement; PointY: measurement; })
Parameters
FillAndFrame
enumeration Specify whether the line object is open or closed, whether the object outline is on or off, and whether the object fill is on or off.
Both!
ClosedFrame!
Filled!
OpenFrame!
PointCount
numeric The number of base points in a line. The next two parameters are repeated for each base point. Parameters that can be repeated are enclosed in braces {}.
PointX
measurement (optional) The horizontal coordinate of a base point, in WordPerfect units (1200ths of an inch).
PointY
measurement (optional) The vertical coordinate of a base point, in WordPerfect units.
See Also
BeginLine, BeginPolygon, BeginRectangle, BeginRegularPolygon
AddRoundedRect
Purpose
Draw a rounded rectangle.
Syntax
AddRoundedRect (FillAndFrame: enumeration; LeftEdge: measurement; BottonEdge: measurement; RightEdge: measurement; TopEdge: measurement; HorizontalRadius: measurement; VerticalRadius: measurement)
Parameters
FillAndFrame
enumeration Specify whether the object outline is on or off, and whether the object fill is on or off.
Both!
Filled!
Framed!
LeftEdge
measurement Position of the left edge of the elliptical area of a rounded rectangle, in WordPerfect units (1200ths of an inch).
BottonEdge
measurement The position of the bottom edge of the elliptical area of a rounded rectangle, in WordPerfect units. (Please note: this is the correct spelling for this parameter.)
RightEdge
measurement Position of the right edge of the elliptical area of a rounded rectangle, in WordPerfect units.
TopEdge
measurement Position of the top edge of the elliptical area of a rounded rectangle, in WordPerfect units.
HorizontalRadius
measurement The horizontal radius of the corner ellipse, in Corel WordPerfect units.
VerticalRadius
measurement The vertical radius of the corner ellipse, in WordPerfect units.
See Also
BeginRoundedRectangle
AddSlide
Purpose
Add one or more blank slides to the current slide show. If no parameters are specified, this command adds one slide that has been created using the current template.
Syntax
AddSlide (Count: numeric; TemplateName: string)
Parameters
Count
numeric (optional) The number of slides to add.
TemplateName
string (optional) Name of template.
See Also
AddSlideDlg
AddSlideDlg
Purpose
Display the New Slide dialog box, which is used to add slides to the current slide show.
Syntax
AddSlideDlg ()
See Also
AddSlide
AddTextBox
Purpose
Create a text area or a text line.
Syntax
AddTextBox (LeftEdge: measurement; BottomEdge: measurement; RightEdge: measurement; TopEdge: measurement)
Parameters
LeftEdge
measurement Specify the left edge of a text box, in WordPerfect units (1200ths of an inch.)
BottomEdge
measurement Specify the bottom edge of a text box, in WordPerfect units.
RightEdge
measurement Specify the right edge of a text box, in WordPerfect units.
TopEdge
measurement Specify the top edge of a text box, in WordPerfect units.
See Also
TextBoxCreate, TextLineCreate
AirBrush
Purpose
Use the Air Brush painting tool to create a bitmap object in the Bitmap Editor.
Syntax
AirBrush ({X: numeric; Y: numeric; })
Parameters
X
numeric (optional) The horizontal position of pixels clicked when painting. Repeat the X and Y parameters for each pixel covered, and enclose sets of repeated parameters in braces {}.
Y
numeric (optional) The vertical position of pixels clicked when painting.
See Also
BeginAirBrush
AlignCenterLeftRight
Purpose
Center a selected object horizontally on the page, or align multiple selected objects with the horizontal center of the selection area.
Syntax
AlignCenterLeftRight ()
See Also
AlignObjectsBottom, AlignObjectsCenter, AlignObjectsLeft, AlignObjectsRight, AlignObjectsTop, AlignObjectsTopBottom
AlignObjectsBottom
Purpose
Align the bottom edge of a selected object with the bottom of the page, or align the bottom edges of multiple selected objects with the bottom edge of the lowest object.
Syntax
AlignObjectsBottom ()
See Also
AlignCenterLeftRight, AlignObjectsCenter, AlignObjectsLeft, AlignObjectsRight, AlignObjectsTop, AlignObjectsTopBottom
AlignObjectsCenter
Purpose
Center a selected object on the page, or align the centers of multiple selected objects with the center of the selection area.
Syntax
AlignObjectsCenter ()
See Also
AlignCenterLeftRight, AlignObjectsBottom, AlignObjectsLeft, AlignObjectsRight, AlignObjectsTop, AlignObjectsTopBottom
AlignObjectsLeft
Purpose
Align the left edge of a selected object with the left edge of the page, or align the left edges of multiple selected objects with the left edge of the leftmost object.
Syntax
AlignObjectsLeft ()
See Also
AlignCenterLeftRight, AlignObjectsBottom, AlignObjectsCenter, AlignObjectsRight, AlignObjectsTop, AlignObjectsTopBottom
AlignObjectsRight
Purpose
Align the right edge of a selected object with the right edge of the page, or align the right edges of multiple selected objects with the right edge of the rightmost object.
Syntax
AlignObjectsRight ()
See Also
AlignCenterLeftRight, AlignObjectsBottom, AlignObjectsCenter, AlignObjectsLeft, AlignObjectsTop, AlignObjectsTopBottom
AlignObjectsTop
Purpose
Align the top edge of a selected object with the top of the page, or align the top edge of multiple selected objects with the top edge of the highest object.
Syntax
AlignObjectsTop ()
See Also
AlignCenterLeftRight, AlignObjectsBottom, AlignObjectsCenter, AlignObjectsLeft, AlignObjectsRight, AlignObjectsTopBottom
AlignObjectsTopBottom
Purpose
Center a selected object vertically on the page, or align multiple selected objects with the vertical center of the selection area.
Syntax
AlignObjectsTopBottom ()
See Also
AlignCenterLeftRight, AlignObjectsBottom, AlignObjectsCenter, AlignObjectsLeft, AlignObjectsRight, AlignObjectsTop
AlignTextBottom
Purpose
Position text from the bottom of an organization chart box.
Syntax
AlignTextBottom ()
See Also
AlignTextMiddle, AlignTextTop
AlignTextMiddle
Purpose
Center text vertically within an organization chart box.
Syntax
AlignTextMiddle ()
See Also
AlignTextBottom, AlignTextTop
AlignTextTop
Purpose
Position text starting from the top of an organization chart box.
Syntax
AlignTextTop ()
See Also
AlignTextBottom, AlignTextMiddle
ApplicationMaximize
Purpose
Maximize the size of an application window. If the window is already maximized, this command terminates the macro or redirects the macro to the LABEL specified by ONERROR.
Syntax
ApplicationMaximize ()
See Also
ApplicationMinimize, ApplicationMove, ApplicationRestore, ApplicationSize
ApplicationMinimize
Purpose
Minimize an application window to an icon. If the window is already minimized, this command terminates the macro or redirects the macro to the LABEL specified by ONERROR.
Syntax
ApplicationMinimize ()
See Also
ApplicationMaximize, ApplicationMove, ApplicationRestore, ApplicationSize
ApplicationMove
Purpose
Pause a macro to allow you to reposition an application window. Click the mouse or press Enter to continue playing the macro. If the window is maximized, this command terminates the macro or redirects the macro to the LABEL specified by ONERROR.
Syntax
ApplicationMove ()
See Also
ApplicationMaximize, ApplicationMinimize, ApplicationRestore, ApplicationSize
ApplicationRestore
Purpose
Restore a window to its previous size. If the window has already been restored, this command terminates the macro and redirects the macro to the LABEL specified by ONERROR.
Syntax
ApplicationRestore ()
See Also
ApplicationMaximize, ApplicationMinimize, ApplicationMove, ApplicationSize
ApplicationSize
Purpose
Pause a macro to allow you to resize a window. Click the mouse or press Enter to continue playing the macro. If the window is maximized, this command terminates the macro or redirects the macro to the LABEL specified by ONERROR.
Syntax
ApplicationSize ()
See Also
ApplicationMaximize, ApplicationMinimize, ApplicationMove, ApplicationRestore
AssignBackgroundDlg
Purpose
Display the Assign Background dialog box, which is used to assign a background to a specified layout.
Syntax
AssignBackgroundDlg ()
See Also
AssignLayoutBackground
AssignLayoutBackground
Purpose
Assign a background to a specified layout.
Syntax
AssignLayoutBackground (LayoutName: string; BackgroundName: string)
Parameters
LayoutName
string The layout to link to a background.
BackgroundName
string The background to link to a layout.
See Also
AssignBackgroundDlg