PageProperties Interface |
Properties specific to Page objects.
Namespace: SystemProperties
The PageProperties type exposes the following members.
Name | Description | |
---|---|---|
BootConsoleTemplate_aspx_Columns | The number of columns in the layout (default) is 1. When multiple columns are specified all non-fixed elements without Column specified will go into column 0. | |
BootConsoleTemplate_aspx_ColumnWidths | A semi-colon separated list column widths. Each width may be an integer Bootstrap grid column count between 1 and 12, or one or more Bootstrap grid column classes (e.g. "col-md-8 col-sm-12"). | |
BootConsoleTemplate_aspx_HomePane | For consoles where some panes participate in PaneNavigation, this is the participant pane to show when no specific pane is specified in the request. | |
BootConsoleTemplate_aspx_Navigator | The navigator to use just at the top of the console. | |
BootConsoleTemplate_aspx_TemplateAttributes | Attributes specifying ConsoleTemplate behaviour. See ConsoleTemplateDisplayAttrs | |
BootConsoleTemplate_aspx_ToolbarController | Normally the "main" pane controls the page's toolbar unless PaneNavigation is in play in which case the active pane controls the toolbar. Set this property to override the pane that should control the toolbar. | |
ButtonImageOverride | Override the default image for toolbar buttons. Enter key value pairs separated by semicolons to replace multiple images. e.g. SaveLg.gif=SaveLgNew.gif;Save16.gif=Save16New.gif. For a full list of possible keys, consult the documentation. | |
Caption | The page name. This value is displayed as the default title for the page for most templates. | |
ClientHtmlBlock | A block of HTML that will be added to the page using the .Net RegisterClientScriptBlock() method. | |
ClientScriptBlock | A block of javascript (typically function declarations) that will be added to the page using the .Net RegisterClientScriptBlock() method, but wrapped in a <script></script> block. | |
ClientStartupScript | A block of javascript (to be run at page startup) that will be added to the page using the .Net RegisterStartupScript() method, but wrapped in a <script></script> block. | |
CommandTimeout | The time (in seconds) to wait for the command to execute. The minimum value is 30 seconds | |
ConsoleTemplate_aspx_Columns | The number of columns in the layout. | |
ConsoleTemplate_aspx_ColumnWidths | A semi-colon separated list of HTML column widths. If only one width is provided it will be used for all columns. | |
ConsoleTemplate_aspx_HomePane | For consoles where some panes participate in PaneNavigation, this is the participant pane to show when no specific pane is specified in the request. | |
ConsoleTemplate_aspx_Navigator | The navigator to use just at the top of the console. | |
ConsoleTemplate_aspx_TemplateAttributes | Attributes specifying ConsoleTemplate behaviour. See ConsoleTemplateDisplayAttrs | |
ConsoleTemplate_aspx_ToolbarController | Normally the "main" pane controls the page's toolbar unless PaneNavigation is in play in which case the active pane controls the toolbar. Set this property to override the pane that should control the toolbar. | |
CssClass | The CssClass to use for the top level div on this page. | |
DeleteQueryParams | Query parameters to be added to the post-delete URL if and only if the DeleteTarget is set for this page. | |
DeleteTarget | The MOP that specifies the navigation target following a delete from a detail record. Overrides the corresponding application property. | |
Description | The page description. Depending on the page type, this may or may not be displayed in an information section of the page. | |
DetailLayout | The layout for a detail control. | |
DetailTarget | The MOP that specifies the detail to navigate to during a drilldown. If none is specified the default is [module]!detail. | |
DisplayAttributes | Attributes that control the display of the page. See PageDisplayAttrs | |
DrilldownAttrs | Attributes to customize the behavior of the drilldown from a list view See DrilldownAttrs | |
DrilldownKey | The field to use as the PK in a drilldown to detail navigation. | |
DrilldownViewKey | The field in the drilldown target corrseponding to the DrilldownKey in this page. If omitted, the drilldown target's PK is assumed. | |
Flavor | The flavor to use on the page's mapper See Flavors | |
Height | Typically page height is determined automatically, but set this pixel height to force a specific height. | |
HelpTopic | If a help link is to be made available, the url topic parameters to be appended to the HelpRootURL. | |
ListCellPadding | The padding for cells in the datasheet | |
ListFontSize | The default font size, in points, to use in lists. | |
ListItemHeight | The height of a row in the datasheet. | |
NavPageTemplate_aspx_Navigator | The top-level navigator to use for the NavPageTemplate | |
NewTarget | The MOP that specifies the detail to navigate to for New records. If none is specified the default is [module]!detail. | |
Package | The package to use for permissions. | |
PageCommands | The navigator to use for page Commands. | |
PageFilter | Filter to apply to the page's Mapper | |
PageGrouping | Grouping to apply to the page's Mapper. Note that this property overrides the DefaultGrouping property on the mapper. | |
PageSet | Assigns the page into a page set which share certain user preference settings. | |
PageSort | Sort to apply to the page's Mapper. Note that this property overrides the DefaultSort property on the mapper. | |
PageView | Override view name to use for the mapper. | |
PerformanceMonitoring | See PerfmonAttrs | |
RecordCountLimit | The default RecordCountLimit for navigators on this page. | |
RefreshInterval | The refresh interval for this page in seconds. | |
RowsPerPage | The number of rows to display on a page in a datasheet (list) view. Overrides mapper setting and can be overridden per NavTarget. | |
SaveQueryParams | Query parameters to be added to the destination SaveTarget upon successful save. | |
SaveTarget | After save, navigate to this page. | |
SearchName | For Global Search, the name to use when searching in this page. | |
SelectedNavTarget | The target to select in the Navigator. | |
Subform | The Subform Navigator to use when rendering this page. | |
TabbedSubformTemplate_aspx_LoadFirstSubformTab | If set to true, the first tab of the TabbedSubformTemplate pages will be automatically displayed. | |
TabOrderAttributes | Specifies how the page's mapper should tab order controls in detail forms. Ignored if the mapper's NoTabOrdering attribute is set. If non-zero, overrides any mapper-level TabOrderAttributes setting. See TabOrderAttrs | |
ToolbarDisplayAttributes | Display flags that control the toolbar. See ToolbarDisplayAttrs | |
Width | Typically page width is determined automatically, but set this pixel width to force a specific width. | |
WizTemplate_aspx_CancelAction | Specifies the type of action to take if the user clicks the wizard cancel button. | |
WizTemplate_aspx_CancelQueryParams | Query parameters to be added to the destination URL if the user clicks the wizard cancel button. | |
WizTemplate_aspx_CancelScript | Script set as Wizard page 'CancelScript' when not specified. | |
WizTemplate_aspx_CancelTarget | The target MOP or URL to which to navigate if the user clicks the wizard cancel button. | |
WizTemplate_aspx_CancelTargetInstance | The element instance of the item to which to navigate if the user clicks the wizard cancel button. | |
WizTemplate_aspx_Finish_Caption | The caption to use on the Finish/Save button on this wizard page. | |
WizTemplate_aspx_FinishAction | Specifies the type of action to take upon successful completion of the wizard. | |
WizTemplate_aspx_FinishQueryParams | Query parameters to be added to the destination URL upon successful completion of the wizard. | |
WizTemplate_aspx_FinishTarget | The target MOP or URL to which to navigate on successful completion of the wizard. | |
WizTemplate_aspx_FinishTargetInstance | The element instance of the item to which to navigate upon successful completion of the wizard. | |
WizTemplate_aspx_NoSaveInstances | A semi-colon-separated list of instances that should NOT be saved. | |
WizTemplate_aspx_PrimaryInstance | Set this property to override the primary instance of the wizard. If not defined, or set incorrectly, the primary instance will be the instance name of the first WizardPage page element. | |
WizTemplate_aspx_PromptCancel | Should the wizard prompt when the cancel button is clicked? | |
WizTemplate_aspx_SummaryFieldList | The semi-colon separated list of mapper field keys of fields to show in the standard primary instance running summary. Standard rules for primary instance running summary fields apply if list is empty. | |
WizTemplate_aspx_SummaryFlags | Options controlling the look and feel of the wizard's running summary. See WizardSummaryFlags | |
WizTemplate_aspx_SummaryHeight | The height of the summary expressed in HTML units. | |
WizTemplate_aspx_SummaryTemplate | Use an HTML template for rendering the primary summary. | |
WizTemplate_aspx_SummaryWidth | The width of the summary expressed in HTML units. | |
WizTemplate_aspx_WizardAttributes | Attributes specifying aspects of behaviour for a wizard. See WizAttrs | |
WizTemplate_aspx_WizardCancelPrompt | If specified, this string will be used to prompt the user to confirm cancellation of the wizard. | |
WizTemplate_aspx_WizardStepList | Semi-colon separated list of wizard steps corresponding to WizardStep items on pages throughout the originating wizard and any chained-to wizards. | |
WizTemplate_aspx_WizardSummaryCaption | Provides the caption for use in the wizard's running summary. |
Note |
---|
This interface is declared for documentation purposes only and is not intended to be used from code. |