Chapter 15
Corel® Presentations™ System Variables
A
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.
EnvActionLinkNumericData
Purpose
Query numeric data from the ActionLink.
Syntax
numeric := EnvActionLinkNumericData (SpecifyData: enumeration)
Parameters
| SpecifyData | enumeration | The data to link. |
| JumpSlideNum! |
Return Value
numeric
See Also
EnvActionLinkSelect, EnvActionLinkStringData
EnvActionLinkSelect
Purpose
Select an object with an ActionLink and return the ActionLink type.
Syntax
numeric := EnvActionLinkSelect (SpecifyLink: enumeration)
Parameters
| SpecifyLink | enumeration | The link to select. |
| FirstLink! | ||
| NextLink! |
Return Value
numeric
See Also
EnvActionLinkNumericData, EnvActionLinkStringData
EnvActionLinkStringData
Purpose
Return the string data associated with the selected ActionLink.
Syntax
string := EnvActionLinkStringData (SpecifyData: enumeration)
Parameters
| SpecifyData | enumeration | The data to link. |
| CDSoundFile! | ||
| Executable! | ||
| InternetAddress! | ||
| MidiSoundFile! | ||
| WaveSoundFile! |
Return Value
string
See Also
EnvActionLinkNumericData, EnvActionLinkSelect
EnvBackgroundTitle
Purpose
Return the name of the current background.
Syntax
string := EnvBackgroundTitle ()
Return Value
string
See Also
SetBackgroundName,
EnvCapBeginSentence
Purpose
Return the state of Capitalize next letter after end-of-sentence punctuation in QuickCorrect.
Syntax
numeric := EnvCapBeginSentence ()
Return Value
numeric 0 Off
See Also
EnvEndOfSentenceSpacing
EnvChartDataWin
Purpose
Indicate whether a chart's Datasheet is displayed.
Syntax
numeric := EnvChartDataWin ()
Return Value
numeric 0 Not displayed
See Also
ChartViewDatasheet,
EnvChartDisplay
Purpose
Indicate whether a specified chart object is displayed. Not recordable.
Syntax
numeric := EnvChartDisplay (Object: enumeration; SubType: enumeration)
Parameters
| Object | enumeration |
| Frames! | |
| TextBoxes! | |
| GridMajor! | |
| TickMajor! | |
| GridMinor! | |
| TickMinor! | |
| Labels! | |
| Titles! | |
| Legend! | |
| SubType | enumeration |
| Back! | |
| Right! | |
| Bottom! | |
| SubTitle! | |
| Data! | |
| Title! | |
| Front! | |
| Top! | |
| Left! | |
| X! | |
| Legend! | |
| Y1! | |
| Pie! | |
| Y2! | |
| Radial! |
Return Value
numeric 0 Not displayed
EnvChartType
Purpose
Return the current data chart type.
Syntax
numeric := EnvChartType ()
Return Value
numeric 0 None
EnvColorPalette
Purpose
Return the numeric value for a component of a specified color.
Syntax
numeric := EnvColorPalette (Separation: enumeration; Index: numeric)
Parameters
| Separation | enumeration | The color component. |
| Blue! | ||
| Green! | ||
| Red! | ||
| Index | numeric | Specify a color by index number. |
Return Value
numeric Color value (0-255)
EnvCurrentBackgroundNumber
Purpose
Return the number of the current background.
Syntax
numeric := EnvCurrentBackgroundNumber ()
Return Value
numeric
EnvCurrentFilename
Purpose
Return the name of the current file.
Syntax
string := EnvCurrentFilename ()
Return Value
string Filename
EnvCurrentLayoutNumber
Purpose
Return the number of the current layout.
Syntax
numeric := EnvCurrentLayoutNumber ()
Return Value
numeric
EnvCurrentMode
Purpose
Return the current editing mode.
Syntax
numeric := EnvCurrentMode ()
Return Value
numeric When more than one editing mode is active, the return value is the sum of the numbers for each active mode.
EnvCurrentSlideNumber
Purpose
Return the current slide number.
Syntax
numeric := EnvCurrentSlideNumber ()
Return Value
numeric
EnvCurrentTool
Purpose
Return the current drawing tool.
Syntax
numeric := EnvCurrentTool ()
Return Value
numeric 0 No tool selected
EnvDoubleSmartQuoteClose
Purpose
Return the current double close SmartQuote in QuickCorrect.
Syntax
string := EnvDoubleSmartQuoteClose ()
Return Value
string
See Also
EnvDoubleSmartQuoteState, EnvDoubleSmartQuoteOpen, DoubleSmartQuote
EnvDoubleSmartQuoteOpen
Purpose
Return the current double open SmartQuote in QuickCorrect.
Syntax
string := EnvDoubleSmartQuoteOpen ()
Return Value
string
See Also
EnvDoubleSmartQuoteClose, EnvDoubleSmartQuoteState, DoubleSmartQuote
EnvDoubleSmartQuoteState
Purpose
Return the state of double quotes in QuickCorrect.
Syntax
numeric := EnvDoubleSmartQuoteState ()
Return Value
numeric 0 Off
See Also
EnvDoubleSmartQuoteClose, EnvDoubleSmartQuoteOpen, DoubleSmartQuote
EnvEndOfSentenceSpacing
Purpose
Return the current end of sentence correction type in QuickCorrect.
Syntax
numeric := EnvEndOfSentenceSpacing ()
Return Value
numeric 0 Off
EnvFormInfo
Purpose
Return information about the current form.
Syntax
numeric := EnvFormInfo (DataType: enumeration)
Parameters
| DataType | enumeration |
| FormHeight! | |
| FormWidth! | |
| MarginBottom! | |
| MarginLeft! | |
| MarginRight! | |
| MarginTop! |
Return Value
numeric
EnvGetCurrentPrinter
Purpose
Return the name of the currently selected printer as a Corel WordPerfect string.
Syntax
string := EnvGetCurrentPrinter ()
Return Value
string String
See Also
PrintDlg
EnvGetMarqueeHeight
Purpose
Return the bitmap marquee height.
Syntax
numeric := EnvGetMarqueeHeight ()
Return Value
numeric
See Also
EnvGetMarqueeWidth, EnvGetMarqueeXPos, EnvGetMarqueeYPos
EnvGetMarqueeWidth
Purpose
Return the bitmap marquee width.
Syntax
numeric := EnvGetMarqueeWidth ()
Return Value
numeric
See Also
EnvGetMarqueeHeight, EnvGetMarqueeXPos, EnvGetMarqueeYPos
EnvGetMarqueeXPos
Purpose
Return the bitmap marquee upper left X position.
Syntax
numeric := EnvGetMarqueeXPos ()
Return Value
numeric
See Also
EnvGetMarqueeHeight, EnvGetMarqueeWidth, EnvGetMarqueeYPos
EnvGetMarqueeYPos
Purpose
Return the bitmap marquee upper left Y position.
Syntax
numeric := EnvGetMarqueeYPos ()
Return Value
numeric
See Also
EnvGetMarqueeHeight, EnvGetMarqueeWidth, EnvGetMarqueeXPos
EnvGetObjectHeight
Purpose
Returns the height of the selected object.
Syntax
numeric := EnvGetObjectHeight ()
Return Value
numeric
See Also
EnvGetObjectWidth
EnvGetObjectWidth
Purpose
Returns the width of the selected object.
Syntax
numeric := EnvGetObjectWidth ()
Return Value
numeric
See Also
EnvGetObjectHeight
EnvGetObjectXPos
Purpose
Return the selected object's left X position.
Syntax
numeric := EnvGetObjectXPos ()
Return Value
numeric
See Also
EnvGetObjectYPos
EnvGetObjectYPos
Purpose
Return the selected object's left Y position.
Syntax
numeric := EnvGetObjectYPos ()
Return Value
numeric
See Also
EnvGetObjectXPos
EnvGetPointerPositionX
Purpose
Returns the cursor x position.
Syntax
numeric := EnvGetPointerPositionX ()
Return Value
numeric
See Also
EnvGetPointerPositionY
EnvGetPointerPositionY
Purpose
Returns the cursor y position.
Syntax
numeric := EnvGetPointerPositionY ()
Return Value
numeric
See Also
EnvGetPointerPositionX
EnvIrregularCap
Purpose
Return the state of Correct TWo IRregular CApitals in QuickCorrect.
Syntax
numeric := EnvIrregularCap ()
Return Value
numeric 0 Off
EnvIsCommandValid
Purpose
Indicate whether a specified macro command is valid in the current state of the program.
Syntax
numeric := EnvIsCommandValid (Command: command name)
Parameters
| Command | command name | The macro command name. |
Return Value
numeric 0 Not valid
EnvIsSlideSkipped
Purpose
Determine if a slide has been set to skip.
Syntax
numeric := EnvIsSlideSkipped ()
Return Value
numeric
EnvLayoutTitle
Purpose
Return the title of the current layout.
Syntax
string := EnvLayoutTitle ()
Return Value
string
See Also
SetLayoutTitle
EnvLeftChar
Purpose
Return the character to the left of the insertion point.
Syntax
string := EnvLeftChar ()
Return Value
string
See Also
EnvRightChar
EnvNextFontFace
Purpose
Return the name of the next font on the font list.
Syntax
any := EnvNextFontFace (Initialize: enumeration)
Parameters
| Initialize | enumeration |
| False! | |
| True! |
Return Value
any
See Also
SetFontFace
EnvNumberOfBackgrounds
Purpose
Return the total number of backgrounds.
Syntax
numeric := EnvNumberOfBackgrounds ()
Return Value
numeric
EnvNumberOfDocuments
Purpose
Return the number of open documents.
Syntax
numeric := EnvNumberOfDocuments ()
Return Value
numeric
EnvNumberOfLayouts
Purpose
Return the total number of layouts.
Syntax
numeric := EnvNumberOfLayouts ()
Return Value
numeric
EnvNumberOfSlides
Purpose
Return the number of slides in the current slide show.
Syntax
numeric := EnvNumberOfSlides ()
Return Value
numeric
EnvOpenDocuments
Purpose
Return the path and filename of each open document.
Syntax
string := EnvOpenDocuments ()
Return Value
string
EnvPaths
Purpose
Return the default path for a specified file type.
Syntax
string := EnvPaths (PathType: enumeration)
Parameters
| PathType | enumeration | The file type. |
| Backgrounds! | ||
| Palettes! | ||
| Backup! | ||
| Pictures! | ||
| ButtonBar! | ||
| Presentations! | ||
| CurrentFile! | ||
| Program! | ||
| ExpressShow! | ||
| QuickGalleries! | ||
| Figures! | ||
| Shared! | ||
| Filters! | ||
| Sound! | ||
| HelpFile! | ||
| SpellMain! | ||
| Macros! | ||
| SpellSupp! | ||
| Masters! | ||
| Textures! | ||
| Movies! | ||
| Utilities! |
Return Value
string Default path for the specified file type.
EnvQuickCorrect
Purpose
Return the state of QuickCorrect.
Syntax
numeric := EnvQuickCorrect ()
Return Value
numeric 0 Off
See Also
QuickCorrect
EnvRightChar
Purpose
Return the character to the right of the insertion point.
Syntax
string := EnvRightChar ()
Return Value
string
See Also
EnvLeftChar
EnvSelectedText
Purpose
Return the selected text with all codes removed except hard returns.
Syntax
string := EnvSelectedText ()
Return Value
string
EnvSingleSmartQuoteClose
Purpose
Return the current single close quote in QuickCorrect.
Syntax
string := EnvSingleSmartQuoteClose ()
Return Value
string
See Also
EnvSingleSmartQuoteOpen, EnvSingleSmartQuoteState, SingleSmartQuote
EnvSingleSmartQuoteOpen
Purpose
Return the current single open quote in QuickCorrect.
Syntax
string := EnvSingleSmartQuoteOpen ()
Return Value
string
See Also
EnvSingleSmartQuoteClose, EnvSingleSmartQuoteState, SingleSmartQuote
EnvSingleSmartQuoteState
Purpose
Return the state of single quotes in QuickCorrect.
Syntax
numeric := EnvSingleSmartQuoteState ()
Return Value
numeric 0 Off
See Also
EnvSingleSmartQuoteOpen, EnvSingleSmartQuoteClose, SingleSmartQuote
EnvSingleSpaceInSentence
Purpose
Return the state of Double Space to Single Space in QuickCorrect.
Syntax
numeric := EnvSingleSpaceInSentence ()
Return Value
numeric 0 Off
EnvSlideStringData
Purpose
Return the name of the sound file associated with the slide.
Syntax
string := EnvSlideStringData (SpecifyData: enumeration)
Parameters
| SpecifyData | enumeration |
| CDSoundFile! | |
| MidiSoundFile! | |
| WaveSoundFile! |
Return Value
string
EnvSlideTitle
Purpose
Return the title of the current slide.
Syntax
string := EnvSlideTitle ()
Return Value
string
EnvSpeakerNotes
Return the speaker notes for the current slide in Corel WordPerfect word string format.
Syntax
string := EnvSpeakerNotes ()
Return Value
string
EnvTemplate
Purpose
Return the name of the current slide template.
Syntax
string := EnvTemplate ()
Return Value
string
EnvTextChartType
Purpose
Return the active portion of a text chart.
Syntax
numeric := EnvTextChartType ()
Return Value
numeric 0 Text
EnvUseRegQuotesWithNumbers
Purpose
Return the state of Use Regular Quotes with Numbers in QuickCorrect is on or off.
Syntax
numeric := EnvUseRegQuotesWithNumbers ()
Return Value
numeric 0 Off