Class definition file: wpobject.idl
Class hierarchy SOMObject
WPObject
Description
This is the root Workplace object class. This is the fundamental class from which all Workplace objects are derived, regardless of where they are actually stored. Immediate descendant classes of WPObject are called storage classes, because they take responsibility for storing the object information, typically in a persistent form. Predefined Workplace object storage classes are the following:
A Workplace object of this class cannot be created.
Menu ID list
The following list shows the WPMENUID menu IDs for this class:
Menu item text
Instance methods
The following lists show how all the WPObject instance methods are related within functional areas:
Settings Notebook methods
Save/Restore State methods
Object Usage methods
Pop-Up Menu methods
Query and Set Object Information methods
Error Handling methods
Memory Management methods
Direct Manipulation methods
Miscellaneous methods
Setup/Cleanup methods
wpSetup override by WPObject
The following table shows the keyname-value pairs added by the WPObject class.
旼컴컴컴컴컴컴컴컴컫컴컴컴컴컴컴컴컴컴컴쩡컴컴컴컴컴컴컴컴컴컴컴컴컴엿KEYNAME 쿣ALUE 쿏ESCRIPTION � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿎CVIEW 쿏EFAULT 쿟he default value of the � � � 쿬oncurrent view setting of � � � 퀃he system is used when the� � � 퀅ser selects open. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿧ES 쿟his sets the object's � � � 쿺ultiple concurrent view � � � 쿫ehavior, so that new views� � � 쿽f this object are created � � � 쿮very time the user selects� � � 쿽pen. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿙O 쿚pened view of this object � � � 퀁esurfaces when the user � � � 퀂elects open. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿏EFAULTVIEW 쿞ETTINGS 쿟his sets the default open � � � 퀆iew to Settings view. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿶d 쿟his sets the default open � � � 퀆iew to the id of a � � � 퀅ser-added view (0-9). � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿏EFAULT 쿟his sets the default open � � � 퀆iew to the object's class � � � 쿭efault view, as returned � � � 쿫y wpclsQueryDefaultView. � � � 쿟his is the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿓ELPLIBRARY 쿯ilename 쿟his sets the help library.� 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿓ELPPANEL 쿶d 쿟his sets the object's � � � 쿭efault help panel for � � � 쿽bject-specific help. This � � � 쿶s equivalent to calling � � � �wpSetDefaultHelp. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿓IDEBUTTON 쿧ES 쿣iews of this object have a� � � 쿴ide button as opposed to a� � � 쿺inimize button. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿙O 쿣iews of this object have a� � � 쿺inimize button as opposed � � � 퀃o a hide button. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � � 쿟he default is the current � � � 퀂ystem Button appearance � � � 쿯or windows setting. This � � � 쿬annot be specified here. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔CONFILE 쿯ilename 쿟his sets the object's � � � 쿶con. This is equivalent to� � � 쿬alling wpSetIconData. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔CONPOS 퀈,y 쿟his sets the object's � � � 쿶nitial icon position in a � � � 쿯older. The x and y values � � � 퀁epresent the position in � � � 퀃he object's folder in � � � 쿾ercentage coordinates. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿔CONRESOURCE 쿶d,module 쿟his sets the object's � � � 쿶con. This is equivalent to� � � 쿬alling wpSetIconData. The � � � �"id" is the icon resource � � � 쿔D in the dynamic link � � � 쿹ibrary (DLL) "module". � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿗OCKEDINPLACE 쿧ES 쿟his sets the object's icon� � � 쿹ocked in place property, � � � 퀂o that the object's icon � � � 쿶s fixed in position in an � � � 쿽pen icon view of the � � � 쿯older containing the � � � 쿽bject. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿙O 쿟his resets the object's � � � 쿶con locked in place � � � 쿾roperty, so that the � � � 쿽bject's icon position can � � � 쿫e moved. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿘ENUITEMSELECTED 쿺enu-item-ID 쿟his simulates selecting � � � 퀃he specified menu item � � � 쿯rom the object's pop-up � � � 쿺enu. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿘ENUS 쿟his sets the � � � 쿽bject's pop-up menu� � � 쿾roperty to short � � � 쿺enus. � � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿞HORT 쿟his sets the object's � � � 쿾op-up menu property to � � � 쿹ong menus. � � � 쿟his is the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿘INWIN 쿓IDE 쿣iews of this object hide � � � 퀇hen their minimize button � � � 쿶s selected. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿣IEWER 쿣iews of this object � � � 쿺inimize to the minimized � � � 퀇indow viewer when their � � � 쿺inimize button is � � � 퀂elected. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿏ESKTOP 쿣iews of this object � � � 쿺inimize to the desktop � � � 퀇hen their minimize button � � � 쿶s selected. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � � 쿟he default is the current � � � 쿘inimize button setting. � � � 쿟his cannot be specified � � � 쿴ere. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿙OCOPY 쿧ES 쿟his sets the object's no � � � 쿬opy property, so that the � � � 쿽bject cannot be copied. � � � 쿟his is equivalent to � � � 쿬alling wpSetStyle with a � � � 퀂tyle of OBJSTYLE_NOCOPY. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿙O 쿟his resets the object's no� � � 쿬opy property, so that the � � � 쿽bject can be copied. � � � 쿟his is the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿙ODELETE 쿧ES 쿟his sets the object's no � � � 쿭elete property, so that � � � 퀃he object cannot be � � � 쿭eleted. This is equivalent� � � 퀃o calling wpSetStyle with � � � 쿪 style of � � � 쿚BJSTYLE_NODELETE. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿙O 쿟his resets the object's no� � � 쿭elete property, so that � � � 퀃he object can be deleted. � � � 쿟his is the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿙ODRAG 쿧ES 쿟his sets the object's no � � � 쿭rag property, so that the � � � 쿽bject cannot be dragged. � � � 쿟his is equivalent to � � � 쿬alling wpSetStyle with a � � � 퀂tyle of OBJSTYLE_NODRAG. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿙O 쿟his resets the object's no� � � 쿭rag property, so that the � � � 쿽bject can be dragged. � � � 쿟his is the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿙ODROP 쿧ES 쿟his sets the object's no � � � 쿭rop property, so that no � � � 쿽ther object can be dropped� � � 쿽n it. This is equivalent � � � 퀃o calling wpSetStyle with � � � 쿪 style of � � � 쿚BJSTYLE_NODROPON. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿙O 쿟his resets the object's no� � � 쿭rop property, so that � � � 쿪nother object can be � � � 쿭ropped on it. � � � 쿟his is the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿙OLINK 쿧ES 쿟his sets the object's no � � � 쿹ink property, so that the � � � 쿽bject cannot be linked. � � � 쿟his is equivalent to � � � 쿬alling wpSetStyle with a � � � 퀂tyle of OBJSTYLE_NOLINK. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿙O 쿟his resets the object's no� � � 쿹ink property, so that the � � � 쿽bject can be linked. � � � 쿟his is the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � � 쿟his is the same as the � � � 쿙OSHADOW keyword. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿙OMOVE 쿧ES 쿟his sets the object's no � � � 쿺ove property, so that the � � � 쿽bject cannot be moved. � � � 쿟his is equivalent to � � � 쿬alling wpSetStyle with a � � � 퀂tyle of OBJSTYLE_NOMOVE. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿙O 쿟his resets the object's no� � � 쿺ove property, so that the � � � 쿽bject can be moved. � � � 쿟his is the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿙OPRINT 쿧ES 쿟his sets the object's no � � � 쿾rint property, so that the� � � 쿽bject cannot be printed. � � � 쿟his is equivalent to � � � 쿬alling wpSetStyle with a � � � 퀂tyle of OBJSTYLE_NOPRINT. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿙O 쿟his resets the object's no� � � 쿾rint property, so that the� � � 쿽bject can be printed. � � � 쿟his is the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿙ORENAME 쿧ES 쿟his sets the object's no � � � 퀁ename property, so that � � � 퀃he object cannot be � � � 퀁enamed. This is equivalent� � � 퀃o calling wpSetStyle with � � � 쿪 style of � � � 쿚BJSTYLE_NORENAME. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿙O 쿟his resets the object's no� � � 퀁ename property, so that � � � 퀃he object can be renamed. � � � 쿟his is the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿙OSETTINGS 쿧ES 쿟his sets the object's no � � � 퀂ettings property, so that � � � 퀃he object' settings cannot� � � 쿫e opened. This is � � � 쿮quivalent to calling � � � �wpSetStyle with a style of � � � 쿚BJSTYLE_NOSETTINGS. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿙O 쿟his resets the object's no� � � 퀂ettings property, so that � � � 퀃he object's settings can � � � 쿫e opened. � � � 쿟his is the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿙OSHADOW 쿧ES 쿟his sets the object's no � � � 쿹ink property, so that the � � � 쿽bject cannot be linked. � � � 쿟his is equivalent to � � � 쿬alling wpSetStyle with a � � � 퀂tyle of OBJSTYLE_NOLINK. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿙O 쿟his resets the object's no� � � 쿹ink property, so that the � � � 쿽bject can be linked. � � � 쿟his is the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � � 쿟his is the same as the � � � 쿙OLINK keyword. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿙OTVISIBLE 쿧ES 쿟his sets the object's not � � � 퀆isible property, so that � � � 퀃he object cannot be made � � � 퀆isible. This is equivalent� � � 퀃o calling wpSetStyle with � � � 쿪 style of � � � 쿚BJSTYLE_NOTVISIBLE. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿙O 쿟his resets the object's � � � 쿻ot visible property, so � � � 퀃hat the object can be made� � � 퀆isible. � � � 쿟his is the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿚BJECTID �<name> 쿟his sets a persistent ID � � � 쿯or the object. The � � � 쿚BJECTID stays with the � � � 쿽bject even if it is moved � � � �or renamed. The object � � � 쿾ointer or handle can be � � � 퀁etrieved via � � � �wpclsQueryObject or � � � �WinQueryObject , � � � 퀁espectively. An OBJECTID � � � 쿶s any unique string � � � 쿾receded with a "<" and � � � 퀃erminated with a ">". � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � � 쿟he default is to not have � � � 쿪n ID. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿚PEN 쿞ETTINGS 쿟his opens the Settings � � � 퀆iew when an object is � � � 쿬reated or when � � � 쿥inSetObjectData is called.� 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿏EFAULT 쿟his opens the default view� � � 퀇hen an object is created � � � 쿽r when WinSetObjectData is� � � 쿬alled. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � � 쿟he default is to not open � � � 쿪 view. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿟EMPLATE 쿧ES 쿟his sets the object's � � � 퀃emplate property. This is � � � 쿮quivalent to calling � � � �wpSetStyle with a style of � � � 쿚BJSTYLE_TEMPLATE. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� � 쿙O 쿟his resets the object's � � � 퀃emplate property. � � � 쿟his is the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴� 쿟ITLE 쿟itle 쿟his sets the object's � � � 퀃itle. This is equivalent � � � 퀃o calling wpSetTitle. � 읕컴컴컴컴컴컴컴컴컨컴컴컴컴컴컴컴컴컴컴좔컴컴컴컴컴컴컴컴컴컴컴컴컴�
Example
pszSetupString="TITLE=MYObject;"
"ICONFILE=myobj.ico;"
"HELPPANEL=132;"
"TEMPLATE=YES;"
"NODELETE=NO";
SOMObject instance methods
The following list shows all the instance methods overridden by the WPObject class. These instance methods are overridden in order to modify the behavior defined by an ancestor class.
Class Methods
The following list shows all the WPObject class methods:
SOMClass methods
The following list shows all the class methods overridden by the the WPObject class. These methods are overridden to modify the behavior defined by an ancestor class.