SiteSettings.getUploadedDocPropsUI (Method)
Returns a SiteSettings_GetNonPagePropsUI_Result structure containing information about UI Properties settings for the Uploaded Document dialog box.
Returns:
SiteSettings_GetNonPagePropsUI_Result (struct)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
Availability | PropsUI_Main_Other_Hidden | 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 | Boolean flag which when true indicates that CommonSpot hides 'Availability' field when it displays the Standard Properties dialog box. |
Category | PropsUI_Main_Other_Hidden | Integer which indicates which tab the field should be rendered on (.i.e 1=Main Tab, 2=Other Tab, 3=Hidden). |
Category_ShowInProps | Boolean | Boolean flag which when true indicates that CommonSpot displays the 'Category' field when it displays the Standard Properties dialog box. |
Description | PropsUI_Show_Hidden_Optional | An integer indicating if CommonSpot displays or hides the 'Description' field. Values are 0 (required) or 1 (optional--main Tab), 2 (optional--other Tab), or 3 (hidden). |
Description_AllowedValues | PropsUI_Allowed_Values | An integer representing which values CommonSpot allows within the 'Description' field. Values are 0 (any value), 1 (any value other than the title). |
Description_ShowInProps | Boolean | Boolean flag which when true indicates that CommonSpot displays the 'Description' field when it displays the Standard Properties dialog box. |
Description_UseTitleIfBlank | Boolean | Boolean flag which when true indicates that CommonSpot sets the 'Description' field to the 'Title' field if the 'Description' field is blank. |
ExpirationDate | PropsUI_Main_Other_Hidden | Integer which indicates which tab the field should be rendered on (.i.e 1=Main Tab, 2=Other Tab, 3=Hidden). |
ExpirationDate_ShowInProps | Boolean | Boolean flag which when true indicates that CommonSpot shows the 'Expiration Date' field when it displays the Standard Properties dialog box. |
Keywords | PropsUI_Show_Hidden_Optional | 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_Licensed | Boolean | True if 'keywords' feature enabled in customer key. |
Keywords_ShowInProps | Boolean | Boolean flag which when true indicates that CommonSpot displays the 'Keywords' field when it displays the Standard Properties dialog box. |
PublicationDate | PropsUI_Main_Other_Hidden | Integer which indicates which tab the field should be rendered on (.i.e 1=Main Tab, 2=Other Tab, 3=Hidden). |
PublicationDate_ShowInProps | Boolean | Boolean flag which when true indicates that CommonSpot displays the 'Publication Date' field when it displays the Standard Properties dialog box. |
SEO_Licensed | Boolean | True if 'SEO' feature enabled in customer key. |
SEOKeywords | PropsUI_Show_Hidden_Optional | An integer indicating if CommonSpot should hide or display the 'SEO Keywords field.. Values are 0 (required), 1 (optional--main tab), 2 (optional--other tab), or 3 (hidden). |
SEOKeywords_ShowInProps | Boolean | Boolean flag which when true indicates that CommonSpot displays the 'SEO Keywords' field when it displays the Standard Properties dialog box. |
TitleMaxLength | PositiveInteger_LTE_250_EmptyString | The maximum number of characters allowed in the 'Title' field. Enter a positive integer not greater than 250 characters. An empty string indicates that a user can enter no more than 250 characters. |
Context:
License Requirements | None |
Permission Requirements | ContributorOrServerCode |
Deny Context | None |
Require Context | None |
Author Lock | (not required) |
Transaction Logging | Transaction logging is disabled for this method |
Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None