Skip to content

Commit 1161975

Browse files
ArunKumarSF4054ArunKumarSF4054
committed
WPF-848727_Properties_highlight
1 parent 12fc850 commit 1161975

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+239
-239
lines changed

‎wpf/Diagram/Annotation/DefineAnnotation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Annotation is a block of text that can be displayed over a node or connector. An
1313

1414
## Define annotation
1515

16-
An annotation can be added to a node or connector by defining the annotation object and adding that to the annotation collection of the node or connector. The `Content` property of `AnnotationEditorViewModel` class defines the text to be displayed. The following code explains how to create an annotation.
16+
An annotation can be added to a node or connector by defining the annotation object and adding that to the annotation collection of the node or connector. The [`Content`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_Content) property of [`AnnotationEditorViewModel`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html) class defines the text to be displayed. The following code explains how to create an annotation.
1717

1818
{% tabs %}
1919
{% highlight xaml %}

‎wpf/Diagram/Annotation/Interaction/Dragging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To learn about annotation constraints, refer to the [Annotation Constraints](htt
1414

1515
## Dragging the annotation
1616

17-
Dragging of annotation can be enabled by using the `Constraints` property of `AnnotationEditorViewModel` class and setting its value as `AnnotationConstraints.Draggable`.
17+
Dragging of annotation can be enabled by using the [`Constraints`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_Constraints) property of [`AnnotationEditorViewModel`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html) class and setting its value as `AnnotationConstraints.Draggable`.
1818

1919
{% tabs %}
2020

@@ -53,7 +53,7 @@ Diagram allows users to nudge annotations by one pixel in a specific direction u
5353

5454
## How to restrict the dragging area
5555

56-
Diagram allows you to specify the amount of dragging area around the annotation by enabling the `Constraints` as `AnnotationConstraints.DragLimit` and dragging area can be specified by using the `DragLimit` property. You cannot drag the annotation behind this drag limit value. Default value is (10, 10, 10, 10).
56+
Diagram allows you to specify the amount of dragging area around the annotation by enabling the `Constraints` as `AnnotationConstraints.DragLimit` and dragging area can be specified by using the [`DragLimit`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_DragLimit) property. You cannot drag the annotation behind this drag limit value. Default value is (10, 10, 10, 10).
5757

5858
{% tabs %}
5959
{% highlight xaml %}

‎wpf/Diagram/Annotation/Interaction/Rotating.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To learn about annotation constraints, refer to the [Annotation Constraints](htt
1414

1515
## Rotating the annotation
1616

17-
Rotation of annotation can be enabled by using the `Constraints` property of `AnnotationEditorViewModel` class and setting its value as `AnnotationConstraints.Rotatable`.
17+
Rotation of annotation can be enabled by using the [`Constraints`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_Constraints) property of `AnnotationEditorViewModel` class and setting its value as `AnnotationConstraints.Rotatable`.
1818

1919
{% tabs %}
2020
{% highlight xaml %}
@@ -46,7 +46,7 @@ Annotations = new ObservableCollection<IAnnotation>()
4646

4747
## How to customize the annotation rotation
4848

49-
The `RotationReference` property of the annotation is to define the rotation based on Page or its host node or connector.To learn about the Rotate Reference property, refer to the [RotationReference](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.RotationReference.html) .
49+
The [`RotationReference`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_RotationReference) property of the annotation is to define the rotation based on Page or its host node or connector.To learn about the Rotate Reference property, refer to the [RotationReference](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.RotationReference.html) .
5050

5151
{% tabs %}
5252
{% highlight xaml %}

‎wpf/Diagram/Annotation/Interaction/SelectionAndResizing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To learn about annotation constraints, refer to the [Annotation Constraints](htt
1414

1515
## Selecting the annotation
1616

17-
Selection of annotation can be enabled by using the `Constraints` property of `AnnotationEditorViewModel` class and setting its value as `AnnotationConstraints.Selectable`.
17+
Selection of annotation can be enabled by using the [`Constraints`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_Constraints) property of [`AnnotationEditorViewModel`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html) class and setting its value as `AnnotationConstraints.Selectable`.
1818

1919
{% tabs %}
2020
{% highlight xaml %}

‎wpf/Diagram/Annotation/PositioningAndAppearance.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Diagram allows you to customize the position and appearance of the annotation ef
1313

1414
## How to position node's annotation
1515

16-
Annotation can be aligned relative to the node boundaries. It has Margin, Offset, Horizontal, and Vertical alignment settings. It is quite tricky when all four alignments are used together but gives more control over alignments properties of `AnnotationEditorViewModel` class.
16+
Annotation can be aligned relative to the node boundaries. It has Margin, Offset, Horizontal, and Vertical alignment settings. It is quite tricky when all four alignments are used together but gives more control over alignments properties of [`AnnotationEditorViewModel`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html) class.
1717

1818
Annotations of a node can be positioned using the following properties of `AnnotationEditorViewModel` class.
1919

@@ -23,7 +23,7 @@ Annotations of a node can be positioned using the following properties of `Annot
2323

2424
### Offset
2525

26-
The `Offset` property of `AnnotationEditorViewModel` is used to align the annotations based on fractions. 0 represents top-left corner, 1 represents bottom-right corner, and 0.5 represents half of width/height. Default value is (0.5, 0.5).
26+
The [`Offset`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_Offset) property of `AnnotationEditorViewModel` is used to align the annotations based on fractions. 0 represents top-left corner, 1 represents bottom-right corner, and 0.5 represents half of width/height. Default value is (0.5, 0.5).
2727

2828
{% tabs %}
2929
{% highlight xaml %}
@@ -80,9 +80,9 @@ NodeViewModel node = new NodeViewModel()
8080

8181
### Horizontal and vertical Alignments
8282

83-
The `HorizontalAlignment` property of `AnnotationEditorViewModel` class is used to align the annotation horizontally. Default value is Center.
83+
The [`HorizontalAlignment`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_HorizontalAlignment) property of `AnnotationEditorViewModel` class is used to align the annotation horizontally. Default value is Center.
8484

85-
The `VerticalAlignment` property of `AnnotationEditorViewModel` class is used to align the annotation vertically. Default value is Center.
85+
The [`VerticalAlignment`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_VerticalAlignment) property of `AnnotationEditorViewModel` class is used to align the annotation vertically. Default value is Center.
8686

8787
{% tabs %}
8888
{% highlight xaml %}
@@ -127,7 +127,7 @@ Annotations = new ObservableCollection<IAnnotation>()
127127

128128
### Margin
129129

130-
`Margin` is an absolute value used to add some blank space in any one of its four sides. The annotations can be displaced with the margin property. The following code example explains how to align an annotation based on its Margin value. Default value is (0,0,0,0).
130+
[`Margin`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_Margin) is an absolute value used to add some blank space in any one of its four sides. The annotations can be displaced with the margin property. The following code example explains how to align an annotation based on its Margin value. Default value is (0,0,0,0).
131131

132132
{% tabs %}
133133
{% highlight xaml %}
@@ -169,7 +169,7 @@ Annotations of a connector can be positioned using the following properties of `
169169

170170
### Alignment
171171

172-
Connector's annotation can be aligned over its segment path using the `Alignment` property of `AnnotationEditorViewModel` class. Default value is Center.
172+
Connector's annotation can be aligned over its segment path using the [`Alignment`]((https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_Alignment)) property of `AnnotationEditorViewModel` class. Default value is Center.
173173

174174
{% tabs %}
175175
{% highlight xaml %}
@@ -205,7 +205,7 @@ Annotations = new ObservableCollection<IAnnotation>()
205205

206206
### Length
207207

208-
The `Length` property of annotation is used to align the annotations based on fractions. 0 represents Top-Left corner, 1 represents Bottom-Right corner, and 0.5 represents half of Width/Height. The default value is 0.5d.
208+
The [`Length`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_Length) property of annotation is used to align the annotations based on fractions. 0 represents Top-Left corner, 1 represents Bottom-Right corner, and 0.5 represents half of Width/Height. The default value is 0.5d.
209209

210210
{% tabs %}
211211
{% highlight xaml %}
@@ -238,7 +238,7 @@ The following image shows the relationship between the annotation position and L
238238

239239
### Displacement
240240

241-
The `Displacement` property is used to dislocate the annotation by the value given. By default, annotation will be in center of the connector path. When you assign value to the `Displacement` property, annotation will be displaced from its position by displacment value. Default value is 0d.
241+
The [`Displacement`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_Displacement) property is used to dislocate the annotation by the value given. By default, annotation will be in center of the connector path. When you assign value to the `Displacement` property, annotation will be displaced from its position by displacment value. Default value is 0d.
242242

243243
{% tabs %}
244244
{% highlight xaml %}
@@ -270,7 +270,7 @@ Annotations = new ObservableCollection<IAnnotation>()
270270

271271
### Pivot
272272

273-
Position of an annotation is controlled by using its `Length` property, which represents the distance from connector center. The `Pivot` property is used to align the annotation based on its center point. Default value of the pivot point is (0.5, 0.5), that means center of length.
273+
Position of an annotation is controlled by using its `Length` property, which represents the distance from connector center. The [`Pivot`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_Pivot) property is used to align the annotation based on its center point. Default value of the pivot point is (0.5, 0.5), that means center of length.
274274

275275
{% tabs %}
276276
{% highlight xaml %}
@@ -343,7 +343,7 @@ Annotations = new ObservableCollection<IAnnotation>()
343343

344344
## How to set size for annotation
345345

346-
Diagram allows you to set size for annotations by using the `UnitWidth` and `UnitHeight` properties. Default value of UnitWidth and UnitHeight properties are double.NaN.
346+
Diagram allows you to set size for annotations by using the [`UnitWidth`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_UnitWidth) and [`UnitHeight`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_UnitHeight) properties. Default value of UnitWidth and UnitHeight properties are double.NaN.
347347

348348
{% tabs %}
349349
{% highlight xaml %}
@@ -378,7 +378,7 @@ N> Size of the annotation is 100% size of the node.
378378

379379
## Wrapping
380380

381-
When text overflows node boundaries, you can control it by using the `WrapText` property. So, it is wrapped into multiple lines. The Wrapping property of annotation defines how the content should be wrapped. Default value is Wrap.
381+
When text overflows node boundaries, you can control it by using the [`WrapText`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_WrapText) property. So, it is wrapped into multiple lines. The Wrapping property of annotation defines how the content should be wrapped. Default value is Wrap.
382382

383383
{% tabs %}
384384
{% highlight xaml %}
@@ -415,7 +415,7 @@ Annotations = new AnnotationCollection()
415415

416416
## How to change the appearance of annotation
417417

418-
Default appearance of the annotations can be customized by using the `EditTemplate` and `ViewTemplate` properties. ViewTemplate is used to control the appearance of the annotation when it is in non-editing stage. EditTemplate is used to control the appearance of the annotation while it is in editing.
418+
Default appearance of the annotations can be customized by using the [`EditTemplate`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_EditTemplate) and [`ViewTemplate`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_ViewTemplate) properties. ViewTemplate is used to control the appearance of the annotation when it is in non-editing stage. EditTemplate is used to control the appearance of the annotation while it is in editing.
419419

420420
{% tabs %}
421421
{% highlight xaml %}
@@ -506,7 +506,7 @@ Annotations = new ObservableCollection<IAnnotation>()
506506

507507
### How to change the editing mode
508508

509-
Diagram allows you to show the annotation in view or edit mode while loading the diagram elements by using the `Mode` property of `AnnotationEditorViewModel` class. Default value is View.
509+
Diagram allows you to show the annotation in view or edit mode while loading the diagram elements by using the [`Mode`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_Mode) property of `AnnotationEditorViewModel` class. Default value is View.
510510

511511
{% tabs %}
512512
{% highlight xaml %}
@@ -542,7 +542,7 @@ N> Edit mode will be applied to a single element at a time.
542542

543543
Annotation will be in editing state when you double click the node or annotation. Annotation will be selected when you single click the annotation if selectable constraints are enabled.
544544

545-
Also, the `ReadOnly` property of `AnnotationEditorViewModel` class allows you to disable the editing option of annotation.
545+
Also, the [`ReadOnly`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.AnnotationEditorViewModel.html#Syncfusion_UI_Xaml_Diagram_AnnotationEditorViewModel_ReadOnly) property of `AnnotationEditorViewModel` class allows you to disable the editing option of annotation.
546546

547547
{% tabs %}
548548
{% highlight xaml %}

‎wpf/Diagram/Automatic-Layouts/Automatic-Layouts.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ diagram.DataSourceSettings = new DataSourceSettings()
179179

180180
## Defining layout
181181

182-
You can use the [LayoutManager.Layout](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.Layout.LayoutManager.html#Syncfusion_UI_Xaml_Diagram_Layout_LayoutManager__ctor) property to specify any one of the layouting algorithm.
182+
You can use the [`LayoutManager.Layout`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.Layout.LayoutManager.html#Syncfusion_UI_Xaml_Diagram_Layout_LayoutManager__ctor) property to specify any one of the layouting algorithm.
183183

184184
{% tabs %}
185185
{% highlight xaml %}
@@ -223,7 +223,7 @@ diagram.LayoutManager = new LayoutManager()
223223

224224
## Updating layout
225225

226-
The [RefreshFrequency](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.Layout.LayoutManager.html#Syncfusion_UI_Xaml_Diagram_Layout_LayoutManager_RefreshFrequency) property of LayoutManager is used to re-arrange the nodes in the diagram area when a node is added, deleted, moved, or resized. Also, you can decide when the nodes should be arranged for every diagram load or only for the first load. Find the description for each condition in the following table.
226+
The [`RefreshFrequency`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.Layout.LayoutManager.html#Syncfusion_UI_Xaml_Diagram_Layout_LayoutManager_RefreshFrequency) property of LayoutManager is used to re-arrange the nodes in the diagram area when a node is added, deleted, moved, or resized. Also, you can decide when the nodes should be arranged for every diagram load or only for the first load. Find the description for each condition in the following table.
227227

228228
| Refresh Frequencies | Description|
229229
| --- | --- |
@@ -273,7 +273,7 @@ diagram.LayoutManager = new LayoutManager()
273273

274274
## Customize tree orientation in layout
275275

276-
[Orientation](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.Layout.DirectedTreeLayout.html#Syncfusion_UI_Xaml_Diagram_Layout_DirectedTreeLayout_Orientation) of `DirectedTreeLayout` is used to arrange the tree layout based on the direction. Orientation is only valid for hierarchical and organization layout. The default value for orientation is TopToBottom. The different orientation types are defined in the following table:
276+
[`Orientation`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.Layout.DirectedTreeLayout.html#Syncfusion_UI_Xaml_Diagram_Layout_DirectedTreeLayout_Orientation) of `DirectedTreeLayout` is used to arrange the tree layout based on the direction. Orientation is only valid for hierarchical and organization layout. The default value for orientation is TopToBottom. The different orientation types are defined in the following table:
277277

278278
| Orientation Type | Description |
279279
|---|---|---|
@@ -303,7 +303,7 @@ diagram.LayoutManager = new LayoutManager()
303303
304304
## Avoiding connector segment overlapping in layout
305305

306-
The [AvoidSegmentOverlapping](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.Layout.DirectedTreeLayout.html#Syncfusion_UI_Xaml_Diagram_Layout_DirectedTreeLayout_AvoidSegmentOverlapping) property of `DirectedTreeLayout` is used to decide whether segment of each connector from a single parent is distributed automatically or not. It is only valid for hierarchical and multi-parent layout.
306+
The [`AvoidSegmentOverlapping`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.Layout.DirectedTreeLayout.html#Syncfusion_UI_Xaml_Diagram_Layout_DirectedTreeLayout_AvoidSegmentOverlapping) property of `DirectedTreeLayout` is used to decide whether segment of each connector from a single parent is distributed automatically or not. It is only valid for hierarchical and multi-parent layout.
307307

308308
{% tabs %}
309309
{% highlight xaml %}
@@ -327,7 +327,7 @@ diagram.LayoutManager = new LayoutManager()
327327
328328
## Customize margin in layout
329329

330-
The [Margin](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.Layout.LayoutBase.html#Syncfusion_UI_Xaml_Diagram_Layout_LayoutBase_Margin) property of `DirectedTreeLayout` is used to provide space between the bounds of the tree layout to the diagram. The default margin value is `50`.
330+
The [`Margin`](https://help.syncfusion.com/cr/wpf/Syncfusion.UI.Xaml.Diagram.Layout.LayoutBase.html#Syncfusion_UI_Xaml_Diagram_Layout_LayoutBase_Margin) property of `DirectedTreeLayout` is used to provide space between the bounds of the tree layout to the diagram. The default margin value is `50`.
331331

332332
{% tabs %}
333333
{% highlight xaml %}

0 commit comments

Comments
 (0)