Tab
A newer version of this page is available. Switch to the current version.

ASPxRibbon.SaveStateToCookiesID Property

Gets or sets the name (identifier) of the cookie in which the ribbon's state is persisted.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v18.2.dll

Declaration

[DefaultValue("")]
public string SaveStateToCookiesID { get; set; }
<DefaultValue("")>
Public Property SaveStateToCookiesID As String

Property Value

Type Default Description
String

String.Empty

A string value specifying a cookie's name.

Remarks

This property is in effect if the ASPxRibbon.SaveStateToCookies property is set to true.

The SaveStateToCookiesID property allows you to control the manner in which the ribbon control's state information is persisted in cookies. If this property is set to an empty string (the default value), the name of the cookie which will store the control's state is composed automatically based upon the page name and the ribbon control's identifier. In this case, such a cookie is tightly linked with the requested page and the corresponding ribbon control. In some cases, however, it may be required that a ribbon control's state information can be shared between different requested pages, for instance, when a control is placed on a master page and its state needs to be kept while displaying different content pages. In this case, you can assign any specific identification name to the SaveStateToCookiesID property and if this name is independent from the page name and the ribbon control's identifier, the state information stored by the cookie can be applied to all the ribbon controls (on all the web pages) whose SaveStateToCookiesID property is set to the same value.

NOTE

Refer to the RFC 2965 - Section 4.1.1 Syntax document to learn about allowed characters in cookies.

See Also