CustomElement.saveMiscProps (Method)
Saves miscellaneous properties for a global custom element; for example, the viewing page's ID, full text indexing, where the indexing information resides, the title field's ID, and the description field ID.
Returns:
Void
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| elementID | CustomElementID | Required | A custom element's ID. |
| viewingPageID | RealPageID_NonBaseTemplate | Required | The page's ID. |
| enableFulltextIndexing | Boolean | Required | Boolean flag which when set to true enables full text indexing for a custom element. |
| collectionName | PlainText | Required | The name of the collection in which the custom element index will reside. |
| titleFieldID | FieldID | Required | The custom element field's ID. |
| descriptionFieldID | FieldID_0 | Required | A custom element field's ID. |
Context:
| License Requirements | None |
| Permission Requirements | customElement:Admin |
| Deny Context | None |
| Require Context | AuthoringEnabled |
| Author Lock | (not required) |
| Transaction Logging | If transaction logging is enabled at the site level, calls to this method will be logged |
| Customization | This method may be customized at the site level |
Error Codes:
| Code | Error Message |
|---|---|
| 9001 | TitleFieldID '$1' is not valid. |
| 9002 | DescriptionFieldID '$1' is not valid. |
| 9009 | You cannot save the miscellaneous properties for a local custom element. |
| 9010 | You cannot save the miscellaneous properties for a global custom element that does not have any fields. |
| 1000100 | The specified collection name cannot be blank. |
| 1000101 | Full text indexing cannot be enabled because no collections are defined for this site. |
| 1000102 | The collection '$1' does not exist. |
Notes:
None