This example shows how to embed a bar from the DXBars library into a dock panel.
Dock panels embed bar containers at their top edges, allowing bars to be displayed in these containers. To add a bar to a dock panel's bar container, the name of the target bar container is assigned to the Bar.DockInfo.ContainerName property. This name matches the name of the LayoutPanel.HeaderBarContainerControlName property's value.
This example shows how to customize a panel's context menu via customization actions.
Menu customization actions are added via the DockLayoutManager.ContextMenuCustomizations collection.
The DXDocking library provides a set of commands on dock panels. These are declared in the DockControllerCommand class. For instance, the Close command allows you to close a specific dock panel. The Activate command activates a dock panel.
This example shows how to associate the Close command with a button. When an end-user clicks the button, the active dock panel is closed.
You can define a Window, Page or UserControl in external XAML files and then, with DXDocking, load their contents into DocumentPanel objects.
This example demonstrates how to load an external Window and UserControl into DocumentPanels.
In the example three approaches are demonstrated:
1) The contents of MyWindow.xaml is loaded into a DocumentPanel at design time (in XAML) via the DocumentPanel.Content property. The Content property accepts a Uri object, which must refer to a XAML file defining a Window, Page or UserControl.
[XAML]<dxdo:DocumentPanelx:Name="docPanel2"Caption="Panel 2"Content="{dxdo:RelativeUri UriString=CustomWindows\\MyWindow.xaml}"/>
2) The DocumentPanel.Content property is set with a Uri object at runtime:
[C#]docPanel1.Content=newUri(@"CustomWindows\MyWindow1.xaml",UriKind.Relative);
3) The DockLayoutManager.DockController.AddDocumentPanel method creates a new DocumentPanel object and loads the contents of an external XAML file into the created panel.
[C#]panel1=dockLayoutManager1.DockController.AddDocumentPanel(documentGroup1,newUri(@"CustomWindows\UserControl1.xaml",UriKind.Relative));panel1.Caption="Document "+(ctr++).ToString();
In the example, the XAML file defines a UserControl object. The loaded UserControl is accessed via the DocumentPanel's Control property and then a method on the UserControl is invoked.
[C#]//...(panel1.ControlasUserControl1).SetDataContext(imageInfo);
You can see this in action by clicking the "Set DataContext for UserControl" button in the example.
Hi,
I am following the same approach in my project. My question is how to close the Usercontrol from Button click event of it.(not using the 'X' on right corner- usercontrol unloaded event).
Thanks
Sudha.
Hi,
If you have a button within a UserControl displayed within a DocumentPanel, you can use the Button.Click event to close the current DocumentPanel:
private void button1_Click(object sender, RoutedEventArgs e) {
DockLayoutManager dm = DockLayoutManager.GetDockLayoutManager(this);
dm.DockController.Close(dm.ActiveDockItem);
}
Thanks, Alex.
Hi,
I've a windows (MDI) with buttons (save, new ecc.) and document panel with loaded windows at runtime. I need to send commands from child windows to MDI window (enable/disable buttons). How can I do?
Thanks, Andrea.
Some of DockLayoutManager’s panel groups can contain documents that were created from ViewModel with IDocumentManagerService. To serialize and restore them correctly, it is necessary to perform these steps:
1. Create a style and set a name for DocumentPanel. To do this, bind DocumentPanel.BindableName to a unique property.
2. Apply this style to all documents that will be created from ViewModel.
3. Before serializing DockLayoutManager, serialize all documents created from ViewModel.
4. Before restoring DockLayoutManager, recreate all documents created from ViewModel.
==============================
This solution can be applied only to the old Security System.
Starting with v13.2, you can configure member permissions to grant access to the associated collections (see Security - Provide the capability to link/unlink objects in non-aggregated collections if they have the corresponding permissions while the master object is restricted ). You should not use this example in a new project.
==============================
Suppose, I have the Organization and Person classes. Each Person object can be associated with a number of Organization objects, and each Organization object can be associated with a number of Person objects (a many-to-many relationship, see the BusinessClasses.cs file):
[C#]publicclassPerson:XPObject{publicPerson(Sessionsession):base(session){}publicstringName{get{returnGetPropertyValue<string>("Name");}set{SetPropertyValue<string>("Name",value);}}[Association("Organizations-Persons2")]publicXPCollection<Organization>Organizations{get{returnGetCollection<Organization>("Organizations");}}}publicclassOrganization:XPObject{publicOrganization(Sessionsession):base(session){}publicstringFullName{get{returnGetPropertyValue<string>("FullName");}set{SetPropertyValue<string>("FullName",value);}}[Association("Organizations-Persons")]publicXPCollection<Person>Persons{get{returnGetCollection<Person>("Persons");}}}
And, an end-user needs to modify any Person object, including its "Organizations" collection ('Link' or 'Unlink' organization objects), but he or she should not modify any property of an Organization object.
To accomplish this, I grant all operations under the Person objects and grant only the Read operation over the Organization objects (see the Updater.cs file):
[C#]userRole.AddPermission(newObjectAccessPermission(typeof(object),ObjectAccess.AllAccess,ObjectAccessModifier.Allow));userRole.AddPermission(newObjectAccessPermission(typeof(Person),ObjectAccess.AllAccess,ObjectAccessModifier.Allow));userRole.AddPermission(newObjectAccessPermission(typeof(Organization),ObjectAccess.ChangeAccess,ObjectAccessModifier.Deny));
With these permissions, I have achieved the necessary behavior, except for that an end-user cannot modify the Organizations collection property. This is a restriction of the current implementation of the XAF Security system.
To avoid it, I introduce a new class and manually allow modifying the "Organizations" property in the code (see the AllowManyToMany_ObjectAccessComparer.cs file):
[C#]publicclassAllowManyToMany_ObjectAccessComparer:ObjectAccessComparer{publicoverrideboolIsSubsetOf(ObjectAccessPermissionsourcePermission,ObjectAccessPermissiontargetPermission){if(sourcePermission.AccessItemList.Count== 1){ParticularAccessItemsourceAccessItem=sourcePermission.AccessItemList[0];if(typeof(Organization).IsAssignableFrom(sourceAccessItem.ObjectType)&&sourceAccessItem.Access==ObjectAccess.Write&&sourceAccessItem.Modifier==ObjectAccessModifier.Allow){if(sourcePermission.Contexts!=null&&sourcePermission.Contexts.CollectionPropertyContext!=null&&sourcePermission.Contexts.CollectionPropertyContext.CollectionPropertyName=="Organizations"&&typeof(Person).IsAssignableFrom(sourcePermission.Contexts.CollectionPropertyContext.MasterObjectType)){returntrue;}}}returnbase.IsSubsetOf(sourcePermission,targetPermission);}}
and set this class as the current ObjectAccessComparer in the main.cs and global.aspx.cs files:
[C#]ObjectAccessComparerBase.SetCurrentComparer(newAllowManyToMany_ObjectAccessComparer());
Thanks,
Dan
In this example, this interface is implemented in the DictionaryWrapper<T> class. In the GetProperties methods, it returns a collection of custom PropertyDescriptor descendants.
The DXPropertyGrid supports several ways to check if the value entered by a user is correct.
First, this functionality can be implemented at the View level by handling the ValidateCell event. This event is raised when a user has modified a cell value and is trying to save changes (either by pressing the Enter key or switching to another property grid cell).
Here is a code snippet demonstrating how to handle this event.
[C#]voidOnPropertyGridControlValidateCell(objectsender,DevExpress.Xpf.PropertyGrid.ValidateCellEventArgse){if(e.NewValue==null||string.IsNullOrEmpty(e.NewValue.ToString()))e.ValidationException=newSystem.Exception("A cell cannot be empty");}
Another way is to implement validation at the data source level using Data Annotation Attributes (assigning attributes using the DevExpress FluentAPI is also supported) or by implementing the IDataErrorInfo interface.
The Diagram control supports a special language for defining shapes. The main element that contains shape description is ShapeTemplate. This element describes a shape contour and may contain several segments:
- Start. Specifies the start point
- Line. Defines a line with start and end points
- Arc. Defines an arc with start and end points
To specify connection points, use the ShapeTemplate.ConnectionPoints property.
Shapes may contain parameters. Parameters may be used to dynamically calculate an end point, row height and other properties. To specify parameters, use the ShapeTemplate.Parameters property.
To register custom shapes, use the DiagramToolboxRegistrator.RegisterShapes method.
Cell editors can be specified at the PropertyGridControl level as well as in a ViewModel/Model.
In the first case, we will need to create PropertyDefinition objects for required properties. There are several ways to map definitions to properties, please refer to Property Definitions for detailed information.
To assign an editor, you can use either of the following properties:
- EditSettings;
- CellTemplate. Pay special attention that CellTemplate should be defined in a specific manner in order not to break navigation, validation, and synchronizing values. These requirements are listed described at PropertyDefinition.CellTemplateProperty.
On the ViewModel/Model level, use the DefaultEditorAttribute (it is used by GridControl, PropertyGridControl, and DataLayoutControl) and PropertyGridEditorAttribute.
This sample shows how to add a button showing MDI child windows list to the XtraTabbedMdiManager's header. A button like "Active Files" in Visual Studio. To accomplish this, we've created an XtraTabbedMdiManager descendant along with descendants of other classes like the TabHeaderViewInfo and TabButtonsPanel. Also, since we cannot make changes to the Enums, we cannot extend the buttons set available in the HeaderButtons property. So, a separate property controlling this button's visibility has been added - HeaderShowActiveFilesButton. It has the bool type and by default is set to false.
Hi I downloaded this example, and ran it, but I didn't see the button on the tab manager header. Where is the button?
Added By: JJDX at: 9/21/2014 11:12:23 AMSame here, dl, run but no buttons, i search for HeaderShowActiveFilesButton , change it to true but there is no button still.
Added By: Yaroslav (DevExpress Support) at: 9/22/2014 6:24:58 AMHi Roman,
This example was created long time ago, so some internal methods have been changed since that time. I slightly updated the target project (both C# and VB.NET versions) in order to fix the aforementioned issue. Now an additional button is displayed as expected under the latest 14.1 version.
Don't hesitate to contact us in case of any difficulty.
I modified the example to have a feature toggle button. I set a super tool tip for the EditorButton but it is not shown.
Do i have to assign it to the RibbonControl on the XtraForm to get it running?
Here my code example:
protected override TabButtonInfo CreateButton(TabButtonType button)
{
if ( button == TabButtonType.User )
{
ButtonPredefines predefine = ButtonPredefines.Glyph;
Boolean selectedPageIsAFavorite = false;
if (this.TabViewInfo.SelectedTabPage != null && this.TabViewInfo.SelectedTabPage is XtraMdiTabPage)
{
XtraMdiTabPage mdiTabPage = (XtraMdiTabPage)this.TabViewInfo.SelectedTabPage;
if ( mdiTabPage.MdiChild != null &&
mdiTabPage.MdiChild.ParentForm != null &&
mdiTabPage.MdiChild.ParentForm is MainForm)
selectedPageIsAFavorite = ((MainForm)mdiTabPage.MdiChild.ParentForm).IsSelectedPageAFavorite((Form)mdiTabPage.MdiChild);
}
SuperToolTip superToolTipForFavoriteToggleButton = new SuperToolTip();
SuperToolTipSetupArgs args = new SuperToolTipSetupArgs();
args.Title.Text = "Favorit setzen/löschen";
Image favoriteGlyph = null;
if (selectedPageIsAFavorite)
{
// page is a favorite
args.Contents.Text = "Anklicken zum Löschen des Favoritenstatus";
favoriteGlyph = Properties.Resources.ov_favorite_active;
}
else
{
// page is NOT a favorite
args.Contents.Text = "Anklicken zum Setzen des Favoritenstatus";
favoriteGlyph = Properties.Resources.ov_favorite_non_active;
}
superToolTipForFavoriteToggleButton.Setup(args);
EditorButton favoriteButton = new EditorButton(predefine, favoriteGlyph, superToolTipForFavoriteToggleButton);
TabButtonInfo tabBtn = new TabButtonInfo(favoriteButton, button);
return tabBtn;
}
return base.CreateButton(button);
}
Hello Christian,
Currently, our XtraTabbedMdiManager can show tooltips only for tab pages. As a possible solution, you can handle the ToolTipController.Default.GetActiveObjectInfo event and manually show a tooltip. For example:
[C#]publicMyTabbedMdiManager(IContainercontainer):base(container){ToolTipController.DefaultController.GetActiveObjectInfo+=DefaultController_GetActiveObjectInfo;}
[C#]privatevoidDefaultController_GetActiveObjectInfo(objectsender,ToolTipControllerGetActiveObjectInfoEventArgse){if(e.SelectedControlisMdiClient){varargs=CreateDXMouseEventArgs(newMouseEventArgs(MouseButtons.None, 0,e.ControlMousePosition.X,e.ControlMousePosition.Y, 0));DevExpress.XtraTab.Buttons.TabButtonInfomyButton=((MyTabButtonsPanel)ViewInfo.HeaderInfo.Buttons).MyButton;//expose your button info to access it from MyTabbedMdiManagerif(myButton.Bounds.Contains(args.Location)){//show your SuperTip here...}}}
Let me know if you have additional questions.
Hello Dimitros,
many thanks for your code parts. I got it running with following additions :-)
private void DefaultController_GetActiveObjectInfo(object sender, ToolTipControllerGetActiveObjectInfoEventArgs e)
{
if (e.SelectedControl is MdiClient)
{
var args = CreateDXMouseEventArgs(new MouseEventArgs(MouseButtons.None, 0, e.ControlMousePosition.X, e.ControlMousePosition.Y, 0));
DevExpress.XtraTab.Buttons.TabButtonInfo favoriteToggleTabBtnInfo = ((MyTabButtonsPanel)ViewInfo.HeaderInfo.Buttons).FavoriteToggleTabBtnInfo;
if (favoriteToggleTabBtnInfo.Bounds.Contains(args.Location))
{
ToolTipController.DefaultController.ShowHint(favoriteToggleTabBtnInfo.Button.ToolTip);
}
}
}
Added By: Dimitros (DevExpress Support) at: 12/15/2015 1:29:07 AMHello Christian,
I am happy to hear that you have successfully implemented tooltips for your custom buttons.
Thank you for sharing your code with us! It may be helpful to other users who need this functionality.
The PropertyGridControl is the control designed to edit object properties. It can be bound to a specific object as well as a collection of objects.
To browse and manage properties of a specific object, set the PropertyGridControl.SelectedObject property to this object.
[C#]publicpartialclassMainWindow{publicMainWindow(){DataContext=newContact("Carolyn","Baker");InitializeComponent();}}publicclassContact{publicstringFirstName{get;set;}publicstringLastName{get;set;}publicContact(stringfirstName,stringlastName){FirstName=firstName;LastName=lastName;}}
[XAML]<dxprg:PropertyGridControlSelectedObject="{Binding Path=.}"/>
To edit properties of multiple objects simultaneously, use PropertyGridControl.SelectedObjects.
[C#]publicpartialclassMainWindow{publicMainWindow(){DataContext=newList<Contact>{newContact("Carolyn","Baker"),newContact("Amber","Seaman")};InitializeComponent();}}
[XAML]<dxprg:PropertyGridControlSelectedObjects="{Binding Path=.}"ExpandCategoriesWhenSelectedObjectChanged="True"/>
Shapes in the Diagram control are colored according to an applied theme. To create a custom theme, add a resource dictionary into your application and add the Theme element into it.
Each theme should contain a color palette which defines main colors used in a theme. To specify a color palette, add the ColorPalette element into Theme.
To specify how colors are used in a theme, set the Theme.Effects property. This property accepts the EffectCollection object. EffectCollection defines colors shown in the following gallery:
EffectCollection has the following properties:
-ThemeEffects. Influences colors in the "Theme Styles" group.
-VariantEffects. Influences colors in the "Variant Styles" group. When a shape is created its default color scheme is taken from this group.
-ConnectorEffects. Influences connector colors.
To register a custom theme, use the ThemeRegistrator.RegisterThemes method.
This example shows how to create a ToolbarListItem, used to provide access to available toolbars. The ToolbarListItem object is added to the sub-menu displayed within the main menu.
This example is an illustration of the KA18686: ASPxGridView - How to implement CRUD operations with a custom data source KB Article. Refer to the Article for an explanation.
See Also:
How to insert, edit and delete data in a data table by ASPxGridView at runtime
This example isn't showing any of the code-behind.
Added By: Helen (DevExpress Support) at: 12/15/2015 9:53:42 AMHello,
I tried to open the example on my side and it displays the code behind for all versions, both VB.NET and C#. See the video. Try to reload the page by pressing Ctrl+F5 and check the example again. If the problem persists, specify your browser family and version.