SiteSettings.getPagePropsUI (Method)

Returns a structure the describes UI Properties settings for the Page Creation dialog box.

Returns:

SiteSettings_GetPagePropsUI_Result (struct)

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

Field Name	Type	Description
Audience	PropsUI_Show_Hidden	Integer indicating if the 'Audience' field is required or hidden. Values are 0 (required) or 3 (hidden).
Audience_ShowInProps	Boolean	Boolean flag which when true indicates that CommonSpot shows the 'Audience' field when it displays the Standard Properties dialog box.
Availability	PropsUI_Main_Other_Hidden	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	Boolean flag which when true indicates that CommonSpot shows the '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 shows the 'Category' field when it displays the Standard Properties dialog box.
Confidentiality	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).
Confidentiality_ShowInProps	Boolean	Boolean flag which when true indicates that CommonSpot shows the 'Confidentiality' field when it displays the Standard Properties dialog box.
Description	PropsUI_Show_Hidden_Optional	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_AllowedValues	PropsUI_Allowed_Values	An integer indicating the information CommonSpot displays for the 'Description' field, as follows: 0 (any value) or 1 (any value other than title).
Description_ShowInProps	Boolean	Boolean flag which when true indicates that CommonSpot shows the 'Description' field when it displays the page property dialog box.
Description_UseTitleIfBlank	Boolean	Boolean flag which when true indicates that CommonSpot sets the 'Description' field to the 'Title' field when 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 page property dialog box.
Keywords	PropsUI_Show_Hidden_Optional	An integer indicating if CommonSpot hides or displays the 'Meta Keywords' field. Values for this field are 0 (required), 1 (optional--main tab), 2 (optional--other tab), or 3 (hidden).
Keywords_Licensed	Boolean	True if 'keywords' feature is included in customer license, false otherwise.
Keywords_ShowInProps	Boolean	Boolean flag which when true indicates that CommonSpot shows the 'Meta Keywords' field when properties are edited.
NameForceLowerCase	Boolean	Boolean flag which when true indicates that CommonSpot forces the text within the 'Name' field to lower case.
NameMaxLength	PositiveInteger_LTE_250_EmptyString	The 'Name' field's maximum length.
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	A Boolean flag which when true indicates that CommonSpot shows the 'Publication Date' field when it displays the page Standard Properties dialog box.
SEO_Licensed	Boolean	True if 'SEO' feature is enabled in customer key, false otherwise.
SEOKeywords	PropsUI_Show_Hidden_Optional	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	A Boolean flag which when true indicates that CommonSpot displays the 'SEO Keywords' field when it displays the Standard Properties dialog box.
TitleBarCaption	PropsUI_Show_Hidden_Optional	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_AllowedValues	PropsUI_Allowed_Values	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	A Boolean flag which when true indicates that CommonSpot displays the 'Title Bar Caption' field when it displays the Standard Properties dialog box.
TitleBarCaption_UseTitleIfBlank	Boolean	Boolean flag which when true indicates that CommonSpot uses the 'Title' field as the 'Title Bar Option' when this field is blank.
TitleMaxLength	PositiveInteger_LTE_250_EmptyString	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 there is no limit.

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