The Settings type exposes the following members.
Constructors
Methods
| Name | Description | |
|---|---|---|
| DeserializeElement |
Reads XML from the configuration file.
(Inherited from ConfigurationElement.) | |
| Equals |
Compares the current ConfigurationElement instance to the specified object.
(Inherited from ConfigurationElement.) | |
| Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| GetHashCode |
Gets a unique value representing the current ConfigurationElement instance.
(Inherited from ConfigurationElement.) | |
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) | |
| Init |
Sets the ConfigurationElement object to its initial state.
(Inherited from ConfigurationElement.) | |
| InitializeAllSettings | Overloaded. | |
| InitializeDefault |
Used to initialize a default set of values for the ConfigurationElement object.
(Inherited from ConfigurationElement.) | |
| IsModified |
Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class.
(Inherited from ConfigurationElement.) | |
| IsReadOnly |
Gets a value indicating whether the ConfigurationElement object is read-only.
(Inherited from ConfigurationElement.) | |
| ListErrors |
Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list.
(Inherited from ConfigurationElement.) | |
| MapHostToSettings |
Maps a host name to a Settings instance.
| |
| MapUrlToSettings |
Maps url to a Settings instance.
| |
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| OnDeserializeUnrecognizedAttribute |
Gets a value indicating whether an unknown attribute is encountered during deserialization.
(Inherited from ConfigurationElement.) | |
| OnDeserializeUnrecognizedElement |
Gets a value indicating whether an unknown element is encountered during deserialization.
(Inherited from ConfigurationElement.) | |
| OnRequiredPropertyNotFound |
Throws an exception when a required property is not found.
(Inherited from ConfigurationElement.) | |
| PostDeserialize |
Called after deserialization.
(Inherited from ConfigurationElement.) | |
| PreSerialize |
Called before serialization.
(Inherited from ConfigurationElement.) | |
| Reset |
Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.
(Inherited from ConfigurationElement.) | |
| ResetModified |
Resets the value of the IsModified()()() method to false when implemented in a derived class.
(Inherited from ConfigurationElement.) | |
| Save |
Save method for the web.config file
| |
| SerializeElement |
Writes the contents of this configuration element to the configuration file when implemented in a derived class.
(Inherited from ConfigurationElement.) | |
| SerializeToXmlElement |
Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.
(Inherited from ConfigurationElement.) | |
| SetPropertyValue |
Sets a property to the specified value.
(Inherited from ConfigurationElement.) | |
| SetReadOnly |
Sets the IsReadOnly()()() property for the ConfigurationElement object and all subelements.
(Inherited from ConfigurationElement.) | |
| ToString | (Inherited from Object.) | |
| Unmerge |
Modifies the ConfigurationElement object to remove all values that should not be saved.
(Inherited from ConfigurationElement.) | |
| ValidateRuntimeSettings |
Validates all settings consistency and with the runtime.
|
Properties
| Name | Description | |
|---|---|---|
| All |
Gets a Dictionary containing all Settings instances
in the application's configuration file. The Dictionary uses the site-tags' applicationId attribute as keys.
| |
| CategoryId |
Defines ID for the root Category
| |
| ConnectionStringName |
Gets or sets the name of the connection string.
| |
| DatabaseQueryTimeout |
Gets or sets the database query timeout.
| |
| DeadlockRetries |
Gets or sets the number of retry attempts when a database deadlock occurs.
| |
| DeadlockRetryDelay |
Gets or sets the deadlock retry delay.
| |
| ElementInformation |
Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object.
(Inherited from ConfigurationElement.) | |
| ElementName |
Element name
(Inherited from ConfigurationElementBase.) | |
| ElementProperty |
Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.
(Inherited from ConfigurationElement.) | |
| EnableEvents |
Gets or sets a value indicating whether event is enabled.
| |
| EnableRemoteEvents |
Gets or sets a value indicating whether remote event is enabled.
| |
| EnableScheduler |
Set to true to disable EPiServer's connection with the scheduler. Default value (if the tag does not exist) is true.
| |
| EnableXmlRpcHeader |
Defines whether xmlrpc headers should be added to page output.
| |
| ErrorMailHandler |
Gets or sets the error mail handler.
| |
| EvaluationContext |
Gets the ContextInformation object for the ConfigurationElement object.
(Inherited from ConfigurationElement.) | |
| GlobalErrorHandling |
Set whether you want to use EPiServer's error handling.
| |
| GlobalErrorMail |
E-mail address that error messages should be sent to
| |
| HttpCacheability |
Value to set the HttpCacheability enumeration for the cach.
| |
| HttpCacheExpiration |
Value to set the number of seconds a page should be cached.
| |
| HttpCacheVaryByCustom |
Specifies a custom text string to vary cached output responses by. Passed to Response.Cache.SetVaryByCustom.
| |
| HttpCacheVaryByParams |
The parameters to the page (i.e. querystring) that the cache should vary by. Forwarded to Response.Cache.SetVaryByParams.
| |
| IndexingDelayAfterPublish |
Delay time between publish and indexing
| |
| IndexingTextEnabled |
If indexing of text into keywords should be enabled
| |
| IndexingTextRegExp |
The regular expression to index words in pages
| |
| Instance |
Get the current configuration settings.
| |
| Item | Overloaded. | |
| LockAllAttributesExcept |
Gets the collection of locked attributes.
(Inherited from ConfigurationElement.) | |
| LockAllElementsExcept |
Gets the collection of locked elements.
(Inherited from ConfigurationElement.) | |
| LockAttributes |
Gets the collection of locked attributes
(Inherited from ConfigurationElement.) | |
| LockElements |
Gets the collection of locked elements.
(Inherited from ConfigurationElement.) | |
| LockItem |
Gets or sets a value indicating whether the element is locked.
(Inherited from ConfigurationElement.) | |
| LogServiceUrl |
URL to the log service
| |
| MirroringFileWriteRetryDelay |
Gets or sets the mirroring file write retry delay.
| |
| MirroringHtmlTextEncoding |
Sets which encoding should be used when mirroring to HTML
| |
| MirroringRetries |
Number of retries when a mirroring job fails
| |
| MirroringRetryDelay |
Number of milliseconds until next retry
| |
| OperationCompatibility |
Gets or sets the operation compatibility. by default the value is None.
The operationCompatibility attribute can have None, PageStoreDelete, PageStoreSave or Full value
None: There is no Compatibility at all
PageStoreSave: The save operation on Data factory Component can treat as old version of Data Factory
PageStoreDelete: The Delete operation on Data factory Component can treat as old version of Data Factory
Full: Both Save and Delete operation on Data FActory component treat as old version
| |
| PageCacheSlidingExpiration |
The page cache interval (in hours) for the local database. Set to "0" to disable.
| |
| PageFolderVirtualPathProviderName |
Name for the VirtualPathProvider that is responsible for handling of page folders
| |
| PageOfficeStartId |
Defines from where the Office plug-in should display the site tree
| |
| PageRootId |
ID of the root folder
| |
| PageStartId |
ID of the Web page that serves as the start page for the site.
| |
| PageUseBrowserLanguagePreferences |
Determines if the browser language should define which language is used
| |
| PageValidateTemplate |
Sets if the current template has to match the page type template
| |
| PageWastebasketId |
ID of the Recycle Bin.
| |
| Parent |
Gets or sets the parent.
| |
| Properties |
Gets the collection of properties.
(Inherited from ConfigurationElement.) | |
| RemoteCacheListenerShortNames |
A list of remote sites that will recieve notifications when a change is made
| |
| RemotePageCacheSlidingExpiration |
The page cache intervals (in hours) for remote sites. Set to "0" to disable.
| |
| RemoteWebServiceCulture |
Set the System.Threading.Thread.CurrentThread.CurrentCulture if handling pages remote
| |
| SgmlParserDecodeCharEntities |
Defines whether SgmlParser should decode character entitities (like " ") or not.
| |
| SiteDisplayName |
The name of the site. RegExp Pattern for validation: "^([a-zA-Z0-9\.-]{0,256})$".
| |
| SiteShortName | Obsolete.
The site name that is used when communicating with other EPiServer sites.
RegExp Pattern for validation: "^([a-zA-Z0-9\.-]{0,256})$".
| |
| SiteUrl |
Gets or sets the site URL. It must be a Web URL, and include the path to the site root. It is only to be used
to generate direct references to the site in external locations. For references from a page, use root-relative
URLs and ResolveUrl etc as appropriate.
| |
| StringCompressionThreshold |
Set to the number of characters when compression should be activated.
| |
| StringDelayedLoadThreshold |
The number of characters when delayed loading should be activated for large strings in properties deriving from Long String.
| |
| SubscriptionHandler |
Defines which class should handle mail
| |
| UIDefaultPanelTab |
The index of the EditPanel tab that is to be shown by default when clicking a page in the editmode pagetree.
| |
| UIEditorColors |
Defines what colors should be available for the editors
| |
| UIEditorCssPaths |
Defines which css file to use when rendering the editor. Reg exp pattern
for validation is "^/[\w/\.-]{1,256}".
| |
| UIEditorHeight |
Defines the height of the editor in edit mode
| |
| UIEditorUnformattingPersistedTags |
Controls which html tags that should not be preserved in "Remove format" action in editor.
| |
| UIEditorValueOptions |
Setting for use of DIV tags or P tags
| |
| UIEditorWidth |
Defines the width of the editor in edit mode
| |
| UIImageTransparencyReplacement |
The color that should replace the transparent color in a picture compression
| |
| UIKeepUserLoggedOn |
Sets if the current windows authenticated user must reauthenticate after
session timeout.
| |
| UIMaxVersions |
The maximum number of page versions that EPiServer will retain.
| |
| UIOptimizeTreeForSpeed |
Sets if page tree controls should evaluate if tree nodes have children.
| |
| UISafeHtmlTags |
Set which tags should not be encoded
| |
| UIShowGlobalizationUserInterface |
Defines if the globalization module should be used
| |
| UITheme |
Setting for what graphical theme should be used.
| |
| UIUrl |
Gets or sets the URL to the relocateable UI folder. It must be a Web URL, and may include scheme and port.
It must be a Web URL, and include the path to the site root. It is only to be used
to generate direct references to the site in external locations. For references from a page, use root-relative
URLs and ResolveUrl etc as appropriate.
| |
| UIVersionMerging |
Gets or sets if information on a page should be merged if it has been published while being edited.
| |
| UrlPreventRewriteAttrebute |
Defines an extension that is mapped to ASP.NET for the URL
| |
| UrlRebaseKind |
Defines the type of rebasing to do for links when using Friendly URLs
| |
| UrlRewriteExtension |
Defines an extension that is mapped to ASP.NET for the URL
| |
| UtilUrl |
Gets or sets the URL to the relocateable Util folder. It must be a Web URL, and may include scheme and port.
It must be a Web URL, and include the path to the site root. It is only to be used
to generate direct references to the site in external locations. For references from a page, use root-relative
URLs and ResolveUrl etc as appropriate.
| |
| WCFConfigFilePath | ||
| Version |
Gets the version of this configuration.
|