Skip to content

Documentation(1039182): Update the UG Documentation for WPF control#2346

Merged
durga-muthu merged 7 commits into
hotfix/hotfix-v34.1.29from
1039182-UG-doc-changes-hotfix
Jul 15, 2026
Merged

Documentation(1039182): Update the UG Documentation for WPF control#2346
durga-muthu merged 7 commits into
hotfix/hotfix-v34.1.29from
1039182-UG-doc-changes-hotfix

Conversation

@harinath-2699

Copy link
Copy Markdown
Collaborator

Description

Updated the UG Documentation for the Wpf Ribbon and DockingManager controls

AI Usage

Code Studio used in this PR/MR?

  • Yes
  • No

If Yes: Primary use (choose one)

  • Generate new code
  • Refactor/improve existing code
  • Tests
  • Bug fix / debugging help
  • Docs / comments
  • Review assistance (explanations/summaries)
  • Other

Outcome

  • Saved time (AI made development faster)
  • Neutral (No major difference)
  • Cost time (AI slowed things down)

If Cost time: Provide one line explanation

@harinath-2699
harinath-2699 requested a review from durga-muthu July 8, 2026 09:31
@harinath-2699 harinath-2699 self-assigned this Jul 8, 2026
@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: 1039182-UG-doc-changes-hotfix

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: 1039182-UG-doc-changes-hotfix
Technical Error(s): 0
Spelling Error(s): 15
Image Alt Text Error(s): 0
Image Size Error(s): 2
Image Name Error(s): 0
Front matter Error(s): 27
File Path Error(s): 0
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 2

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: 1039182-UG-doc-changes-hotfix

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: 1039182-UG-doc-changes-hotfix
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 27
File Path Error(s): 0
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 0

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: 1039182-UG-doc-changes-hotfix

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: FAILURE ❌
Source Compilation: SUCCESS ✅
Failure Reason: CI Failure with violation
Build Location: 1039182-UG-doc-changes-hotfix
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 1
File Path Error(s): 0
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 0

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: 1039182-UG-doc-changes-hotfix

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: 1039182-UG-doc-changes-hotfix
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 0

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: 1039182-UG-doc-changes-hotfix

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: 1039182-UG-doc-changes-hotfix
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 0

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: 1039182-UG-doc-changes-hotfix

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: 1039182-UG-doc-changes-hotfix
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 0

Comment thread wpf/Docking/Advanced-Features.md Outdated
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`).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SfSkinManager.SetVisualStyle is the recommended one or SetTheme is recommended?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SetTheme is mentioned in SkinManager md ka will address the content

Comment thread wpf/Docking/Advanced-Features.md Outdated
<!--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">

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this code runnable?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please verify this AutoHideVisibility and CanAutoHide together in code and confirm here.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread wpf/Docking/Pattern-and-Practices.md Outdated
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/"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure whether the modified namespace is working properly.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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" />

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we change the provider action here? Are the screenshot and codes the same or having different visions?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

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)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check whether the modified code is correct.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

while using TabOrderChanging event TabOrderChangingEventArgs is generated

<syncfusion:TabControlExt OnCloseAllTabs="TabControlExt_OnCloseAllTabs"
OnCloseButtonClick="TabControlExt_OnCloseButtonClick"
OnCloseOtherTabs="TabControlExt_OnCloseAllTabs"
OnCloseOtherTabs="TabControlExt_OnCloseOtherTabs"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TabControl or TabControlExt?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

The example screenshot explains the cascade mode only so the changes we have made are valid

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INQUEUE 🕒
Build Location: 1039182-UG-doc-changes-hotfix

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

Build Status: INPROGRESS 🔃
Build Location: 1039182-UG-doc-changes-hotfix

@SyncfusionBuild

Copy link
Copy Markdown
Contributor

CI Status: SUCCESS ✅
Source Compilation: SUCCESS ✅
Build Location: 1039182-UG-doc-changes-hotfix
Technical Error(s): 0
Spelling Error(s): 0
Image Alt Text Error(s): 0
Image Size Error(s): 0
Image Name Error(s): 0
Front matter Error(s): 0
File Path Error(s): 0
CodeSnippet File Path Missing Error(s): 0
Toc Anchor Tags Validation Error(s): 0
MD Tag Validation Error(s): 0

@durga-muthu
durga-muthu merged commit 99f02a2 into hotfix/hotfix-v34.1.29 Jul 15, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants