ViewShortcut Class

Supplies key information on a View.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v18.2.dll

Declaration

public class ViewShortcut :
    LightDictionary<string, string>,
    IEnumerable<string>,
    IDictionary<string, string>,
    ICollection<KeyValuePair<string, string>>,
    IEnumerable<KeyValuePair<string, string>>,
    IEnumerable
Public Class ViewShortcut
    Inherits LightDictionary(Of String, String)
    Implements IEnumerable(Of String),
               IDictionary(Of String, String),
               ICollection(Of KeyValuePair(Of String, String)),
               IEnumerable(Of KeyValuePair(Of String, String)),
               IEnumerable

A View Shortcut is a dictionary containing key/value pairs describing a View. Each key names a parameter describing a View, and has the associated value. For example, by default, a View Shortcut contains a key corresponding to the View identifier, the type of the object(s) displayed by the View, the key property value of the object displayed by the View and so on. This information is used to recreate a particular View in the future.

To create a View Shortcut, use the View.CreateShortcut method. To recreate a View based on the information provided by the View Shortcut, use the XafApplication.ProcessShortcut method. You can add custom key/value pairs to View Shortcuts when they are created, by handling the View.CustomizeViewShortcut event. However, generally, you should not modify values corresponding to keys already existing in just created View Shortcuts, as this information is used by XAF to support various built-in functionalities, and you can easily break it. To process custom key/value pairs when a View is recreated via the ProcessShortcut method, handle the XafApplication.CustomProcessShortcut event.

The following help topic contains examples of using View Shortcuts.

Inheritance

Object
DevExpress.ExpressApp.Utils.LightDictionary<String, String>
ViewShortcut

See Also