Skip to content

Methods for cWorkspace

View method list in hierarchical order.

Name Type Description Defining Class
ChildByIndex Function Can be used to iterate the direct children of an object ChildByIndex is a function that can be used to iterate the direct children of an object. cObject
ClassSuperClass Function Returns the superclass of the passed class This returns the superclass of the passed class. cObject
CountOfPaths Function Returns the number of paths present in a string of paths CountOfPaths returns the number of paths present in a string of paths. cWorkspace
Create Function Creates an object based on the passed Class Id The Create function is used to dynamically create objects. cObject
CreateNamed Function Creates an object based on the passed Class Id and assigns it a name Name based on a passed name Creates an object based on the passed Class Id and assigns it a name Name based on a passed name. cObject
Destroy Procedure Destroys the object that receives the message and any child objects of that object The Destroy message destroys the object that receives the message. cObject
DoAssignPaths Procedure Automatically called when a Workspace is opened to set the psDfPath property cWorkspace
DoClearPaths Procedure Clears all properties associated with opening a new Workspace Use the DoClearPaths procedure to clear the values of all properties associated with opening a new Workspace. cWorkspace
DoSetPaths Procedure Automatically sets the Filelist and Dfpath for the program, when a Workspace is opened The DoSetPaths procedure automatically sets the Filelist and Dfpath for the program, when a Workspace is opened. cWorkspace
EnumerateWorkspaceData Procedure Sends information about the current Workspace to another object EnumerateWorkspaceData sends information about the current Workspace to another object. cWorkspace
Exit_Application Procedure Starts the process of closing an application The Exit_Application message is used to close the program. cObject
GetWorkspaceFileName Function Returns the name of the physical Workspace file for a Workspace name Obsolete Use psWorkspaceWSFile instead of this method. cWorkspace
IsClassOfClass Function Determines whether the target class is part of the searched class's hierarchy cObject
IsObjectOfClass Function Determines whether the passed class is part of the object's class hierarchy This returns True if the passed class is part of the object's class hierarchy. cObject
IsRegistered Function Determines whether a Workspace is registered Obsolete There is no replacement for this method, since the concept of registering workspaces has been removed from the product. cWorkspace
ObjectClass Function Returns the integer class ID assigned to the class this object is based on Returns the integer class ID assigned to the class this object is based on. cObject
OpenWorkspace Function Opens a registered Workspace Obsolete Use OpenWorkspaceFile instead of this method. cWorkspace
OpenWorkspaceErrorMessage Function Returns a description for an error code that was returned opening a Workspace cWorkspace
OpenWorkspaceFile Function Opens a Workspace using its filename The OpenWorkspaceFile function opens a Workspace by directly reading the file that describes it. cWorkspace
PathAtIndex Function Returns a single path from a string containing multiple delimited paths The PathAtIndex function is used to return a single path from a string containing multiple semi-colon delimited paths. cWorkspace
Request_Destroy_Object Procedure Use the Destroy method instead This method is used to destroy an object and all of its children. cObject