DatasheetElement.getViewInfo (Method)

Returns a structure containing information a view; for example, the view's name, source, and so on.

Returns:

DatasheetElement_GetViewInfo_Struct (struct)

Each row of the returned query results has the following fields:

Field Name	Type	Description
Description	PlainText_2000	The view's description.
isDefaultView	Boolean	Boolean flag which when set to true indicates that this view is the default.
isPublic	Boolean	Boolean flag which when set to true indicates that the view is public.
Name	PlainText_NonNull_255	The datasheet's view.
Source	DatasheetElementSource	The datasheet's source.
SourceFormID	CustomElement_SimpleForm_ID_0	The ID of the source form to which the datasheet is bound if the source is a custom element or a simple form. If it is neither, this value is 0.
SourceFormName	PlainText	The name of the custom element or simple form to which the datasheet is bound. This is an empty string if the datasheet is bound to a custom query's results.
ViewID	PositiveInteger	The view's ID.

Arguments:

Name	Type	Required	Description
pageID	RealPageID_NonBaseTemplate	Required	A page's ID.
elementID	ControlID	Required	The datasheet element's control ID.
viewName	PlainText_NonNull	Required	The name of the view for which CommonSpot retrieves information.
versionID	VersionID_NEG1_NEG2	Optional. Defaults to '-1'.	A datasheet's version ID (positive integer), -1 for the current version, or -2 for the most recent version.

Context:

License Requirements	Datasheet
Permission Requirements	(none)
Deny Context	None
Require Context	None
Author Lock	(not required)
Transaction Logging	Transaction logging is disabled for this method
Customization	This method may be customized at the site level

Error Codes:

None

Notes:

None