[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.Localization
  [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
  [Expand]DevExpress.Snap.Core.API
  [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.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.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
  [Collapse]DevExpress.XtraPdfViewer
   [Expand]IPdfViewerCommandFactoryService Interface
   [Expand]PdfAnnotationDeletingEventArgs Class
    PdfAnnotationDeletingEventHandler Delegate
   [Expand]PdfCancelSaveOperationException Class
    PdfContentMarginMode Enumeration
   [Expand]PdfCurrentPageChangedEventArgs Class
    PdfCurrentPageChangedEventHandler Delegate
    PdfCursorMode Enumeration
   [Expand]PdfDocumentChangedEventArgs Class
    PdfDocumentChangedEventHandler Delegate
   [Expand]PdfDocumentClosingEventArgs Class
    PdfDocumentClosingEventHandler Delegate
   [Expand]PdfDocumentProperties Class
   [Expand]PdfFileAttachmentOpeningEventArgs Class
    PdfFileAttachmentOpeningEventHandler Delegate
   [Expand]PdfFindDialogOptions Structure
   [Expand]PdfFindDialogVisibilityChangedEventArgs Class
    PdfFindDialogVisibilityChangedEventHandler Delegate
   [Expand]PdfFormFieldFocusEventArgs Class
    PdfFormFieldFocusEventHandler Delegate
   [Expand]PdfFormFieldValueChangedEventArgs Class
    PdfFormFieldValueChangedEventHandler Delegate
   [Expand]PdfFormFieldValueChangingEventArgs Class
    PdfFormFieldValueChangingEventHandler Delegate
   [Expand]PdfMarkupAnnotationGotFocusEventArgs Class
    PdfMarkupAnnotationGotFocusEventHandler Delegate
   [Expand]PdfMarkupAnnotationLostFocusEventArgs Class
    PdfMarkupAnnotationLostFocusEventHandler Delegate
   [Expand]PdfMarkupToolsSettings Class
    PdfNavigationPanePage Enumeration
    PdfNavigationPanePageVisibility Enumeration
   [Expand]PdfNavigationPaneSelectedPageChangedEventArgs Class
    PdfNavigationPaneSelectedPageChangedEventHandler Delegate
    PdfNavigationPaneVisibility Enumeration
   [Expand]PdfNavigationPaneVisibilityChangedEventArgs Class
    PdfNavigationPaneVisibilityChangedEventHandler Delegate
    PdfOutlineNodeTextSize Enumeration
   [Expand]PdfOutlineViewerSettings Class
   [Expand]PdfPageSetupDialogShowingEventArgs Class
    PdfPageSetupDialogShowingEventHandler Delegate
    PdfPopupMenuKind Enumeration
   [Expand]PdfPopupMenuShowingEventArgs Class
    PdfPopupMenuShowingEventHandler Delegate
   [Expand]PdfReferencedDocumentOpeningEventArgs Class
    PdfReferencedDocumentOpeningEventHandler Delegate
   [Expand]PdfScrollPositionChangedEventArgs Class
    PdfScrollPositionChangedEventHandler Delegate
   [Expand]PdfSelectionContent Structure
    PdfSelectionContentType Enumeration
   [Expand]PdfSelectionEventArgs Class
    PdfSelectionPerformedEventHandler Delegate
   [Expand]PdfTextMarkupAnnotationChangedEventArgs Class
    PdfTextMarkupAnnotationChangedEventHandler Delegate
   [Expand]PdfTextMarkupAnnotationCreatedEventArgs Class
    PdfTextMarkupAnnotationCreatedEventHandler Delegate
   [Expand]PdfTextMarkupAnnotationCreatingEventArgs Class
    PdfTextMarkupAnnotationCreatingEventHandler Delegate
   [Expand]PdfUriOpeningEventArgs Class
    PdfUriOpeningEventHandler Delegate
   [Collapse]PdfViewer Class
     PdfViewer Members
     PdfViewer Constructor
    [Expand]PdfViewer Properties
    [Collapse]PdfViewer Events
      AnnotationDeleting Event
      CurrentPageChanged Event
      DocumentChanged Event
      DocumentClosing Event
      FileAttachmentOpening Event
      FindDialogVisibilityChanged Event
      FormFieldGotFocus Event
      FormFieldLostFocus Event
      FormFieldValueChanged Event
      FormFieldValueChanging Event
      MarkupAnnotationGotFocus Event
      MarkupAnnotationLostFocus Event
      NavigationPaneSelectedPageChanged Event
      NavigationPaneVisibilityChanged Event
      PageSetupDialogShowing Event
      PasswordRequested Event
      PopupMenuShowing Event
      PrintPage Event
      QueryPageSettings Event
      ReferencedDocumentOpening Event
      ScrollPositionChanged Event
      SelectionContinued Event
      SelectionEnded Event
      SelectionStarted Event
      TextMarkupAnnotationChanged Event
      TextMarkupAnnotationCreated Event
      TextMarkupAnnotationCreating Event
      UpdateUI Event
      UriOpening Event
      ZoomChanged Event
    [Expand]PdfViewer Methods
    PdfViewerToolbarKind Enumeration
   [Expand]PdfZoomChangedEventArgs Class
    PdfZoomChangedEventHandler Delegate
    PdfZoomMode Enumeration
  [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]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)

PdfViewer.TextMarkupAnnotationCreating Event

Occurs when a text markup annotation (highlight, strikethrough or underline) is being created.

Namespace:DevExpress.XtraPdfViewer
Assembly:DevExpress.XtraPdfViewer.v18.2.dll

Expanded Syntax

Expanded Event Data

The event handler receives an argument of type PdfTextMarkupAnnotationCreatingEventArgs containing data related to this event.

The following PdfTextMarkupAnnotationCreatingEventArgs properties provide information specific to this event.
Property Description
Author Specifies the author of a text markup annotation.
Bounds Gets the text markup annotation's bounds on a page.
Cancel Gets or sets a value indicating whether the event should be canceled.
Color Specifies the markup annotation color and transparency.
Comment Specifies text to be displayed when the markup annotation's popup window is opened over a page.
CreationDate Specifies the date and time when the markup annotation was created on the page.
IsSelected Specifies whether a newly created markup annotation is selected.
ModificationDate Specifies the date and time of the markup annotation's last modification.
Name Specifies the markup annotation name.
PageNumber Gets the page number where the annotation is being created.
Quads Gets a collection of quadrilaterals that encompass the text markup annotation drawing area.
SelectedText Gets a selected text for which a markup annotation is being created on a page.
Style Specifies the style of a text markup annotation.
Subject Specifies a short description of the subject being addressed by the text markup annotation.

Expanded Remarks

You can prohibit the text markup annotation creation for a selected text by setting the e.Cancel property to true.

Expanded Example

This example demonstrates how to specify the text markup annotation properties when the annotation is being created in a document.

To add a markup to text:

  • Select the text;
  • Right-click the text and choose Highlight, Strikethrough or Underline item in the invoked context menu.

When the text markup annotation is being created in a document, the TextMarkupAnnotationCreating event is raised. In this event, you can specify the annotation properties (for example, the default color used to underline a text using the PdfTextMarkupAnnotationCreatingEventArgs.Color property as shown in the code below).

You can see properties applied to a newly created annotation in the Annotation Properties dialog.

To open this dialog, right-click the annotation and choose the Properties… item in the context menu.

The Annotation Properties dialog is shown below.

The following code shows how to handle the TextMarkupAnnotationCreating event.

Expanded See Also

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