Skip to content

WPF-62104-Updated ReadMe file. #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/workflows/gitleaks.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Secret Value found!
on:
push:
public:
jobs:
scan:
name: gitleaks
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Install the gitleaks
run: wget https://github.com/zricethezav/gitleaks/releases/download/v8.15.2/gitleaks_8.15.2_linux_x64.tar.gz
shell: pwsh
- name: Extract the tar file
run: tar xzvf gitleaks_8.15.2_linux_x64.tar.gz
- name: Generate the report
id: gitleaks
run: $GITHUB_WORKSPACE/gitleaks detect -s $GITHUB_WORKSPACE -f json -r $GITHUB_WORKSPACE/leaksreport.json
shell: bash
continue-on-error: true
- name: Setup NuGet.exe
if: steps.gitleaks.outcome != 'success'
uses: nuget/setup-nuget@v1
with:
nuget-version: latest
- name: Install the dotnet
if: steps.gitleaks.outcome != 'success'
uses: actions/setup-dotnet@v3
with:
dotnet-version: '3.1.x'
- name: Install the report tool packages
if: steps.gitleaks.outcome != 'success'
run: |
nuget install "Syncfusion.Email" -source "https://nexus.syncfusion.com/repository/nuget-hosted/"
dir $GITHUB_WORKSPACE/Syncfusion.Email.1.0.0/lib/netcoreapp3.1
dotnet $GITHUB_WORKSPACE/Syncfusion.Email.1.0.0/lib/netcoreapp3.1/Email.dll "citeam@syncfusion.com" "$GITHUB_REF_NAME" ${{ secrets.NETWORKCREDENTIALS }} ${{ secrets.NETWORKKEY }} "$GITHUB_WORKSPACE"
exit 1
64 changes: 64 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,67 @@ This repository contains the samples that demonstrate the functionalities of Doc
<td><a href="Samples/DocumentTabOrdering">TDI window re-ordering notification in DocumentContainer</a></td>
</tr>
</table>

## AutoHide Window
AutoHidden window can be placed in four different sides such as Top, Bottom, Left and Right. To place the four auto hidden children in four different sides, set SideInDockedMode property according to its corresponding values in the DockingManager.

The AutoHideWindow can be placed on a required target window through the TargetNameInDockedMode property of the DockingManager. DockingWindow will auto hidden in place according to its Parent position, if any target exist. For example: Here “Output” docked at bottom of “SolutionExplorer” which docked at left side. While auto hiding Output window, it will auto hide at left due to it’s TargetWindow side.

## Custom ContextMenu
A dockable window is well associated with a default context menu with default menu items. You can also add custom menu items to the existing context menu items of the dockable window. CustomMenuItems property is used for this purpose.

CustomMenuItems - This property is attached to a docking manager child, and gives an ability to add some additional menu items to the context menu. This can easily extend GUI functionality by using the Custom menu items.

To add the custom menu item:

## C#
<syncfusion:DockingManager Name="DockingManager1" >

<syncfusion:DockingManager.CustomMenuItems>

<syncfusion:CustomMenuItemCollection>

<syncfusion:CustomMenuItem Header="CustomItem" />

</syncfusion:CustomMenuItemCollection>

</syncfusion:DockingManager.CustomMenuItems>

<TextBox syncfusion:DockingManager.SideInDockedMode="Left" syncfusion:DockingManager.State="Dock"/>

</syncfusion:DockingManager>

## DocumentTabOrdering
You will be notified when the TDI item’s order is changed by using the DocumentTabOrderChanged event. You can get the order changed TDI window with its old and new index values by using the SourceTabItem, OldIndex and NewIndex properties. You can also get old and new tab group of the order changed item by using the the SourceTabGroup and TargetTabGroup properties.

## Restrict DocumentTabOrdering
If you want to restrict the user to reordering the TDI window by drag and drop operation, use the DocumentTabOrderChanging event and set Cancel property value as true.

## C#
private void DockingManager_DocumentTabOrderChanging(object sender, DocumentTabOrderChangingEventArgs e)
{
// Restrict the TDI window re-ordering
e.Cancel = true;
}

## TabbedWindowOrdering
You will be notified when the tabbed window’s order is changed by using the TabOrderChanged event. You can get the order changed tabbed window with its old and new index values by using the TargetItem, OldIndex and NewIndex properties.

## C#
private void DockingManager1_TabOrderChanged(object sender, TabOrderChangedEventArgs e)
{
var dragged_Item = e.TargetItem;
var oldIndex = e.OldIndex;
var newIndex = e.NewIndex;
}

## Restrict Tabbed Windoe ReOrdering
If you want to restrict the user to reordering the tabbed window by drag and drop operation, use the TabOrderChanging event and set Cancel property value as true.

## Restricting DockingHints
You can disabled the dock hints at run-time by handling PreviewDockHints event in the DockingManager. It helps to handle before displaying the dock hints when drag the windows in DockingManager based on mouse hovered window. This event will be triggered for both inner dockability and outer dockability while drag the windows. It receives an argument of type PreviewDockHintsEventArgs containing the following information about the event.

* DraggingSource - Gets or sets the dragging element of DockingManager that raises the PreviewDockHints event.
* DraggingTarget - Gets or sets the target element in which the dragging window of DockingManager to be docked.
* DockAbility - Gets or sets the DockAbility, to restrict docking on target window.
* OuterDockAbility - Gets or sets the OuterDockability, to restrict docking on edges of DockingManager.