@syncfusion/ej2-pdf 24.1.44 → 24.1.48

package/src/pdf/core/form/field.d.ts

@@ -51,7 +51,7 @@ export declare abstract class PdfField {
     _silver: PdfBrush;
     _white: PdfBrush;
     _black: PdfBrush;
-    _backColorSet: boolean;
+    _isTransparentBackColor: boolean;
     _tabIndex: number;
     _annotationIndex: number;
     _defaultFont: PdfStandardFont;
@@ -350,7 +350,7 @@ export declare abstract class PdfField {
     */
     color: number[];
     /**
-     * Gets the back color of the field.
+     * Gets the background color of the field.
      *
      * @returns {number[]} R, G, B color values in between 0 to 255.
      * ```typescript
@@ -358,7 +358,7 @@ export declare abstract class PdfField {
      * let document: PdfDocument = new PdfDocument(data, password);
      * // Access the form field at index 0
      * let field: PdfField = document.form.fieldAt(0);
-     * // Gets the back color of the field.
+     * // Gets the background color of the field.
      * let backColor: number[] = field.backColor;
      * // Save the document
      * document.save('output.pdf');
@@ -367,7 +367,7 @@ export declare abstract class PdfField {
      * ```
      */
     /**
-    * Sets the back color of the field.
+    * Sets the background color of the field.
     *
     * @param {number[]} value R, G, B color values in between 0 to 255.
     * ```typescript
@@ -375,7 +375,7 @@ export declare abstract class PdfField {
     * let document: PdfDocument = new PdfDocument(data, password);
     * // Access the form field at index 0
     * let field: PdfField = document.form.fieldAt(0);
-    * // Sets the back color of the field.
+    * // Sets the background color of the field.
     * field.backColor = [255, 0, 0];
     * // Save the document
     * document.save('output.pdf');
@@ -704,6 +704,9 @@ export declare abstract class PdfField {
     readonly _whiteBrush: PdfBrush;
     readonly _blackBrush: PdfBrush;
     readonly _kidsCount: number;
+    readonly _hasBackColor: boolean;
+    _parseBackColor(hasTransparency: boolean): number[];
+    _updateBackColor(value: number[], hasTransparency?: boolean): void;
     /**
      * Gets the field item as `PdfWidgetAnnotation` at the specified index.
      *
@@ -1349,6 +1352,45 @@ export declare class PdfTextBoxField extends PdfField {
     * ```
     */
     font: PdfFont;
+    /**
+     * Gets the background color of the field.
+     *
+     * @returns {number[]} R, G, B color values in between 0 to 255.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Access the form field at index 0
+     * let field: PdfField = document.form.fieldAt(0);
+     * // Gets the background color of the field.
+     * let backColor: number[] = field.backColor;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    /**
+    * Sets the background color of the field.
+    *
+    * @param {number[]} value Array with R, G, B, A color values in between 0 to 255. For optional A (0-254), it signifies transparency.
+    * ```typescript
+    * // Load an existing PDF document
+    * let document: PdfDocument = new PdfDocument(data, password);
+    * // Access the text box field at index 0
+    * let firstName: PdfField = document.form.fieldAt(0);
+    * // Sets the background color of the field.
+    * firstName.backColor = [255, 0, 0];
+    * // Access the text box field at index 1
+    * let secondName: PdfField = document.form.fieldAt(1);
+    * // Sets the background color of the field to transparent.
+    * secondName.backColor = [0, 0, 0, 0];
+    * // Save the document
+    * document.save('output.pdf');
+    * // Destroy the document
+    * document.destroy();
+    * ```
+    */
+    backColor: number[];
     _initialize(page: PdfPage, name: string, bounds: {
         x: number;
         y: number;
@@ -1565,6 +1607,45 @@ export declare class PdfButtonField extends PdfField {
     * ```
     */
     font: PdfFont;
+    /**
+     * Gets the background color of the field.
+     *
+     * @returns {number[]} R, G, B color values in between 0 to 255.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Access the form field at index 0
+     * let field: PdfField = document.form.fieldAt(0);
+     * // Gets the background color of the field.
+     * let backColor: number[] = field.backColor;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    /**
+    * Sets the background color of the field.
+    *
+    * @param {number[]} value Array with R, G, B, A color values in between 0 to 255. For optional A (0-254), it signifies transparency.
+    * ```typescript
+    * // Load an existing PDF document
+    * let document: PdfDocument = new PdfDocument(data, password);
+    * // Access the button field at index 0
+    * let submitButton: PdfField = document.form.fieldAt(0);
+    * // Sets the background color of the field.
+    * submitButton.backColor = [255, 0, 0];
+    * // Access the button field at index 1
+    * let cancelButton: PdfField = document.form.fieldAt(1);
+    * // Sets the background color of the field to transparent.
+    * cancelButton.backColor = [0, 0, 0, 0];
+    * // Save the document
+    * document.save('output.pdf');
+    * // Destroy the document
+    * document.destroy();
+    * ```
+    */
+    backColor: number[];
     _assignText(fieldDictionary: _PdfDictionary, value: string): void;
     /**
      * Parse an existing button field.
@@ -1810,6 +1891,45 @@ export declare class PdfCheckBoxField extends PdfField {
     * ```
     */
     textAlignment: PdfTextAlignment;
+    /**
+     * Gets the background color of the field.
+     *
+     * @returns {number[]} R, G, B color values in between 0 to 255.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Access the form field at index 0
+     * let field: PdfField = document.form.fieldAt(0);
+     * // Gets the background color of the field.
+     * let backColor: number[] = field.backColor;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    /**
+    * Sets the background color of the field.
+    *
+    * @param {number[]} value Array with R, G, B, A color values in between 0 to 255. For optional A (0-254), it signifies transparency.
+    * ```typescript
+    * // Load an existing PDF document
+    * let document: PdfDocument = new PdfDocument(data, password);
+    * // Access the check box field at index 0
+    * let checkBox1: PdfField = document.form.fieldAt(0);
+    * // Sets the background color of the field.
+    * checkBox1.backColor = [255, 0, 0];
+    * // Access the check box field at index 1
+    * let checkBox2: PdfField = document.form.fieldAt(1);
+    * // Sets the background color of the field to transparent.
+    * checkBox2.backColor = [0, 0, 0, 0];
+    * // Save the document
+    * document.save('output.pdf');
+    * // Destroy the document
+    * document.destroy();
+    * ```
+    */
+    backColor: number[];
     _initialize(page: PdfPage, name: string, bounds: {
         x: number;
         y: number;
@@ -2572,6 +2692,45 @@ export declare abstract class PdfListField extends PdfField {
     * ```
     */
     textAlignment: PdfTextAlignment;
+    /**
+     * Gets the background color of the field.
+     *
+     * @returns {number[]} R, G, B color values in between 0 to 255.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Access the form field at index 0
+     * let field: PdfField = document.form.fieldAt(0);
+     * // Gets the background color of the field.
+     * let backColor: number[] = field.backColor;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    /**
+    * Sets the background color of the field.
+    *
+    * @param {number[]} value Array with R, G, B, A color values in between 0 to 255. For optional A (0-254), it signifies transparency.
+    * ```typescript
+    * // Load an existing PDF document
+    * let document: PdfDocument = new PdfDocument(data, password);
+    * // Access the list field at index 0
+    * let list1: PdfField = document.form.fieldAt(0);
+    * // Sets the background color of the field.
+    * list1.backColor = [255, 0, 0];
+    * // Access the list field at index 1
+    * let list2: PdfField = document.form.fieldAt(1);
+    * // Sets the background color of the field to transparent.
+    * list2.backColor = [0, 0, 0, 0];
+    * // Save the document
+    * document.save('output.pdf');
+    * // Destroy the document
+    * document.destroy();
+    * ```
+    */
+    backColor: number[];
     readonly _options: Array<string[]>;
     /**
      * Gets the item at the specified index.
@@ -2966,6 +3125,45 @@ export declare class PdfSignatureField extends PdfField {
      * ```
      */
     readonly isSigned: boolean;
+    /**
+     * Gets the background color of the field.
+     *
+     * @returns {number[]} R, G, B color values in between 0 to 255.
+     * ```typescript
+     * // Load an existing PDF document
+     * let document: PdfDocument = new PdfDocument(data, password);
+     * // Access the form field at index 0
+     * let field: PdfField = document.form.fieldAt(0);
+     * // Gets the background color of the field.
+     * let backColor: number[] = field.backColor;
+     * // Save the document
+     * document.save('output.pdf');
+     * // Destroy the document
+     * document.destroy();
+     * ```
+     */
+    /**
+    * Sets the background color of the field.
+    *
+    * @param {number[]} value Array with R, G, B, A color values in between 0 to 255. For optional A (0-254), it signifies transparency.
+    * ```typescript
+    * // Load an existing PDF document
+    * let document: PdfDocument = new PdfDocument(data, password);
+    * // Access the signature field at index 0
+    * let field1: PdfField = document.form.fieldAt(0);
+    * // Sets the background color of the field.
+    * field1.backColor = [255, 0, 0];
+    * // Access the signature field at index 1
+    * let field2: PdfField = document.form.fieldAt(1);
+    * // Sets the background color of the field to transparent.
+    * field2.backColor = [0, 0, 0, 0];
+    * // Save the document
+    * document.save('output.pdf');
+    * // Destroy the document
+    * document.destroy();
+    * ```
+    */
+    backColor: number[];
     static _load(form: PdfForm, dictionary: _PdfDictionary, crossReference: _PdfCrossReference, reference: _PdfReference): PdfSignatureField;
     _initialize(page: PdfPage, name: string, bounds: {
         x: number;