Class for representing field properties. More...

Inherits System::Object.

Public Member Functions

System::Drawing::Color get_BorderColor ()
 The color of a field border. More...
 
void set_BorderColor (System::Drawing::Color value)
 The color of a field border. More...
 
int32_t get_BorderStyle ()
 The style of a field border. More...
 
void set_BorderStyle (int32_t value)
 The style of a field border. More...
 
float get_BorderWidth ()
 The width of a field border. More...
 
void set_BorderWidth (float value)
 The width of a field border. More...
 
FontStyle get_Font ()
 The font type of a field text. More...
 
void set_Font (FontStyle value)
 The font type of a field text. More...
 
System::String get_CustomFont ()
 Gets name of the font when this is non-standart (other then 14 standard fonts). More...
 
void set_CustomFont (System::String value)
 Sets name of the font when this is non-standart (other then 14 standard fonts). More...
 
float get_FontSize ()
 The size of a field text. More...
 
void set_FontSize (float value)
 The size of a field text. More...
 
System::Drawing::Color get_TextColor ()
 The color of the field text. More...
 
void set_TextColor (System::Drawing::Color value)
 The color of the field text. More...
 
EncodingType get_TextEncoding ()
 The text encoding type of the field text. More...
 
void set_TextEncoding (EncodingType value)
 The text encoding type of the field text. More...
 
int32_t get_Alignment ()
 The alignment of a field text, default is left alignment. More...
 
void set_Alignment (int32_t value)
 The alignment of a field text, default is left alignment. More...
 
int32_t get_Rotation ()
 The rotation of a field text. More...
 
void set_Rotation (int32_t value)
 The rotation of a field text. More...
 
System::String get_Caption ()
 The normal caption of form field. More...
 
void set_Caption (System::String value)
 The normal caption of form field. More...
 
int32_t get_ButtonStyle ()
 The style of check box or radio box field, defined by FormFieldFacade.CheckBoxStyle*. More...
 
void set_ButtonStyle (int32_t value)
 The style of check box or radio box field, defined by FormFieldFacade.CheckBoxStyle*. More...
 
System::Drawing::Rectangle get_Box ()
 A rectangle object holding field's location. More...
 
void set_Box (System::Drawing::Rectangle value)
 A rectangle object holding field's location. More...
 
System::ArrayPtr< float > get_Position ()
 A rectangle object holding field's location. More...
 
void set_Position (System::ArrayPtr< float > value)
 A rectangle object holding field's location. More...
 
int32_t get_PageNumber ()
 An integer value holding the number of page on which field locates. More...
 
void set_PageNumber (int32_t value)
 An integer value holding the number of page on which field locates. More...
 
System::ArrayPtr< System::Stringget_Items ()
 An array of string, each representing an option of a combo box/list/radio box field. More...
 
void set_Items (System::ArrayPtr< System::String > value)
 An array of string, each representing an option of a combo box/list/radio box field. More...
 
System::ArrayPtr< System::ArrayPtr< System::String > > get_ExportItems ()
 The options for adding a list/combo/radio box More...
 
void set_ExportItems (System::ArrayPtr< System::ArrayPtr< System::String >> value)
 The options for adding a list/combo/radio box More...
 
System::Drawing::Color get_BackgroundColor ()
 The color of a field background, default is white. More...
 
void set_BackgroundColor (System::Drawing::Color value)
 The color of a field background, default is white. More...
 
void Reset ()
 Reset all visual attribtues to empty value. More...
 
 FormFieldFacade ()
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Static Public Attributes

static constexpr float BorderWidthUndefined = -1
 
static constexpr float BorderWidthThin = 1
 
static constexpr float BorderWidthMedium = 2
 
static constexpr float BorderWidthThick = 3
 
static constexpr int32_t BorderStyleSolid = 0
 
static constexpr int32_t BorderStyleDashed = 1
 
static constexpr int32_t BorderStyleBeveled = 2
 
static constexpr int32_t BorderStyleInset = 3
 
static constexpr int32_t BorderStyleUnderline = 4
 
static constexpr int32_t BorderStyleUndefined = 5
 
static constexpr int32_t AlignLeft = 0
 
static constexpr int32_t AlignCenter = 1
 
static constexpr int32_t AlignRight = 2
 
static constexpr int32_t AlignUndefined = 3
 
static constexpr int32_t AlignJustified = 4
 
static constexpr int32_t AlignTop = 0
 
static constexpr int32_t AlignMiddle = 1
 
static constexpr int32_t AlignBottom = 2
 
static constexpr int32_t CheckBoxStyleCircle = u'l'
 
static constexpr int32_t CheckBoxStyleCheck = u'4'
 
static constexpr int32_t CheckBoxStyleCross = u'8'
 
static constexpr int32_t CheckBoxStyleDiamond = u'u'
 
static constexpr int32_t CheckBoxStyleStar = u'H'
 
static constexpr int32_t CheckBoxStyleSquare = u'n'
 
static constexpr int32_t CheckBoxStyleUndefined = u' '
 

Protected Member Functions

void setFontStyle (System::String fontName)
 
FontStyle shortNameToStyle (System::String fontName)
 Converts font name into fotn style name. More...
 
Aspose::Pdf::Forms::BoxStyle translateCheckBoxStyle ()
 

Protected Attributes

bool _customFontSpecified
 
System::String _customFont
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

Class for representing field properties.

Constructor & Destructor Documentation

◆ FormFieldFacade()

Aspose::Pdf::Facades::FormFieldFacade::FormFieldFacade ( )

Member Function Documentation

◆ get_Alignment()

int32_t Aspose::Pdf::Facades::FormFieldFacade::get_Alignment ( )

The alignment of a field text, default is left alignment.

◆ get_BackgroundColor()

System::Drawing::Color Aspose::Pdf::Facades::FormFieldFacade::get_BackgroundColor ( )

The color of a field background, default is white.

◆ get_BorderColor()

System::Drawing::Color Aspose::Pdf::Facades::FormFieldFacade::get_BorderColor ( )

The color of a field border.

◆ get_BorderStyle()

int32_t Aspose::Pdf::Facades::FormFieldFacade::get_BorderStyle ( )

The style of a field border.

◆ get_BorderWidth()

float Aspose::Pdf::Facades::FormFieldFacade::get_BorderWidth ( )

The width of a field border.

◆ get_Box()

System::Drawing::Rectangle Aspose::Pdf::Facades::FormFieldFacade::get_Box ( )

A rectangle object holding field's location.

◆ get_ButtonStyle()

int32_t Aspose::Pdf::Facades::FormFieldFacade::get_ButtonStyle ( )

The style of check box or radio box field, defined by FormFieldFacade.CheckBoxStyle*.

◆ get_Caption()

System::String Aspose::Pdf::Facades::FormFieldFacade::get_Caption ( )

The normal caption of form field.

◆ get_CustomFont()

System::String Aspose::Pdf::Facades::FormFieldFacade::get_CustomFont ( )

Gets name of the font when this is non-standart (other then 14 standard fonts).

◆ get_ExportItems()

System::ArrayPtr<System::ArrayPtr<System::String> > Aspose::Pdf::Facades::FormFieldFacade::get_ExportItems ( )

The options for adding a list/combo/radio box

◆ get_Font()

FontStyle Aspose::Pdf::Facades::FormFieldFacade::get_Font ( )

The font type of a field text.

◆ get_FontSize()

float Aspose::Pdf::Facades::FormFieldFacade::get_FontSize ( )

The size of a field text.

◆ get_Items()

System::ArrayPtr<System::String> Aspose::Pdf::Facades::FormFieldFacade::get_Items ( )

An array of string, each representing an option of a combo box/list/radio box field.

◆ get_PageNumber()

int32_t Aspose::Pdf::Facades::FormFieldFacade::get_PageNumber ( )

An integer value holding the number of page on which field locates.

◆ get_Position()

System::ArrayPtr<float> Aspose::Pdf::Facades::FormFieldFacade::get_Position ( )

A rectangle object holding field's location.

◆ get_Rotation()

int32_t Aspose::Pdf::Facades::FormFieldFacade::get_Rotation ( )

The rotation of a field text.

◆ get_TextColor()

System::Drawing::Color Aspose::Pdf::Facades::FormFieldFacade::get_TextColor ( )

The color of the field text.

◆ get_TextEncoding()

EncodingType Aspose::Pdf::Facades::FormFieldFacade::get_TextEncoding ( )

The text encoding type of the field text.

◆ Reset()

void Aspose::Pdf::Facades::FormFieldFacade::Reset ( )

Reset all visual attribtues to empty value.

◆ set_Alignment()

void Aspose::Pdf::Facades::FormFieldFacade::set_Alignment ( int32_t  value)

The alignment of a field text, default is left alignment.

◆ set_BackgroundColor()

void Aspose::Pdf::Facades::FormFieldFacade::set_BackgroundColor ( System::Drawing::Color  value)

The color of a field background, default is white.

◆ set_BorderColor()

void Aspose::Pdf::Facades::FormFieldFacade::set_BorderColor ( System::Drawing::Color  value)

The color of a field border.

◆ set_BorderStyle()

void Aspose::Pdf::Facades::FormFieldFacade::set_BorderStyle ( int32_t  value)

The style of a field border.

◆ set_BorderWidth()

void Aspose::Pdf::Facades::FormFieldFacade::set_BorderWidth ( float  value)

The width of a field border.

◆ set_Box()

void Aspose::Pdf::Facades::FormFieldFacade::set_Box ( System::Drawing::Rectangle  value)

A rectangle object holding field's location.

◆ set_ButtonStyle()

void Aspose::Pdf::Facades::FormFieldFacade::set_ButtonStyle ( int32_t  value)

The style of check box or radio box field, defined by FormFieldFacade.CheckBoxStyle*.

◆ set_Caption()

void Aspose::Pdf::Facades::FormFieldFacade::set_Caption ( System::String  value)

The normal caption of form field.

◆ set_CustomFont()

void Aspose::Pdf::Facades::FormFieldFacade::set_CustomFont ( System::String  value)

Sets name of the font when this is non-standart (other then 14 standard fonts).

◆ set_ExportItems()

void Aspose::Pdf::Facades::FormFieldFacade::set_ExportItems ( System::ArrayPtr< System::ArrayPtr< System::String >>  value)

The options for adding a list/combo/radio box

◆ set_Font()

void Aspose::Pdf::Facades::FormFieldFacade::set_Font ( FontStyle  value)

The font type of a field text.

◆ set_FontSize()

void Aspose::Pdf::Facades::FormFieldFacade::set_FontSize ( float  value)

The size of a field text.

◆ set_Items()

void Aspose::Pdf::Facades::FormFieldFacade::set_Items ( System::ArrayPtr< System::String value)

An array of string, each representing an option of a combo box/list/radio box field.

◆ set_PageNumber()

void Aspose::Pdf::Facades::FormFieldFacade::set_PageNumber ( int32_t  value)

An integer value holding the number of page on which field locates.

◆ set_Position()

void Aspose::Pdf::Facades::FormFieldFacade::set_Position ( System::ArrayPtr< float >  value)

A rectangle object holding field's location.

◆ set_Rotation()

void Aspose::Pdf::Facades::FormFieldFacade::set_Rotation ( int32_t  value)

The rotation of a field text.

◆ set_TextColor()

void Aspose::Pdf::Facades::FormFieldFacade::set_TextColor ( System::Drawing::Color  value)

The color of the field text.

◆ set_TextEncoding()

void Aspose::Pdf::Facades::FormFieldFacade::set_TextEncoding ( EncodingType  value)

The text encoding type of the field text.

◆ setFontStyle()

void Aspose::Pdf::Facades::FormFieldFacade::setFontStyle ( System::String  fontName)
protected

◆ shortNameToStyle()

FontStyle Aspose::Pdf::Facades::FormFieldFacade::shortNameToStyle ( System::String  fontName)
protected

Converts font name into fotn style name.

Parameters
fontName
Returns

◆ translateCheckBoxStyle()

Aspose::Pdf::Forms::BoxStyle Aspose::Pdf::Facades::FormFieldFacade::translateCheckBoxStyle ( )
protected

Member Data Documentation

◆ _customFont

System::String Aspose::Pdf::Facades::FormFieldFacade::_customFont
protected

◆ _customFontSpecified

bool Aspose::Pdf::Facades::FormFieldFacade::_customFontSpecified
protected

◆ AlignBottom

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::AlignBottom = 2
static

◆ AlignCenter

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::AlignCenter = 1
static

◆ AlignJustified

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::AlignJustified = 4
static

◆ AlignLeft

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::AlignLeft = 0
static

◆ AlignMiddle

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::AlignMiddle = 1
static

◆ AlignRight

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::AlignRight = 2
static

◆ AlignTop

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::AlignTop = 0
static

◆ AlignUndefined

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::AlignUndefined = 3
static

◆ BorderStyleBeveled

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::BorderStyleBeveled = 2
static

◆ BorderStyleDashed

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::BorderStyleDashed = 1
static

◆ BorderStyleInset

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::BorderStyleInset = 3
static

◆ BorderStyleSolid

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::BorderStyleSolid = 0
static

◆ BorderStyleUndefined

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::BorderStyleUndefined = 5
static

◆ BorderStyleUnderline

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::BorderStyleUnderline = 4
static

◆ BorderWidthMedium

constexpr float Aspose::Pdf::Facades::FormFieldFacade::BorderWidthMedium = 2
static

◆ BorderWidthThick

constexpr float Aspose::Pdf::Facades::FormFieldFacade::BorderWidthThick = 3
static

◆ BorderWidthThin

constexpr float Aspose::Pdf::Facades::FormFieldFacade::BorderWidthThin = 1
static

◆ BorderWidthUndefined

constexpr float Aspose::Pdf::Facades::FormFieldFacade::BorderWidthUndefined = -1
static

◆ CheckBoxStyleCheck

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::CheckBoxStyleCheck = u'4'
static

◆ CheckBoxStyleCircle

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::CheckBoxStyleCircle = u'l'
static

◆ CheckBoxStyleCross

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::CheckBoxStyleCross = u'8'
static

◆ CheckBoxStyleDiamond

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::CheckBoxStyleDiamond = u'u'
static

◆ CheckBoxStyleSquare

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::CheckBoxStyleSquare = u'n'
static

◆ CheckBoxStyleStar

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::CheckBoxStyleStar = u'H'
static

◆ CheckBoxStyleUndefined

constexpr int32_t Aspose::Pdf::Facades::FormFieldFacade::CheckBoxStyleUndefined = u' '
static