Click or drag to resize
CMSEcommerceStoreSettingsPage Class
Base page for the E-commerce store settings pages to apply global settings to the pages.
Inheritance Hierarchy

Namespace: CMS.Ecommerce.Web.UI
Assembly: CMS.Ecommerce.Web.UI (in CMS.Ecommerce.Web.UI.dll) Version: 12.0.0
Syntax
C#
public class CMSEcommerceStoreSettingsPage : CMSEcommerceConfigurationPage, 
	IPostBackEventHandler

The CMSEcommerceStoreSettingsPage type exposes the following members.

Constructors
  NameDescription
Public methodCMSEcommerceStoreSettingsPage
Top
Fields
  NameDescription
Protected fieldmBodyClass
Generic body class - contains the base body CSS class
(Inherited from CMSPage.)
Top
Properties
  NameDescription
Protected propertyAction
Action query parameter value.
(Inherited from CMSDeskPage.)
Public propertyAddBaseTag
Gets or sets the value that indicates whether base tag with target _self should be added to the header
(Inherited from CMSPage.)
Public propertyAfterFormPlaceHolder
Gets placeholder located after form element.
(Inherited from AbstractCMSPage.)
Protected propertyAllowCombineSiteAndGlobal
Indicates if ecommerce object type specified by SiteOrGlobalObjectType property allows using global and site objects on the same site.
(Inherited from CMSEcommerceConfigurationPage.)
Public propertyBodyClass
Body class
(Inherited from CMSPage.)
Public propertyCheckDocPermissions
Indicates if document permissions should be checked during page load.
(Inherited from CMSDeskPage.)
Public propertyCheckHashValidationAttribute
(Inherited from CMSPage.)
Protected propertyConfiguredSiteID
Returns id of the configured site. For global admin with site manager enabled allows to configure global objects on demand (siteId in querystring == 0). In other cases returns 0 (when using global objects) or current site ID (when using site specific configuration).
(Inherited from CMSEcommerceConfigurationPage.)
Public propertyContextMenuContainer
Container control for the context menus.
(Inherited from AbstractCMSPage.)
Public propertyCultureCode
Culture to consider as preferred.
(Inherited from CMSDeskPage.)
Public propertyCurrentMaster
Current CMSMasterPage page
(Inherited from CMSPage.)
Public propertyCurrentSiteName
Current site name
(Inherited from CMSPage.)
Protected propertyCurrentUser
Current user
(Inherited from CMSPage.)
Public propertyCurrentUseXUACompatible
If true, X-UA-Compatible header will be added to the page.
(Inherited from AbstractCMSPage.)
Protected propertyDevice
Device query parameter value.
(Inherited from CMSDeskPage.)
Public propertyDisableAdministrationInterface
If true, the administration interface is disabled
(Inherited from CMSPage.)
Public propertyDocumentID
Gets document ID of current document.
(Inherited from CMSDeskPage.)
Public propertyDocumentManager
Document manager control.
(Inherited from AbstractCMSPage.)
Public propertyEditedObject
Object edited by the current page. If set to NULL, redirects to the information page with information that object has been deleted.
(Inherited from CMSPage.)
Public propertyEditedObjectParent
Parent of object edited by the current page. If set to NULL, redirects to the information page with information that object has been deleted.
(Inherited from CMSPage.)
Protected propertyEnableContextHelp
Tells you whether context help script generation into page is enabled.
(Inherited from AbstractCMSPage.)
Protected propertyEnableSplitMode
Indicates if split mode (side by side comparison) is enabled for this page. Default value is false.
(Inherited from CMSDeskPage.)
Protected propertyEnsureDocumentManager
Indicates if document manager should be ensured
(Inherited from AbstractCMSPage.)
Public propertyEnsurePreferredCulture
Indicates if content preferred culture should be ensured.
(Inherited from AbstractCMSPage.)
Public propertyFooterContainer
Container control for the page footers.
(Inherited from AbstractCMSPage.)
Protected propertyGlobalObjectsKeyName
Settings key name configuring usage of global/site objects.
(Inherited from CMSEcommerceConfigurationPage.)
Public propertyHeaderActions
Local header actions
(Inherited from AbstractCMSPage.)
Protected propertyIsAdmin
Indicates if current user has 'Admin' privilege level.
(Inherited from CMSEcommercePage.)
Public propertyIsCMSDesk
Determines whether the current page is located under the CMS Desk.
(Inherited from AbstractCMSPage.)
Public propertyIsDialog
Indicates whether page is a dialog. False by default.
(Inherited from AbstractCMSPage.)
Protected propertyIsGlobalStoreAdmin
Indicates if current user is allowed to access global (multistore) configuration.
(Inherited from CMSEcommercePage.)
Protected propertyIsMultiStoreConfiguration
Indicates if this configuration page is opened under multistore configuration (i.e. Global Admin requesting global configuration).
(Inherited from CMSEcommerceConfigurationPage.)
Protected propertyIsProductsUI
Identifies if the page is used for products UI
(Inherited from CMSEcommercePage.)
Public propertyIsRootDialog
Indicates whether page is root dialog (top dialog page with header and footer)
(Inherited from AbstractCMSPage.)
Protected propertyIsStandardPage
If true, the page is a UI page
(Inherited from AbstractCMSPage.)
Public propertyLogsContainer
Container control for the log controls.
(Inherited from AbstractCMSPage.)
Public propertyManagersContainer
Container for the page and script managers
(Inherited from CMSPage.)
Public propertyMessagesPlaceHolder
Local page messages placeholder
(Inherited from AbstractCMSPage.)
Protected propertyMode
Mode query parameter value.
(Inherited from CMSDeskPage.)
Public propertyNode
Gets current document.
(Inherited from CMSDeskPage.)
Public propertyNodeID
Gets node ID of current document.
(Inherited from CMSDeskPage.)
Public propertyPageBreadcrumbs
Page title
(Inherited from CMSPage.)
Protected propertyPageStatusContainer
Page status container
(Inherited from CMSPage.)
Public propertyPageTitle
Page title
(Inherited from CMSPage.)
Public propertyPersistentEditedObject
Special property allowing to treat edited object as non-static property Usable when you need to store information about edited object and then after post back reload it based on id and object type
(Inherited from CMSPage.)
Protected propertyRegisterGlobalHotKeyScript
Gets or sets the value that indicates whether global hotkey script should be registered
(Inherited from AbstractCMSPage.)
Protected propertyRegisterPageLoadedScript
Indicates if page loaded script should be registered.
(Inherited from CMSPage.)
Protected propertyRegisterSplitScrollSync
Indicates if scrollbar synchronization script is registered. Default value is true.
(Inherited from CMSDeskPage.)
Public propertyRegisterWOpener
If true, the page registers the wopener JavaScript variable
(Inherited from CMSPage.)
Public propertyRelativePath
Page relative path
(Inherited from CMSPage.)
Public propertyRequiresDialog
Gets or sets the value that indicates whether the page is displayed as dialog.
(Inherited from CMSPage.)
Public propertyRequireSite
If true, current site is required.
(Inherited from CMSDeskPage.)
Public propertyScriptManagerControl
Script manager control.
(Inherited from AbstractCMSPage.)
Protected propertyShowSiteInGrids
Indicates if information that object belongs to specific site or is global will be shown in listings.
(Inherited from CMSEcommerceConfigurationPage.)
Public propertySiteID
Id of the site. Value taken from query string parameter "siteId", or from SiteContext.CurrentSiteID when no SiteId supplied or not an admin. Special values (non-positive) are passed without change.
(Inherited from CMSEcommercePage.)
Protected propertySiteOrGlobalObjectType
Name of ecommerce object type configured on this page.
(Inherited from CMSEcommerceConfigurationPage.)
Protected propertySplitModeAllwaysRefresh
Indicates if split mode frame should be refreshed always on post-back (even for different cultures).
(Inherited from CMSPage.)
Public propertyTabMode
Indicates if the page is in tab mode.
(Inherited from AbstractCMSPage.)
Public propertyTree
Tree provider object.
(Inherited from AbstractCMSPage.)
Public propertyTypeName
Returns the object type name
(Inherited from CMSPage.)
Public propertyUIContext
Page's UI context
(Inherited from AbstractCMSPage.)
Protected propertyUseGlobalObjects
Indicates if current site uses global objects. Type of objects depends on settings key name set in GlobalObjectsKeyName property.
(Inherited from CMSEcommerceConfigurationPage.)
Public propertyUseViewStateUserKey
If true, ViewStateUserKey is used.
(Inherited from AbstractCMSPage.)
Top
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractCMSPage.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractCMSPage.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractCMSPage.)
Public methodAddHeaderActions
Adds the list of header actions to the page header actions.
(Inherited from AbstractCMSPage.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractCMSPage.)
Public methodAddMenuButtonSelectScript(String, String, String)
Adds script for selecting of ecommerce menu button.
(Inherited from CMSDeskPage.)
Public methodAddMessage
Adds text to existing message on the page.
(Inherited from AbstractCMSPage.)
Public methodAddNoCacheTag
Adds the no-cache tag to the page header
(Inherited from CMSPage.)
Public methodAddScript
Adds the script to the page
(Inherited from CMSPage.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractCMSPage.)
Protected methodBasePage_Load
PageLoad event handler
(Inherited from CMSDeskPage.)
Public methodCheckAdministrationInterface
Checks if the administration interface is enabled, if not, redirects to access denied
(Inherited from CMSPage.)
Protected methodCheckConfigurationModification
Checks ecommerce ConfigurationModify and ConfigurationGlobalModify permissions. Redirects to access denied page if check fails.
(Inherited from CMSEcommerceConfigurationPage.)
Protected methodCheckConfigurationModification(Int32)
Checks ecommerce ConfigurationModify and ConfigurationGlobalModify permissions. Redirects to access denied page if check fails.
(Inherited from CMSEcommerceConfigurationPage.)
Protected methodCheckDocumentPermissions
Checks document permissions regarding the document manager mode and optionally redirects to access denied page
(Inherited from CMSDeskPage.)
Protected methodCheckDocumentPermissions(PermissionsEnum)
Checks currently edited document permissions and optionally redirects to access denied page
(Inherited from CMSDeskPage.)
Protected methodCheckEditedObjectSiteID
Checks if site id of edited object corresponds to configured site. If it does not, user is redirected to 'Object doesn't exist' page. Check is skipped for global objects when allowed by setting or when edited under multistore configuration.
(Inherited from CMSEcommerceConfigurationPage.)
Public methodCheckEditor
Checks whether the user is an editor
(Inherited from CMSPage.)
Public methodCheckGlobalAdministrator
Checks whether user is global administrator with access to all applications User without global access is redirected to access denied page.
(Inherited from CMSPage.)
Public methodCheckLicense
Checks the license for the given feature. Redirects to feature not available if not available.
(Inherited from CMSPage.)
Protected methodCheckMainCurrency
Checks if the site specified by the site ID has a main currency defined. Returns true if the main currency is defined, otherwise returns false and shows warning on the page.
(Inherited from CMSEcommercePage.)
Public methodCheckPermissions
Checks the security of the permissions, returns true if the security check succeeded
(Inherited from CMSPage.)
Protected methodCheckPermissionsAndSave
Check whether the user is authorized to modify configuration and returns true if so. This method needs to be overridden to save store settings.
Protected methodCheckProductModifyAndRedirect
Checks permissions to modify given product and redirect to access denied page when not passed. Returns true if current user is authorized to modify given product;
(Inherited from CMSEcommercePage.)
Public methodCheckResourceSite
Checks the security of the resource, returns true if the module is assigned to the site
(Inherited from CMSPage.)
Public methodCheckSite
Checks if current site is valid. Redirects to invalid web site if not.
(Inherited from CMSPage.)
Public methodCheckUIElements
Checks the security of the UI elements, returns true if the security check succeeded
(Inherited from CMSPage.)
Protected methodCMSDeskPage_Init
Handles the Init event of the CMSDeskPage control.
(Inherited from CMSDeskPage.)
Protected methodCreateDocumentManager
Creates a document manager for this page.
(Inherited from AbstractCMSPage.)
Public methodDisableDebugging
Disables all debugging for current page
(Inherited from CMSPage.)
Protected methodEnsureDocumentBreadcrumbs
Ensures current document breadcrumbs (non-clickable)
(Inherited from CMSDeskPage.)
Public methodEnsureFootersControl
Ensures the page footer control.
(Inherited from AbstractCMSPage.)
Public methodEnsureScriptManager
Ensures the script manager on the page.
(Inherited from CMSPage.)
Protected methodEnsureSplitMode
Ensures split mode.
(Inherited from CMSDeskPage.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractCMSPage.)
Public methodEvalReturnType(String)
Templated Eval, returns the value converted to specific type.
(Inherited from AbstractCMSPage.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractCMSPage.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractCMSPage.)
Public methodEvalDecimal
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractCMSPage.)
Public methodEvalDouble
Evaluates the item data and converts it to the double.
(Inherited from AbstractCMSPage.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractCMSPage.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractCMSPage.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractCMSPage.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractCMSPage.)
Public methodEvalText
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractCMSPage.)
Protected methodGetDocumentManagerContainer
Gets control ideal for containing document manager.
(Inherited from AbstractCMSPage.)
Protected methodGetGridRememberStateParam
Returns string param according IsMultiStoreConfiguration for Unigrid. Assign the returned value to RememberStateByParam to handle different filter states for Store and MultiStore configuration listings.
(Inherited from CMSEcommerceConfigurationPage.)
Public methodGetImageUrl
Gets UI image URL.
(Inherited from AbstractCMSPage.)
Protected methodHandleGlobalObjectInformation
Checks and displays info message stating that current site uses global objects of given type if used.
(Inherited from CMSEcommerceConfigurationPage.)
Protected methodHandleGridsSiteIDColumn
Shows/hides column with SiteID in given unigrid according allow global XXX setting accessible via AllowGlobalObjects property.
(Inherited from CMSEcommercePage.)
Public methodInitDebug
Initializes the debug controls.
(Inherited from AbstractCMSPage.)
Protected methodInitSiteWhereCondition
Creates where condition for UniGrid according object site separability settings.
(Inherited from CMSEcommerceConfigurationPage.)
Public methodInitTabs(String)
Initializes the array for the tabs data
(Inherited from CMSPage.)
Public methodInitTabs(String, String, String)
Initializes the array for the tabs data
(Inherited from CMSPage.)
Protected methodLoadContextHelp
Loads application description and help topics with respect to current UI context. Does nothing when context help not enabled or not on standard page.
(Inherited from AbstractCMSPage.)
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractCMSPage.)
Public methodLogAndShowError
Logs the exception and displays a general error message
(Inherited from AbstractCMSPage.)
Protected methodOnInit
Page OnInit event.
(Inherited from CMSEcommerceConfigurationPage.)
Protected methodOnLoad
Load event handler
(Inherited from CMSPage.)
Protected methodOnPreInit
Page PreInit event.
(Inherited from CMSEcommercePage.)
Protected methodOnPreRender
PreRender event handler
(Inherited from CMSPage.)
Protected methodOnPreRenderComplete
Raises the PreRenderComplete event after the OnPreRenderComplete event and before the page is rendered.
(Inherited from AbstractCMSPage.)
Public methodRaiseCheckTabSecurity
Raises OnCheckTabSecurity event.
(Inherited from CMSPage.)
Public methodRaisePostBackEvent
Handles postback event with argument "save". Permissions are checked and method SaveChanges() is called as reaction.
Public methodRaiseTabCreated
Raises OnTabCreated event.
(Inherited from CMSPage.)
Protected methodRedirectToNewCultureVersionPage
Redirects to new document language version page.
(Inherited from CMSDeskPage.)
Public methodRegisterBodyModifyingScript
Registers script that modified body element. (For IE7,8 compatibility reasons. See KB927917 for more information.)
(Inherited from AbstractCMSPage.)
Protected methodRegisterContextHelpScript
Registers script which passes application description and help topics to UI. If applicationName is null or empty, no application context is assumed (and applicationDescriptionUrl, applicationHelpTopics is not used).
(Inherited from AbstractCMSPage.)
Public methodRegisterDialogCSSLink
Registers CSS file for dialogs
(Inherited from CMSPage.)
Protected methodRegisterDialogHandlingScripts
Registers script for centralized dialog closing. (Contains functionality for refreshing opener window.)
(Inherited from CMSPage.)
Public methodRegisterEscScript
Registers the script to handle the close window operation on ESC key
(Inherited from CMSPage.)
Public methodRegisterExportScript
Registers the object export function
(Inherited from CMSPage.)
Public methodRegisterModalDialogScript
Registers the model dialog script
(Inherited from CMSPage.)
Protected methodRegisterModalPageScripts
Register wopener script and base target tag and resizable frameset for this page
(Inherited from CMSPage.)
Protected methodRegisterSplitModeSync(Boolean, Boolean)
Registers js script for synchronization scroll bars in split mode.
(Inherited from CMSPage.)
Protected methodRegisterSplitModeSync(Boolean, Boolean, Boolean)
Registers java script for synchronization scroll bars in split mode.
(Inherited from CMSPage.)
Public methodRegisterTooltipScript
Registers the tooltip script
(Inherited from CMSPage.)
Protected methodRender
Render event handler
(Inherited from CMSPage.)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractCMSPage.)
Protected methodSaveChanges
Override this method to handle saving of store settings.
Public methodSetAction
Sets the particular action data.
(Inherited from CMSPage.)
Public methodSetBreadcrumb
Sets the particular Breadcrumb data
(Inherited from CMSPage.)
Public methodSetBrowserClass
Sets the browser class to the body class
(Inherited from CMSPage.)
Protected methodSetCulture
Sets current UI culture
(Inherited from CMSPage.)
Public methodSetEditedObject
Set edited object and ensure redirection to frame set if necessary
(Inherited from CMSPage.)
Protected methodSetFormAction
Sets the form action for current page if was rewritten by URL rewriter
(Inherited from AbstractCMSPage.)
Public methodSetHelp
Sets the page title
(Inherited from CMSPage.)
Protected methodSetLiveCulture
Sets current UI culture for live site
(Inherited from CMSPage.)
Public methodSetLiveDialogClass
Sets the live site dialog body class.
(Inherited from CMSPage.)
Public methodSetLiveRTL
Sets the RTL culture for live site to the body class if RTL language
(Inherited from CMSPage.)
Public methodSetRTL
Sets the RTL culture to the body class if RTL language
(Inherited from CMSPage.)
Public methodSetTab(UITabItem)
Sets the tab.
(Inherited from CMSPage.)
Public methodSetTab(Int32, String, String, String)
Sets the particular tab.
(Inherited from CMSPage.)
Public methodSetTitle
Sets the page title
(Inherited from CMSPage.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractCMSPage.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractCMSPage.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractCMSPage.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractCMSPage.)
Public methodShowMessage
Shows the specified message, optionally with a tooltip text and description.
(Inherited from AbstractCMSPage.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractCMSPage.)
Protected methodStoreSettingsActions_ActionPerformed
Handles default actions performed on the master header (Save changes action).
Protected methodValidateHash
Checks if the user is global administrator (can access the administration (development) page, or a hash is valid)
(Inherited from CMSPage.)
Top
Extension Methods
  NameDescription
Public Extension MethodAddToHeader
Adds the given HTML code to the header of the page.
(Defined by PageExtensions.)
Public Extension MethodCallHandled
Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Public Extension MethodLoadUserControl
Loads the user control based on the given path
(Defined by ControlsExtensions.)
Top
Events
  NameDescription
Public eventOnCheckTabSecurity
Check security event.
(Inherited from CMSPage.)
Public eventOnTabCreated
Tab creation event.
(Inherited from CMSPage.)
Top
See Also