945 lines
39 KiB
XML
945 lines
39 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>DevExpress.ExpressApp.ViewVariantsModule.v17.2</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:DevExpress.ExpressApp.ViewVariantsModule.IModelNavigationItemsVariantSettings">
|
|
|
|
<summary>
|
|
<para>Used to extend the Application Model's NavigationItems node with properties specific to the View Variants Module functionality.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.IModelNavigationItemsVariantSettings.GenerateRelatedViewVariantsGroup">
|
|
<summary>
|
|
<para>Specifies whether context navigation is enabled for the View Variants module.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if the context navigation is enabled for the View Variants module; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.IModelNavigationItemsVariantSettings.RelatedViewVariantsGroupCaption">
|
|
<summary>
|
|
<para>Specifies the caption for the navigation items generated by the View Variants module, when context navigation is enabled.
|
|
</para>
|
|
</summary>
|
|
<value>A string specifying the caption for the navigation items generated by the View Variants module, when context navigation is enabled.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.ExpressApp.ViewVariantsModule.IModelVariant">
|
|
|
|
<summary>
|
|
<para>A Variant node defines an item of the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.ChangeVariantAction"/> action. Each item represents a View variant available for a varied View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.IModelVariant.Caption">
|
|
<summary>
|
|
<para>Specifies the caption of a View variant.
|
|
</para>
|
|
</summary>
|
|
<value>A string representing the caption of a View variant.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.IModelVariant.Id">
|
|
<summary>
|
|
<para>Specifies the identifier of a View variant.
|
|
</para>
|
|
</summary>
|
|
<value>A string representing the identifier of a View variant.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.IModelVariant.View">
|
|
<summary>
|
|
<para>Represents the node of the View to be displayed when selecting a View variant.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.ExpressApp.Model.IModelView"/> node representing the View to be displayed when selecting a View variant.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.IModelVariant.Views">
|
|
<summary>
|
|
<para>Represents the list of possible <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.IModelVariant.View"/> values.
|
|
</para>
|
|
</summary>
|
|
<value>An <b>IModelList<IModelView></b> object representing a list of available views.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.ExpressApp.ViewVariantsModule.IModelVariants">
|
|
|
|
<summary>
|
|
<para>The Variants node provides access to the varied Views declared for a particular view.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.IModelVariants.Current">
|
|
<summary>
|
|
<para>Specifies a node of the currently selected View variant.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.IModelVariant"/> object representing the node of the currently selected View variant.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.ExpressApp.ViewVariantsModule.IModelViewVariants">
|
|
|
|
<summary>
|
|
<para>Used to extend the Application Model's View nodes with properties specific to the View Variants Module functionality.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.IModelViewVariants.Variants">
|
|
<summary>
|
|
<para>Provides access to the Variants node.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.IModelVariants"/> object representing the Variants node.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo">
|
|
|
|
<summary>
|
|
<para>Represents a View variant.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo.#ctor(System.String,System.String,System.String)">
|
|
<summary>
|
|
<para>Initializes a new instance of the VariantInfo class.
|
|
</para>
|
|
</summary>
|
|
<param name="id">
|
|
A string representing the View variant identifier.
|
|
|
|
</param>
|
|
<param name="viewId">
|
|
A string representing the identifier of a View displayed when selecting the variant.
|
|
|
|
</param>
|
|
<param name="caption">
|
|
A string representing the View variant caption.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo.Caption">
|
|
<summary>
|
|
<para>Specifies the caption of the View variant.
|
|
</para>
|
|
</summary>
|
|
<returns>A string holding the caption of the View variant.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo.Id">
|
|
<summary>
|
|
<para>Specifies the identifier of the View variant.
|
|
</para>
|
|
</summary>
|
|
<returns>A string representing the identifier of the View variant.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo.ViewID">
|
|
<summary>
|
|
<para>Specifies the identifier of the View displayed when selecting the variant.
|
|
</para>
|
|
</summary>
|
|
<returns>
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo">
|
|
|
|
<summary>
|
|
<para>Represents a set of variants available for the View.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo.#ctor(System.String,System.String,System.Collections.Generic.IList`1)">
|
|
<summary>
|
|
<para>Initializes a new instance of the VariantsInfo class.
|
|
|
|
</para>
|
|
</summary>
|
|
<param name="rootViewId">
|
|
A string representing the identifier of the View with variants available.
|
|
|
|
</param>
|
|
<param name="currentVariantId">
|
|
A string representing the currently selected variant identifier.
|
|
|
|
</param>
|
|
<param name="items">
|
|
An indexed collection of <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo"/> objects representing the available variants set.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo.CurrentVariantId">
|
|
<summary>
|
|
<para>Specifies the identifier of the currently selected View variant.
|
|
</para>
|
|
</summary>
|
|
<value>A string representing the identifier of the currently selected View variant.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo.FindById(System.String)">
|
|
<summary>
|
|
<para>Returns a <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo"/> object having the specified <see cref="F:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo.Id"/> identifier.
|
|
</para>
|
|
</summary>
|
|
<param name="id">
|
|
A string representing the identifier of the required View variant.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo"/> object having the specified <see cref="F:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo.Id"/> identifier.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo.GetCurrentVariantInfo">
|
|
<summary>
|
|
<para>Returns the currently selected View variant.
|
|
</para>
|
|
</summary>
|
|
<returns>A <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo"/> object representing the currently selected View variant. If no variant was selected, the first item of the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo.Items"/> collection is returned.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo.Items">
|
|
<summary>
|
|
<para>Gets a collection of <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo"/> objects representing the available View variants.
|
|
</para>
|
|
</summary>
|
|
<value>A read-only collection of <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo"/> objects representing the available View variants.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo.RootViewId">
|
|
<summary>
|
|
<para>Gets the identifier of the varied View having the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo.Items"/> as View variants.
|
|
</para>
|
|
</summary>
|
|
<value>A string representing the identifier of the varied View having the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo.Items"/> as View variants.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo.TryGetItem(System.String,DevExpress.ExpressApp.ViewVariantsModule.VariantInfo@)">
|
|
<summary>
|
|
<para>Returns a <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo"/> object having the specified <see cref="F:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo.Id"/> identifier via the <i>result</i> parameter.
|
|
</para>
|
|
</summary>
|
|
<param name="id">
|
|
A string representing the identifier of the required view variant.
|
|
|
|
</param>
|
|
<param name="result">
|
|
A <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo"/> object having the specified <see cref="F:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo.Id"/> identifier.
|
|
|
|
</param>
|
|
<returns><b>true</b>, if the required view variant is found; otherwise - <b>false</b>.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController">
|
|
|
|
<summary>
|
|
<para>Represents a <see cref="T:DevExpress.ExpressApp.ViewController"/> descendant that contains the <b>ChangeVariant</b> Action.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.#ctor">
|
|
<summary>
|
|
<para>Initializes a new instance of the ChangeVariantController class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.AllowChangeVariantWhenObjectSpaceIsModified">
|
|
<summary>
|
|
<para>Indicates whether the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.ChangeVariantAction"/> is enabled when the Object Space is modified.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if the <b>ChangeVariantAction</b> is enabled when the Object Space is modified; otherwize - <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.ChangeVariantAction">
|
|
<summary>
|
|
<para>Gets a <see cref="T:DevExpress.ExpressApp.Actions.SingleChoiceAction"/> used to change View variants.
|
|
</para>
|
|
</summary>
|
|
<value> A <see cref="T:DevExpress.ExpressApp.Actions.SingleChoiceAction"/> object representing the Action used to change View variants.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.ChangeVariantActionId">
|
|
<summary>
|
|
<para>Gets a string representing the identifier of the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.ChangeVariantAction"/>.
|
|
</para>
|
|
</summary>
|
|
<returns>
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.ChangeVariantActionRefreshed">
|
|
<summary>
|
|
<para>Occurs when the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.ChangeVariantAction"/> items list is refreshed via the <see cref="M:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.RefreshChangeVariantAction"/> method.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.CurrentFrameViewVariantsManager">
|
|
<summary>
|
|
<para>Specifies the <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.ICurrentFrameViewVariantsManager"/> object that provides available View Variants and changes the View of the current <see cref="T:DevExpress.ExpressApp.Frame"/>.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.ICurrentFrameViewVariantsManager"/> object that provides available View Variants and changes the View of the current <see cref="T:DevExpress.ExpressApp.Frame"/>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.DefaultVariantId">
|
|
<summary>
|
|
<para>Gets the identifier of the automatically generated default variant.
|
|
</para>
|
|
</summary>
|
|
<returns> </returns>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.HasVariantsManagerChangeVariantActionActiveKey">
|
|
<summary>
|
|
<para>Specifies the name of the key that is added to the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.ChangeVariantAction"/> Action's <see cref="P:DevExpress.ExpressApp.Actions.ActionBase.Active"/> collection to indicate that the Action should be inactive when the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.CurrentFrameViewVariantsManager"/> property is <i>null</i>.
|
|
</para>
|
|
</summary>
|
|
<returns> </returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.IsCurrentFrameViewVariantsManagerOwner">
|
|
<summary>
|
|
<para>Specifies whether or not the object referenced by the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.CurrentFrameViewVariantsManager"/> property is to be disposed when another value is assigned.
|
|
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, when the object referenced by the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.CurrentFrameViewVariantsManager"/> property is to be disposed when another object is assigned; otherwise - <b>false</b>.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="F:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.NotModifiedEnabledKey">
|
|
<summary>
|
|
<para>An <see cref="P:DevExpress.ExpressApp.Actions.ActionBase.Enabled"/> property's key name. This key indicates that the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.ChangeVariantAction"/> should be enabled or disabled due to the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.AllowChangeVariantWhenObjectSpaceIsModified"/> and <see cref="P:DevExpress.ExpressApp.BaseObjectSpace.IsModified"/> values.
|
|
|
|
</para>
|
|
</summary>
|
|
<returns> </returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.RefreshAllowChangeVariantWhenObjectSpaceIsModified(System.Type)">
|
|
<summary>
|
|
<para>For internal use.
|
|
</para>
|
|
</summary>
|
|
<param name="applicationType">
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.RefreshChangeVariantAction">
|
|
<summary>
|
|
<para>Refreshes the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.ChangeVariantController.ChangeVariantAction"/> items list.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.ExpressApp.ViewVariantsModule.FrameVariantsEngine">
|
|
|
|
<summary>
|
|
<para>Provides methods to manage View Variants.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.FrameVariantsEngine.#ctor(DevExpress.ExpressApp.ViewVariantsModule.IVariantsProvider,DevExpress.ExpressApp.ViewVariantsModule.IViewsFactory)">
|
|
<summary>
|
|
<para>Initializes a new instance of the FrameVariantsEngine class.
|
|
</para>
|
|
</summary>
|
|
<param name="variantsProvider">
|
|
A <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.IVariantsProvider"/> object that provides a list of view variants available for the specific View, and stores the variant selected by a user.
|
|
|
|
|
|
</param>
|
|
<param name="viewsFactory">
|
|
An <b>IViewsFactory</b> object used to create Views.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.FrameVariantsEngine.ChangeFrameViewToVariant(DevExpress.ExpressApp.Frame,DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo,DevExpress.ExpressApp.ViewVariantsModule.VariantInfo)">
|
|
<summary>
|
|
<para>Changes the view variant.
|
|
</para>
|
|
</summary>
|
|
<param name="frame">
|
|
A <see cref="T:DevExpress.ExpressApp.Frame"/> object.
|
|
|
|
</param>
|
|
<param name="variantsInfo">
|
|
A <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo"/> object that specifies a set of available view variants.
|
|
|
|
</param>
|
|
<param name="variantInfo">
|
|
A <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo"/> object that specifies the new view variant.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.FrameVariantsEngine.Dispose">
|
|
<summary>
|
|
<para>Disposes the FrameVariantsEngine object.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.FrameVariantsEngine.GetVariants(DevExpress.ExpressApp.View)">
|
|
<summary>
|
|
<para>Returns a set of view variants available for the specific View.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.ExpressApp.View"/> object.
|
|
|
|
</param>
|
|
<returns>An <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo"/> object that contains a list of view variants.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.FrameVariantsEngine.IsDisposed">
|
|
<summary>
|
|
<para>Gets a value indicating whether the FrameVariantsEngine object is disposed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if the current <b>FrameVariantsEngine</b> is disposed; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.FrameVariantsEngine.RecreateFrameView(DevExpress.ExpressApp.ViewVariantsModule.IViewsFactory,DevExpress.ExpressApp.Frame,System.String)">
|
|
<summary>
|
|
<para>For internal use.
|
|
</para>
|
|
</summary>
|
|
<param name="viewsFactory">
|
|
|
|
|
|
</param>
|
|
<param name="frame">
|
|
|
|
|
|
</param>
|
|
<param name="rootViewId">
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.FrameVariantsEngine.VariantsProvider">
|
|
<summary>
|
|
<para>Gets an object that provides a list of view variants available for the specific View, and stores the variant selected by the user.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.IVariantsProvider"/> object that provides a list of view variants available for the specific View, and stores the variant selected by the user.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.ExpressApp.ViewVariantsModule.IFrameVariantsEngine">
|
|
|
|
<summary>
|
|
<para>Implemented by classes that provide methods to manage View Variants.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.IFrameVariantsEngine.ChangeFrameViewToVariant(DevExpress.ExpressApp.Frame,DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo,DevExpress.ExpressApp.ViewVariantsModule.VariantInfo)">
|
|
<summary>
|
|
<para>Changes the view variant.
|
|
</para>
|
|
</summary>
|
|
<param name="frame">
|
|
A <see cref="T:DevExpress.ExpressApp.Frame"/> object.
|
|
|
|
</param>
|
|
<param name="variantsInfo">
|
|
A <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo"/> object that specifies a set of available view variants.
|
|
|
|
</param>
|
|
<param name="variantInfo">
|
|
A <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo"/> object that specifies the new view variant.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.IFrameVariantsEngine.GetVariants(DevExpress.ExpressApp.View)">
|
|
<summary>
|
|
<para>Returns a set of view variants available for the specific View.
|
|
</para>
|
|
</summary>
|
|
<param name="view">
|
|
A <see cref="T:DevExpress.ExpressApp.View"/> object.
|
|
|
|
</param>
|
|
<returns>An <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo"/> object that contains a list of view variants.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.ExpressApp.ViewVariantsModule.CurrentFrameViewVariantsManager">
|
|
|
|
<summary>
|
|
<para>Manages View Variants in the context of the current <see cref="T:DevExpress.ExpressApp.Frame"/>.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.CurrentFrameViewVariantsManager.#ctor(DevExpress.ExpressApp.Frame,DevExpress.ExpressApp.ViewVariantsModule.IFrameVariantsEngine)">
|
|
<summary>
|
|
<para>Initializes a new instance of the CurrentFrameViewVariantsManager class.
|
|
</para>
|
|
</summary>
|
|
<param name="frame">
|
|
A <see cref="T:DevExpress.ExpressApp.Frame"/> object.
|
|
|
|
</param>
|
|
<param name="variantsManager">
|
|
An <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.IFrameVariantsEngine"/> object.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.CurrentFrameViewVariantsManager.ChangeToVariant(DevExpress.ExpressApp.ViewVariantsModule.VariantInfo)">
|
|
<summary>
|
|
<para>Switches the current View to the specified view variant.
|
|
</para>
|
|
</summary>
|
|
<param name="variantInfo">
|
|
A <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo"/> object that specifies the view variant to which the current View will be switched.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.CurrentFrameViewVariantsManager.Dispose">
|
|
<summary>
|
|
<para>Disposes the CurrentFrameViewVariantsManager object.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.CurrentFrameViewVariantsManager.RefreshVariants">
|
|
<summary>
|
|
<para>Refreshes the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.CurrentFrameViewVariantsManager.Variants"/> list.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.CurrentFrameViewVariantsManager.Variants">
|
|
<summary>
|
|
<para>Gets a list of available View Variants.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo"/> object that provides a list of available View Variants.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.ExpressApp.ViewVariantsModule.CurrentFrameViewVariantsManager.VariantsChanged">
|
|
<summary>
|
|
<para>Occurs when the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.CurrentFrameViewVariantsManager.Variants"/> value is changed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.CurrentFrameViewVariantsManager.VariantsManager">
|
|
<summary>
|
|
<para>Gets the <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.IFrameVariantsEngine"/> object that provides methods to manage view variants.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.IFrameVariantsEngine"/> object that provides methods to manage view variants.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.ExpressApp.ViewVariantsModule.ICurrentFrameViewVariantsManager">
|
|
|
|
<summary>
|
|
<para>Implemented by classes that manage View Variants in the context of the current <see cref="T:DevExpress.ExpressApp.Frame"/>.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.ICurrentFrameViewVariantsManager.ChangeToVariant(DevExpress.ExpressApp.ViewVariantsModule.VariantInfo)">
|
|
<summary>
|
|
<para>Switches the current View to the specified view variant.
|
|
</para>
|
|
</summary>
|
|
<param name="variantInfo">
|
|
A <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantInfo"/> object that specifies the view variant to which the current View will be switched.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.ICurrentFrameViewVariantsManager.RefreshVariants">
|
|
<summary>
|
|
<para>Refreshes the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.ICurrentFrameViewVariantsManager.Variants"/> list.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.ICurrentFrameViewVariantsManager.Variants">
|
|
<summary>
|
|
<para>Gets available View Variants.
|
|
</para>
|
|
</summary>
|
|
<value>A <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo"/> object that provides a list of available View Variants.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.ExpressApp.ViewVariantsModule.ICurrentFrameViewVariantsManager.VariantsChanged">
|
|
<summary>
|
|
<para>Occurs when the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.CurrentFrameViewVariantsManager.Variants"/> value is changed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.ExpressApp.ViewVariantsModule.ModelVariantsProvider">
|
|
|
|
<summary>
|
|
<para>Provide a list of view variants available for the specific View in the <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.IModelVariants"/> Application Model node, and stores the variant selected by the user to the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.IModelVariants.Current"/> property.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.ModelVariantsProvider.#ctor(DevExpress.ExpressApp.Model.IModelApplication)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ModelVariantsProvider class.
|
|
</para>
|
|
</summary>
|
|
<param name="model">
|
|
An <see cref="T:DevExpress.ExpressApp.Model.IModelApplication"/> object that contains the Application Model.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.ModelVariantsProvider.#ctor(DevExpress.ExpressApp.Model.IModelList`1)">
|
|
<summary>
|
|
<para>Initializes a new instance of the ModelVariantsProvider class.
|
|
</para>
|
|
</summary>
|
|
<param name="views">
|
|
An <b>IModelList<</b><see cref="T:DevExpress.ExpressApp.Model.IModelView"/><b>></b> list of View nodes.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.ModelVariantsProvider.AllowSingleVariant">
|
|
<summary>
|
|
<para>Specifies whether of not a single view variant is allowed.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, if a single view variant is allowed; otherwise - <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.ModelVariantsProvider.GenerateDefaultVariant">
|
|
<summary>
|
|
<para>This property is obsolete. Instead, use the approach demonstrated in the How to: Create Additional ListView Nodes in Code using a Generator Updater topic to create a default View Variant.
|
|
</para>
|
|
</summary>
|
|
<value>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.ModelVariantsProvider.GetVariants(System.String)">
|
|
<summary>
|
|
<para>Returns a set of view variants available for the specific root View in the <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.IModelVariants"/> Application Model node. In case there are no view variants, returns <i>null</i> (<i>Nothing</i> in VB).
|
|
</para>
|
|
</summary>
|
|
<param name="rootVariantViewId">
|
|
A string representing the identifier of the varied View having the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo.Items"/> as View variants.
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo"/> object that contains a set of view variants.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.ModelVariantsProvider.SaveCurrentVariantId(System.String,System.String)">
|
|
<summary>
|
|
<para>Saves the identifier of the currently selected View variant to the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.IModelVariants.Current"/> property in the Application Model.
|
|
</para>
|
|
</summary>
|
|
<param name="rootViewId">
|
|
A string representing the identifier of the root varied View.
|
|
|
|
</param>
|
|
<param name="currentVariantId">
|
|
A string representing the identifier of the currently selected View variant.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.ModelVariantsProvider.Views">
|
|
<summary>
|
|
<para>Gets the list of View nodes used by the ModelVariantsProvider.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An <b>IModelList<</b><see cref="T:DevExpress.ExpressApp.Model.IModelView"/><b>></b> list of View nodes.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.ExpressApp.ViewVariantsModule.IVariantsProvider">
|
|
|
|
<summary>
|
|
<para>Implemented by objects that provide a list of view variants available for the specific View, and stores the variant selected by the user.
|
|
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.IVariantsProvider.GetVariants(System.String)">
|
|
<summary>
|
|
<para>Returns a set of view variants available for the specific root View. In case there are no view variants, returns <i>null</i> (<i>Nothing</i> in VB).
|
|
</para>
|
|
</summary>
|
|
<param name="rootVariantViewId">
|
|
A string representing the identifier of the varied View having the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo.Items"/> as View variants.
|
|
|
|
|
|
</param>
|
|
<returns>A <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.VariantsInfo"/> object that contains a set of view variants.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.IVariantsProvider.SaveCurrentVariantId(System.String,System.String)">
|
|
<summary>
|
|
<para>Saves the identifier of the currently selected View variant.
|
|
</para>
|
|
</summary>
|
|
<param name="rootViewId">
|
|
A string representing the identifier of the root varied View.
|
|
|
|
</param>
|
|
<param name="currentVariantId">
|
|
A string representing the identifier of the currently selected View variant.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="T:DevExpress.ExpressApp.ViewVariantsModule.ViewVariantsModule">
|
|
|
|
<summary>
|
|
<para>The module contained in the <i>DevExpress.ExpressApp.ViewVariantsModule.v17.2.dll</i> assembly.
|
|
</para>
|
|
</summary>
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.ViewVariantsModule.#ctor">
|
|
<summary>
|
|
<para>Creates an instance of the ViewVariantsModule class.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.ViewVariantsModule.AddGeneratorUpdaters(DevExpress.ExpressApp.Model.Core.ModelNodesGeneratorUpdaters)">
|
|
<summary>
|
|
<para>Registers the <b>UpdateNavigationItemNodeGenerator</b> and <b>UpdateModelListViewNodesGenerator</b> Generator Updaters.
|
|
</para>
|
|
</summary>
|
|
<param name="updaters">
|
|
A <b>ModelNodesGeneratorUpdaters</b> object providing access to the list of Generator Updaters.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.ViewVariantsModule.ExtendModelInterfaces(DevExpress.ExpressApp.Model.ModelInterfaceExtenders)">
|
|
<summary>
|
|
<para>Extends the Application Model with the <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.IModelViewVariants"/> interface.
|
|
</para>
|
|
</summary>
|
|
<param name="extenders">
|
|
A <b>ModelInterfaceExtenders</b> object that is a collection of Application Model interface extenders.
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.ViewVariantsModule.FrameVariantsEngine">
|
|
<summary>
|
|
<para>Specifies the <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.IFrameVariantsEngine"/> object that provides methods to manage view variants.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.IFrameVariantsEngine"/> object that provides methods to manage view variants.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.ViewVariantsModule.GenerateVariantsNode">
|
|
<summary>
|
|
<para>This property is obsolete. Use the approach demonstrated in the How to: Create Additional ListView Nodes in Code using a Generator Updater topic to generate View Variants in code.
|
|
|
|
</para>
|
|
</summary>
|
|
<value>
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.ViewVariantsModule.GetModuleUpdaters(DevExpress.ExpressApp.IObjectSpace,System.Version)">
|
|
<summary>
|
|
<para>Returns the list of <see cref="T:DevExpress.ExpressApp.Updating.ModuleUpdater"/> updaters that handle database updates for the ViewVariantsModule module.
|
|
</para>
|
|
</summary>
|
|
<param name="objectSpace">
|
|
An <see cref="T:DevExpress.ExpressApp.IObjectSpace"/> object which represents the Object Space used to update the database.
|
|
|
|
</param>
|
|
<param name="versionFromDB">
|
|
A <b>System.Version</b> object which represents the current database version.
|
|
|
|
</param>
|
|
<returns>An IEnumerable<<see cref="T:DevExpress.ExpressApp.Updating.ModuleUpdater"/>> list of updaters that handle database updates for the ViewVariantsModule module.
|
|
</returns>
|
|
|
|
|
|
</member>
|
|
<member name="M:DevExpress.ExpressApp.ViewVariantsModule.ViewVariantsModule.Setup(DevExpress.ExpressApp.XafApplication)">
|
|
<summary>
|
|
<para>Sets up the ViewVariantsModule module after it has been added to the <see cref="P:DevExpress.ExpressApp.XafApplication.Modules"/> collection.
|
|
</para>
|
|
</summary>
|
|
<param name="application">
|
|
An <see cref="T:DevExpress.ExpressApp.XafApplication"/> object that provides methods and properties to manage the current application. This parameter value is set for the <see cref="P:DevExpress.ExpressApp.ModuleBase.Application"/> property.
|
|
|
|
|
|
</param>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.ViewVariantsModule.ShowAdditionalNavigation">
|
|
<summary>
|
|
<para>Specifies the default value for the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.IModelNavigationItemsVariantSettings.GenerateRelatedViewVariantsGroup"/> property.
|
|
</para>
|
|
</summary>
|
|
<value><b>true</b>, to enable context navigation for the View Variants module, by default; otherwise, <b>false</b>.
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="P:DevExpress.ExpressApp.ViewVariantsModule.ViewVariantsModule.VariantsProvider">
|
|
<summary>
|
|
<para>Specifies the <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.IVariantsProvider"/> object that provides a list of view variants available for the specific View, and stores the variant selected by user.
|
|
</para>
|
|
</summary>
|
|
<value>An <see cref="T:DevExpress.ExpressApp.ViewVariantsModule.IVariantsProvider"/> object that provides a list of view variants available for the specific View, and stores the variant selected by the user.
|
|
|
|
</value>
|
|
|
|
|
|
</member>
|
|
<member name="E:DevExpress.ExpressApp.ViewVariantsModule.ViewVariantsModule.VariantsProviderChanged">
|
|
<summary>
|
|
<para>Occurs when the <see cref="P:DevExpress.ExpressApp.ViewVariantsModule.ViewVariantsModule.VariantsProvider"/> property is changed.
|
|
</para>
|
|
</summary>
|
|
|
|
|
|
</member>
|
|
</members>
|
|
</doc>
|