Possible Containment
Properties
Property Name: | Description: | Optional/Required: | Default Value: | Data Type: | Allowable Values/Range: |
Edition | Edition | Optional | PROFESSIONAL | character | |
NewIndex | Object Index | Optional | -1 | character | |
NewName | Name | Optional | character | ||
RevisionDate | Revision Date | Optional | 26 Jan 2001 | character | |
Version | Version | Optional | 6.0 | character | |
Visible | Visible | Optional | T | logical | T, F |
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 |
ChooseGraphAndPlotType | Displays a chooser dialog allowing selection of a graph type and plot type. Returns the strings selected from the lists. | Function ChooseGraphAndPlotType( GraphType as ByRef Variant, PlotType as ByRef Variant, hWndParent as Long ) as Boolean |
ChooseGraphAndPlotTypeModeless | Displays chooser dialog allowing selection of graph and plot type. Returns dialog handle or 0 on failure. | Function ChooseGraphAndPlotTypeModeless( GraphType as Variant, PlotType as Variant, hWndParent as Long ) as Long |
ClassName | Returns the class name (i.e. 'Arrow') of this object. | Function ClassName( ) as Variant |
CloseModelessDialog | Closes and destroys dialog specified by dialog handle. Returns FALSE on failure. | Function CloseModelessDialog( DialogHandle as Long ) as Boolean |
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 |
ExecuteString | Executes a string in valid S-PLUS syntax. | Function ExecuteString( StringToExecute as Variant ) as Boolean |
ExecuteStringResult | Executes a string in valid S-PLUS syntax and returns the result as a formatted string. Second parameter controls how result is formatted. | Function ExecuteStringResult( StringToExecute as Variant, UseOlderResultFormatting as Variant ) as Variant |
GetHwndForModelessDialog | Gets window handle for dialog handle specified. Returns 0 on failure. | Function GetHwndForModelessDialog( DialogHandle as Long ) as Long |
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 |
GetOptionValue | Gets the current value of the option specified. | Function GetOptionValue( OptionNameToGet as Variant ) 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 |
GetSAPIObject | Returns the first instance of an S_api binary object of the name specified. | Function GetSAPIObject( ObjectName as Variant ) as Variant |
GetSelectedGraphAndPlotType | Returns selected graph and plot type from dialog handle specified. Empty variants returned for no selection. | Function GetSelectedGraphAndPlotType( DialogHandle as Long, GraphType as ByRef Variant, PlotType as ByRef Variant ) as Boolean |
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 |
SetOptionValue | Sets an option using a value specified. | Function SetOptionValue( OptionNameToSet as Variant, NewOptionValue as Variant ) as Boolean |
SetSAPIObject | Sets an S_api binary object of the name specified in database 1 in S-PLUS. | Function SetSAPIObject( S_apiObject as Variant, ObjectName as Variant ) 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
Children
Possible child objects: |
ActiveDocument |
DataFrame |
DataObject |
GraphSheet |
list |
matrix |
MenuItem |
ObjectBrowser |
Options |
Report |
Script |
SPlusCommandLine |
Toolbar |
vector |