PXC_SignDocumentFlags Enumeration

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
{{ToWrite}}
+
{{#customTitle:PXC_SignDocumentFlags Enumeration}}
 +
{{#parentPage:PXV:PXC_Enumerations|PXC_SignDocumentFlags|enum}}
 
{{ToReview}}
 
{{ToReview}}
 +
 +
Combination of flags that determine how the signature field should appear on the page.
 +
 +
== Syntax ==
 +
<pre class="brush:cpp;gutter:false">enum PXC_SignDocumentFlags
 +
{
 +
    Sign_GR_NoGraphics = 0,
 +
    Sign_GR_Image      = 1,
 +
    Sign_GR_Name      = 2,
 +
    Sign_TextDir_Auto  = 0,
 +
    Sign_TextDir_LTR  = 16,
 +
    Sign_TextDir_RTL  = 32,
 +
    Sign_TX_Name      = 256,
 +
    Sign_TX_Date      = 512,
 +
    Sign_TX_Location  = 1024,
 +
    Sign_TX_Reason    = 2048,
 +
    Sign_TX_DName      = 4096,
 +
    Sign_TX_Labels    = 8192,
 +
    Sign_TX_Subject    = 16384,
 +
    Sign_TX_Logo      = 32768,
 +
};
 +
</pre>
 +
 +
== Constants ==
 +
;Sign_GR_NoGraphics
 +
:No graphics element of the signature field will be displayed.
 +
;Sign_GR_Image
 +
:In the graphics element of the signature field the image specified by the ''sImageFile'' parameter will be displayed.
 +
;Sign_GR_Name
 +
:In the graphics element of the signature field the signatory's name will be displayed.
 +
;Sign_TextDir_Auto
 +
:The text direction will be taken from the current settings.
 +
;Sign_TextDir_LTR
 +
:The left to right text direction will be used.
 +
;Sign_TextDir_RTL
 +
:The right to left text direction will be used.
 +
;Sign_TX_Name
 +
:In the text part of the signature field the signatory's name will be displayed.
 +
;Sign_TX_Date
 +
:In the text part of the signature field the date and time of signing will be displayed.
 +
;Sign_TX_Location
 +
:In the text part of the signature field the location specified by ''sLocation'' parameter will be displayed.
 +
;Sign_TX_Reason
 +
:In the text part of the signature field the reason of signing as specified by ''sReason'' parameter will be displayed.
 +
;Sign_TX_DName
 +
:In the text part of the signature field the detailed information about signatory will be displayed.
 +
;Sign_TX_Labels
 +
:If this flag is specified, all text information (eg. Name, Date, etc.) will be labeled on the signature field.
 +
;Sign_TX_Subject
 +
:Specifies whether the subject of the signature should be displayed.
 +
;Sign_TX_Logo
 +
:Specifies whether the signature's logo should be drawn on it's background.

Latest revision as of 23:45, 25 April 2016


Combination of flags that determine how the signature field should appear on the page.

Syntax

enum PXC_SignDocumentFlags
{
    Sign_GR_NoGraphics = 0,
    Sign_GR_Image      = 1,
    Sign_GR_Name       = 2,
    Sign_TextDir_Auto  = 0,
    Sign_TextDir_LTR   = 16,
    Sign_TextDir_RTL   = 32,
    Sign_TX_Name       = 256,
    Sign_TX_Date       = 512,
    Sign_TX_Location   = 1024,
    Sign_TX_Reason     = 2048,
    Sign_TX_DName      = 4096,
    Sign_TX_Labels     = 8192,
    Sign_TX_Subject    = 16384,
    Sign_TX_Logo       = 32768,
};

Constants

Sign_GR_NoGraphics
No graphics element of the signature field will be displayed.
Sign_GR_Image
In the graphics element of the signature field the image specified by the sImageFile parameter will be displayed.
Sign_GR_Name
In the graphics element of the signature field the signatory's name will be displayed.
Sign_TextDir_Auto
The text direction will be taken from the current settings.
Sign_TextDir_LTR
The left to right text direction will be used.
Sign_TextDir_RTL
The right to left text direction will be used.
Sign_TX_Name
In the text part of the signature field the signatory's name will be displayed.
Sign_TX_Date
In the text part of the signature field the date and time of signing will be displayed.
Sign_TX_Location
In the text part of the signature field the location specified by sLocation parameter will be displayed.
Sign_TX_Reason
In the text part of the signature field the reason of signing as specified by sReason parameter will be displayed.
Sign_TX_DName
In the text part of the signature field the detailed information about signatory will be displayed.
Sign_TX_Labels
If this flag is specified, all text information (eg. Name, Date, etc.) will be labeled on the signature field.
Sign_TX_Subject
Specifies whether the subject of the signature should be displayed.
Sign_TX_Logo
Specifies whether the signature's logo should be drawn on it's background.