'DeclarationPublic Overloads Function AddCheckBoxFormField( _ ByVal Left As Single, _ ByVal Top As Single, _ ByVal Width As Single, _ ByVal Height As Single, _ ByVal FieldName As String, _ ByVal Style As PdfCheckBoxStyle, _ ByVal Checked As Boolean, _ ByVal CheckMarkCyan As Byte, _ ByVal CheckMarkMagenta As Byte, _ ByVal CheckMarkYellow As Byte, _ ByVal CheckMarkBlack As Byte _ ) As Integer
public int AddCheckBoxFormField( float Left, float Top, float Width, float Height, string FieldName, PdfCheckBoxStyle Style, bool Checked, byte CheckMarkCyan, byte CheckMarkMagenta, byte CheckMarkYellow, byte CheckMarkBlack )
public function AddCheckBoxFormField( Left: Single; Top: Single; Width: Single; Height: Single; FieldName: String; Style: PdfCheckBoxStyle; Checked: Boolean; CheckMarkCyan: Byte; CheckMarkMagenta: Byte; CheckMarkYellow: Byte; CheckMarkBlack: Byte ): Integer;
public function AddCheckBoxFormField( Left : float, Top : float, Width : float, Height : float, FieldName : String, Style : PdfCheckBoxStyle, Checked : boolean, CheckMarkCyan : byte, CheckMarkMagenta : byte, CheckMarkYellow : byte, CheckMarkBlack : byte ) : int;
public: int AddCheckBoxFormField( float Left, float Top, float Width, float Height, string* FieldName, PdfCheckBoxStyle Style, bool Checked, byte CheckMarkCyan, byte CheckMarkMagenta, byte CheckMarkYellow, byte CheckMarkBlack )
public: int AddCheckBoxFormField( float Left, float Top, float Width, float Height, String^ FieldName, PdfCheckBoxStyle Style, bool Checked, byte CheckMarkCyan, byte CheckMarkMagenta, byte CheckMarkYellow, byte CheckMarkBlack )
Parameters
- Left
- The horizontal (X) coordinate of the closest point to the currently defined origin, where the form field's bounding box is to be located. The value is expressed in the current units specified by the SetMeasurementUnit method and it is related to the current page. For further assistance, please see the Remarks section below.
- Top
- The vertical (Y) coordinate of the closest point to the currently defined origin, where the form field's bounding box is to be located. The value is expressed in the current units specified by the SetMeasurementUnit method and it is related to the current page. For further assistance, please see the Remarks section below.
- Width
- The width of the form field's bounding box, expressed in the current units specified by the SetMeasurementUnit method.
- Height
- The height of the form field's bounding box, expressed in the current units specified by the SetMeasurementUnit method.
- FieldName
- The name of the form field. It can be an empty string, but it is recommended to set a value.
- Style
- A member of the PdfCheckBoxStyle enumeration. The style of the checkmark to be used to display a checked state of a check box field.
- Checked
- The state value of a check box field. Set this parameter to true, if you want to check the check box field, otherwise set it to false.
- CheckMarkCyan
- The amount of cyan color to be used for the resulting color when displaying the check box's checkmark. Use the value between 0 and 255.
- CheckMarkMagenta
- The amount of magenta color to be used for the resulting color when displaying the check box's checkmark. Use the value between 0 and 255.
- CheckMarkYellow
- The amount of yellow color to be used for the resulting color when displaying the check box's checkmark. Use the value between 0 and 255.
- CheckMarkBlack
- The amount of black color to be used for the resulting color when displaying the check box's checkmark. Use the value between 0 and 255.
Return Value
The unique identifier of the newly created check box form field. The GdPicturePDF.GetStat method can be subsequently used to determine if this method has been successful.