TextHighlight Members

PDFTron SilverDox SDK

previous page next page

The TextHighlight type exposes the following members.

Constructors

	Name	Description
	TextHighlight()()()()	Creates a new instance of the TextHighlight class. This constructor is used when loading annotations with LoadAnnotations(Stream, Predicate<(Of <<'(Annotation>)>>)).
	TextHighlight(AnnotationManager)	Creates a new instance of the TextHighlight class.

Methods

	Name	Description
	Create	Creates a new instance of the TextHighlight class.
	CreateAppearanceCanvas	Creates and returns the annotation's appearance canvas that will be displayed on screen. (Inherited from TextMarkup.)
	CreatePopupCanvas	Creates canvas used as the popup when an annotation is double clicked on. Override this method to provide a customized popup canvas. (Inherited from Annotation.)
	DrawTextAnnotation	Alters Appearance using the TextQuads so that the text is highlighted. (Overrides TextMarkup..::..DrawTextAnnotation()()()().)
	OnAnnotationResizeEnded	Called by the annotation's AnnotationManager when the user has finished resizing the annotation (Inherited from Annotation.)
	OnAnnotationResizeStarted	Called by the annotation's AnnotationManager when the user has began resizing this annotation (Inherited from Annotation.)
	OnCreateMouseDown	Called by the annotation's AnnotationManager when a MouseDown event is received and the AnnotationManager is set to create this type of annotation. (Inherited from Annotation.)
	OnCreateMouseMove	Called by the annotation's AnnotationManager when a MouseMove event is received and the AnnotationManager is set to create this type of annotation. (Inherited from TextMarkup.)
	OnCreateMouseUp	Called by the annotation's AnnotationManager when a MouseUp event is received and the AnnotationManager is set to create this type of annotation. (Inherited from Annotation.)

Fields

	Name	Description
	Appearance	The canvas that was last returned by the method CreateAppearanceCanvas()()()(). (Inherited from TextMarkup.)
	shouldBeCreated	Determines whether or not the annotation should be created in OnCreateMouseUp This is used for TextMarkups that do not select any text to prevent it from being created when the user releases the mouse (Inherited from Annotation.)

Properties

	Name	Description
	AnnotationManager	Gets or sets the annotation's AnnotationManager. (Inherited from Annotation.)
	Author	Represents the author of the annotation. Default is an empty string. (Inherited from Annotation.)
	Bottom	Gets the y-axis value of the bottom of the annotation. (Inherited from Annotation.)
	DateModified	Gets or sets the last date and time that the annotation was modified. (Inherited from Annotation.)
	Document	The document that is used to determine the location of the text on a page. (Inherited from TextMarkup.)
	FillColor	Gets or sets the color of the annotation's interior. (Inherited from Markup.)
	Height	Gets or sets the annotation's height. (Inherited from Markup.)
	Id	A unique identifier that can be assigned to determine different annotations (Inherited from Annotation.)
	IsCopyable	Indicates whether or not the user should be able to copy this annotation Returns false by default for TextMarkup annotations (Inherited from TextMarkup.)
	IsCreated	Gets or sets if the annotation has finished being created by the user. (Inherited from Annotation.)
	IsSelectable	Indicates whether or not the user can select this annotation Default is true (Inherited from Annotation.)
	Left	Gets the x-axis value of the left side of the annotation. (Inherited from Annotation.)
	MirroredHorizontally	True if the annotation has been mirrored horizontally. (Inherited from Annotation.)
	MirroredVertically	True if the annotation has been mirrored vertically. (Inherited from Annotation.)
	NoMove	Gets or sets if this annotation can be moved by the user. (Inherited from Annotation.)
	NoResize	Gets or sets if this annotation can be resized by the user. (Inherited from Annotation.)
	NoZoom	Gets or sets if this annotation scales with the page. (Inherited from Annotation.)
	PageNumber	Gets or sets the page number of a document that the annotation appears on. (Inherited from Annotation.)
	PopupContents	Gets or sets the contents of the annotation's popup. (Inherited from Annotation.)
	PopupHeight	Gets or sets the annotation's popup's height. (Inherited from Annotation.)
	PopupIsVisible	Gets or sets if the annotation's popup is visible. (Inherited from Annotation.)
	PopupWidth	Gets or sets the annotation's popup's width. (Inherited from Annotation.)
	PopupX	Gets or sets the annotation's popup's x-axis position. (Inherited from Annotation.)
	PopupY	Gets or sets the annotation's popup's y-axis position. (Inherited from Annotation.)
	Right	Gets the x-axis value of the right side of the annotation. (Inherited from Annotation.)
	SelectEnd	The point at which text selection ends. (Inherited from TextMarkup.)
	SelectStart	The point at which text selection starts. (Inherited from TextMarkup.)
	StrokeColor	Gets or sets the color of the annotation's stroke. (Inherited from Markup.)
	StrokeDashArray	Gets or sets a collection of Double values that indicate the pattern of dashes and gaps that is used to outline the annotation. (Inherited from Markup.)
	StrokeThickness	Gets or sets the width of the annotation's stroke outline. (Inherited from Markup.)
	Subject	Represents the subject of the annotation. Default is the annotation's type. (Inherited from Annotation.)
	TextQuads	Represents the boundaries of the text selected between the corner points defined by SelectStart and SelectEnd. (Inherited from TextMarkup.)
	Top	Gets the y-axis position of the top of the annotation. (Inherited from Annotation.)
	Width	Gets or sets the annotation's width. (Inherited from Markup.)
	X	Gets or sets the annotation's x-axis position. (Inherited from Markup.)
	Y	Gets or sets the annotation's y-axis position. (Inherited from Markup.)

Events

	Name	Description
	PropertyChanged	Occurs when a property changes in the annotation (Inherited from Annotation.)

TextHighlight Members

PDFTron SilverDox SDK

Constructors

Methods

Fields

Properties

Events

See Also

Get in touch