CustomElement.getMiscProps (Method)

Returns a structure containing general properties for a custom element; for example, 'EnableFullTextIndexing', 'SearchCollection,' ViewingPageFullPath'.

Returns:

CustomElement_GetMiscProps_Result (struct)

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

Field Name	Type	Description
DescriptionFieldID	FieldID_0	The ID of the custom element's description. If this value is 0, no description field mapping exists.
EnableFullTextIndexing	Boolean	Boolean flag which when set to true indicates that this custom element will have its text indexed.
SearchCollection	PlainText	The search collection's name.
TitleFieldID	FieldID_0	The ID of custom element field that CommonSpot uses as the search's title. If this value is 0, no title field mapping exists.
ViewingPageFullPath	PlainText	The full path (including the filename) of the viewing page. If an empty string then no viewing page was setup for this global custom element.
ViewingPageID	PageID_0	The viewing page's ID. If this value is 0, no viewing page was set up for this global custom element.

Arguments:

Name	Type	Required	Description
elementID	CustomElementID	Required	A custom element's ID.

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:

Code	Error Message
9007	You cannot view the miscellaneous properties of a local custom element.
9008	You cannot view the miscellaneous properties of a global custom element that does not have any fields.

Notes:

None