SiteSettings.savePagePropsUI (Method)

Saves a site's page creation UI settings.

Returns:

Void

Arguments:

Name Type Required Description
nameMaxLength Integer_1_to_250_EmptyString Required The maximum number of characters allowed in the 'Name' field. An empty string means no limit exists.
nameForceLowerCase Boolean Required Boolean flag which when set to true tells CommonSpot to force text within the 'Name' field to lowercase.
titleMaxLength Integer_1_to_250_EmptyString Required The maximum number of characters CommonSpot allows within the 'Title' field. This value should be a positive integer less than 250 or an empty string, which indicates that the limit is 250 characters.
titleBarCaption Integer_0_to_3 Required An integer indicating if CommonSpot hides or displays the 'Title Bar Caption' field. Values for this field are 0 (required), 1 (optional--main tab), 2 (optional--other tab), or 3 (hidden).
titleBarCaption_ShowInProps Boolean Required Boolean flag which when set to true indicates that CommonSpot displays the 'Title Bar Caption' field when it displays the page property dialog box.
titleBarCaption_AllowedValues Integer_0_1 Required An integer indicating if CommonSpot hides or displays the 'Title Bar Caption' field. Values for this field are 0 (required), 1 (optional--main tab), 2 (optional--Other Tab), or 3 (Hidden).
titleBarCaption_UseTitleIfBlank Boolean Required Boolean flag which when set to true indicates that CommonSpot uses the 'Title' field as the 'Title Bar Option' when this field is blank.
description Integer_0_to_3 Required An integer indicating if CommonSpot hides or displays the 'Description' field. Values for this field are 0 (required), 1 (optional--main tab), 2 (optional--other tab), or 3 (hidden).
description_ShowInProps Boolean Required Boolean flag which when set to true indicates that CommonSpot shows the 'Description' field when it displays the page property dialog box. (as opposed to creating it initially).
description_AllowedValues PropsUI_Allowed_Values Required An integer indicating the information CommonSpot displays for the 'Description' field, as follows: 0 (any value) or 1 (any value other than the title).
description_UseTitleIfBlank Boolean Required Boolean flag which when set to true indicates that CommonSpot sets the 'Description' field to the 'Title' field when the 'Description' field is blank.
category PropsUI_Main_Other_Hidden Required An integer indicating if CommonSpot displays or hides the 'Category' field. Values are 1 (Main tab), 2 (Other tab) or 3 (hidden).
category_ShowInProps Boolean Required Boolean flag which when set to true indicates that CommonSpot shows the 'Category' field when it displays the page property dialog box.
audience PropsUI_Show_Hidden Required An integer indicating if the 'Audience' field is required or hidden. Values are 0 (required) or 3 (hidden).
audience_ShowInProps Boolean Required Boolean flag which when set to true indicates that CommonSpot shows the 'Audience' field when it displays the page property dialog.
availability PropsUI_Main_Other_Hidden Required An integer indicating if CommonSpot hides or displays the 'Availability' field. Values for this field 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 CommonSpot displays the 'Availability' field when it displays the page property dialog box.
keywords Integer_0_to_3 Required An integer indicating if CommonSpot hides or displays the 'Keywords' field. Values for this field 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 indicates that CommonSpot shows the 'Keywords' field when properties are edited.
confidentiality PropsUI_Main_Other_Hidden Required An integer indicating if CommonSpot displays or hides the 'Confidentiality' field. Values are 1 (Main tab), 2 (Other tab) or 3 (hidden).
confidentiality_ShowInProps Boolean Required Boolean flag which when set to true indicates that CommonSpot shows the 'Confidentiality' field when it displays the page property dialog box (as opposed to creating it initially).
publicationDate PropsUI_Main_Other_Hidden Required An integer indicating if CommonSpot displays or hides the 'PublicationDate' field. Values are 1 (Main tab), 2 (Other tab) or 3 (hidden).
publicationDate_ShowInProps Boolean Required Boolean flag which when set to true indicates that CommonSpot shows the 'Publication Date' field when it displays the page property dialog box.
expirationDate PropsUI_Main_Other_Hidden Required An integer indicating if CommonSpot displays or hides the 'ExpirationDate' field. Values are 1 (Main tab), 2 (Other tab) or 3 (hidden).
expirationDate_ShowInProps Boolean Required Boolean flag which when set to true indicates that CommonSpot shows 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