PdfContentEditorTool Class Members

In This Topic

The following tables list the members exposed by PdfContentEditorTool.

Public Constructors

	Name	Description
	PdfContentEditorTool	Initializes a new instance of the PdfContentEditorTool class.

Public Fields

	Name	Description
	ContentChangeDescription_AddClip	A string that describes the content change action when editor adds clip to the figure. The content change description that uses when clip adding.
	ContentChangeDescription_RemoveContent	A string that describes the content change action when editor removes content.
	ContentChangeDescription_RemoveFigures	A string that describes the content change action when editor removes figures.
	ContentChangeDescription_RenderFigures	A string that describes the content change action when editor renders figures.
	ContentChangeDescription_ReplaceResource	A string that describes the content change action when editor replaces the resource.
	ContentChangeDescription_SetGraphicsProperties	A string that describes the content change action when editor sets graphics properties of the content figure.
	ContentChangeDescription_TextChange	A string that describes the content change action when editor changes text of figure.
	ContentChangeDescription_Transform	A string that describes the content change action when editor transforms the content figure.

Public Properties

	Name	Description
	ActionButton	Gets or sets the mouse button, which executes the action of this tool. (Inherited from VisualTool)
	ActionCursor	Gets or sets a cursor, which should be used in image viewer when visual tool executes its action. (Inherited from VisualTool)
	ActiveInteractionController	Gets an active interaction controller. (Inherited from UserInteractionVisualTool)
	AllowNextItemSelection	Gets or sets a value indicating whether the tool allows changing focused item using the PerformNextItemSelection(Boolean) method. (Inherited from VisualTool)
	AppendMode	Gets or sets a value indicating whether the content editor tool edits PDF page content in append mode.
	BringToBackAction	Gets the UI action that moves the focused graphics figure view to the first position in view collection.
	BringToFrontAction	Gets the UI action that moves the focused graphics figure view to the last position in view collection.
	CanModifyImage	Gets a value indicating whether this visual tool can modify the image. (Inherited from VisualTool)
	ChangeFocusedItemBeforeInteraction	Gets or sets a value indicating whether focused item can be changed before interaction. (Inherited from UserInteractionVisualTool)
	Clipboard	Gets or sets the clipboard of this tool.
	ClipboardGraphicsFigureDataFormat	Gets the data format for graphics figures in clipboard.
	ContentFigureHighlightBrush	Gets or sets a brush, which must be used for filling the content figure bounding box.
	ContentFigureHighlightPen	Gets or sets a pen, which must be used for drawing the content figure bounding box.
	ContentFigureInteractionBrush	Gets or sets the brush that is used to fill content figure area when transformation occurs.
	CopyAction	Gets the UI action that copies the selected graphics figure to the clipboard.
	CurrentPage	Gets the PdfPage, which is associated with ImageViewer.FocusedImage.
	Cursor	Gets or sets a cursor, which should be used in image viewer when visual tool is active in image viewer. (Inherited from VisualTool)
	CutAction	Gets the UI action that cuts the selected graphics figure to the clipboard.
	DeleteAction	Gets the UI action that deletes the selected graphics figure.
	DeselectAllAction	Gets the UI action that deselects all graphics figures.
	DisableContextMenu	Gets or sets a value indicating whether image viewer must disable context menu in image viewer if the right mouse button is set as an action button of the visual tool. (Inherited from VisualTool)
	DocumentFontController	Gets the PDF document font controller that stores fonts of PDF document.
	Enabled	Gets or sets a value indicating whether VisualTool can respond to the user interaction. (Inherited from VisualTool)
	FigureHighlightBrush	Gets or sets a brush, which must be used for filling the figure bounding box.
	FigureHighlightPen	Gets or sets a pen, which must be used for drawing the figure bounding box.
	FiguresHighlight	Gets or sets a value indicating whether the tool must highlight the figures.
	FigureViewCollection	Gets the figure view collection that is showing using this visual tool.
	GroupContentFigures	Gets or sets a value indicating whether the content editor tool must group content figures.
	ImageViewer	Gets the ImageViewer object associated with this tool. (Inherited from VisualTool)
	InteractiveContentType	Gets or sets the type of the interactive content.
	IsFinishInteractionOnLostFocus	Gets or sets a value indicating whether interaction should be finished when focus is lost. (Inherited from UserInteractionVisualTool)
	IsMultipageModeSupported	Gets a value indicating whether this tool supports multipage mode.
	IsVisibleWithoutImage	Gets a value indicating whether this visual tool is visible if image is not painted in image viewer. (Inherited from VisualTool)
	Name	Gets the name of visual tool.
	PasteAction	Gets the UI action that pastes a graphics figure from the clipboard.
	RenderFiguresWhenDeactivating	Gets or sets a value indicating whether the RenderFiguresOnAllPages must be executed when visual tool is deactivated.
	RenderFiguresWhenImageIndexChanging	Gets or sets a value indicating whether the RenderFiguresOnPage must be executed when current page is changed in image viewer.
	SelectedFigure	Gets a current graphics figure.
	SelectedFigurePoints	Gets points of selected graphics figure.
	SelectedFigureView	Gets or sets a current graphics figure view.
	SelectNextItemKeyCode	Gets or sets a key code that changes the selected item to the next item. (Inherited from VisualTool)
	SelectPrevItemKeyCode	Gets or sets a key code that changes the selected item to the previous item. (Inherited from VisualTool)
	UndoManager	Gets or sets the undo manager.

Protected Properties

	Name	Description
	CanBeginInteractionAfterSetFocusedItem	Gets or sets a value indicating whether the interaction can be started right after the interactive object is selected. (Inherited from UserInteractionVisualTool)
	CanUserSetFocusedItem	Gets or sets a value indicating whether user can set the focused interactive object. (Inherited from UserInteractionVisualTool)
	EnableViewerInvalidate	Gets or sets a value indicating whether viewer must be invalidated when InvalidateViewer method is executed. (Inherited from VisualTool)
	FocusedItem	Gets or sets a focused item. (Inherited from UserInteractionVisualTool)
	InvokeRequired	Gets a value indicating whether the caller must call an invoke method when making method calls to the VisualTool because the caller is on a different thread than the one the VisualTool was created on. (Inherited from VisualTool)
	Items	Gets a collection of IInteractiveObject. (Inherited from UserInteractionVisualTool)
	MouseClickCount	Gets the count of mouse clicks in series of clicks. (Inherited from VisualTool)
	MouseClicksDelta	Gets or sets a delay, in milliseconds, between mouse clicks in series of clicks. (Inherited from VisualTool)
	UseActionButtonToInteractionController	Gets a value indicating whether interaction controller should use ActionButton of visual tool. (Inherited from UserInteractionVisualTool)

Public Methods

	Name	Description
	AbortBuildFigure	Aborts the building process of figure and removes the figure from FigureViewCollection collection.
	AddFigure	Overloaded. Adds a to the .
	AddFigureClip	Adds clip to the specified figure.
	BeginUndoAction	Begins a composite undo action.
	CancelActiveInteraction	Cancels an active interaction with interaction area of interactive object. (Inherited from UserInteractionVisualTool)
	EndUndoAction	Ends the undo action.
	FindFigures	Finds all figures, which are located at specified point.
	FindVisualTool<T>	Finds the specified visual tool of specified type in visual tool. (Inherited from VisualTool)
	FinishActiveInteraction	Finishes an active interaction with interaction area of interactive object. (Inherited from UserInteractionVisualTool)
	GetActiveInteractionController	Overloaded. Returns the active interaction controller of specified visual tool. (Inherited from UserInteractionVisualTool)
	GetNonContentFigures	Overloaded. Returns the non-content graphics figures for focused image.
	GetSupportedUIActions	Returns the supported UI actions.
	InvalidateFocusedItem	Invalidates a drawing box of focused interactive object. (Inherited from UserInteractionVisualTool)
	InvalidateItem	Invalidates a drawing box of specified interactive object. (Inherited from UserInteractionVisualTool)
	PerformNextItemSelection	Selects the next available item and makes it as the active item. (Inherited from UserInteractionVisualTool)
	RemoveAllFigures	Removes all figures.
	RemoveFigure	Removes specified figure.
	RemoveFigures	Removes the figures.
	RenderFigures	Renders the figure collection on the specified VintasoftImage.
	RenderFiguresOnAllPages	Renders the figure collection on all PDF pages.
	RenderFiguresOnPage	Renders the figure collection on current PDF page.
	ReplaceResource	Replaces the resource of ContentStreamGraphicsFigure.
	ScrollToFocusedItem	Scrolls the viewer to the focused item. (Inherited from UserInteractionVisualTool)
	SetContentGraphicsProperties	Sets the content graphics properties of specified content stream graphics figure.
	StartBuildClosedCurves	Starts the building process of closed curves.
	StartBuildCurves	Starts the building process of curves.
	StartBuildEllipse	Starts the building process of an EllipseFigure.
	StartBuildFigure	Overloaded. Starts the building process of a figure.
	StartBuildFormXObject	Starts the building process of form XObject.
	StartBuildFreehandLines	Starts the building process of freehand lines.
	StartBuildImage	Starts the building process of an ImageFigure.
	StartBuildLines	Starts the building process of lines.
	StartBuildPolygon	Starts the building process of a polygon.
	StartBuildRectangle	Starts the building process of a RectangleFigure.
	StartBuildTextBox	Starts the building process of a TextBoxFigure.
	StartBuildTextLine	Starts the building process of a text line.
	ToString	Returns the string representation of this object. (Inherited from VisualTool)
	TransformFigure	Transforms the figure using specified affine matrix.

Protected Methods

	Name	Description
	BeginInteraction	Begins an active interaction. (Inherited from UserInteractionVisualTool)
	CanChangeFocusedItem	Determines that focused item can be changed. (Inherited from UserInteractionVisualTool)
	CanSelectNextItem	Returns a value indicating whether next item can be selected.
	CheckIsPointOnUnfocusedImage	Returns a value indicating whether the point is located on unfocused image. (Inherited from UserInteractionVisualTool)
	CreateDocumentFontController	Creates the PDF document font controller that stores PDF document fonts.
	CreateFigureView	Creates the figure view.
	Dispose	Overloaded. Releases all resources used by the object. (Inherited from UserInteractionVisualTool)
	DrawFigureHighlight	Draws the highlighting for figures.
	DrawItem	Draws an interactive object on specified graphics.
	FindInteractionArea	Finds the interaction area at the specified location, in viewer space. (Inherited from UserInteractionVisualTool)
	FindInteractiveObject	Finds an interactive object at specified point on image viewer. (Inherited from UserInteractionVisualTool)
	FinishInteraction	Finishes an active interaction.
	GetItemDrawingBox	Returns the item drawing box. (Inherited from UserInteractionVisualTool)
	GetPointsTransform	Returns a point transformation of specified interactive object. (Inherited from UserInteractionVisualTool)
	InvalidateViewer	Overloaded. Invalidates the specified region of the , and causes a paint message to be sent to the . (Inherited from VisualTool)
	Invoke	Overloaded. Executes the specified delegate, on the thread that owns the 's underlying , with the specified list of arguments. (Inherited from VisualTool)
	IsActionButtonContains	Determines whether the ActionButton contains the button. (Inherited from VisualTool)
	NeedProcessMouseEvent	Returns a value indicating whether the visual tool will process the mouse event. (Inherited from UserInteractionVisualTool)
	OnActivated	Raises the Activated event.
	OnActivating	Raises the Activating event. (Inherited from VisualTool)
	OnActiveInteractionControllerChanged	Raises the Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool.ActiveInteractionControllerChanged event.
	OnBeginBuilding	Raises the FigureBuildingStarted event.
	OnCancelBuilding	Raises the FigureBuildingCanceled event.
	OnDeactivated	Raises the Deactivated event.
	OnDeactivating	Raises the Deactivating event. (Inherited from VisualTool)
	OnEnabledChanged	Raises the EnabledChanged event. (Inherited from VisualTool)
	OnFigureCollectionChanged	Raises the FigureCollectionChanged event.
	OnFigureCollectionChanging	Raises the FigureCollectionChanging event.
	OnFigureViewCollectionChanged	Raises the FigureViewCollectionChanged event.
	OnFinishBuilding	Raises the FigureBuildingFinished event.
	OnFocusedItemChanged	Occurs when selected item is changed.
	OnFocusedItemChanging	Occurs when focused item is changing. (Inherited from UserInteractionVisualTool)
	OnImageChanged	Raises the ImageChanged event. (Inherited from VisualTool)
	OnImageChanging	Raises the ImageChanging event. (Inherited from VisualTool)
	OnImageLoadingException	Raises the ImageLoadingException event. (Inherited from VisualTool)
	OnInteraction	Raises the interaction event for specified interactive object. (Inherited from UserInteractionVisualTool)
	OnItemCollectionChanged	Called when item collection is changed. (Inherited from UserInteractionVisualTool)
	OnItemStateChanged	Occurs when state of interactive object is changed. (Inherited from UserInteractionVisualTool)
	OnKeyDown	Raises the KeyDown event. (Inherited from UserInteractionVisualTool)
	OnKeyUp	Raises the KeyUp event. (Inherited from UserInteractionVisualTool)
	OnLostFocus	Occurs when visual tool loses the focus. (Inherited from UserInteractionVisualTool)
	OnMouseClick	Raises the MouseClick event. (Inherited from VisualTool)
	OnMouseDoubleClick	Raises the MouseDoubleClick event. (Inherited from VisualTool)
	OnMouseDown	Raises the MouseDown event. (Inherited from UserInteractionVisualTool)
	OnMouseEnter	Raises the MouseEnter event. (Inherited from VisualTool)
	OnMouseLeave	Raises the MouseLeave event. (Inherited from VisualTool)
	OnMouseMove	Raises the MouseMove event. (Inherited from UserInteractionVisualTool)
	OnMouseUp	Raises the MouseUp event. (Inherited from UserInteractionVisualTool)
	OnMouseWheel	Raises the MouseWheel event. (Inherited from VisualTool)
	OnPageContentChanged	Raises the PageContentChanged event.
	OnPageContentChanging	Raises the PageContentChanged event.
	OnPaint	Overloaded. Paints the content of visual tool on specified image.
	OnPreviewKeyDown	Raises the PreviewKeyDown event. (Inherited from VisualTool)
	OnSelectedFigureViewChanged	Raises the SelectedFigureViewChanged event.
	PointToInteractiveObject	Transforms a point from the viewer space to the interactive object space. (Inherited from UserInteractionVisualTool)
	ProcessImeMessages	Processes the IME Windows messages. (Inherited from UserInteractionVisualTool)
	Reset	Resets this tool. (Inherited from VisualTool)
	ScrollToItem	Scrolls the viewer to the specified item. (Inherited from UserInteractionVisualTool)
	SetInteractionControllerProperties	Sets properties to the specified interaction controller. (Inherited from UserInteractionVisualTool)
	TryFinishInteraction	Tries to finish the current interaction. (Inherited from UserInteractionVisualTool)

Public Events

	Name	Description
	Activated	Occurs when the visual tool is activated in the image viewer. (Inherited from VisualTool)
	Activating	Occurs when the visual tool is activating in the image viewer. (Inherited from VisualTool)
	ActiveInteractionControllerChanged	Occurs when the ActiveInteractionController property is changed. (Inherited from UserInteractionVisualTool)
	Deactivated	Occurs when the visual tool is deactivated in the image viewer. (Inherited from VisualTool)
	Deactivating	Occurs when the visual tool is deactivating in the image viewer. (Inherited from VisualTool)
	EnabledChanged	Occurs when value of Enabled property is changed. (Inherited from VisualTool)
	FigureBuildingCanceled	Occurs when the figure building is canceled.
	FigureBuildingFinished	Occurs when the figure building is finished.
	FigureBuildingStarted	Occurs when the figure building is started.
	FigureCollectionChanged	Occurs when the collection of figures is changed.
	FigureCollectionChanging	Occurs when the collection of figures is changing.
	FigureViewCollectionChanged	Occurs when the collection of figure view is changed.
	ImageChanged	Occurs when the image is changed. (Inherited from VisualTool)
	ImageChanging	Occurs when the image is changing. (Inherited from VisualTool)
	ImageLoadingException	Occurs when the image is not loaded because of error. (Inherited from VisualTool)
	KeyDown	Occurs when a key is pressed while the image viewer has focus and this tool is enabled. (Inherited from VisualTool)
	KeyUp	Occurs when a key is released while the image viewer has focus and this tool is enabled. (Inherited from VisualTool)
	MouseClick	Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is clicked. (Inherited from VisualTool)
	MouseDoubleClick	Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is double clicked. (Inherited from VisualTool)
	MouseDown	Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is pressed. (Inherited from VisualTool)
	MouseEnter	Occurs when the mouse enters an area of visual tool. (Inherited from VisualTool)
	MouseLeave	Occurs when the mouse leaves an area of visual tool. (Inherited from VisualTool)
	MouseMove	Occurs when the mouse pointer is moved over the image viewer and this tool is enabled. (Inherited from VisualTool)
	MouseUp	Occurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is released. (Inherited from VisualTool)
	MouseWheel	Occurs when the mouse wheel moves while the image viewer has focus and this tool is enabled. (Inherited from VisualTool)
	PageContentChanged	Occurs when PDF page content is changed.
	PageContentChanging	Occurs when page content is changing.
	PreviewKeyDown	Occurs before the KeyDown event when a key is pressed while focus is on this visual tool. (Inherited from VisualTool)
	SelectedFigureViewChanged	Occurs when the selected figure is changed.

Reference

PdfContentEditorTool Class
Vintasoft.Imaging.Pdf.UI Namespace

Send Feedback