Skip to content

947788-Updated the note tag for maui controls ug #3170

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.

Sign up for GitHub

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 1 commit into
base: development
Choose a base branch
from
Open

947788-Updated the note tag for maui controls ug #3170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions MAUI/DataForm/Data-annotations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ public string Name { get; set; }
{% endhighlight %}
{% endtabs %}

N> The `ReadOnlyAttribute` takes higher priority than `EditableAttribute`
>Note: The `ReadOnlyAttribute` takes higher priority than `EditableAttribute`

## DataType attribute

Expand Down Expand Up @@ -373,4 +373,4 @@ public DateTime EventDate { get; set; }
{% endhighlight %}
{% endtabs %}

N> [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/DataFormAnnotations)
>Note: [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/DataFormAnnotations)
28 changes: 14 additions & 14 deletions MAUI/DataForm/DataForm-settings.md
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions MAUI/DataForm/Editing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,9 @@ this.dataForm.Commit();
{% endhighlight %}
{% endtabs %}

N> On manual commit, manual validation will be called to validate the properties before the commit.
>Note: On manual commit, manual validation will be called to validate the properties before the commit.

N> [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/ManualCommit)
>Note: [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/ManualCommit)

## Value converter attribute

Expand Down Expand Up @@ -144,7 +144,7 @@ public class StringToDateTimeConverter : IValueConverter

Here, the editor will display the original value as `DateTime`. While committing, it is converted to a `string` and stored in the data object.

N> [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/ConvertersSample)
>Note: [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/ConvertersSample)

## Read only mode

Expand Down
50 changes: 25 additions & 25 deletions MAUI/DataForm/Editors.md
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions MAUI/DataForm/Validation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ If the data form or property is valid, `true` will be returned. Or else `false`

![Error message in .NET MAUI DataForm.](images/validation/error-message.png)

N> [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/ManualValidation)
>Note: [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/ManualValidation)

## Valid message

Expand All @@ -154,7 +154,7 @@ public string Password { get; set; }

Get the validation details of all the editors of the data form using the [ValidateForm](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.SfDataForm.html#Syncfusion_Maui_DataForm_SfDataForm_ValidateForm) event of the data form.

N> This event will be raised once after the manual validation call using the [SfDataForm.Validate()](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.SfDataForm.html#Syncfusion_Maui_DataForm_SfDataForm_Validate) method.
>Note: This event will be raised once after the manual validation call using the [SfDataForm.Validate()](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.SfDataForm.html#Syncfusion_Maui_DataForm_SfDataForm_Validate) method.

{% tabs %}
{% highlight c# tabtitle="MainPage.xaml.cs" %}
Expand Down
2 changes: 1 addition & 1 deletion MAUI/DataForm/accessibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@ Shift + Tab<br/><br/></td><td>
Moves to the previous editor in DataForm<br/><br/></td></tr>
</table>

N>In the DataForm multiline editor, the Enter key is not functioning to move to the next editor.
>Note:In the DataForm multiline editor, the Enter key is not functioning to move to the next editor.

6 changes: 3 additions & 3 deletions MAUI/DataForm/explicit-data-editors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ documentation: UG

The data form auto-generates the editors based on the data type. You can explicitly add the data editors by adding [SfDataForm.Items](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.SfDataForm.html#Syncfusion_Maui_DataForm_SfDataForm_Items) manually, and you need to change the [AutoGenerateItems](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.SfDataForm.html#Syncfusion_Maui_DataForm_SfDataForm_AutoGenerateItems) property to false.

N> Use the [FieldName](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormItem.html#Syncfusion_Maui_DataForm_DataFormItem_FieldName) property to bind the editor to the data object property.
>Note: Use the [FieldName](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormItem.html#Syncfusion_Maui_DataForm_DataFormItem_FieldName) property to bind the editor to the data object property.
[GenerateDataFormItem](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.SfDataForm.html#Syncfusion_Maui_DataForm_SfDataForm_GenerateDataFormItem) event will not be triggered when [AutoGenerateItems](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.SfDataForm.html#Syncfusion_Maui_DataForm_SfDataForm_AutoGenerateItems) is false.

{% tabs %}
Expand Down Expand Up @@ -215,7 +215,7 @@ You can add custom editor manually by adding the custom view as an [EditorView](
{% endhighlight %}
{% endtabs %}

N> [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/ExplicitDataFormItems)
>Note: [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/ExplicitDataFormItems)

## Explicitly create data editors from custom data dictionary

Expand Down Expand Up @@ -288,4 +288,4 @@ public class DataFormItemManagerExt : DataFormItemManager
{% endhighlight %}
{% endtabs %}

N> [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/CustomDataDictionarySample)
>Note: [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/CustomDataDictionarySample)
12 changes: 6 additions & 6 deletions MAUI/DataForm/floating-label-layout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Dataform supports the floating label layout for the following editors.
* Date picker
* Time picker

N> The time picker will not work in the Windows platform within the text input layout.
>Note: The time picker will not work in the Windows platform within the text input layout.

## Container types
Containers enhance the perspective of the dataform editor views. By default, the container type is [Outlined](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.TextInputLayoutContainerType.html#Syncfusion_Maui_DataForm_TextInputLayoutContainerType_Outlined). By using the [ContainerType](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.TextInputLayoutSettings.html#Syncfusion_Maui_DataForm_TextInputLayoutSettings_ContainerType) property of the [TextInputLayoutSettings](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.TextInputLayoutSettings.html) in [DataForm](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.SfDataForm.html) or [DataFormItem](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormItem.html), modify the container type to [Filled](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.TextInputLayoutContainerType.html#Syncfusion_Maui_DataForm_TextInputLayoutContainerType_Filled) or [None](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.TextInputLayoutContainerType.html#Syncfusion_Maui_DataForm_TextInputLayoutContainerType_None).
Expand Down Expand Up @@ -286,7 +286,7 @@ private void OnGenerateDataFormItem(object sender, GenerateDataFormItemEventArgs
{% endhighlight %}
{% endtabs %}

N> The [LeadingView](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormItem.html#Syncfusion_Maui_DataForm_DataFormItem_LeadingView) is applicable for both [Default](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormLayoutType.html#Syncfusion_Maui_DataForm_DataFormLayoutType_Default) and [TextInputLayout](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormLayoutType.html#Syncfusion_Maui_DataForm_DataFormLayoutType_TextInputLayout) layout types
>Note: The [LeadingView](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormItem.html#Syncfusion_Maui_DataForm_DataFormItem_LeadingView) is applicable for both [Default](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormLayoutType.html#Syncfusion_Maui_DataForm_DataFormLayoutType_Default) and [TextInputLayout](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormLayoutType.html#Syncfusion_Maui_DataForm_DataFormLayoutType_TextInputLayout) layout types

![Leading view in .NET MAUI DataForm.](images/floating-label-layout/leading-view.png)

Expand Down Expand Up @@ -332,7 +332,7 @@ private void OnGenerateDataFormItem(object sender, GenerateDataFormItemEventArgs
{% endhighlight %}
{% endtabs %}

N> The [TrailingView](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormItem.html#Syncfusion_Maui_DataForm_DataFormItem_TrailingView) is applicable only when the [LayoutType](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormItem.html#Syncfusion_Maui_DataForm_DataFormItem_LayoutType) is [TextInputLayout](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormLayoutType.html#Syncfusion_Maui_DataForm_DataFormLayoutType_TextInputLayout).
>Note: The [TrailingView](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormItem.html#Syncfusion_Maui_DataForm_DataFormItem_TrailingView) is applicable only when the [LayoutType](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormItem.html#Syncfusion_Maui_DataForm_DataFormItem_LayoutType) is [TextInputLayout](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormLayoutType.html#Syncfusion_Maui_DataForm_DataFormLayoutType_TextInputLayout).

![Trailing view in .NET MAUI DataForm.](images/floating-label-layout/trailing-view.png)

Expand Down Expand Up @@ -865,11 +865,11 @@ private void OnGenerateDataFormItem(object sender, GenerateDataFormItemEventArgs

![Focused and unfocused stroke thickness in .NET MAUI DataForm.](images/floating-label-layout/stroke-thickness.png)

N> [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/FloatingLabelLayoutSample)
>Note: [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/FloatingLabelLayoutSample)

## Unsupported editors
The Floating label layout does not support non-editable editors such as [RadioGroup editor](https://help.syncfusion.com/maui/dataform/editors#radiogroup-editor), [CheckBox editor](https://help.syncfusion.com/maui/dataform/editors#checkbox-editor), and [Switch editor](https://help.syncfusion.com/maui/dataform/editors#switch-editor).

N> By default, the layout type of unsupported editors is `Default`. You can also set the layout type for the unsupported editor using this [Changing layout type of the DataFormItem](https://help.syncfusion.com/maui/dataform/floating-label-layout#changing-the-layout-type-for-the-editor).
>Note: By default, the layout type of unsupported editors is `Default`. You can also set the layout type for the unsupported editor using this [Changing layout type of the DataFormItem](https://help.syncfusion.com/maui/dataform/floating-label-layout#changing-the-layout-type-for-the-editor).

N> The time picker will not work in Windows platform within the text input layout.
>Note: The time picker will not work in Windows platform within the text input layout.
2 changes: 1 addition & 1 deletion MAUI/DataForm/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ public partial class MainPage : ContentPage
{% endtabcontent %}
{% endtabcontents %}

N> [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/GettingStarted)
>Note: [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/GettingStarted)

## DataForm inside stack layout

Expand Down
4 changes: 2 additions & 2 deletions MAUI/DataForm/grouping.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ private void OnGenerateDataFormItem(object sender, GenerateDataFormItemEventArgs

![Group header padding in .NET MAUI DataForm.](images/grouping/padding.png)

N> [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/DataFormGrouping)
>Note: [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/DataFormGrouping)

## Group header customization

Expand All @@ -438,5 +438,5 @@ The group header of the dataform can be customized by using the [GroupHeaderTemp
{% endhighlight %}
{% endtabs %}

N>
>Note:
* The BindingContext of the [GroupHeaderTemplate](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.SfDataForm.html#Syncfusion_Maui_DataForm_SfDataForm_GroupHeaderTemplate) is the [DataFormGroupItem](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormGroupItem.html).
8 changes: 4 additions & 4 deletions MAUI/DataForm/layout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ this.Content = dataForm;
{% endhighlight %}
{% endtabs %}

N> Setting the [ColumnCount](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.SfDataForm.html#Syncfusion_Maui_DataForm_SfDataForm_ColumnCount) property to SfDataForm does not arrange the data fields in a group according to the column count. To set the column count for data fields in the data form group, refer to the [loading different layout for data form group](https://help.syncfusion.com/maui/dataform/grouping#changing-the-layout-for-the-group).
>Note: Setting the [ColumnCount](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.SfDataForm.html#Syncfusion_Maui_DataForm_SfDataForm_ColumnCount) property to SfDataForm does not arrange the data fields in a group according to the column count. To set the column count for data fields in the data form group, refer to the [loading different layout for data form group](https://help.syncfusion.com/maui/dataform/grouping#changing-the-layout-for-the-group).

When the label position is Top, the grid layout is shown as follows:

Expand Down Expand Up @@ -191,7 +191,7 @@ private void OnGenerateDataFormItem(object sender, GenerateDataFormItemEventArgs

![Leading label icon in .NET MAUI DataForm.](images/layout/leading-label-icon.png)

N> [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/LabelIconSample)
>Note: [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/LabelIconSample)

## Changing order of the editors

Expand Down Expand Up @@ -278,7 +278,7 @@ this.Content = dataForm;
{% endhighlight %}
{% endtabs %}

N> The label width customization is applicable only when the [LabelPosition](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormDefaultLayoutSettings.html#Syncfusion_Maui_DataForm_DataFormDefaultLayoutSettings_LabelPosition) is Left.
>Note: The label width customization is applicable only when the [LabelPosition](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormDefaultLayoutSettings.html#Syncfusion_Maui_DataForm_DataFormDefaultLayoutSettings_LabelPosition) is Left.

By default, the available width is divided into 40% for the label and 60% for the editor.

Expand Down Expand Up @@ -437,4 +437,4 @@ private void OnGenerateDataFormItem(object sender, GenerateDataFormItemEventArgs
{% endhighlight %}
{% endtabs %}

N> The `EditorHeight` customization is applicable for both [Default](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormLayoutType.html#Syncfusion_Maui_DataForm_DataFormLayoutType_Default) and [TextInputLayout](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormLayoutType.html#Syncfusion_Maui_DataForm_DataFormLayoutType_TextInputLayout) layout types.
>Note: The `EditorHeight` customization is applicable for both [Default](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormLayoutType.html#Syncfusion_Maui_DataForm_DataFormLayoutType_Default) and [TextInputLayout](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.DataForm.DataFormLayoutType.html#Syncfusion_Maui_DataForm_DataFormLayoutType_TextInputLayout) layout types.
4 changes: 2 additions & 2 deletions MAUI/DataForm/localization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public partial class App : Application
{% endhighlight %}
{% endtabs %}

N> The required `resx` files with `Build Action` as `EmbeddedResource` (File name should contain culture code) into the `Resources` folder.
>Note: The required `resx` files with `Build Action` as `EmbeddedResource` (File name should contain culture code) into the `Resources` folder.

## Add Localization resx file in sample level

Expand Down Expand Up @@ -186,4 +186,4 @@ Here, the radio group items source gets localized based on culture from Localiza

![Localization in .NET MAUI DataForm.](images/localization/localization.jpg)

N> [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/Localization)
>Note: [View sample in GitHub](https://github.com/SyncfusionExamples/maui-dataform/tree/master/Localization)
2 changes: 1 addition & 1 deletion MAUI/DigitalGauge/Getting-Started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,4 +353,4 @@ public partial class MainPage : ContentPage

![getting-started](Images\getting-started.png)

N> You can refer to our [.NET MAUI Digital Gauge](https://www.syncfusion.com/maui-controls/maui-digital-gauge) feature tour page for its groundbreaking feature representations. You can also explore our [.NET MAUI Digital Gauge Example](https://github.com/syncfusion/maui-demos/tree/master/MAUI/Gauges/SampleBrowser.Maui.Gauges/Samples/DigitalGauge) that shows you how to render the Digital Gauge in .NET MAUI.
>Note: You can refer to our [.NET MAUI Digital Gauge](https://www.syncfusion.com/maui-controls/maui-digital-gauge) feature tour page for its groundbreaking feature representations. You can also explore our [.NET MAUI Digital Gauge Example](https://github.com/syncfusion/maui-demos/tree/master/MAUI/Gauges/SampleBrowser.Maui.Gauges/Samples/DigitalGauge) that shows you how to render the Digital Gauge in .NET MAUI.
4 changes: 2 additions & 2 deletions MAUI/ImageEditor/accessibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Image Editor is designed to work effectively with the icons and sliders on i

The [Syncfusion .NET MAUI Image Editor](https://www.syncfusion.com/maui-controls/maui-image-editor) supports keyboard shortcuts for user interaction. The table provided outlines various shortcuts and their associated functions.

N> [ToolbarItemSelected](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.ImageEditor.SfImageEditor.html#Syncfusion_Maui_ImageEditor_SfImageEditor_ToolbarItemSelected) event triggers for toolbar item tapped.
>Note: [ToolbarItemSelected](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.ImageEditor.SfImageEditor.html#Syncfusion_Maui_ImageEditor_SfImageEditor_ToolbarItemSelected) event triggers for toolbar item tapped.

#### Toolbar

Expand Down Expand Up @@ -59,4 +59,4 @@ Opens the image browser to import the new image inside ImageEditor.
<br/><br/></td></tr>
</table>

N> Use the `Command` key instead of the `Ctrl` key in macOS.
>Note: Use the `Command` key instead of the `Ctrl` key in macOS.
6 changes: 3 additions & 3 deletions MAUI/ImageEditor/custom-view.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ Delete the selected custom view using the [`DeleteAnnotation`](https://help.sync

Remove all the custom view annotations using the [`ClearAnnotations`](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.ImageEditor.SfImageEditor.html#Syncfusion_Maui_ImageEditor_SfImageEditor_ClearAnnotations) method.

N> This is common for Shape, Text and CustomView annotations.
>Note: This is common for Shape, Text and CustomView annotations.

{% tabs %}
{% highlight xaml tabtitle="MainPage.xaml" %}
Expand Down Expand Up @@ -193,7 +193,7 @@ N> This is common for Shape, Text and CustomView annotations.

This [`AnnotationSelected`](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.ImageEditor.SfImageEditor.html#Syncfusion_Maui_ImageEditor_SfImageEditor_AnnotationSelected) event occurs when the annotation is selected.

N> This is common for Shape, Text and CustomView annotations.
>Note: This is common for Shape, Text and CustomView annotations.

{% tabs %}

Expand Down Expand Up @@ -221,7 +221,7 @@ N> This is common for Shape, Text and CustomView annotations.

This [AnnotationUnselected](https://help.syncfusion.com/cr/maui/Syncfusion.Maui.ImageEditor.SfImageEditor.html#Syncfusion_Maui_ImageEditor_SfImageEditor_AnnotationUnselected) event occurs when the annotation is unselected.

N> This is common for Shape, Text and CustomView annotations.
>Note: This is common for Shape, Text and CustomView annotations.

{% tabs %}

Expand Down
Loading