HelpRequestEventArgs.HelpLink Property

Gets or sets a help link that is opened when an end-user clicks the help button.

Namespace: DevExpress.Xpf.Dialogs

Assembly: DevExpress.Xpf.Dialogs.v24.2.dll

NuGet Package: DevExpress.Wpf.Dialogs

Declaration

C#

public string HelpLink { get; set; }

VB.NET

Public Property HelpLink As String

Property Value

Type	Description
String	A String that is a help link that is opened when an end-user clicks the help button.

Remarks

Use the HelpLink property to provide a help link for end users.

Note

The provided link will be opened using the Process.Start method.

The code sample below demonstrates how to provide a custom help link by handling the DXFileDialog.HelpRequest event.

C#

private void button_Click(object sender, RoutedEventArgs e) {
    var fileDialog = new DXSaveFileDialog();
    fileDialog.Filter = "Image Files|*.BMP;*.JPG;*.GIF|All files|*.*";
    fileDialog.ShowHelp = true;
    fileDialog.HelpRequest += FileDialog_HelpRequest;
    fileDialog.ShowDialog();
}

private void FileDialog_HelpRequest(object sender, HelpRequestEventArgs e) {
    e.HelpLink = "https://docs.devexpress.com";
}

VB.NET

Private Sub button_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Dim fileDialog = New DXSaveFileDialog()
    fileDialog.Filter = "Image Files|*.BMP;*.JPG;*.GIF|All files|*.*"
    fileDialog.ShowHelp = True
    fileDialog.HelpRequest += FileDialog_HelpRequest
    fileDialog.ShowDialog()
End Sub

Private Sub FileDialog_HelpRequest(ByVal sender As Object, ByVal e As HelpRequestEventArgs)
    e.HelpLink = "https://docs.devexpress.com"
End Sub