SiteSettings.saveUploadedDocPropsUI (Method)
Saves UI settings information for the Uploaded Document dialog box. This information defines the UI properties that CommonSpot displays.
Returns:
Void
Arguments:
Name | Type | Required | Description |
---|---|---|---|
titleMaxLength | Integer_1_to_250_EmptyString | Required | The maximum number of characters allowed in the 'Title' field. If you enter an empty string, the limit is 250 characters. |
description | Integer_0_to_3 | Required | An integer representing whether the 'Description' field is required, and if not, where it is displayed. 0=Required, 1=Optional (Main tab), 2=Optional (Other tab), 3=Hidden. |
description_ShowInProps | Boolean | Required | Boolean flag which when set to true tells CommonSpot to show the 'Description' when it displays the page property dialog box. |
description_AllowedValues | PropsUI_Allowed_Values | Required | An integer representing the allowed values for the 'Description' field.: 0 (any value) or 1 (any value other than title). |
description_UseTitleIfBlank | Boolean | Required | Boolean flag which when set to true tells CommonSpot should set the 'Description' field to the 'Title' field when the 'Description' field is blank. |
category | PropsUI_Main_Other_Hidden | Required | An integer representing whether the 'Category' field is required, and if not where it is displayed, as follows: 0 (shown) or 3 (hidden). |
category_ShowInProps | Boolean | Required | Boolean flag which when set to true tells CommonSpot to show the 'Category' field when editing properties. |
availability | PropsUI_Main_Other_Hidden | Required | An integer indicating if CommonSpot hides or displays the 'Availability' field. Values are 1 (optional--main tab), 2 (optional--other tab), or 3 (hidden). |
availability_ShowInProps | Boolean | Required | Boolean flag which when set to true indicates that the 'Availability' field should be displayed when editing the properties (as opposed to creating initially). |
keywords | Integer_0_to_3 | Required | An integer indicating if CommonSpot should hide or display the 'Keywords field. Values are 0 (required), 1 (optional--main tab), 2 (optional--other tab), or 3 (hidden). |
keywords_ShowInProps | Boolean | Required | Boolean flag which when set to true tells CommonSpot to show the 'Keywords' field when it displays the page property dialog box. |
publicationDate | PropsUI_Main_Other_Hidden | Required | An integer indicating if CommonSpot hides or displays the 'Publication Date' field. Values are 0 (required), 1 (optional--main tab), 2 (optional--other tab), or 3 (hidden). |
publicationDate_ShowInProps | Boolean | Required | Boolean flag which when set to true tells CommonSpot to show the 'Publication Date' field when it displays the page property dialog box. |
expirationDate | PropsUI_Main_Other_Hidden | Required | An integer indicating if CommonSpot hides or displays the 'Expiration Date' field. Values are 0 (required), 1 (optional--main tab), 2 (optional--other tab), or 3 (hidden). |
expirationDate_ShowInProps | Boolean | Required | Boolean flag which when set to true tells CommonSpot to show the 'Expiration Date' field when it displays the page property dialog box. |
seoKeywords | Integer_0_to_3 | Optional. Defaults to '2'. | An integer indicating if CommonSpot hides or displays the 'SEO Keywords' field. Values for this field are 0 (required), 1 (optional--main tab), 2 (optional--other tab), or 3 (hidden). |
seoKeywords_ShowInProps | Boolean | Optional. Defaults to '1'. | Boolean flag which when set to true indicates that CommonSpot shows the 'Keywords' field when properties are edited. |
Context:
License Requirements | None |
Permission Requirements | site:SiteAdmin |
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 | Customization is not supported for this method. |
Error Codes:
None
Notes:
None