CustomElement.getDataBrowserFields (Method)

Returns one or more structures, each containing information about global custom element fields that will be displayed in a data browser's window; for example, a field's name, description, is it a sort column, and so on.

Returns:

GetDataBrowserFields_Result (query)

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

Field Name	Type	Description
allowHTML	Boolean	Boolean flag - when true, field is safe to render without using EncodeForHTML().
FieldDescription	PlainText	The custom element field's description.
FieldID	FieldID_NEG1_NEG2_NEG3	A custom element field's ID.
FieldLabel	PlainText_NonNull	The custom element field's label.
FieldName	PlainText_NonNull	The custom element field's name.
FieldType	PlainText	Commonspot field type specified for this field.
isDisplayed	Boolean	Boolean flag which when set to true indicates that the data browser displays this column.
isSortColumn	Boolean	Boolean flag which when set to true indicates that CommonSpot sorts results using this field.

Arguments:

Name	Type	Required	Description
elementID	CustomElementID	Required	A custom element's ID.
visibleOnly	Boolean	Optional. Defaults to '0'.	A boolean flag which when set to True indicates that only fields specified to show in the Data Browser Properties dialog will be returned.

Context:

License Requirements	None
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