Documentation(1039182): Update the UG Documentation for WPF control#2346
Conversation
|
Build Status: INPROGRESS 🔃 |
|
CI Status: FAILURE ❌ |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: FAILURE ❌ |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: FAILURE ❌ |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: SUCCESS ✅ |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: SUCCESS ✅ |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: SUCCESS ✅ |
| Visual styles are available for the dockable windows, which give the windows a rich and professional look and feel. The visual style for the DockingManager is set using the VisualStyle property. The following are some of the visual styles that can be applied to the Docking Manager. | ||
|
|
||
| Property table | ||
| > NOTE: `SkinStorage.SetVisualStyle` is a legacy API. For new development, use [SfSkinManager.SetVisualStyle](https://help.syncfusion.com/wpf/themes/skin-manager), which requires the additional assemblies `Syncfusion.SfSkinManager.WPF` and a theme assembly (e.g. `Syncfusion.Themes.VisualStudio2013.WPF`). |
There was a problem hiding this comment.
SfSkinManager.SetVisualStyle is the recommended one or SetTheme is recommended?
There was a problem hiding this comment.
SetTheme is mentioned in SkinManager md ka will address the content
| <!--Declaring Docking Manager with Close AllTabs and CloseOtherTabs--> | ||
|
|
||
| <syncfusion:DockingManager CloseAllTabs="DockingManager_CloseAllTabs" CloseOtherTabs="DockingManager_CloseOtherTabs"> | ||
| <syncfusion:DockingManager CloseAllTabs="DockingManager_CloseAllTabs" CloseOtherTabs="DockingManager_CloseOtherTabs" CloseButtonClick="DockingManager_CloseButtonClick"> |
There was a problem hiding this comment.
is this code runnable?
There was a problem hiding this comment.
will check and address
|
|
||
|
|
||
| To enable or disable the AutoHide functionality for a specific child in the DockingManager, [CanAutoHide](https://help.syncfusion.com/cr/wpf/Syncfusion.Windows.Tools.Controls.DockItem.html#Syncfusion_Windows_Tools_Controls_DockItem_CanAutoHide) can be used. By default its value is `true`, this functionality can disable by set its value as `false`. | ||
| To enable or disable the AutoHide functionality for a specific child in the DockingManager, [CanAutoHide](https://help.syncfusion.com/cr/wpf/Syncfusion.Windows.Tools.Controls.DockItem.html#Syncfusion_Windows_Tools_Controls_DockItem_CanAutoHide) can be used. By default its value is `true`; this functionality can be disabled by setting its value to `false`. Note that `CanAutoHide` only affects the pin/unpin; the AutoHide button on the caption bar of a Float window is controlled separately by `AutoHideVisibility` on the DockingManager. |
There was a problem hiding this comment.
please verify this AutoHideVisibility and CanAutoHide together in code and confirm here.
There was a problem hiding this comment.
I have tested the below scenarios and its works fine
dockingManager.AutoHideVisibility = false — pin button is removed from the caption bar of docked/floating windows.
CanAutoHide = false on a specific child — the pin button is hidden for that child only.
CanAutoHide = true (default) and AutoHideVisibility = true — both pin and unpin behave normally.
| DockingManager.SetDesiredMaxWidthInDockedMode(dockWindow2, 300); | ||
|
|
||
| DockingManager.SetDesiredMaxWidthInDockedMode(dockWindow3, 200); | ||
| DockingManager.SetDesiredMaxHeightInDockedMode(dockWindow3, 200); |
There was a problem hiding this comment.
This section explains max width. Why do we need to update details about MAHeight? Is maxheight not defined in a separate section? Please check the output for the code.
There was a problem hiding this comment.
This section explains both DesiredMaxWidthInDockedMode and DesiredMaxHeightInDockedMode to limit the size and height respectively to the specific window.
MaxHeight already explained in the XAML code itself, so in C# code the Height definition is needed.
I have now altered the C# code to match the output screenshot, XAML code is ideal for the output image
| xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" | ||
| xmlns:syncfusion="http://schemas.syncfusion.com/wpf" | ||
| xmlns:prsm="http://www.codeplex.com/prism" | ||
| xmlns:prsm="http://prismlibrary.com/" |
There was a problem hiding this comment.
Ensure whether the modified namespace is working properly.
There was a problem hiding this comment.
I will revert the namespace changes
| <ControlTemplate TargetType="{x:Type ContentControl}"> | ||
|
|
||
| <Image Name="Img" syncfusion:DockPreviewManagerVS2005.ProviderAction="GlobalLeft" Source="Images\synclogo.png" /> | ||
| <Image Name="Img" syncfusion:DockPreviewManagerVS2005.ProviderAction="GlobalTop" Source="Images\synclogo.png" /> |
There was a problem hiding this comment.
Why do we change the provider action here? Are the screenshot and codes the same or having different visions?
There was a problem hiding this comment.
I have attached the image used for TopDragprovider customization. The changes we have done are valid in this case.
Already LeftDragProvider content is there - https://help.syncfusion.com/wpf/docking/styling-and-templates#leftdragprovider
| {% highlight c# %} | ||
|
|
||
| private void DockingManager1_TabOrderChanging(object sender, Syncfusion.Windows.Tools.Controls.TabOrderChangedEventArgs e) | ||
| private void DockingManager1_TabOrderChanging(object sender, Syncfusion.Windows.Tools.Controls.TabOrderChangingEventArgs e) |
There was a problem hiding this comment.
Please check whether the modified code is correct.
| <syncfusion:TabControlExt OnCloseAllTabs="TabControlExt_OnCloseAllTabs" | ||
| OnCloseButtonClick="TabControlExt_OnCloseButtonClick" | ||
| OnCloseOtherTabs="TabControlExt_OnCloseAllTabs" | ||
| OnCloseOtherTabs="TabControlExt_OnCloseOtherTabs" |
There was a problem hiding this comment.
The event name has been updated in the XAML, but the code-behind still references the old event name. Please verify and update this consistently across all modified files in the PR.
There was a problem hiding this comment.
The OnCloseOtherTabs have been consistent in XAML and in C# content its been consistent
tabControlExt.OnCloseOtherTabs += TabControlExt_OnCloseOtherTabs;
private void TabControlExt_OnCloseOtherTabs(object sender, CloseTabEventArgs e) {
var closingTabItems = e.ClosingTabItems;
| * Syncfusion.Shared.WPF | ||
| * Syncfusion.Tools.WPF | ||
|
|
||
| 3. Include the required namespace and create an instance of `TabControl` and add it to the window. |
There was a problem hiding this comment.
TabControl or TabControlExt?
There was a problem hiding this comment.
verified other md files given as TabControlExt
| void DocumentContainer_Loaded(object sender, RoutedEventArgs e) | ||
| { | ||
| (DockingManager1.DocContainer as DocumentContainer).SetLayout(MDILayout.Vertical); | ||
| (DockingManager1.DocContainer as DocumentContainer).SetLayout(MDILayout.Cascade); |
There was a problem hiding this comment.
If a screenshot reference is provided for this section, please verify that the new code changes align with the screenshot and match the expected UI/behavior.
|
Build Status: INQUEUE 🕒 |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: SUCCESS ✅ |


Description
Updated the UG Documentation for the Wpf Ribbon and DockingManager controls
AI Usage
Code Studio used in this PR/MR?
If Yes: Primary use (choose one)
Outcome
If Cost time: Provide one line explanation