Classes can define keynames and values that affect the behavior of their objects. Use keynames with setup methods as follows:
Because keynames have default values, setup strings are not required for these calls.
Every class may define its own set of keynames and values. The Workplace Shell Reference contains the definition of keynames for all classes. Keynames and the values supported by the WPObject class are listed in the following table:
旼컴컴컴컴컴컴컴컴컫컴컴컴컴컴컴쩡컴컴컴컴컴컴컴컴컴컴컴컴컴컴커쿖eyname 쿣alue 쿏escription � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿎CVIEW 쿏EFAULT 쿢ses the default value of the � � � 쿬oncurrent view setting of the� � � 퀂ystem, when the user selects � � � 쿽pen. This is the default � � � 퀆alue. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿧ES 쿎reates new views of the � � � 쿽bject every time the user � � � 퀂elects open. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿙O 쿝esurfaces open views of � � � 쿽bject, when the user selects � � � 쿽pen. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿏EFAULTVIEW 쿏EFAULT 쿞ets the default open view to � � � 퀃he object's class default � � � 퀆iew as returned by � � � 퀇pclsQueryDefaultView. This is� � � 퀃he default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿞ETTINGS 쿞ets the default open view to � � � 퀃he Settings view. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿔D 쿞ets the default open view to � � � 퀃he "id" of a user-added view � � � �(0 - 9). � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿓ELPLIBRARY 쿯ilename 쿞ets the help library. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿓ELPPANEL 쿶d 쿞ets the object's default help� � � 쿾anel. This is equivalent to � � � 쿬alling 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 to � � � 쿪 hide button. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � � 쿟he default is the current � � � 퀂ystem Button appearance for � � � 퀇indows setting. This cannot � � � 쿫e specified here. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿔CONFILE 쿯ilename 쿞ets the object's icon. This � � � 쿶s equivalent to calling � � � 퀇pSetIconData. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿔CONPOS 퀈, y 쿞ets the object's initial icon� � � 쿾osition in a folder. The x � � � 쿪nd y values represent the � � � 쿾osition in the folder in � � � 쿾ercentage coordinates. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿔CONRESOURCE 쿶d, module 쿞ets the object's icon. This � � � 쿶s equivalent to calling � � � 퀇pSetIconData. The "id" is the� � � 쿶con resource ID in the � � � 쿭ynamic link library (DLL) � � � �"module". � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿘INWIN 쿓IDE 쿓ides views of object, when � � � 퀃he minimize button is � � � 퀂elected. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿣IEWER 쿘inimizes views of the object � � � 퀃o Minimize window to viewer, � � � 퀇hen the minimize button is � � � 퀂elected. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿏ESKTOP 쿘inimizes views of the object � � � 퀃o Minimize window to Desktop,� � � 퀇hen the minimize button is � � � 퀂elected. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � � 쿟he default is the current � � � 쿘inimize button setting. This � � � 쿬annot be specified here. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿙OCOPY 쿧ES 쿢sers cannot copy objects. � � � 쿟his is equivalent to calling � � � 퀇pSetStyle with the � � � 쿚BJSTYLE_NOCOPY style. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿙O 쿢sers can copy objects. This � � � 쿶s the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿙ODELETE 쿧ES 쿢sers cannot delete objects. � � � 쿟his is equivalent to calling � � � 퀇pSetStyle with the � � � 쿚BJSTYLE_NODELETE style. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿙O 쿢sers can delete objects. This� � � 쿶s the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿙ODRAG 쿧ES 쿢sers cannot drag objects. � � � 쿟his is equivalent to calling � � � 퀇pSetStyle with the � � � 쿚BJSTYLE_NODRAG style. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿙O 쿢sers can drag objects. This � � � 쿶s the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿙ODROP 쿧ES 쿙o other objects can be � � � 쿭ropped on this object. This � � � 쿶s equivalent to calling � � � 퀇pSetStyle with the � � � 쿚BJSTYLE_NODROPON style. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿙O 쿚bjects can be dropped on this� � � 쿽bject. This is the default � � � 퀆alue. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿙OLINK 쿧ES 쿚bjects cannot be linked. This� � � 쿶s equivalent to calling � � � 퀇pSetStyle with the � � � 쿚BJSTYLE_NOLINK style. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿙O 쿚bjects can be linked. This is� � � 퀃he default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿙OMOVE 쿧ES 쿢sers cannot move objects. � � � 쿟his is equivalent to calling � � � 퀇pSetStyle with the � � � 쿚BJSTYLE_NOMOVE style. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿙O 쿢sers can move objects. This � � � 쿶s the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿙OPRINT 쿧ES 쿢sers cannot print objects. � � � 쿟his is equivalent to calling � � � 퀇pSetStyle with the � � � 쿚BJSTYLE_NOPRINT style. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿙O 쿢sers can print objects. This � � � 쿶s the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿙ORENAME 쿧ES 쿢sers cannot rename objects. � � � 쿟his is equivalent to calling � � � 퀇pSetStyle with the � � � 쿚BJSTYLE_NORENAME style. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿙O 쿢sers can rename objects. This� � � 쿶s the default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿙OSETTINGS 쿧ES 쿢sers cannot open the object's� � � 쿞ettings notebook. This is � � � 쿮quivalent to calling � � � 퀇pSetStyle with the � � � 쿚BJSTYLE_NOSETTINGS style. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿙O 쿢sers can open the object's � � � 쿞ettings notebook. This is the� � � 쿭efault value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿙OSHADOW (Same as 쿧ES 쿢sers cannot create shadows of� 쿙OLINK) � 쿽bjects. This is equivalent to� � � 쿬alling wpSetStyle with the � � � 쿚BJSTYLE_NOLINK style. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿙O 쿢sers can create shadows of � � � 쿽bjects. This is the default � � � 퀆alue. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿙OTVISIBLE 쿧ES 쿚bjects are not visible. This � � � 쿶s equivalent to calling � � � 퀇pSetStyle with the � � � 쿚BJSTYLE_NOTVISIBLE style. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿙O 쿚bjects are visible. This is � � � 퀃he default value. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿚BJECTID �<name> 쿞ets a persistent ID for the � � � 쿽bject. The OBJECTID can be � � � 퀅sed to obtain a pointer or � � � 쿴andle to the object by � � � 쿬alling wpclsQueryObject or � � � 쿥inQueryObject. An OBJECTID is� � � 쿪ny unique string preceded � � � 퀇ith a < and terminated with a� � � �>. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � � 쿟he default is to not have an � � � 쿔D. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿚PEN 쿞ETTINGS 쿚pens settings view when � � � 쿽bject is created or when � � � 쿥inSetObjectData is called. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿏EFAULT 쿚pens the default view when an� � � 쿽bject is created or when � � � 쿥inSetObjectData is called. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � � 쿟he default is to not open a � � � 퀆iew. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿟EMPLATE 쿧ES 쿢sers can create object � � � 퀃emplate. This is equivalent � � � 퀃o calling wpSetStyle with the� � � 쿚BJSTYLE_TEMPLATE style. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 � 쿙O 쿢sers cannot create object � � � 퀃emplate. This is the default � � � 퀆alue. � 쳐컴컴컴컴컴컴컴컴컵컴컴컴컴컴컴탠컴컴컴컴컴컴컴컴컴컴컴컴컴컴캑 쿟ITLE 쿟itle 쿞ets the object's title. This � � � 쿶s equivalent to calling � � � 퀇pSetTitle. � 읕컴컴컴컴컴컴컴컴컨컴컴컴컴컴컴좔컴컴컴컴컴컴컴컴컴컴컴컴컴컴켸
The following code fragments is an example of WPObject setup string:
PSZ pszSetupString = "TITLE = MYObject;"
"ICONFILE = MYOBJ.ICO;"
"OBJECTID = <MyObjectID>";