WebCenter Interaction API  
 

IPTAsyncGadgetProvider.GetHTMLText Method (Int32, IPTSession, IPTGadgetInfo, IPTStates, IPTAdminSettings, Object, IPTUserInterface, Int32)

Get the HTML text for this portlet as an array of markup fragments, some of which require post-processing. You must call BeginProcessing before calling this function and pass the same set of arguments to both.

object[][] GetHTMLText(
   int lMode,
   IPTSession pUserSession,
   IPTGadgetInfo pGadgetInfo,
   IPTStates pStates,
   IPTAdminSettings pAdminSettings,
   object vAppDataStateObject,
   IPTUserInterface pUserInterface,
   int nStateMode
);

Parameters

lMode
The mode, see see {@link com.plumtree.server.PT_GADGET_MODES PT_GADGET_MODES}.
pUserSession
The current user's session.
pGadgetInfo
Used to get and set persistent settings.
pStates
State information, used to store page, session, and application level state.
pAdminSettings
Used to set administrator settings. Null if the current user cannot set admin settings in the current mode or context.
vAppDataStateObject
Contains additonal arguments specific to the provider or the user interface.
pUserInterface
The user interface (e.g. devices, low bandwidth). Optional, may be null.
nStateMode
The state to use for storing the requests {@link com.plumtree.server.PT_STATEMODES PT_STATEMODES}.

Return Value

A 2D array of markup fragments with columns defined by {@link com.plumtree.server.PT_MARKUP_ARRAY_COLS PT_MARKUP_ARRAY_COLS}.

See Also

IPTAsyncGadgetProvider Interface | com.plumtree.server Namespace | IPTAsyncGadgetProvider.GetHTMLText Overload List