Options Object


Possible Containment

$$Options

Properties

Property Name: Description: Optional/Required: Default Value: Data Type: Allowable Values/Range:
AutoAddPages
AutoloadDS
AutoloadFunctions
AutoLoadWorkspace
AutoSaveWorkspace
BackColorStd
BackColorTBW
BackColorTrellis
BackColorUser
BackgroundColorCM
BackgroundColorTopo
BackgroundColorUser1
BackgroundColorWB
BrushSpinBackgroundColor
BrushSpinFont
BrushSpinFontSize
BrushSpinForegroundColor
BufferDataEntry
BWImageColors
BWUserColors
CmdCheck
CmdEditor
CmdError
CmdExpressions
CmdPager
CmdPrintDigits
CmdTSEps
CmdWarn
ColorSchemeTableCM
ColorSchemeTableStd
ColorSchemeTableTBW
ColorSchemeTableTopo
ColorSchemeTableTrellis
ColorSchemeTableWB
ColorToolbars
CommandObjectMode
ConditionMode
CycleBWFillColor1
CycleBWFillColor10
CycleBWFillColor2
CycleBWFillColor3
CycleBWFillColor4
CycleBWFillColor5
CycleBWFillColor6
CycleBWFillColor7
CycleBWFillColor8
CycleBWFillColor9
CycleBWFillPatt1
CycleBWFillPatt10
CycleBWFillPatt2
CycleBWFillPatt3
CycleBWFillPatt4
CycleBWFillPatt5
CycleBWFillPatt6
CycleBWFillPatt7
CycleBWFillPatt8
CycleBWFillPatt9
CycleBWGrpBarFillPatt
CycleBWGrpBarPattColor
CycleBWGrpFillColor
CycleBWLnColor
CycleBWLnColor1
CycleBWLnColor10
CycleBWLnColor2
CycleBWLnColor3
CycleBWLnColor4
CycleBWLnColor5
CycleBWLnColor6
CycleBWLnColor7
CycleBWLnColor8
CycleBWLnColor9
CycleBWLnStyle
CycleBWLnStyle1
CycleBWLnStyle10
CycleBWLnStyle2
CycleBWLnStyle3
CycleBWLnStyle4
CycleBWLnStyle5
CycleBWLnStyle6
CycleBWLnStyle7
CycleBWLnStyle8
CycleBWLnStyle9
CycleBWPattColor1
CycleBWPattColor10
CycleBWPattColor2
CycleBWPattColor3
CycleBWPattColor4
CycleBWPattColor5
CycleBWPattColor6
CycleBWPattColor7
CycleBWPattColor8
CycleBWPattColor9
CycleBWPieFillColor
CycleBWPieFillPatt
CycleBWPiePattColor
CycleBWStdBarFillPatt
CycleBWStdBarPattColor
CycleBWStdFillColor
CycleBWStripColor1
CycleBWStripColor10
CycleBWStripColor2
CycleBWStripColor3
CycleBWStripColor4
CycleBWStripColor5
CycleBWStripColor6
CycleBWStripColor7
CycleBWStripColor8
CycleBWStripColor9
CycleBWSymColor
CycleBWSymColor1
CycleBWSymColor10
CycleBWSymColor2
CycleBWSymColor3
CycleBWSymColor4
CycleBWSymColor5
CycleBWSymColor6
CycleBWSymColor7
CycleBWSymColor8
CycleBWSymColor9
CycleBWSymStyle
CycleBWSymStyle1
CycleBWSymStyle10
CycleBWSymStyle2
CycleBWSymStyle3
CycleBWSymStyle4
CycleBWSymStyle5
CycleBWSymStyle6
CycleBWSymStyle7
CycleBWSymStyle8
CycleBWSymStyle9
CycleFillColor1
CycleFillColor10
CycleFillColor2
CycleFillColor3
CycleFillColor4
CycleFillColor5
CycleFillColor6
CycleFillColor7
CycleFillColor8
CycleFillColor9
CycleFillPatt1
CycleFillPatt10
CycleFillPatt2
CycleFillPatt3
CycleFillPatt4
CycleFillPatt5
CycleFillPatt6
CycleFillPatt7
CycleFillPatt8
CycleFillPatt9
CycleGrpBarFillPatt
CycleGrpBarPattColor
CycleGrpFillColor
CycleLnColor
CycleLnColor1
CycleLnColor10
CycleLnColor2
CycleLnColor3
CycleLnColor4
CycleLnColor5
CycleLnColor6
CycleLnColor7
CycleLnColor8
CycleLnColor9
CycleLnStyle
CycleLnStyle1
CycleLnStyle10
CycleLnStyle2
CycleLnStyle3
CycleLnStyle4
CycleLnStyle5
CycleLnStyle6
CycleLnStyle7
CycleLnStyle8
CycleLnStyle9
CyclePattColor1
CyclePattColor10
CyclePattColor2
CyclePattColor3
CyclePattColor4
CyclePattColor5
CyclePattColor6
CyclePattColor7
CyclePattColor8
CyclePattColor9
CyclePieFillColor
CyclePieFillPatt
CyclePiePattColor
CycleStdBarFillPatt
CycleStdBarPattColor
CycleStdFillColor
CycleStripColor1
CycleStripColor10
CycleStripColor2
CycleStripColor3
CycleStripColor4
CycleStripColor5
CycleStripColor6
CycleStripColor7
CycleStripColor8
CycleStripColor9
CycleSymColor
CycleSymColor1
CycleSymColor10
CycleSymColor2
CycleSymColor3
CycleSymColor4
CycleSymColor5
CycleSymColor6
CycleSymColor7
CycleSymColor8
CycleSymColor9
CycleSymStyle
CycleSymStyle1
CycleSymStyle10
CycleSymStyle2
CycleSymStyle3
CycleSymStyle4
CycleSymStyle5
CycleSymStyle6
CycleSymStyle7
CycleSymStyle8
CycleSymStyle9
DataSetTips
Default2DAxes
DefaultGraphStyle
DisplayCommitDialogOnExit
DisplayExecuteStringOutput
DisplaySelectedPoints
DraftMode
EchoExecuteStringInCmdWnd
EnableDDEServer
ExportDelimiter
FactorOnNewColCharEntry
GraphDataTips
GridsPerInch
HistoryType
ImageColors
ImageColorTableCM
ImageColorTableStd
ImageColorTableTBW
ImageColorTableTopo
ImageColorTableTrellis
ImageColorTableUser
ImageColorTableUser1
ImageColorTableWB
ImportDelimiter
ImportDisplayData
ImportOverwritePrompt
LargeToolbarButtons
LoadAndSaveMenus
NewStatsGraphSheetFlag
NumberOfUndos
NumConditioningVars
NumHistEntries
NumImageColorsCM
NumImageColorsStd
NumImageColorsTBW
NumImageColorsTopo
NumImageColorsTrellis
NumImageColorsUser
NumImageColorsUser1
NumImageColorsWB
NumShadesCM
NumShadesStd
NumShadesTBW
NumShadesTopo
NumShadesTrellis
NumShadesUser
NumShadesUser1
NumShadesWB
PanelResizeFonts
PanelResizeSymbols
PanningHorizOverlap
PanningVertOverlap
RegisterAllOLEObjectsAtStartup
RemoveDataPrompt
ResizeFonts
ResizeSymbols
SaveDataPrompt
SaveGraphPrompt
SavePosTabPage
SaveReportAsRTF
SaveWindowPos
SchemeColorTableUser
SchemeColorTableUser1
SelectedSymbolColor
SelectedSymbolLineWtIncr
SelectedSymbolSizeMult
SelectedSymbolStyle
SendColMissingsAsErrors
ShareViolations
ShowDataInView
ShowOpenProjectDialog
ShowSplashScreen
SmartCursor
SpecialToolbar
StandardToolbar
StartupCommandLine
StartupObjectBrowser
StartupSelectDataDialog
StatsEditableGraphsFlag
StatusBar
StatusMsgForDialogs
SuppressGraphWarnings
TextRoutingOutputDialogParent
ToolTips
ToolTipsForDialogs
UseOlderSPlusDDERequestFormat
UsePrinterPageDefaults
UseRaggedDataFrame
UserColors
UseWorkingDirForHome
WorkspaceFileName
WorkspaceFolder

Methods

Method Name: Description: Syntax:
BeginTransaction Starts remembering property set calls so changes can be applied on CommitTransaction.
Function BeginTransaction(  ) as Boolean
CancelTransaction Cancels remembering property set calls made after last call to BeginTransaction.
Function CancelTransaction(  ) as Boolean
ClassName Returns the class name (i.e. 'Arrow') of this object.
Function ClassName(  ) as Variant
CommitTransaction Commits all property changes made since last call to BeginTransaction.
Function CommitTransaction(  ) as Boolean
Containees Returns array of objects of class specified contained by this object.
Function Containees( ObjectClassToFind as Variant ) as Variant
Container Returns the container object of this object.
Function Container(  ) as Object
CreateObject Creates an object or a child object of a particular type.
Function CreateObject( ObjectClassName as Variant ) as Object
GetMethodArgumentNames Returns an array of argument names including the ReturnValue (if any) for a given method name for this object.
Function GetMethodArgumentNames( MethodName as Variant ) as Variant
GetMethodArgumentTypes Returns an array of argument types including the ReturnValue type (if any) for a given method name for this object. Specify the LanguageType (i.e. BASIC or C) so strings are appropriate for language.
Function GetMethodArgumentTypes( MethodName as Variant, LanguageType as Variant ) as Variant
GetMethodHelpString Returns the help string for a given method name for this object.
Function GetMethodHelpString( MethodName as Variant ) as Variant
GetObject Gets an object or a child object of the class name specified, identified by an object path name.
Function GetObject( ObjectClassName as Variant, ObjectPathName as Variant ) as Object
GetObjectPicture Returns array of byte values representing the metafile picture of the object. Returns empty variant if unsuccessful.
Function GetObjectPicture(  ) as Variant
GetObjectRectangle Returns rectangle that contains this object in client or screen coordinates depending on ReturnClientCoordsIfTrue. Returns empty variant if unsuccessful.
Function GetObjectRectangle( ReturnClientCoordsIfTrue as Boolean ) as Variant
GetPropertyAllowedValues Returns an array of allowable values for the specified property of this object.
Function GetPropertyAllowedValues( PropertyName as Variant ) as Variant
GetPropertyInformation Returns an array of property information including default value and allowable values for the specified property of this object.
Function GetPropertyInformation( PropertyName as Variant ) as Variant
GetSelectedObjects Returns array of objects which are selected of class specified contained by this object. StartIndex and EndIndex can be used to return subsets of selected objects.
Function GetSelectedObjects( ObjectClassToFind as String, StartIndex as Long, EndIndex as Long ) as Variant
GetSelectedText Returns the selected text as a string if any in this object. If this object has no selected text, an empty string is returned.
Function GetSelectedText(  ) as String
Methods Returns comma delimited list of methods which can be called on this object.
Function Methods(  ) as Variant
MethodsList Returns an array of method names which can be called on this object.
Function MethodsList(  ) as Variant
Objects If 'CONTAINEES', returns comma delimited list of objects which can be contained by this object. If 'CONTAINER', returns list of containers for this object.
Function Objects( ObjectHierarchyType as Variant ) as Variant
ObjectsList If 'CONTAINEES', returns an array of object names which can be contained by this object. If 'CONTAINER', returns an array of container object names for this object.
Function ObjectsList( ObjectHierarchyType as Variant ) as Variant
PathName Returns the path name in the S-PLUS project space (i.e. '$$GS1$Arrow1') of this object.
Function PathName(  ) as Variant
Properties Returns comma delimited list of properties for this object.
Function Properties(  ) as Variant
PropertiesList Returns an array of property names for this object.
Function PropertiesList(  ) as Variant
RemoveObject Removes a child object from this container object.
Function RemoveObject( Object as Object ) as Boolean
SelectObject Selects this object in all views. SelectionType is 'add', 'new', or 'remove' to control how object is selected. Returns TRUE if successful or FALSE if not.
Function SelectObject( SelectionType as String ) as Boolean
ShowDialog Displays object property dialog.
Function ShowDialog(  ) as Boolean
ShowDialogInParent Displays object property dialog using the HWND parameter passed as its parent.
Function ShowDialogInParent( ParentWindowHWND as Variant ) as Boolean
ShowDialogInParentModeless Displays object property dialog modelessly using the HWND parameter passed as its parent.
Function ShowDialogInParentModeless( ParentWindowHWND as Variant ) as Boolean

Containers

Possible parent objects:
Application

Children