Skip to content

Commit cce9c6b

Browse files
Merge pull request #264 from syncfusion-content/PopupAPI_hotfix
Included API reference for the public API's for MAUI Toolkit Popup
2 parents b88ca5d + 5f74751 commit cce9c6b

File tree

9 files changed

+102
-102
lines changed

9 files changed

+102
-102
lines changed

maui-toolkit/Popup/Popup-Events.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ There are four built-in events in the SfPopup control namely:
1818

1919
## Opening event
2020

21-
The `Opening` event will be fired whenever opening the Popup in the application. It can cancel popup opening with `CancelEventArgs` that contains the following property:
21+
The [Opening](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_Opening) event will be fired whenever opening the Popup in the application. It can cancel popup opening with `CancelEventArgs` that contains the following property:
2222

2323
* `Cancel`: Popup opening is based on this value.
2424

@@ -43,7 +43,7 @@ private void Popup_Opening(object sender, System.ComponentModel.CancelEventArgs
4343

4444
## Opened event
4545

46-
The `Opened` event will be fired whenever displaying the Popup in the application.
46+
The [Opened](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_Opened) event will be fired whenever displaying the Popup in the application.
4747

4848
You can execute your own set of codes once the popup is opened, and visible in the application in its respective event handler.
4949

@@ -68,7 +68,7 @@ private void Popup_Opened(object sender, EventArgs e)
6868

6969
## Closing event
7070

71-
The `Closing` event will be fired whenever closing the Popup in the application. It can cancel the popup closing with `CancelEventArgs` that contains the following property:
71+
The [Closing](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_Closing) event will be fired whenever closing the Popup in the application. It can cancel the popup closing with `CancelEventArgs` that contains the following property:
7272

7373
* `Cancel`: Popup closing is based on this value.
7474

@@ -93,7 +93,7 @@ private void Popup_Closing(object sender, System.ComponentModel.CancelEventArgs
9393

9494
## Closed event
9595

96-
The `Closed` event will be fired whenever dismissing the Popup from the view.
96+
The [Closed](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_Closed) event will be fired whenever dismissing the Popup from the view.
9797

9898
You can execute your own set of codes once the popup is completely closed in its respective event handler.
9999

@@ -118,15 +118,15 @@ private void Popup_Closed(object sender, EventArgs e)
118118

119119
## Accept command
120120

121-
The `AcceptCommand` will be fired when clicking the Accept button in the popup footer.
121+
The [AcceptCommand](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_AcceptCommand) will be fired when clicking the Accept button in the popup footer.
122122

123123
To handle the Accept button,
124124

125125
* Derive a class from the `ICommand`, and implement its interface.
126126
* To prevent the popup from closing, return false in the `CanExecute()` override method and the `Execute()` override method will not be fired.
127127
* Else return true in the `CanExecute()` override method and do the required operations in the `Execute()` method.
128128
* Now, create a property of your custom command type in the view model class and initialize it.
129-
* Bind the property in the view model to the `AcceptCommand` in XAML.
129+
* Bind the property in the view model to the [AcceptCommand](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_AcceptCommand) in XAML.
130130

131131
{% tabs %}
132132

@@ -199,15 +199,15 @@ class PopupViewModel : INotifyPropertyChanged
199199

200200
## Decline command
201201

202-
The `DeclineCommand` will be fired when clicking the Decline button in the popup footer.
202+
The [DeclineCommand](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_DeclineCommand) will be fired when clicking the Decline button in the popup footer.
203203

204204
To handle the Decline button,
205205

206206
* Derive a class from the ICommand, and implement its interface.
207207
* To prevent the popup from closing, return false in the `CanExecute()` override method and the `Execute()` override method will not be fired.
208208
* Else return true in the `CanExecute()` override method and do the required operations in the `Execute()` method.
209209
* Now, create a property of your custom command type in the view model class and initialize it.
210-
* Bind the property in the view model to the `DeclineCommand` in XAML.
210+
* Bind the property in the view model to the [DeclineCommand](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_DeclineCommand) in XAML.
211211

212212
{% tabs %}
213213

maui-toolkit/Popup/getting-started.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ documentation: ug
99

1010
# Getting Started with .NET MAUI Popup
1111

12-
This section guides you through setting up and configuring a `Popup` in your .NET MAUI application. Follow the steps below to add a basic Popup to your project.
12+
This section guides you through setting up and configuring a [Popup](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html) in your .NET MAUI application. Follow the steps below to add a basic Popup to your project.
1313

1414
{% tabcontents %}
1515
{% tabcontent Visual Studio %}
@@ -68,7 +68,7 @@ namespace GettingStarted
6868
## Step 4: Add a Basic Popup
6969

7070
1. To initialize the control, import the `Syncfusion.Maui.Toolkit.Popup` namespace into your code.
71-
2. Initialize `SfPopup` class.
71+
2. Initialize [SfPopup](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html) class.
7272

7373
{% tabs %}
7474
{% highlight xaml tabtitle="MainPage.xaml" %}
@@ -100,7 +100,7 @@ public partial class MainPage : ContentPage
100100

101101
## Step 5: Displaying popup
102102

103-
Display a popup over your view by calling the `Show` method.
103+
Display a popup over your view by calling the [Show](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_Show_System_Boolean_) method.
104104

105105
Refer to the following code example for displaying popup using Button's Click event.
106106

@@ -215,7 +215,7 @@ namespace GettingStarted
215215
## Step 4: Add a Basic Popup
216216

217217
1. To initialize the control, import the `Syncfusion.Maui.Toolkit.Popup` namespace into your code.
218-
2. Initialize `SfPopup` class.
218+
2. Initialize [SfPopup](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html) class.
219219

220220
{% tabs %}
221221
{% highlight xaml tabtitle="MainPage.xaml" %}
@@ -247,7 +247,7 @@ public partial class MainPage : ContentPage
247247

248248
## Step 5: Displaying popup
249249

250-
Display a popup over your view by calling the `Show` method.
250+
Display a popup over your view by calling the [Show](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_Show_System_Boolean_) method.
251251

252252
Refer to the following code example for displaying popup using Button's Click event.
253253

@@ -361,7 +361,7 @@ namespace GettingStarted
361361
## Step 4: Add a Basic Popup
362362

363363
1. To initialize the control, import the `Syncfusion.Maui.Toolkit.Popup` namespace into your code.
364-
2. Initialize `SfPopup` class.
364+
2. Initialize [SfPopup](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html) class.
365365

366366
{% tabs %}
367367
{% highlight xaml tabtitle="MainPage.xaml" %}
@@ -395,7 +395,7 @@ public partial class MainPage : ContentPage
395395

396396
## Close the popup
397397

398-
To close the popup programmatically, you can call either the `Dismiss` method or set the IsOpen property to false.
398+
To close the popup programmatically, you can call either the [Dismiss](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_Dismiss) method or set the IsOpen property to false.
399399

400400
Refer to the following code example for dismissing popup.
401401

@@ -419,17 +419,17 @@ The .NET MAUI Popup (SfPopup) allows showing the popup content at various positi
419419

420420
The following list of options is available to position the SfPopup in the desired position:
421421

422-
* `Center Positioning`: Use the `IsOpen` property or `Show` method to display the SfPopup at the center.
423-
* `Absolute Positioning`: Use the `Show(x-position, y-position)` to display the SfPopup at the specified X and y position.
424-
* `Relative Positioning`: Use the `ShowRelativeToView(View, RelativePosition)` to display the SfPopup at any of the 8 positions relative to the specified view.
425-
* `Absolute relative positioning`: Use the `ShowRelativeToView(View, RelativePosition,x position,y position)` to display the SfPopup at an absolute x,y coordinate from the relative position of the specified view.
422+
* `Center Positioning`: Use the [IsOpen](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_IsOpen) property or [Show](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_Show_System_Boolean_) method to display the SfPopup at the center.
423+
* `Absolute Positioning`: Use the [Show(x-position, y-position)](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_Show_System_Double_System_Double_) to display the SfPopup at the specified X and y position.
424+
* `Relative Positioning`: Use the [ShowRelativeToView(View, RelativePosition)](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_ShowRelativeToView_Microsoft_Maui_Controls_View_Syncfusion_Maui_Toolkit_Popup_PopupRelativePosition_System_Double_System_Double_) to display the SfPopup at any of the 8 positions relative to the specified view.
425+
* `Absolute relative positioning`: Use the [ShowRelativeToView(View, RelativePosition,x position,y position)](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_ShowRelativeToView_Microsoft_Maui_Controls_View_Syncfusion_Maui_Toolkit_Popup_PopupRelativePosition_System_Double_System_Double_) to display the SfPopup at an absolute x,y coordinate from the relative position of the specified view.
426426

427427
## Customizing layouts
428428

429-
By default, choose a layout from the following available layouts in the SfPopup by using the `AppearanceMode` property.
429+
By default, choose a layout from the following available layouts in the SfPopup by using the [AppearanceMode](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_AppearanceMode) property.
430430

431-
* `OneButton`: Shows the SfPopup with one button in the footer view. This is the default value.
432-
* `TwoButton`: Shows the SfPopup with two buttons in the footer view.
431+
* [OneButton]()https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.PopupButtonAppearanceMode.html#Syncfusion_Maui_Toolkit_Popup_PopupButtonAppearanceMode_OneButton) : Shows the SfPopup with one button in the footer view. This is the default value.
432+
* [TwoButton](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.PopupButtonAppearanceMode.html#Syncfusion_Maui_Toolkit_Popup_PopupButtonAppearanceMode_TwoButton): Shows the SfPopup with two buttons in the footer view.
433433

434434
Also, customize the entire popup view by loading the templates or custom views for the header, body, and footer.
435435

@@ -487,7 +487,7 @@ namespace GettingStarted
487487

488488
## Load template view in the popup body
489489

490-
Any view can be added as popup content by using the `ContentTemplate` property to refresh it. Refer to the following code example in which a label is added as popup content.
490+
Any view can be added as popup content by using the [ContentTemplate](https://help.syncfusion.com/cr/maui-toolkit/Syncfusion.Maui.Toolkit.Popup.SfPopup.html#Syncfusion_Maui_Toolkit_Popup_SfPopup_ContentTemplate) property to refresh it. Refer to the following code example in which a label is added as popup content.
491491

492492
{% tabs %}
493493

0 commit comments

Comments
 (0)