Aspose::Pdf::InteractiveFeatures Namespace Reference

Namespaces

 Annotations
 
 Forms
 

Classes

class  ActionCollection
 Collection of actions More...
 
class  DefaultAppearance
 Describes default appearance of field (font, text size and color). More...
 
class  DocumentActionCollection
 Class describes actions performed on some actions with document More...
 
class  ExplicitDestination
 Represents the base class for explicit destinations in PDF document. More...
 
class  ExplicitDestinationTypeConverter
 
class  FitBExplicitDestination
 Represents explicit destination that displays the page with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the window in the other dimension. More...
 
class  FitBHExplicitDestination
 Represents explicit destination that displays the page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window. A null value for top specifies that the current value of that parameter is to be retained unchanged. More...
 
class  FitBVExplicitDestination
 Represents explicit destination that displays the page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window. A null value for left specifies that the current value of that parameter is to be retained unchanged. More...
 
class  FitExplicitDestination
 Represents explicit destination that displays the page with its contents magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension. More...
 
class  FitHExplicitDestination
 Represents explicit destination that displays the page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of the page within the window. A null value for top specifies that the current value of that parameter is to be retained unchanged. More...
 
class  FitRExplicitDestination
 Represents explicit destination that displays the page with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and topentirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension. A null value for any of the parameters may result in unpredictable behavior. More...
 
class  FitVExplicitDestination
 Represents explicit destination that displays the page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of the page within the window. A null value for left specifies that the current value of that parameter is to be retained unchanged. More...
 
class  GoToAction
 Represents a go-to action that changes the view to a specified destination (page, location, and magnification factor). More...
 
class  GoToRemoteAction
 Represents a remote go-to action that is similar to an ordinary go-to action but jumps to a destination in another PDF file instead of the current file. More...
 
class  GoToURIAction
 Represents a URI action causes a URI to be resolved. More...
 
class  HighlightingModeConverter
 
class  IAppointment
 Represents general interface for actions and destinations. More...
 
class  JustificationConverter
 
class  LaunchAction
 Represents a launch action that launches an application or opens or prints a document. More...
 
class  LaunchActionOperationConverter
 
class  NamedAction
 Represents named actions that PDF viewer applications are expected to support. More...
 
class  NamedDestination
 Instead of being defined directly with the explicit syntax, a destination may be referred to indirectly by means of a name object or a byte string. More...
 
class  NamespaceDoc
 The Aspose.Pdf.InteractiveFeatures namespace provides classes for working with various types of actions, destinations and other features of document which traditionally called as interactive providing means user can intercommunicate with it. More...
 
class  PdfAction
 Represents Action in PDF document More...
 
class  PredefinedActionConverter
 
class  RenditionAction
 A rendition action that controls the playing of multimedia content. More...
 
class  SoundData
 Represents a sound data defining the sound to be played when the annotation is activated. More...
 
class  SubmitFormAction
 Class which describes submit-form action. More...
 
class  XfdfReader
 Class which peroformes reading of XFDF format. More...
 
class  XYZExplicitDestination
 Represents explicit destination that displays the page with the coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom. A null value for any of the parameters left, top, or zoom specifies that the current value of that parameter is to be retained unchanged. A zoom value of 0 has the same meaning as a null value. More...
 

Enumerations

enum  ExplicitDestinationType {
  ExplicitDestinationType::XYZ, ExplicitDestinationType::Fit, ExplicitDestinationType::FitH, ExplicitDestinationType::FitV,
  ExplicitDestinationType::FitR, ExplicitDestinationType::FitB, ExplicitDestinationType::FitBH, ExplicitDestinationType::FitBV
}
 Enumerates the types of explicit destinations. More...
 
enum  HighlightingMode {
  HighlightingMode::None, HighlightingMode::Invert, HighlightingMode::Outline, HighlightingMode::Push,
  HighlightingMode::Toggle
}
 Enumerates the annotation�s highlighting mode, the visual effect to be used when the mouse button is pressed or held down inside its active area. More...
 
enum  Justification { Justification::Left = 0, Justification::Center = 1, Justification::Right = 2 }
 Enumerates the forms of quadding (justification) to be used in displaying the annotation�s text. More...
 
enum  LaunchActionOperation { LaunchActionOperation::Undefined, LaunchActionOperation::Open, LaunchActionOperation::Print }
 Enumerates the operations to perform with document during launch action executing. More...
 
enum  PredefinedAction {
  PredefinedAction::FirstPage, PredefinedAction::LastPage, PredefinedAction::NextPage, PredefinedAction::PrevPage,
  PredefinedAction::PrintDialog, PredefinedAction::Bookmarks_ExpanCurrentBookmark, PredefinedAction::Bookmarks_HightlightCurrentBookmark, PredefinedAction::Document_AttachFile,
  PredefinedAction::Document_CropPages, PredefinedAction::Document_DeletePages, PredefinedAction::Document_ExtractPages, PredefinedAction::Document_InsertPages,
  PredefinedAction::Document_ReplacePages, PredefinedAction::Document_RotatePages, PredefinedAction::Edit_CheckSpelling_InComFieldEdit, PredefinedAction::Edit_Find,
  PredefinedAction::Edit_Preferences, PredefinedAction::Edit_Search, PredefinedAction::File_AttachToEmail, PredefinedAction::File_Close,
  PredefinedAction::File_CreatePDF_FromScanner, PredefinedAction::File_CreatePDF_FromWebPage, PredefinedAction::File_Exit, PredefinedAction::File_Organizer_OpenOrganizer,
  PredefinedAction::File_Print, PredefinedAction::File_Properties, PredefinedAction::File_SaveAs, PredefinedAction::Miscellaneous_ZoomIn,
  PredefinedAction::Miscellaneous_ZoomOut, PredefinedAction::PageImages_PrintPages, PredefinedAction::View_GoTo_NextView, PredefinedAction::View_GoTo_Page,
  PredefinedAction::View_GoTo_PreDocument, PredefinedAction::View_GoTo_PreView, PredefinedAction::View_NavigationPanels_Articles, PredefinedAction::View_NavigationPanels_Attachments,
  PredefinedAction::View_NavigationPanels_Boomarks, PredefinedAction::View_NavigationPanels_Comments, PredefinedAction::View_NavigationPanels_Fields, PredefinedAction::View_NavigationPanels_Layers,
  PredefinedAction::View_NavigationPanels_ModelTree, PredefinedAction::View_NavigationPanels_Pages, PredefinedAction::View_NavigationPanels_Signatures, PredefinedAction::View_PageDisplay_SinglePage,
  PredefinedAction::View_PageDisplay_SinglePageContinuous, PredefinedAction::View_PageDisplay_TwoUp, PredefinedAction::View_PageDisplay_TwoUpContinuous, PredefinedAction::View_Toolbars_AdvanceEditing,
  PredefinedAction::View_Toolbars_CommentMarkup, PredefinedAction::View_Toolbars_Edit, PredefinedAction::View_Toolbars_File, PredefinedAction::View_Toolbars_Find,
  PredefinedAction::View_Toolbars_Forms, PredefinedAction::View_Toolbars_Measuring, PredefinedAction::View_Toolbars_ObjectData, PredefinedAction::View_Toolbars_PageDisplay,
  PredefinedAction::View_Toolbars_PageNavigation, PredefinedAction::View_Toolbars_PrintProduction, PredefinedAction::View_Toolbars_PropertiesBar, PredefinedAction::View_Toolbars_Redaction,
  PredefinedAction::View_Toolbars_SelectZoom, PredefinedAction::View_Toolbars_Tasks, PredefinedAction::View_Toolbars_Typewriter, PredefinedAction::View_Zoom_ActualSize,
  PredefinedAction::View_Zoom_FitHeight, PredefinedAction::View_Zoom_FitPage, PredefinedAction::View_Zoom_FitVisible, PredefinedAction::View_Zoom_FitWidth,
  PredefinedAction::View_Zoom_ZoomTo, PredefinedAction::Window_FullScreenMode
}
 Defines different actions which can be triggered from a PDF file. More...
 

Enumeration Type Documentation

◆ ExplicitDestinationType

Enumerates the types of explicit destinations.

Enumerator
XYZ 

Display the page with the coordinates (left,�top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom. A null value for any of the parameters left, top, or zoom specifies that the current value of that parameter is to be retained unchanged. A zoom value of 0 has the same meaning as a null value.

Fit 

Display the page with its contents magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.

FitH 

Display the page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of the page within the window. A null value for top specifies that the current value of that parameter is to be retained unchanged.

FitV 

Display the page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of the page within the window. A null value for left specifies that the current value of that parameter is to be retained unchanged.

FitR 

Display the page with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and topentirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension. A null value for any of the parameters may result in unpredictable behavior.

FitB 

Display the page with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the window in the other dimension.

FitBH 

Display the page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window. A null value for top specifies that the current value of that parameter is to be retained unchanged.

FitBV 

Display the page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window. A null value for left specifies that the current value of that parameter is to be retained unchanged.

◆ HighlightingMode

Enumerates the annotation�s highlighting mode, the visual effect to be used when the mouse button is pressed or held down inside its active area.

Enumerator
None 

No highlighting.

Invert 

Invert the contents of the annotation rectangle.

Outline 

Invert the annotation�s border.

Push 

Display the annotation�s down appearance, if any. If no down appearance is defined, offset the contents of the annotation rectangle to appear as if it were being pushed below the surface of the page.

Toggle 

Same as Push (which is preferred).

◆ Justification

Enumerates the forms of quadding (justification) to be used in displaying the annotation�s text.

Enumerator
Left 

Left justification.

Center 

Center justification.

Right 

Right justification.

◆ LaunchActionOperation

Enumerates the operations to perform with document during launch action executing.

Enumerator
Undefined 

Undefined state.

Open 

Open a document.

Print 

Print a document.

◆ PredefinedAction

Defines different actions which can be triggered from a PDF file.

Enumerator
FirstPage 

A named action to go to the first page.

LastPage 

A named action to go to the last page.

NextPage 

A named action to go to the next page.

PrevPage 

A named action to go to the previous page.

PrintDialog 

A named action to open a print dialog.

Bookmarks_ExpanCurrentBookmark 

A named action to find current bookmark.

Bookmarks_HightlightCurrentBookmark 

A named action to highlight current bookmark.

Document_AttachFile 

A named action to add file attachment.

Document_CropPages 

A named action to crop document pages.

Document_DeletePages 

A named action to delete document pages.

Document_ExtractPages 

A named action to exctract document pages.

Document_InsertPages 

A named action to insert pages from a document.

Document_ReplacePages 

A named action to replace document pages.

Document_RotatePages 

A named action to rotate document pages.

Edit_CheckSpelling_InComFieldEdit 

A named action to check spelling in comments.

Edit_Find 

A named action to find.

Edit_Preferences 

A named action to edit preferences.

Edit_Search 

A named action for searching.

File_AttachToEmail 

A named action for attaching current pdf document into email message.

File_Close 

A named action to close the document.

File_CreatePDF_FromScanner 

A named action to create pdf document from scanner.

File_CreatePDF_FromWebPage 

A named action to create pdf document from web page.

File_Exit 

A named action to exit pdf reader.

File_Organizer_OpenOrganizer 

A named action to open organizer.

File_Print 

A named action to print the document.

File_Properties 

A named action to open the document properties.

File_SaveAs 

A named action to save the document with another name.

Miscellaneous_ZoomIn 

A named action to zoom in the document.

Miscellaneous_ZoomOut 

A named action to zoom out the document.

PageImages_PrintPages 

A named action to print the document pages.

View_GoTo_NextView 

A named action to go to the next view.

View_GoTo_Page 

A named action to go to the certain page.

View_GoTo_PreDocument 

A named action to go to the previous document.

View_GoTo_PreView 

A named action to go to the previous view.

View_NavigationPanels_Articles 

A named action to show/hide articles panel.

View_NavigationPanels_Attachments 

A named action to show/hide attachment panel.

View_NavigationPanels_Boomarks 

A named action to show/hide bookmark panel.

View_NavigationPanels_Comments 

A named action to show/hide comments panel.

View_NavigationPanels_Fields 

A named action to show/hide fields panel.

View_NavigationPanels_Layers 

A named action to show/hide layers panel.

View_NavigationPanels_ModelTree 

A named action to show/hide model tree panel.

View_NavigationPanels_Pages 

A named action to show/hide pages panel.

View_NavigationPanels_Signatures 

A named action to show/hide signatures panel.

View_PageDisplay_SinglePage 

A named action to display single page.

View_PageDisplay_SinglePageContinuous 

A named action to display single continious page.

View_PageDisplay_TwoUp 

A named action to display pages as Two-Up.

View_PageDisplay_TwoUpContinuous 

A named action to display pages as Two-Up continious.

View_Toolbars_AdvanceEditing 

A named action to show/hide advanced editing toolbar.

View_Toolbars_CommentMarkup 

A named action to show/hide commenting toolbar.

View_Toolbars_Edit 

A named action to show/hide edit toolbar.

View_Toolbars_File 

A named action to show/hide file toolbar.

View_Toolbars_Find 

A named action to show/hide find toolbar.

View_Toolbars_Forms 

A named action to show/hide forms toolbar.

View_Toolbars_Measuring 

A named action to show/hide measuring toolbar.

View_Toolbars_ObjectData 

A named action to show/hide object data toolbar.

View_Toolbars_PageDisplay 

A named action to show/hide page display toolbar.

View_Toolbars_PageNavigation 

A named action to show/hide navigation toolbar.

View_Toolbars_PrintProduction 

A named action to show/hide print production toolbar.

View_Toolbars_PropertiesBar 

A named action to show/hide property toolbar.

View_Toolbars_Redaction 

A named action to show/hide redaction toolbar.

View_Toolbars_SelectZoom 

A named action to show/hide select & zoom toolbar.

View_Toolbars_Tasks 

A named action to show/hide tasks toolbar.

View_Toolbars_Typewriter 

A named action to show/hide typewriter toolbar.

View_Zoom_ActualSize 

A named action to view pages in actual size.

View_Zoom_FitHeight 

A named action to fit page on height.

View_Zoom_FitPage 

A named action to fit page.

View_Zoom_FitVisible 

A named action to fit page visibility.

View_Zoom_FitWidth 

A named action to fit page on width.

View_Zoom_ZoomTo 

A named action to make zoom.

Window_FullScreenMode 

A named action to view the document in the full screen mode.