Foxit PDF SDK
foxit.pdf.AnnotationSummarySettings Class Reference
Inheritance diagram for foxit.pdf.AnnotationSummarySettings:
foxit.common.Base

Public Types

enum  FontSizeType { FontSizeType.e_FontSizeSmall = 0, FontSizeType.e_FontSizeMedium = 1, FontSizeType.e_FontSizeLarge = 2 }
 Enumeration for options used for font size type in result document. More...
 
enum  SortType { SortType.e_TypeSortByAuthor = 0, SortType.e_TypeSortByDate = 1, SortType.e_TypeSortByPage = 2, SortType.e_TypeSortByAnnotationType = 3 }
 Enumeration for options used for sorting annotation in result document. More...
 
enum  SummaryLayout {
  SummaryLayout.e_SummaryLayoutSeparatePagesWithLine = 0, SummaryLayout.e_SummaryLayoutSinglePageWithLine = 1, SummaryLayout.e_SummaryLayoutAnnotationOnly = 2, SummaryLayout.e_SummaryLayoutSeparatePagesWithSequenceNumber = 3,
  SummaryLayout.e_SummaryLayoutSinglePageWithSequenceNumber = 4
}
 Enumeration for options used for annotation summary layout. More...
 

Public Member Functions

 AnnotationSummarySettings ()
 Constructor, with parameters.
 
 AnnotationSummarySettings (AnnotationSummarySettings other)
 Constructor, with another annotation summary setting object. More...
 
void EnableOutputNoAnnotationPage (bool enable)
 Set the flag to decide whether to output information of pages which have no annotation. More...
 
bool IsEmpty ()
 Check whether current object is empty or not. More...
 
void SetAnnotThumbnail (Annot.Type type, Bitmap thumbnail)
 Set the markup annotation thumbnail used in result document to indicates the type of annotation. More...
 
void SetAnnotType (Annot.Type type, bool use_all)
 Set the option to decide which type of annotations will be summarized. More...
 
void SetConnectorLineColor (int color)
 Set connector line color. More...
 
void SetConnectorLineOpacity (float opacity)
 Set connector line opacity. More...
 
void SetEndPage (int page_index)
 Set ending page index. More...
 
void SetFileTitle (string title)
 Set the file title string when location of the document needs to be outputed in result document. More...
 
void SetFontSize (AnnotationSummarySettings.FontSizeType type)
 Set the font size type used in result document of annotation summary. More...
 
void SetPageMargin (RectF margin)
 Set the page margin used in result document. More...
 
void SetPageRect (RectF rect)
 Set the page rectangle in result document. More...
 
void SetSortType (AnnotationSummarySettings.SortType type)
 Set the option to decide to sort annotation by what. More...
 
void SetStartPage (int page_index)
 Set starting page index. More...
 
void SetSummaryLayout (AnnotationSummarySettings.SummaryLayout type)
 Set summary layout type. More...
 

Detailed Description

This class represents settings for summarizing annotation. This would be used in class AnnotationSummary .

See also
AnnotationSummary

Member Enumeration Documentation

◆ FontSizeType

Enumeration for options used for font size type in result document.

Values of this enumeration can be used alone.

Enumerator
e_FontSizeSmall 

If set, that means to use small font size in result document.

e_FontSizeMedium 

If set, that means to use medium font size in result document.

e_FontSizeLarge 

If set, that means to use large font size in result document.

◆ SortType

Enumeration for options used for sorting annotation in result document.

Values of this enumeration can be used alone.

Enumerator
e_TypeSortByAuthor 

If set, that means to sort annotation by author in result document.

e_TypeSortByDate 

If set, that means to sort annotation by date in result document.

e_TypeSortByPage 

If set, that means to sort annotation by page in result document.

e_TypeSortByAnnotationType 

If set, that means to sort annotation by annotation type in result document.

◆ SummaryLayout

Enumeration for options used for annotation summary layout.

Values of this enumeration can be used alone.

Enumerator
e_SummaryLayoutSeparatePagesWithLine 

If set, that means to layout document and annotations with connector lines on separate pages.

e_SummaryLayoutSinglePageWithLine 

If set, that means to layout document and annotations with connector lines on single pages.

e_SummaryLayoutAnnotationOnly 

If set, that means to layout annotations only.

e_SummaryLayoutSeparatePagesWithSequenceNumber 

If set, that means to layout document and annotations with sequence numbers on separate pages.

e_SummaryLayoutSinglePageWithSequenceNumber 

If set, that means to layout document and annotations with sequence numbers on separate pages.

Constructor & Destructor Documentation

◆ AnnotationSummarySettings()

foxit.pdf.AnnotationSummarySettings.AnnotationSummarySettings ( AnnotationSummarySettings  other)
inline

Constructor, with another annotation summary setting object.

Parameters
[in]otherAnother annotation summary setting object.

Member Function Documentation

◆ EnableOutputNoAnnotationPage()

void foxit.pdf.AnnotationSummarySettings.EnableOutputNoAnnotationPage ( bool  enable)
inline

Set the flag to decide whether to output information of pages which have no annotation.

or a newly constructed object, if this function is not called, default value true will be used.

Parameters
[in]enableA boolean value to decide whether to output information of pages which have no annotation: true means to output information of pages which have no annotation, while false means not to output information of pages which have no annotation,
Returns
None.

◆ IsEmpty()

bool foxit.pdf.AnnotationSummarySettings.IsEmpty ( )
inline

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ SetAnnotThumbnail()

void foxit.pdf.AnnotationSummarySettings.SetAnnotThumbnail ( Annot.Type  type,
Bitmap  thumbnail 
)
inline

Set the markup annotation thumbnail used in result document to indicates the type of annotation.

Thumbnail bitmap does not use alpha channel. So user is recommended to set a bitmap without alpha channel to be the new thumbnail. If a bitmap with alpha channel is set, the new thumbnail will use white background by default.
If not set, no thumbnail will be used for corresponding annotation type.

Parameters
[in]typeAnnotation type to decide whose thumbnail is to be set. Please refer to values starting from foxit.pdf.annots.Annot.Type.e_Note and this should be one of these values except foxit.pdf.annots.Annot.Type.e_Link , foxit.pdf.annots.Annot.Type.e_PSInk , foxit.pdf.annots.Annot.Type.e_Sound , foxit.pdf.annots.Annot.Type.e_Movie , foxit.pdf.annots.Annot.Type.e_Widget , foxit.pdf.annots.Annot.Type.e_Screen , foxit.pdf.annots.Annot.Type.e_PrinterMark , foxit.pdf.annots.Annot.Type.e_TrapNet , foxit.pdf.annots.Annot.Type.e_Watermark , foxit.pdf.annots.Annot.Type.e_3D , foxit.pdf.annots.Annot.Type.e_Popup , foxit.pdf.annots.Annot.Type.e_Redact .
[in]thumbnailA bitmap used as thumbnail for an annotation type in result document. This should be a valid bitmap. If the bitmap size is not 12*12, the bitmap will be scaled to 12*12 when being used.
Returns
None.

◆ SetAnnotType()

void foxit.pdf.AnnotationSummarySettings.SetAnnotType ( Annot.Type  type,
bool  use_all 
)
inline

Set the option to decide which type of annotations will be summarized.

For a newly constructed object, if this function is not called to set this option, that means to summarize annotation in all supported types.

Parameters
[in]typeAnnotation type to decide which annotations is to be summarized. Please refer to values starting from foxit.pdf.annots.Annot.Type.e_Note and this should be one of these values except foxit.pdf.annots.Annot.Type.e_Link , foxit.pdf.annots.Annot.Type.e_PSInk , foxit.pdf.annots.Annot.Type.e_Sound , foxit.pdf.annots.Annot.Type.e_Movie , foxit.pdf.annots.Annot.Type.e_Widget , foxit.pdf.annots.Annot.Type.e_Screen , foxit.pdf.annots.Annot.Type.e_PrinterMark , foxit.pdf.annots.Annot.Type.e_TrapNet , foxit.pdf.annots.Annot.Type.e_Watermark , foxit.pdf.annots.Annot.Type.e_3D , foxit.pdf.annots.Annot.Type.e_Popup , foxit.pdf.annots.Annot.Type.e_Redact .
[in]use_allA boolean value to decide whether to summarize all the supported annotations in result document:
  • true means to summarize annotations in all the supported types. In this case, parameter type would be ignored.

  • false means to only summarize annotations specified by parameter type.

Returns
None.

◆ SetConnectorLineColor()

void foxit.pdf.AnnotationSummarySettings.SetConnectorLineColor ( int  color)
inline

Set connector line color.

This option will take effect when summary layout type is set foxit.pdf.AnnotationSummarySettings.SummaryLayout.e_SummaryLayoutSeparatePagesWithLine or foxit.pdf.AnnotationSummarySettings.SummaryLayout.e_SummaryLayoutSinglePageWithLine by function by AnnotationSummarySettings.SetSummaryLayout . If not set, default value 0x000000 will be used.

Parameters
[in]colorConnector line color. Format: 0xRRGGBB.
Returns
None.

◆ SetConnectorLineOpacity()

void foxit.pdf.AnnotationSummarySettings.SetConnectorLineOpacity ( float  opacity)
inline

Set connector line opacity.

This option will take effect when summary layout type is set foxit.pdf.AnnotationSummarySettings.SummaryLayout.e_SummaryLayoutSeparatePagesWithLine or foxit.pdf.AnnotationSummarySettings.SummaryLayout.e_SummaryLayoutSinglePageWithLine by function by AnnotationSummarySettings.SetSummaryLayout . If not set, default value 1.0 will be used.

Parameters
[in]opacityConnector line opacity. Valid range: from 0.0 to 1.0. 0.0 means full transparency and 1.0 means full opaque.
Returns
None.

◆ SetEndPage()

void foxit.pdf.AnnotationSummarySettings.SetEndPage ( int  page_index)
inline

Set ending page index.

For a newly constructed object, if this function is not called, default value (count-1) will be used as the ending page index. count is returned by function PDFDoc.GetPageCount for the PDF document whose annotations are to be summarized.

Parameters
[in]page_indexPage index to specify the ending page where summarizing operation ends. Valid range: from 0 to (count-1). count is returned by function PDFDoc.GetPageCount for the PDF document whose annotations are to be summarized. This index will be checked when function AnnotationSummary.StartSummarize is called.
Returns
None.

◆ SetFileTitle()

void foxit.pdf.AnnotationSummarySettings.SetFileTitle ( string  title)
inline

Set the file title string when location of the document needs to be outputed in result document.

If not set, an empty string will be used as default.

Parameters
[in]titleSummary title used in result document.
Returns
None.

◆ SetFontSize()

void foxit.pdf.AnnotationSummarySettings.SetFontSize ( AnnotationSummarySettings.FontSizeType  type)
inline

Set the font size type used in result document of annotation summary.

For a newly constructed object, if this function is not called to set this option, that means to use foxit.pdf.AnnotationSummarySettings.FontSizeType.e_FontSizeMedium as the default value of this option.

Parameters
[in]typeFont size type used in result document of annotation summary. Please refer to values starting from foxit.pdf.AnnotationSummarySettings.FontSizeType.e_FontSizeSmall and this should be one of these values.
Returns
None.

◆ SetPageMargin()

void foxit.pdf.AnnotationSummarySettings.SetPageMargin ( RectF  margin)
inline

Set the page margin used in result document.

This value does not represents a rectangle. It just defines the left margin, bottom margin, right margin and top margin of a PDF page. If no margin value is set, Foxit PDF SDK will use a maring defined as (50.0, 50.0, 50.0, 50.0) as default.

Parameters
[in]marginPage margin used in result document.
Returns
None.

◆ SetPageRect()

void foxit.pdf.AnnotationSummarySettings.SetPageRect ( RectF  rect)
inline

Set the page rectangle in result document.

If not set, default rectangle (0.0, 0.0, 612.0, 792.0) will be used.

Parameters
[in]rectPage rectangle used in result document.
Returns
None.

◆ SetSortType()

void foxit.pdf.AnnotationSummarySettings.SetSortType ( AnnotationSummarySettings.SortType  type)
inline

Set the option to decide to sort annotation by what.

For a newly constructed object, if this function is not called to set this option, that means to use foxit.pdf.AnnotationSummarySettings.SortType.e_TypeSortByAnnotationType as the default value of this option.

Parameters
[in]typeSorting type for summarizing annotations. Please refer to values starting from foxit.pdf.AnnotationSummarySettings.SortType.e_TypeSortByAuthor and this should be one of these values.
Returns
None.

◆ SetStartPage()

void foxit.pdf.AnnotationSummarySettings.SetStartPage ( int  page_index)
inline

Set starting page index.

For a newly constructed object, if this function is not called, default value 0 will be used as the starting page index.

Parameters
[in]page_indexPage index to specify the starting page where summarizing operation starts. Valid range: from 0 to (count-1). count is returned by function PDFDoc.GetPageCount for the PDF document whose annotations are to be summarized. This index will be checked when function AnnotationSummary.StartSummarize is called.
Returns
None.

◆ SetSummaryLayout()

void foxit.pdf.AnnotationSummarySettings.SetSummaryLayout ( AnnotationSummarySettings.SummaryLayout  type)
inline

Set summary layout type.

For a newly constructed object, if this function is not called to set this option, that means to use foxit.pdf.AnnotationSummarySettings.SummaryLayout.e_SummaryLayoutSeparatePagesWithLine as the default value of this option.

Parameters
[in]typeSummary layout type. Please refer to values starting from foxit.pdf.AnnotationSummarySettings.SummaryLayout.e_SummaryLayoutSeparatePagesWithLine and this should be one of these values.
Returns
None.