Microsoft Information Protection SDK - C++ 1.17
API Reference Documentation for C++
Loading...
Searching...
No Matches
AddContentFooterAction Class Referenceabstract

An action class that specifies adding a content footer to the document. More...

#include <add_content_footer_action.h>

Inheritance diagram for AddContentFooterAction:
Action

Public Member Functions

virtual const std::string & GetUIElementName ()=0
 An API used to mark the content footer element.
 
virtual const std::string & GetText () const =0
 Get the text that is meant to go into the content footer.
 
virtual const std::string & GetFontName () const =0
 Get the font name, used to display the content footer.
 
virtual int GetFontSize () const =0
 Get the font size used to display the content footer.
 
virtual const std::string & GetFontColor () const =0
 Get the font color used to display the content footer.
 
virtual ContentMarkAlignment GetAlignment () const =0
 Get the alignment of the footer.
 
virtual int GetMargin () const =0
 Get the margin of the footer from the bottom.
 
- Public Member Functions inherited from Action
virtual ActionType GetType () const =0
 Get the type of Action.
 

Detailed Description

An action class that specifies adding a content footer to the document.

Member Function Documentation

◆ GetAlignment()

virtual ContentMarkAlignment AddContentFooterAction::GetAlignment ( ) const
pure virtual

Get the alignment of the footer.

Returns
The ContentMarkAlignment enumerator: LEFT|RIGHT|CENTER.
See also
ContentMarkAlignment

◆ GetFontColor()

virtual const std::string & AddContentFooterAction::GetFontColor ( ) const
pure virtual

Get the font color used to display the content footer.

Returns
font color as a string (for example, "#000000").

◆ GetFontName()

virtual const std::string & AddContentFooterAction::GetFontName ( ) const
pure virtual

Get the font name, used to display the content footer.

Returns
Font name. Default value is Calibri if nothing is set by the policy.

◆ GetFontSize()

virtual int AddContentFooterAction::GetFontSize ( ) const
pure virtual

Get the font size used to display the content footer.

Returns
font size as an integer.

◆ GetMargin()

virtual int AddContentFooterAction::GetMargin ( ) const
pure virtual

Get the margin of the footer from the bottom.

Returns
the margins from the bottom of the document (for example, 10 mm).

◆ GetText()

virtual const std::string & AddContentFooterAction::GetText ( ) const
pure virtual

Get the text that is meant to go into the content footer.

Returns
content footer text.

◆ GetUIElementName()

virtual const std::string & AddContentFooterAction::GetUIElementName ( )
pure virtual

An API used to mark the content footer element.

Returns
the name that should be used for the UI element that holds the content footer. The same name will be returned in RemoveContentFooterAction in case the content footer needs to be removed.

The documentation for this class was generated from the following file: