java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.essbasic.v20210526.models.Component

public class Component
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

Constructor Summary

Constructors
Constructor	Description
`Component()`
`Component(Component source)`	NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getChannelComponentId()`	Get 平台企业控件ID。如果不为空，属于平台企业预设控件；
`Long`	`getComponentDateFontSize()`	Get 日期签署控件的字号，默认为 12 签署区日期控件会转换成图片格式并带存证，需要通过字体决定图片大小
`String`	`getComponentDescription()`	Get 控件描述，不超过30个字符
`String`	`getComponentExtra()`	Get 扩展参数：为JSON格式。不同类型的控件会有部分非通用参数 TEXT/MULTI_LINE_TEXT控件可以指定 1 Font：目前只支持黑体、宋体 2 FontSize：范围12-72 3 FontAlign： Left/Right/Center，左对齐/居中/右对齐例如：{"FontSize":12} ComponentType为FILL_IMAGE时，支持以下参数： NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true: 不居中 FillMethod: int.
`Float`	`getComponentHeight()`	Get 参数控件高度，默认100，单位px 表单域和关键字转换控件不用填
`String`	`getComponentId()`	Get 控件编号 CreateFlowByTemplates发起合同时优先以ComponentId（不为空）填充；否则以ComponentName填充注：当GenerateMode=KEYWORD时，通过"^"来决定是否使用关键字整词匹配能力。例：当GenerateMode=KEYWORD时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。创建控件时，此值为空查询时返回完整结构
`String`	`getComponentName()`	Get 控件简称，不超过30个字符
`Long`	`getComponentPage()`	Get 参数控件所在页码，从1开始
`Float`	`getComponentPosX()`	Get 参数控件X位置，单位px
`Float`	`getComponentPosY()`	Get 参数控件Y位置，单位px
`String`	`getComponentRecipientId()`	Get 控件关联的参与方ID，对应Recipient结构体中的RecipientId
`Boolean`	`getComponentRequired()`	Get 控件是否为必填项，默认为false-非必填
`String`	`getComponentType()`	Get 如果是Component控件类型，则可选的字段为： TEXT - 普通文本控件，输入文本字符串； MULTI_LINE_TEXT - 多行文本控件，输入文本字符串； CHECK_BOX - 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE - 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE - 动态表格控件； ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分割； SELECTOR - 选择器控件，ComponentValue填写选择的字符串内容； DATE - 日期控件；默认是格式化为xxxx年xx月xx日字符串； DISTRICT - 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；如果是SignComponent控件类型，则可选的字段为 SIGN_SEAL - 签署印章控件； SIGN_DATE - 签署日期控件； SIGN_SIGNATURE - 用户签名控件； SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）； SIGN_PAGING_SEAL - 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight SIGN_OPINION - 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认; SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。表单域的控件不能作为印章和签名控件
`String`	`getComponentValue()`	Get 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DATE - 默认是格式化为xxxx年xx月xx日 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo SIGN_SEAL - 印章ID SIGN_PAGING_SEAL - 可以指定印章ID 控件值约束说明：企业全称控件：约束：企业名称中文字符中文括号检查正则表达式：/^[㐀-䶿一-龥（）]+$/ 统一社会信用代码控件：检查正则表达式：/^[A-Z0-9]{1,18}$/ 法人名称控件：约束：最大50个字符，2到25个汉字或者1到50个字母检查正则表达式：/^([㐀-䶿一-龥.·]{2,25}\|[a-zA-Z·,\s-]{1,50})$/ 签署意见控件：约束：签署意见最大长度为50字符签署人手机号控件：约束：国内手机号 13,14,15,16,17,18,19号段长度11位签署人身份证控件：约束：合法的身份证号码检查控件名称：约束：控件名称最大长度为20字符单行文本控件：约束：只允许输入中文，英文，数字，中英文标点符号多行文本控件：约束：只允许输入中文，英文，数字，中英文标点符号勾选框控件：约束：选择填字符串true，不选填字符串false 选择器控件：约束：同单行文本控件约束，填写选择值中的字符串数字控件：约束：请输入有效的数字(可带小数点) 检查正则表达式：/^(-\|\+)?\d+(\.\d+)?$/ 日期控件：约束：格式：yyyy年mm月dd日附件控件：约束：JPG或PNG图片，上传数量限制，1到6个，最大6个附件图片控件：约束：JPG或PNG图片，填写上传的图片资源ID 邮箱控件：约束：请输入有效的邮箱地址, w3c标准检查正则表达式：/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/ 参考：https://emailregex.com/ 地址控件：同单行文本控件约束省市区控件：同单行文本控件约束性别控件：同单行文本控件约束，填写选择值中的字符串学历控件：同单行文本控件约束，填写选择值中的字符串
`Float`	`getComponentWidth()`	Get 参数控件宽度，默认100，单位px 表单域和关键字转换控件不用填
`String`	`getDocumentId()`	Get 控件所属文档的Id, 模板相关接口为空值
`Long`	`getFileIndex()`	Get 控件所属文件的序号 (文档中文件的排列序号，从0开始)
`Boolean`	`getForbidMoveAndDelete()`	Get 是否禁止移动和删除控件默认false，不禁止移动和删除控件注意：此字段可能返回 null，表示取不到有效值。
`String`	`getGenerateMode()`	Get 控件生成的方式： NORMAL - 普通控件 FIELD - 表单域 KEYWORD - 关键字
`Long[]`	`getKeywordIndexes()`	Get 关键字索引，如果一个关键字在PDF文件中存在多个，可以通过关键字索引指定使用第几个关键字作为最后的结果，可指定多个索引。示例[0,2]，说明使用PDF文件内第1个和第3个关键字位置。
`String`	`getKeywordOrder()`	Get 指定关键字排序规则， Positive-正序， Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的第一个关键字。传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的最后一个关键字。
`Long`	`getKeywordPage()`	Get 指定关键字页码。指定页码后，将只在指定的页码内查找关键字，非该页码的关键字将不会查询出来
`Boolean`	`getLockComponentValue()`	Get 是否锁定控件值不允许编辑（嵌入式发起使用）默认false：不锁定控件值，允许在页面编辑控件值注意：此字段可能返回 null，表示取不到有效值。
`Float`	`getOffsetX()`	Get 指定关键字时横坐标偏移量，单位pt
`Float`	`getOffsetY()`	Get 指定关键字时纵坐标偏移量，单位pt
`String`	`getPlaceholder()`	Get 填写提示的内容注意：此字段可能返回 null，表示取不到有效值。
`String`	`getRelativeLocation()`	Get 关键字位置模式， Middle-居中， Below-正下方， Right-正右方， LowerRight-右上角， UpperRight-右下角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
`void`	`setChannelComponentId(String ChannelComponentId)`	Set 平台企业控件ID。如果不为空，属于平台企业预设控件；
`void`	`setComponentDateFontSize(Long ComponentDateFontSize)`	Set 日期签署控件的字号，默认为 12 签署区日期控件会转换成图片格式并带存证，需要通过字体决定图片大小
`void`	`setComponentDescription(String ComponentDescription)`	Set 控件描述，不超过30个字符
`void`	`setComponentExtra(String ComponentExtra)`	Set 扩展参数：为JSON格式。不同类型的控件会有部分非通用参数 TEXT/MULTI_LINE_TEXT控件可以指定 1 Font：目前只支持黑体、宋体 2 FontSize：范围12-72 3 FontAlign： Left/Right/Center，左对齐/居中/右对齐例如：{"FontSize":12} ComponentType为FILL_IMAGE时，支持以下参数： NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true: 不居中 FillMethod: int.
`void`	`setComponentHeight(Float ComponentHeight)`	Set 参数控件高度，默认100，单位px 表单域和关键字转换控件不用填
`void`	`setComponentId(String ComponentId)`	Set 控件编号 CreateFlowByTemplates发起合同时优先以ComponentId（不为空）填充；否则以ComponentName填充注：当GenerateMode=KEYWORD时，通过"^"来决定是否使用关键字整词匹配能力。例：当GenerateMode=KEYWORD时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。创建控件时，此值为空查询时返回完整结构
`void`	`setComponentName(String ComponentName)`	Set 控件简称，不超过30个字符
`void`	`setComponentPage(Long ComponentPage)`	Set 参数控件所在页码，从1开始
`void`	`setComponentPosX(Float ComponentPosX)`	Set 参数控件X位置，单位px
`void`	`setComponentPosY(Float ComponentPosY)`	Set 参数控件Y位置，单位px
`void`	`setComponentRecipientId(String ComponentRecipientId)`	Set 控件关联的参与方ID，对应Recipient结构体中的RecipientId
`void`	`setComponentRequired(Boolean ComponentRequired)`	Set 控件是否为必填项，默认为false-非必填
`void`	`setComponentType(String ComponentType)`	Set 如果是Component控件类型，则可选的字段为： TEXT - 普通文本控件，输入文本字符串； MULTI_LINE_TEXT - 多行文本控件，输入文本字符串； CHECK_BOX - 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE - 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE - 动态表格控件； ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分割； SELECTOR - 选择器控件，ComponentValue填写选择的字符串内容； DATE - 日期控件；默认是格式化为xxxx年xx月xx日字符串； DISTRICT - 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；如果是SignComponent控件类型，则可选的字段为 SIGN_SEAL - 签署印章控件； SIGN_DATE - 签署日期控件； SIGN_SIGNATURE - 用户签名控件； SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）； SIGN_PAGING_SEAL - 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight SIGN_OPINION - 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认; SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。表单域的控件不能作为印章和签名控件
`void`	`setComponentValue(String ComponentValue)`	Set 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DATE - 默认是格式化为xxxx年xx月xx日 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo SIGN_SEAL - 印章ID SIGN_PAGING_SEAL - 可以指定印章ID 控件值约束说明：企业全称控件：约束：企业名称中文字符中文括号检查正则表达式：/^[㐀-䶿一-龥（）]+$/ 统一社会信用代码控件：检查正则表达式：/^[A-Z0-9]{1,18}$/ 法人名称控件：约束：最大50个字符，2到25个汉字或者1到50个字母检查正则表达式：/^([㐀-䶿一-龥.·]{2,25}\|[a-zA-Z·,\s-]{1,50})$/ 签署意见控件：约束：签署意见最大长度为50字符签署人手机号控件：约束：国内手机号 13,14,15,16,17,18,19号段长度11位签署人身份证控件：约束：合法的身份证号码检查控件名称：约束：控件名称最大长度为20字符单行文本控件：约束：只允许输入中文，英文，数字，中英文标点符号多行文本控件：约束：只允许输入中文，英文，数字，中英文标点符号勾选框控件：约束：选择填字符串true，不选填字符串false 选择器控件：约束：同单行文本控件约束，填写选择值中的字符串数字控件：约束：请输入有效的数字(可带小数点) 检查正则表达式：/^(-\|\+)?\d+(\.\d+)?$/ 日期控件：约束：格式：yyyy年mm月dd日附件控件：约束：JPG或PNG图片，上传数量限制，1到6个，最大6个附件图片控件：约束：JPG或PNG图片，填写上传的图片资源ID 邮箱控件：约束：请输入有效的邮箱地址, w3c标准检查正则表达式：/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/ 参考：https://emailregex.com/ 地址控件：同单行文本控件约束省市区控件：同单行文本控件约束性别控件：同单行文本控件约束，填写选择值中的字符串学历控件：同单行文本控件约束，填写选择值中的字符串
`void`	`setComponentWidth(Float ComponentWidth)`	Set 参数控件宽度，默认100，单位px 表单域和关键字转换控件不用填
`void`	`setDocumentId(String DocumentId)`	Set 控件所属文档的Id, 模板相关接口为空值
`void`	`setFileIndex(Long FileIndex)`	Set 控件所属文件的序号 (文档中文件的排列序号，从0开始)
`void`	`setForbidMoveAndDelete(Boolean ForbidMoveAndDelete)`	Set 是否禁止移动和删除控件默认false，不禁止移动和删除控件注意：此字段可能返回 null，表示取不到有效值。
`void`	`setGenerateMode(String GenerateMode)`	Set 控件生成的方式： NORMAL - 普通控件 FIELD - 表单域 KEYWORD - 关键字
`void`	`setKeywordIndexes(Long[] KeywordIndexes)`	Set 关键字索引，如果一个关键字在PDF文件中存在多个，可以通过关键字索引指定使用第几个关键字作为最后的结果，可指定多个索引。示例[0,2]，说明使用PDF文件内第1个和第3个关键字位置。
`void`	`setKeywordOrder(String KeywordOrder)`	Set 指定关键字排序规则， Positive-正序， Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的第一个关键字。传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的最后一个关键字。
`void`	`setKeywordPage(Long KeywordPage)`	Set 指定关键字页码。指定页码后，将只在指定的页码内查找关键字，非该页码的关键字将不会查询出来
`void`	`setLockComponentValue(Boolean LockComponentValue)`	Set 是否锁定控件值不允许编辑（嵌入式发起使用）默认false：不锁定控件值，允许在页面编辑控件值注意：此字段可能返回 null，表示取不到有效值。
`void`	`setOffsetX(Float OffsetX)`	Set 指定关键字时横坐标偏移量，单位pt
`void`	`setOffsetY(Float OffsetY)`	Set 指定关键字时纵坐标偏移量，单位pt
`void`	`setPlaceholder(String Placeholder)`	Set 填写提示的内容注意：此字段可能返回 null，表示取不到有效值。
`void`	`setRelativeLocation(String RelativeLocation)`	Set 关键字位置模式， Middle-居中， Below-正下方， Right-正右方， LowerRight-右上角， UpperRight-右下角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
`void`	`toMap(HashMap<String,String> map, String prefix)`	Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Component
```
public Component()
```
  - Component
```
public Component(Component source)
```
    NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
- Method Detail
  - getComponentId
```
public String getComponentId()
```
    Get 控件编号 CreateFlowByTemplates发起合同时优先以ComponentId（不为空）填充；否则以ComponentName填充注：当GenerateMode=KEYWORD时，通过"^"来决定是否使用关键字整词匹配能力。例：当GenerateMode=KEYWORD时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。创建控件时，此值为空查询时返回完整结构
    
    Returns:
    
    ComponentId 控件编号 CreateFlowByTemplates发起合同时优先以ComponentId（不为空）填充；否则以ComponentName填充注：当GenerateMode=KEYWORD时，通过"^"来决定是否使用关键字整词匹配能力。例：当GenerateMode=KEYWORD时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。创建控件时，此值为空查询时返回完整结构
  - setComponentId
```
public void setComponentId(String ComponentId)
```
    Set 控件编号 CreateFlowByTemplates发起合同时优先以ComponentId（不为空）填充；否则以ComponentName填充注：当GenerateMode=KEYWORD时，通过"^"来决定是否使用关键字整词匹配能力。例：当GenerateMode=KEYWORD时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。创建控件时，此值为空查询时返回完整结构
    
    Parameters:
    
    ComponentId - 控件编号 CreateFlowByTemplates发起合同时优先以ComponentId（不为空）填充；否则以ComponentName填充注：当GenerateMode=KEYWORD时，通过"^"来决定是否使用关键字整词匹配能力。例：当GenerateMode=KEYWORD时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。创建控件时，此值为空查询时返回完整结构
  - getComponentType
```
public String getComponentType()
```
    Get 如果是Component控件类型，则可选的字段为： TEXT - 普通文本控件，输入文本字符串； MULTI_LINE_TEXT - 多行文本控件，输入文本字符串； CHECK_BOX - 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE - 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE - 动态表格控件； ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分割； SELECTOR - 选择器控件，ComponentValue填写选择的字符串内容； DATE - 日期控件；默认是格式化为xxxx年xx月xx日字符串； DISTRICT - 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；如果是SignComponent控件类型，则可选的字段为 SIGN_SEAL - 签署印章控件； SIGN_DATE - 签署日期控件； SIGN_SIGNATURE - 用户签名控件； SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）； SIGN_PAGING_SEAL - 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight SIGN_OPINION - 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认; SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。表单域的控件不能作为印章和签名控件
    
    Returns:
    
    ComponentType 如果是Component控件类型，则可选的字段为： TEXT - 普通文本控件，输入文本字符串； MULTI_LINE_TEXT - 多行文本控件，输入文本字符串； CHECK_BOX - 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE - 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE - 动态表格控件； ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分割； SELECTOR - 选择器控件，ComponentValue填写选择的字符串内容； DATE - 日期控件；默认是格式化为xxxx年xx月xx日字符串； DISTRICT - 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；如果是SignComponent控件类型，则可选的字段为 SIGN_SEAL - 签署印章控件； SIGN_DATE - 签署日期控件； SIGN_SIGNATURE - 用户签名控件； SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）； SIGN_PAGING_SEAL - 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight SIGN_OPINION - 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认; SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。表单域的控件不能作为印章和签名控件
  - setComponentType
```
public void setComponentType(String ComponentType)
```
    Set 如果是Component控件类型，则可选的字段为： TEXT - 普通文本控件，输入文本字符串； MULTI_LINE_TEXT - 多行文本控件，输入文本字符串； CHECK_BOX - 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE - 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE - 动态表格控件； ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分割； SELECTOR - 选择器控件，ComponentValue填写选择的字符串内容； DATE - 日期控件；默认是格式化为xxxx年xx月xx日字符串； DISTRICT - 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；如果是SignComponent控件类型，则可选的字段为 SIGN_SEAL - 签署印章控件； SIGN_DATE - 签署日期控件； SIGN_SIGNATURE - 用户签名控件； SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）； SIGN_PAGING_SEAL - 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight SIGN_OPINION - 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认; SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。表单域的控件不能作为印章和签名控件
    
    Parameters:
    
    ComponentType - 如果是Component控件类型，则可选的字段为： TEXT - 普通文本控件，输入文本字符串； MULTI_LINE_TEXT - 多行文本控件，输入文本字符串； CHECK_BOX - 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串； FILL_IMAGE - 图片控件，ComponentValue 填写图片的资源 ID； DYNAMIC_TABLE - 动态表格控件； ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分割； SELECTOR - 选择器控件，ComponentValue填写选择的字符串内容； DATE - 日期控件；默认是格式化为xxxx年xx月xx日字符串； DISTRICT - 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；如果是SignComponent控件类型，则可选的字段为 SIGN_SEAL - 签署印章控件； SIGN_DATE - 签署日期控件； SIGN_SIGNATURE - 用户签名控件； SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）； SIGN_PAGING_SEAL - 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight SIGN_OPINION - 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认; SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。表单域的控件不能作为印章和签名控件
  - getComponentName
```
public String getComponentName()
```
    Get 控件简称，不超过30个字符
    
    Returns:
    
    ComponentName 控件简称，不超过30个字符
  - setComponentName
```
public void setComponentName(String ComponentName)
```
    Set 控件简称，不超过30个字符
    
    Parameters:
    
    ComponentName - 控件简称，不超过30个字符
  - getComponentRequired
```
public Boolean getComponentRequired()
```
    Get 控件是否为必填项，默认为false-非必填
    
    Returns:
    
    ComponentRequired 控件是否为必填项，默认为false-非必填
  - setComponentRequired
```
public void setComponentRequired(Boolean ComponentRequired)
```
    Set 控件是否为必填项，默认为false-非必填
    
    Parameters:
    
    ComponentRequired - 控件是否为必填项，默认为false-非必填
  - getComponentRecipientId
```
public String getComponentRecipientId()
```
    Get 控件关联的参与方ID，对应Recipient结构体中的RecipientId
    
    Returns:
    
    ComponentRecipientId 控件关联的参与方ID，对应Recipient结构体中的RecipientId
  - setComponentRecipientId
```
public void setComponentRecipientId(String ComponentRecipientId)
```
    Set 控件关联的参与方ID，对应Recipient结构体中的RecipientId
    
    Parameters:
    
    ComponentRecipientId - 控件关联的参与方ID，对应Recipient结构体中的RecipientId
  - getFileIndex
```
public Long getFileIndex()
```
    Get 控件所属文件的序号 (文档中文件的排列序号，从0开始)
    
    Returns:
    
    FileIndex 控件所属文件的序号 (文档中文件的排列序号，从0开始)
  - setFileIndex
```
public void setFileIndex(Long FileIndex)
```
    Set 控件所属文件的序号 (文档中文件的排列序号，从0开始)
    
    Parameters:
    
    FileIndex - 控件所属文件的序号 (文档中文件的排列序号，从0开始)
  - getGenerateMode
```
public String getGenerateMode()
```
    Get 控件生成的方式： NORMAL - 普通控件 FIELD - 表单域 KEYWORD - 关键字
    
    Returns:
    
    GenerateMode 控件生成的方式： NORMAL - 普通控件 FIELD - 表单域 KEYWORD - 关键字
  - setGenerateMode
```
public void setGenerateMode(String GenerateMode)
```
    Set 控件生成的方式： NORMAL - 普通控件 FIELD - 表单域 KEYWORD - 关键字
    
    Parameters:
    
    GenerateMode - 控件生成的方式： NORMAL - 普通控件 FIELD - 表单域 KEYWORD - 关键字
  - getComponentWidth
```
public Float getComponentWidth()
```
    Get 参数控件宽度，默认100，单位px 表单域和关键字转换控件不用填
    
    Returns:
    
    ComponentWidth 参数控件宽度，默认100，单位px 表单域和关键字转换控件不用填
  - setComponentWidth
```
public void setComponentWidth(Float ComponentWidth)
```
    Set 参数控件宽度，默认100，单位px 表单域和关键字转换控件不用填
    
    Parameters:
    
    ComponentWidth - 参数控件宽度，默认100，单位px 表单域和关键字转换控件不用填
  - getComponentHeight
```
public Float getComponentHeight()
```
    Get 参数控件高度，默认100，单位px 表单域和关键字转换控件不用填
    
    Returns:
    
    ComponentHeight 参数控件高度，默认100，单位px 表单域和关键字转换控件不用填
  - setComponentHeight
```
public void setComponentHeight(Float ComponentHeight)
```
    Set 参数控件高度，默认100，单位px 表单域和关键字转换控件不用填
    
    Parameters:
    
    ComponentHeight - 参数控件高度，默认100，单位px 表单域和关键字转换控件不用填
  - getComponentPage
```
public Long getComponentPage()
```
    Get 参数控件所在页码，从1开始
    
    Returns:
    
    ComponentPage 参数控件所在页码，从1开始
  - setComponentPage
```
public void setComponentPage(Long ComponentPage)
```
    Set 参数控件所在页码，从1开始
    
    Parameters:
    
    ComponentPage - 参数控件所在页码，从1开始
  - getComponentPosX
```
public Float getComponentPosX()
```
    Get 参数控件X位置，单位px
    
    Returns:
    
    ComponentPosX 参数控件X位置，单位px
  - setComponentPosX
```
public void setComponentPosX(Float ComponentPosX)
```
    Set 参数控件X位置，单位px
    
    Parameters:
    
    ComponentPosX - 参数控件X位置，单位px
  - getComponentPosY
```
public Float getComponentPosY()
```
    Get 参数控件Y位置，单位px
    
    Returns:
    
    ComponentPosY 参数控件Y位置，单位px
  - setComponentPosY
```
public void setComponentPosY(Float ComponentPosY)
```
    Set 参数控件Y位置，单位px
    
    Parameters:
    
    ComponentPosY - 参数控件Y位置，单位px
  - getComponentExtra
```
public String getComponentExtra()
```
    Get 扩展参数：为JSON格式。不同类型的控件会有部分非通用参数 TEXT/MULTI_LINE_TEXT控件可以指定 1 Font：目前只支持黑体、宋体 2 FontSize：范围12-72 3 FontAlign： Left/Right/Center，左对齐/居中/右对齐例如：{"FontSize":12} ComponentType为FILL_IMAGE时，支持以下参数： NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true: 不居中 FillMethod: int. 填充方式。0-铺满（默认）；1-等比例缩放 ComponentType为SIGN_SIGNATURE类型可以控制签署方式 {“ComponentTypeLimit”: [“xxx”]} xxx可以为： HANDWRITE – 手写签名 OCR_ESIGN -- AI智能识别手写签名 ESIGN -- 个人印章类型 SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）如：{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]} ComponentType为SIGN_DATE时，支持以下参数： 1 Font：字符串类型目前只支持"黑体"、"宋体"，如果不填默认为"黑体" 2 FontSize：数字类型，范围6-72，默认值为12 3 FontAlign：字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐 4 Format：字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。 5 Gaps:：字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "ComponentExtra": "{"Format":“yyyy m d”,"FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}" ComponentType为SIGN_SEAL类型时，支持以下参数： 1.PageRanges：PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）参数样例： "ComponentExtra":"{["PageRange":{"BeginPage":1,"EndPage":-1}]}"
    
    Returns:
    
    ComponentExtra 扩展参数：为JSON格式。不同类型的控件会有部分非通用参数 TEXT/MULTI_LINE_TEXT控件可以指定 1 Font：目前只支持黑体、宋体 2 FontSize：范围12-72 3 FontAlign： Left/Right/Center，左对齐/居中/右对齐例如：{"FontSize":12} ComponentType为FILL_IMAGE时，支持以下参数： NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true: 不居中 FillMethod: int. 填充方式。0-铺满（默认）；1-等比例缩放 ComponentType为SIGN_SIGNATURE类型可以控制签署方式 {“ComponentTypeLimit”: [“xxx”]} xxx可以为： HANDWRITE – 手写签名 OCR_ESIGN -- AI智能识别手写签名 ESIGN -- 个人印章类型 SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）如：{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]} ComponentType为SIGN_DATE时，支持以下参数： 1 Font：字符串类型目前只支持"黑体"、"宋体"，如果不填默认为"黑体" 2 FontSize：数字类型，范围6-72，默认值为12 3 FontAlign：字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐 4 Format：字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。 5 Gaps:：字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "ComponentExtra": "{"Format":“yyyy m d”,"FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}" ComponentType为SIGN_SEAL类型时，支持以下参数： 1.PageRanges：PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）参数样例： "ComponentExtra":"{["PageRange":{"BeginPage":1,"EndPage":-1}]}"
  - setComponentExtra
```
public void setComponentExtra(String ComponentExtra)
```
    Set 扩展参数：为JSON格式。不同类型的控件会有部分非通用参数 TEXT/MULTI_LINE_TEXT控件可以指定 1 Font：目前只支持黑体、宋体 2 FontSize：范围12-72 3 FontAlign： Left/Right/Center，左对齐/居中/右对齐例如：{"FontSize":12} ComponentType为FILL_IMAGE时，支持以下参数： NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true: 不居中 FillMethod: int. 填充方式。0-铺满（默认）；1-等比例缩放 ComponentType为SIGN_SIGNATURE类型可以控制签署方式 {“ComponentTypeLimit”: [“xxx”]} xxx可以为： HANDWRITE – 手写签名 OCR_ESIGN -- AI智能识别手写签名 ESIGN -- 个人印章类型 SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）如：{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]} ComponentType为SIGN_DATE时，支持以下参数： 1 Font：字符串类型目前只支持"黑体"、"宋体"，如果不填默认为"黑体" 2 FontSize：数字类型，范围6-72，默认值为12 3 FontAlign：字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐 4 Format：字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。 5 Gaps:：字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "ComponentExtra": "{"Format":“yyyy m d”,"FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}" ComponentType为SIGN_SEAL类型时，支持以下参数： 1.PageRanges：PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）参数样例： "ComponentExtra":"{["PageRange":{"BeginPage":1,"EndPage":-1}]}"
    
    Parameters:
    
    ComponentExtra - 扩展参数：为JSON格式。不同类型的控件会有部分非通用参数 TEXT/MULTI_LINE_TEXT控件可以指定 1 Font：目前只支持黑体、宋体 2 FontSize：范围12-72 3 FontAlign： Left/Right/Center，左对齐/居中/右对齐例如：{"FontSize":12} ComponentType为FILL_IMAGE时，支持以下参数： NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true: 不居中 FillMethod: int. 填充方式。0-铺满（默认）；1-等比例缩放 ComponentType为SIGN_SIGNATURE类型可以控制签署方式 {“ComponentTypeLimit”: [“xxx”]} xxx可以为： HANDWRITE – 手写签名 OCR_ESIGN -- AI智能识别手写签名 ESIGN -- 个人印章类型 SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）如：{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]} ComponentType为SIGN_DATE时，支持以下参数： 1 Font：字符串类型目前只支持"黑体"、"宋体"，如果不填默认为"黑体" 2 FontSize：数字类型，范围6-72，默认值为12 3 FontAlign：字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐 4 Format：字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。 5 Gaps:：字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "ComponentExtra": "{"Format":“yyyy m d”,"FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}" ComponentType为SIGN_SEAL类型时，支持以下参数： 1.PageRanges：PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）参数样例： "ComponentExtra":"{["PageRange":{"BeginPage":1,"EndPage":-1}]}"
  - getComponentValue
```
public String getComponentValue()
```
    Get 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DATE - 默认是格式化为xxxx年xx月xx日 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo SIGN_SEAL - 印章ID SIGN_PAGING_SEAL - 可以指定印章ID 控件值约束说明：企业全称控件：约束：企业名称中文字符中文括号检查正则表达式：/^[㐀-䶿一-龥（）]+$/ 统一社会信用代码控件：检查正则表达式：/^[A-Z0-9]{1,18}$/ 法人名称控件：约束：最大50个字符，2到25个汉字或者1到50个字母检查正则表达式：/^([㐀-䶿一-龥.·]{2,25}|[a-zA-Z·,\s-]{1,50})$/ 签署意见控件：约束：签署意见最大长度为50字符签署人手机号控件：约束：国内手机号 13,14,15,16,17,18,19号段长度11位签署人身份证控件：约束：合法的身份证号码检查控件名称：约束：控件名称最大长度为20字符单行文本控件：约束：只允许输入中文，英文，数字，中英文标点符号多行文本控件：约束：只允许输入中文，英文，数字，中英文标点符号勾选框控件：约束：选择填字符串true，不选填字符串false 选择器控件：约束：同单行文本控件约束，填写选择值中的字符串数字控件：约束：请输入有效的数字(可带小数点) 检查正则表达式：/^(-|\+)?\d+(\.\d+)?$/ 日期控件：约束：格式：yyyy年mm月dd日附件控件：约束：JPG或PNG图片，上传数量限制，1到6个，最大6个附件图片控件：约束：JPG或PNG图片，填写上传的图片资源ID 邮箱控件：约束：请输入有效的邮箱地址, w3c标准检查正则表达式：/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/ 参考：https://emailregex.com/ 地址控件：同单行文本控件约束省市区控件：同单行文本控件约束性别控件：同单行文本控件约束，填写选择值中的字符串学历控件：同单行文本控件约束，填写选择值中的字符串
    
    Returns:
    
    ComponentValue 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DATE - 默认是格式化为xxxx年xx月xx日 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo SIGN_SEAL - 印章ID SIGN_PAGING_SEAL - 可以指定印章ID 控件值约束说明：企业全称控件：约束：企业名称中文字符中文括号检查正则表达式：/^[㐀-䶿一-龥（）]+$/ 统一社会信用代码控件：检查正则表达式：/^[A-Z0-9]{1,18}$/ 法人名称控件：约束：最大50个字符，2到25个汉字或者1到50个字母检查正则表达式：/^([㐀-䶿一-龥.·]{2,25}|[a-zA-Z·,\s-]{1,50})$/ 签署意见控件：约束：签署意见最大长度为50字符签署人手机号控件：约束：国内手机号 13,14,15,16,17,18,19号段长度11位签署人身份证控件：约束：合法的身份证号码检查控件名称：约束：控件名称最大长度为20字符单行文本控件：约束：只允许输入中文，英文，数字，中英文标点符号多行文本控件：约束：只允许输入中文，英文，数字，中英文标点符号勾选框控件：约束：选择填字符串true，不选填字符串false 选择器控件：约束：同单行文本控件约束，填写选择值中的字符串数字控件：约束：请输入有效的数字(可带小数点) 检查正则表达式：/^(-|\+)?\d+(\.\d+)?$/ 日期控件：约束：格式：yyyy年mm月dd日附件控件：约束：JPG或PNG图片，上传数量限制，1到6个，最大6个附件图片控件：约束：JPG或PNG图片，填写上传的图片资源ID 邮箱控件：约束：请输入有效的邮箱地址, w3c标准检查正则表达式：/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/ 参考：https://emailregex.com/ 地址控件：同单行文本控件约束省市区控件：同单行文本控件约束性别控件：同单行文本控件约束，填写选择值中的字符串学历控件：同单行文本控件约束，填写选择值中的字符串
  - setComponentValue
```
public void setComponentValue(String ComponentValue)
```
    Set 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DATE - 默认是格式化为xxxx年xx月xx日 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo SIGN_SEAL - 印章ID SIGN_PAGING_SEAL - 可以指定印章ID 控件值约束说明：企业全称控件：约束：企业名称中文字符中文括号检查正则表达式：/^[㐀-䶿一-龥（）]+$/ 统一社会信用代码控件：检查正则表达式：/^[A-Z0-9]{1,18}$/ 法人名称控件：约束：最大50个字符，2到25个汉字或者1到50个字母检查正则表达式：/^([㐀-䶿一-龥.·]{2,25}|[a-zA-Z·,\s-]{1,50})$/ 签署意见控件：约束：签署意见最大长度为50字符签署人手机号控件：约束：国内手机号 13,14,15,16,17,18,19号段长度11位签署人身份证控件：约束：合法的身份证号码检查控件名称：约束：控件名称最大长度为20字符单行文本控件：约束：只允许输入中文，英文，数字，中英文标点符号多行文本控件：约束：只允许输入中文，英文，数字，中英文标点符号勾选框控件：约束：选择填字符串true，不选填字符串false 选择器控件：约束：同单行文本控件约束，填写选择值中的字符串数字控件：约束：请输入有效的数字(可带小数点) 检查正则表达式：/^(-|\+)?\d+(\.\d+)?$/ 日期控件：约束：格式：yyyy年mm月dd日附件控件：约束：JPG或PNG图片，上传数量限制，1到6个，最大6个附件图片控件：约束：JPG或PNG图片，填写上传的图片资源ID 邮箱控件：约束：请输入有效的邮箱地址, w3c标准检查正则表达式：/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/ 参考：https://emailregex.com/ 地址控件：同单行文本控件约束省市区控件：同单行文本控件约束性别控件：同单行文本控件约束，填写选择值中的字符串学历控件：同单行文本控件约束，填写选择值中的字符串
    
    Parameters:
    
    ComponentValue - 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DATE - 默认是格式化为xxxx年xx月xx日 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo SIGN_SEAL - 印章ID SIGN_PAGING_SEAL - 可以指定印章ID 控件值约束说明：企业全称控件：约束：企业名称中文字符中文括号检查正则表达式：/^[㐀-䶿一-龥（）]+$/ 统一社会信用代码控件：检查正则表达式：/^[A-Z0-9]{1,18}$/ 法人名称控件：约束：最大50个字符，2到25个汉字或者1到50个字母检查正则表达式：/^([㐀-䶿一-龥.·]{2,25}|[a-zA-Z·,\s-]{1,50})$/ 签署意见控件：约束：签署意见最大长度为50字符签署人手机号控件：约束：国内手机号 13,14,15,16,17,18,19号段长度11位签署人身份证控件：约束：合法的身份证号码检查控件名称：约束：控件名称最大长度为20字符单行文本控件：约束：只允许输入中文，英文，数字，中英文标点符号多行文本控件：约束：只允许输入中文，英文，数字，中英文标点符号勾选框控件：约束：选择填字符串true，不选填字符串false 选择器控件：约束：同单行文本控件约束，填写选择值中的字符串数字控件：约束：请输入有效的数字(可带小数点) 检查正则表达式：/^(-|\+)?\d+(\.\d+)?$/ 日期控件：约束：格式：yyyy年mm月dd日附件控件：约束：JPG或PNG图片，上传数量限制，1到6个，最大6个附件图片控件：约束：JPG或PNG图片，填写上传的图片资源ID 邮箱控件：约束：请输入有效的邮箱地址, w3c标准检查正则表达式：/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/ 参考：https://emailregex.com/ 地址控件：同单行文本控件约束省市区控件：同单行文本控件约束性别控件：同单行文本控件约束，填写选择值中的字符串学历控件：同单行文本控件约束，填写选择值中的字符串
  - getComponentDateFontSize
```
public Long getComponentDateFontSize()
```
    Get 日期签署控件的字号，默认为 12 签署区日期控件会转换成图片格式并带存证，需要通过字体决定图片大小
    
    Returns:
    
    ComponentDateFontSize 日期签署控件的字号，默认为 12 签署区日期控件会转换成图片格式并带存证，需要通过字体决定图片大小
  - setComponentDateFontSize
```
public void setComponentDateFontSize(Long ComponentDateFontSize)
```
    Set 日期签署控件的字号，默认为 12 签署区日期控件会转换成图片格式并带存证，需要通过字体决定图片大小
    
    Parameters:
    
    ComponentDateFontSize - 日期签署控件的字号，默认为 12 签署区日期控件会转换成图片格式并带存证，需要通过字体决定图片大小
  - getDocumentId
```
public String getDocumentId()
```
    Get 控件所属文档的Id, 模板相关接口为空值
    
    Returns:
    
    DocumentId 控件所属文档的Id, 模板相关接口为空值
  - setDocumentId
```
public void setDocumentId(String DocumentId)
```
    Set 控件所属文档的Id, 模板相关接口为空值
    
    Parameters:
    
    DocumentId - 控件所属文档的Id, 模板相关接口为空值
  - getComponentDescription
```
public String getComponentDescription()
```
    Get 控件描述，不超过30个字符
    
    Returns:
    
    ComponentDescription 控件描述，不超过30个字符
  - setComponentDescription
```
public void setComponentDescription(String ComponentDescription)
```
    Set 控件描述，不超过30个字符
    
    Parameters:
    
    ComponentDescription - 控件描述，不超过30个字符
  - getOffsetX
```
public Float getOffsetX()
```
    Get 指定关键字时横坐标偏移量，单位pt
    
    Returns:
    
    OffsetX 指定关键字时横坐标偏移量，单位pt
  - setOffsetX
```
public void setOffsetX(Float OffsetX)
```
    Set 指定关键字时横坐标偏移量，单位pt
    
    Parameters:
    
    OffsetX - 指定关键字时横坐标偏移量，单位pt
  - getOffsetY
```
public Float getOffsetY()
```
    Get 指定关键字时纵坐标偏移量，单位pt
    
    Returns:
    
    OffsetY 指定关键字时纵坐标偏移量，单位pt
  - setOffsetY
```
public void setOffsetY(Float OffsetY)
```
    Set 指定关键字时纵坐标偏移量，单位pt
    
    Parameters:
    
    OffsetY - 指定关键字时纵坐标偏移量，单位pt
  - getChannelComponentId
```
public String getChannelComponentId()
```
    Get 平台企业控件ID。如果不为空，属于平台企业预设控件；
    
    Returns:
    
    ChannelComponentId 平台企业控件ID。如果不为空，属于平台企业预设控件；
  - setChannelComponentId
```
public void setChannelComponentId(String ChannelComponentId)
```
    Set 平台企业控件ID。如果不为空，属于平台企业预设控件；
    
    Parameters:
    
    ChannelComponentId - 平台企业控件ID。如果不为空，属于平台企业预设控件；
  - getKeywordOrder
```
public String getKeywordOrder()
```
    Get 指定关键字排序规则， Positive-正序， Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的第一个关键字。传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的最后一个关键字。
    
    Returns:
    
    KeywordOrder 指定关键字排序规则， Positive-正序， Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的第一个关键字。传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的最后一个关键字。
  - setKeywordOrder
```
public void setKeywordOrder(String KeywordOrder)
```
    Set 指定关键字排序规则， Positive-正序， Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的第一个关键字。传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的最后一个关键字。
    
    Parameters:
    
    KeywordOrder - 指定关键字排序规则， Positive-正序， Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的第一个关键字。传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时，0代表在PDF内查找内容时，查找到的最后一个关键字。
  - getKeywordPage
```
public Long getKeywordPage()
```
    Get 指定关键字页码。指定页码后，将只在指定的页码内查找关键字，非该页码的关键字将不会查询出来
    
    Returns:
    
    KeywordPage 指定关键字页码。指定页码后，将只在指定的页码内查找关键字，非该页码的关键字将不会查询出来
  - setKeywordPage
```
public void setKeywordPage(Long KeywordPage)
```
    Set 指定关键字页码。指定页码后，将只在指定的页码内查找关键字，非该页码的关键字将不会查询出来
    
    Parameters:
    
    KeywordPage - 指定关键字页码。指定页码后，将只在指定的页码内查找关键字，非该页码的关键字将不会查询出来
  - getRelativeLocation
```
public String getRelativeLocation()
```
    Get 关键字位置模式， Middle-居中， Below-正下方， Right-正右方， LowerRight-右上角， UpperRight-右下角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
    
    Returns:
    
    RelativeLocation 关键字位置模式， Middle-居中， Below-正下方， Right-正右方， LowerRight-右上角， UpperRight-右下角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
  - setRelativeLocation
```
public void setRelativeLocation(String RelativeLocation)
```
    Set 关键字位置模式， Middle-居中， Below-正下方， Right-正右方， LowerRight-右上角， UpperRight-右下角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
    
    Parameters:
    
    RelativeLocation - 关键字位置模式， Middle-居中， Below-正下方， Right-正右方， LowerRight-右上角， UpperRight-右下角。示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方
  - getKeywordIndexes
```
public Long[] getKeywordIndexes()
```
    Get 关键字索引，如果一个关键字在PDF文件中存在多个，可以通过关键字索引指定使用第几个关键字作为最后的结果，可指定多个索引。示例[0,2]，说明使用PDF文件内第1个和第3个关键字位置。
    
    Returns:
    
    KeywordIndexes 关键字索引，如果一个关键字在PDF文件中存在多个，可以通过关键字索引指定使用第几个关键字作为最后的结果，可指定多个索引。示例[0,2]，说明使用PDF文件内第1个和第3个关键字位置。
  - setKeywordIndexes
```
public void setKeywordIndexes(Long[] KeywordIndexes)
```
    Set 关键字索引，如果一个关键字在PDF文件中存在多个，可以通过关键字索引指定使用第几个关键字作为最后的结果，可指定多个索引。示例[0,2]，说明使用PDF文件内第1个和第3个关键字位置。
    
    Parameters:
    
    KeywordIndexes - 关键字索引，如果一个关键字在PDF文件中存在多个，可以通过关键字索引指定使用第几个关键字作为最后的结果，可指定多个索引。示例[0,2]，说明使用PDF文件内第1个和第3个关键字位置。
  - getPlaceholder
```
public String getPlaceholder()
```
    Get 填写提示的内容注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    Placeholder 填写提示的内容注意：此字段可能返回 null，表示取不到有效值。
  - setPlaceholder
```
public void setPlaceholder(String Placeholder)
```
    Set 填写提示的内容注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    Placeholder - 填写提示的内容注意：此字段可能返回 null，表示取不到有效值。
  - getLockComponentValue
```
public Boolean getLockComponentValue()
```
    Get 是否锁定控件值不允许编辑（嵌入式发起使用）
    默认false：不锁定控件值，允许在页面编辑控件值注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    LockComponentValue 是否锁定控件值不允许编辑（嵌入式发起使用）
    默认false：不锁定控件值，允许在页面编辑控件值注意：此字段可能返回 null，表示取不到有效值。
  - setLockComponentValue
```
public void setLockComponentValue(Boolean LockComponentValue)
```
    Set 是否锁定控件值不允许编辑（嵌入式发起使用）
    默认false：不锁定控件值，允许在页面编辑控件值注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    LockComponentValue - 是否锁定控件值不允许编辑（嵌入式发起使用）
    默认false：不锁定控件值，允许在页面编辑控件值注意：此字段可能返回 null，表示取不到有效值。
  - getForbidMoveAndDelete
```
public Boolean getForbidMoveAndDelete()
```
    Get 是否禁止移动和删除控件
    默认false，不禁止移动和删除控件注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    ForbidMoveAndDelete 是否禁止移动和删除控件
    默认false，不禁止移动和删除控件注意：此字段可能返回 null，表示取不到有效值。
  - setForbidMoveAndDelete
```
public void setForbidMoveAndDelete(Boolean ForbidMoveAndDelete)
```
    Set 是否禁止移动和删除控件
    默认false，不禁止移动和删除控件注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    ForbidMoveAndDelete - 是否禁止移动和删除控件
    默认false，不禁止移动和删除控件注意：此字段可能返回 null，表示取不到有效值。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class Component

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

Component

Component

Method Detail

getComponentId

setComponentId

getComponentType

setComponentType

getComponentName

setComponentName

getComponentRequired

setComponentRequired

getComponentRecipientId

setComponentRecipientId

getFileIndex

setFileIndex

getGenerateMode

setGenerateMode

getComponentWidth

setComponentWidth

getComponentHeight

setComponentHeight

getComponentPage

setComponentPage

getComponentPosX

setComponentPosX

getComponentPosY

setComponentPosY

getComponentExtra

setComponentExtra

getComponentValue

setComponentValue

getComponentDateFontSize

setComponentDateFontSize

getDocumentId

setDocumentId

getComponentDescription

setComponentDescription

getOffsetX

setOffsetX

getOffsetY

setOffsetY

getChannelComponentId

setChannelComponentId

getKeywordOrder

setKeywordOrder

getKeywordPage

setKeywordPage

getRelativeLocation

setRelativeLocation

getKeywordIndexes

setKeywordIndexes

getPlaceholder

setPlaceholder

getLockComponentValue

setLockComponentValue

getForbidMoveAndDelete

setForbidMoveAndDelete

toMap