Aqualogic Interaction API  
 

IPTGadget Members

IPTGadget overview

Public Instance Methods

AddMandatoryGroup Adds this gadget as mandatory to the specified group
GetAlignment Gadget alignment refers to the column the gadget is in within the specific page layout. 0 is column zero, 1 is column 1, and so on. The maximum, at this time, is 2, only achievable in the narrow-wide-narrow page layout.
GetGadgetBrowserCLSID Obsolete. Used in Plumtree 3.X for the standalone Windows client version fo the administration server.
GetGadgetProviderCLSID Retrieves the CLSID of the gadget provider (for example, the remote gadget provider, or intrinsic gadget provider)
GetGadgetTemplateID Retrieves the template ID of this gadget Note: This value is only set if the gadget was instantiated from a gadget template, or if this gadget is of type template
GetGadgetType Gadget types refer to personal, community, and template (gadget template). The "panel" type is not supported.
GetHTMLText Retrieves the HTML text from the portlet
GetMandatoryGadgetOrder Retrieves the "priority" of this gadget if it is mandatory. Used to determine vertical order of mandatory gadgets.
GetProviderInfo Gets the property bag containing all properties for the associated gadget provider
GetSuppressTitleBar Returns true if the title bar is supressed for this gadget.
GetWebServiceID Retrieves the web service ID for this gadget. If this is an intrinsic gadget no web service is required.
Initialize Initializes the portlet instance using a CLSID to specify gadget type.
QueryMandatoryGroups Queries for the list of groups this gadget is mandatory on
RemoveMandatoryGroup Removes this gadget as a mandatory for the specified group
SetAlignment Sets the gadget alignment (column number). See GetAlignment().
SetGadgetTemplateID Sets the gadget template ID. See GetGadgetTemplateID();
SetGadgetType Sets the gadget type. See GetGadgetType().
SetMandatoryGadgetOrder Sets the mandatory order. See GetMandatoryGadgetOrder().
SetProviderInfo Sets the gadget provider properties
SetSuppressTitleBar If you set this to true, the titlebar on the gadget will be supressed when it is displayed.
SetWebServiceID Sets the wbe service ID. See GetWebServiceID().

See Also

IPTGadget Interface | com.plumtree.server Namespace | IPTGdagetInfo | IPTGadgetGateway | IPTGadgetCacheSite | IPTWebService | IPTQueryResult | IPTState | PT_MARKUP_ARRAY_COLS | PT_MANDATORYORDERING | PT_GADGET_TYPES