Foxit PDF SDK

Instance Methods | List of all members
<FSAnnotationSummaryCallback> Protocol Reference

Inherits <NSObject>.

## Instance Methods
(FSLocaleID) | - getCurrentLocaleID
| A callback function used to specify current locale id. More...
(NSString *) | - getLocalFontName
| A callback function used to specify the font name used locally. More...
(NSString *) | - loadString:
| A callback function used to load a string in local language for a specified case. More...

## Detailed Description

This class represents a callback object which is used during summarizing annotation to allow user to decide some format/data. All the pure virtual functions in this class are used as callback functions and should be implemented by user. An implemented FSAnnotationSummaryCallback object can be set to Foxit PDF SDK by function FSAnnotationSummary::setCallback:.

See also
  FSAnnotationSummary

## Method Documentation

## ◆ getCurrentLocaleID()

- (FSLocaleID) getCurrentLocaleID |  |  |
| required

A callback function used to specify current locale id.

Locale ID is used to decide locale format for some information, such as date format.

Returns
  A locale ID. Please refer to values starting from FSLocaleIDUnspecified and this should be one of these values. If returned locale ID is not supported, Foxit PDF SDK will use value FSLocaleIDUnspecified by default.

## ◆ getLocalFontName()

- (NSString*) getLocalFontName |  |  |
| required

A callback function used to specify the font name used locally.

This function is very useful for user to specify the font used in result document.

Returns
  Font name string. If an empty string is returned, Foxit PDF SDK will use "Helvetica" as default font name. If returned font name is invalid, this name will not take any effect.

## ◆ loadString:()

- (NSString*) loadString: |  | (FSAnnotationSummaryCallbackAnnotationSummaryStringID) | id |
| required

A callback function used to load a string in local language for a specified case.

This function is very useful for user to use local language for some string content in result document. By using this function, user can re-write or translate default output strings to local language for specified case in result document. Default output strings for these specified cases can be found in comment for values starting from FSAnnotationSummaryCallbackAnnotationSummaryStringIDAuthor.
Specially, Foxit PDF SDK will add some necessary information/data to the format part in the result document, in order to make content in the result document more useful.

Parameters

  [in] | id | An annotation summary string ID to specify a summary case. Please refer to values starting from FSAnnotationSummaryCallbackAnnotationSummaryStringIDAuthor and this would be one of these values.

Returns
  A string used for the specified case.