The IShowPropertiesCmd interface is used to initialize the data contained in the ShowProperties command component, which displays FileNet Workplace Properties Java™Server Pages (JSP) page to present the current item and system properties for a specified object store item to the user. Using this interface, the client application can specify the object store item for which to present the properties, as well as specify the page title.
After the ShowProperties command has been executed by calling IAppIntCmd::Invoke, a ShowProperties response component is returned. Client applications may interact with the response component via the standard IAppIntRsp or custom IShowPropertiesRsp interfaces.
coclass ShowPropertiesCmd {
[default] interface IShowPropertiesCmd;
interface IAppIntCmd;
};
DLL | FnAppIntShowPropertiesCmd.dll |
See Also | ISelectPropertiesCmd interface |
The IShowPropertiesCmd interface defines one method:
Method | Description |
---|---|
Initialize |
Customizes the Properties JSP page in preparation for use by the ShowProperties operation, including the object store item for which to present the properties, as well as specifying the page title. |
The following is a fragment from the complete example for the ShowProperties command.
... // Instantiate the ObjectStoreItem component IObjectStoreItemPtr pIObjectStoreItem; hResult = spIObjectStoreItem.CreateInstance(__uuidof(ObjectStoreItem));
if (FAILED(hResult)) {
std::cout << "Could not create the ObjectStoreItem component.\n"; _ASSERTE(0);
} // Initialize the ObjectStoreItem component with // the items' type, object store name, version series ID and item ID ItemType enItemType = eItemTypeDocument; _bstr_t bstrObjectStoreName = (_T("Alaska")); _bstr_t bstrVersionSeriesID = (_T("{6BC064A2-2D58-4B0A-AEF2-B2F8A1100000}")); _bstr_t bstrItemID = (_T("{DDE54469-36D9-4fe9-8676-445E4994DE1F}")); std::cout << "Initializing the ObjectStoreItem component..." << std::endl;
spIObjectStoreItem->Initialize(enItemType, bstrObjectStoreName, bstrVersionSeriesID, bstrItemID); // Instantiate the custom ShowProperties command component IShowPropertiesCmdPtr spIShowPropertiesCmd;
hResult = spIShowPropertiesCmd.CreateInstance(__uuidof(ShowPropertiesCmd));
if (FAILED(hResult)) {
std::cout << "Could not create the ShowProperties command component.\n"; _ASSERTE(0);
} // Initialize the custom ShowProperties command component with the // page title and object store item. _bstr_t bstrPageTitle = (_T("Customized Show Properties Operation")); std::cout << "Initializing the ShowProperties command component..." << std::endl; spIShowPropertiesCmd->Initialize(bstrPageTitle, spIObjectStoreItem); // Execute the ShowProperties command and capture the response component std::cout << "Executing the ShowProperties command..." << std::endl; IAppIntCmdPtr spIAppIntCmd(spIShowPropertiesCmd);
IAppIntRspPtr spIAppIntRsp = spIAppIntCmd->Invoke(spIAppIntSession);...