[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Collapse]DevExpress.Snap.Core.API
   [Expand]AfterInsertSnListColumnsEventArgs Class
    AfterInsertSnListColumnsEventHandler Delegate
   [Expand]AfterInsertSnListDetailEventArgs Class
    AfterInsertSnListDetailEventHandler Delegate
   [Expand]AfterInsertSnListEventArgs Class
    AfterInsertSnListEventHandler Delegate
   [Expand]AfterInsertSnListRecordDataEventArgs Class
    AfterInsertSnListRecordDataEventHandler Delegate
   [Expand]BeforeInsertSnListColumnsEventArgs Class
    BeforeInsertSnListColumnsEventHandler Delegate
   [Expand]BeforeInsertSnListDetailEventArgs Class
    BeforeInsertSnListDetailEventHandler Delegate
   [Expand]BeforeInsertSnListEventArgs Class
    BeforeInsertSnListEventHandler Delegate
   [Expand]BeforeInsertSnListRecordDataEventArgs Class
    BeforeInsertSnListRecordDataEventHandler Delegate
   [Expand]CalculatedField Class
   [Expand]CalculatedFieldCollection Class
   [Expand]DataFieldInfo Class
   [Expand]DataSourceChangedEventArgs Class
    DataSourceChangedEventHandler Delegate
    DataSourceChangeType Enumeration
   [Expand]DataSourceInfo Class
   [Expand]DataSourceInfoCollection Class
    GroupInterval Enumeration
   [Expand]IDataSourceOwner Interface
   [Expand]ISnapFieldOwner Interface
   [Expand]Parameter Class
   [Expand]ParameterCollection Class
   [Expand]PrepareSnListColumnsEventArgs Class
    PrepareSnListColumnsEventHandler Delegate
   [Expand]PrepareSnListDetailEventArgs Class
    PrepareSnListDetailEventHandler Delegate
   [Expand]PrepareSnListEventArgs Class
    PrepareSnListEventHandler Delegate
   [Expand]SnapBarCode Interface
   [Expand]SnapChart Interface
   [Expand]SnapCheckBox Interface
   [Expand]SnapDocument Interface
   [Expand]SnapDocumentFormat Class
   [Expand]SnapDocumentPosition Class
   [Expand]SnapDocumentRange Class
   [Expand]SnapEntity Interface
   [Collapse]SnapHyperlink Interface
     SnapHyperlink Members
    [Expand]SnapHyperlink Properties
   [Expand]SnapImage Interface
   [Expand]SnapList Interface
   [Expand]SnapListFilters Interface
   [Expand]SnapListGroupInfo Interface
   [Expand]SnapListGroupParam Structure
   [Expand]SnapListGroups Interface
   [Expand]SnapListSorting Interface
   [Expand]SnapSingleListItemEntity Interface
   [Expand]SnapSingleListItemEntitySupportsParameters Interface
   [Expand]SnapSparkline Interface
   [Expand]SnapSubDocument Interface
   [Expand]SnapText Interface
   [Expand]Theme Interface
   [Expand]ThemeCollection Interface
   [Expand]Themes Class
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Extensions.UI
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Layout
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Base
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.FluentDesignSystem
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.ToolbarForm
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Docking
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.GoogleCalendar
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraTreeMap.Printing
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

SnapHyperlink Interface

Provides functionality to insert hyperlinks in Snap documents.

Namespace:DevExpress.Snap.Core.API
Assembly:DevExpress.Snap.v19.1.Core.dll

Expanded Syntax

Expanded Remarks

A hyperlink's destination may be a web page, file, or specific position within a document.

Expanded Hyperlinks in the User Interface

Click the Hyperlink button in the General Tools: Insert toolbar tab to create a hyperlink in the User Interface.

The invoked Insert Hyperlink dialog allows you to create a hyperlink and specify its text, screen tip and destination.

To display a field's data as hyperlinks, Select the field and click the Properties button in the Data Tools: Field toolbar tab. Expand the Content Type drop-down menu and select Hyperlink.

You can also set the ScreenTip and Target properties of a hyperlink.

Expanded Hyperlinks in Code

Use the ISnapFieldOwner.CreateSnHyperlink method to create a SNHYPERLINK field in code, as shown below:

Expanded Field Result in Case of Empty Data Entry

The SNHYPERLINK field can be bound to a data field name (the SnapSingleListItemEntity.DataFieldName property) and to a display name (the DisplayField property).

You can use SnapSingleListItemEntity.EnableEmptyFieldDataAlias property to use an alternative field result (the SnapSingleListItemEntity.EmptyFieldDataAlias value) if the data source entry bound as the DataFieldName (see SnapSingleListItemEntity.DataFieldName) value is empty.

The table below shows SNHYPERLINK field result in different empty data source scenarios:

DataFieldName Data Source

DisplayField Data Source

Field Result

Empty data source (no data source entries or objects in the list)

<<DataFieldName>>

The data source does not contain the required entry

Specified

The SnapSingleListItemEntity.EmptyFieldDataAlias value if specified; otherwise, the DisplayField value.

Not Specified

<<DataFieldName>>

Set to an invalid data entry

<<DataFieldName>>

The required data entry returns an empty string.

Specified

The SnapSingleListItemEntity.EmptyFieldDataAlias value, if specified; otherwise, the DisplayField value.

Not Specified

<<DisplayField>>

Set to an invalid data entry

<<DataFieldName>>

The data source contains the required entry.

The required data entry is null, DBNull.Value or string.Empty

<<DataFieldName>>

Not Specified

The data source does not contain the required entry.

<<DisplayField>>
(the SnapSingleListItemEntity.EnableEmptyFieldDataAlias value is ignored).

Expanded Inheritance Hierarchy

Expanded See Also

Is this topic helpful?​​​​​​​