public class Component extends AbstractModel
Constructor and 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.
|
Modifier and Type | Method and 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=3时,通过"^"来决定是否使用关键字整词匹配能力。
例:
当GenerateMode=3时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
创建控件时,此值为空
查询时返回完整结构
|
String |
getComponentName()
Get 控件简称,不能超过30个字符
|
Long |
getComponentPage()
Get 参数控件所在页码,从1开始
|
Float |
getComponentPosX()
Get 参数控件X位置,单位px
|
Float |
getComponentPosY()
Get 参数控件Y位置,单位px
|
String |
getComponentRecipientId()
Get 控件关联的签署方id
|
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开始)
|
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 指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
|
Float |
getOffsetX()
Get 指定关键字时横坐标偏移量,单位pt
|
Float |
getOffsetY()
Get 指定关键字时纵坐标偏移量,单位pt
|
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=3时,通过"^"来决定是否使用关键字整词匹配能力。
例:
当GenerateMode=3时,如果传入关键字"^甲方签署^",则会在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
|
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 |
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 |
setOffsetX(Float OffsetX)
Set 指定关键字时横坐标偏移量,单位pt
|
void |
setOffsetY(Float OffsetY)
Set 指定关键字时纵坐标偏移量,单位pt
|
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.
|
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString
public Component()
public Component(Component source)
public String getComponentId()
public void setComponentId(String ComponentId)
ComponentId
- 控件编号
CreateFlowByTemplates发起合同时优先以ComponentId(不为空)填充;否则以ComponentName填充
注:
当GenerateMode=3时,通过"^"来决定是否使用关键字整词匹配能力。
例:
当GenerateMode=3时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
创建控件时,此值为空
查询时返回完整结构public String getComponentType()
public void setComponentType(String ComponentType)
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 - 企业法定代表人控件。
表单域的控件不能作为印章和签名控件public String getComponentName()
public void setComponentName(String ComponentName)
ComponentName
- 控件简称,不能超过30个字符public Boolean getComponentRequired()
public void setComponentRequired(Boolean ComponentRequired)
ComponentRequired
- 定义控件是否为必填项,默认为falsepublic String getComponentRecipientId()
public void setComponentRecipientId(String ComponentRecipientId)
ComponentRecipientId
- 控件关联的签署方idpublic Long getFileIndex()
public void setFileIndex(Long FileIndex)
FileIndex
- 控件所属文件的序号 (文档中文件的排列序号,从0开始)public String getGenerateMode()
public void setGenerateMode(String GenerateMode)
GenerateMode
- 控件生成的方式:
NORMAL - 普通控件
FIELD - 表单域
KEYWORD - 关键字public Float getComponentWidth()
public void setComponentWidth(Float ComponentWidth)
ComponentWidth
- 参数控件宽度,默认100,单位px
表单域和关键字转换控件不用填public Float getComponentHeight()
public void setComponentHeight(Float ComponentHeight)
ComponentHeight
- 参数控件高度,默认100,单位px
表单域和关键字转换控件不用填public Long getComponentPage()
public void setComponentPage(Long ComponentPage)
ComponentPage
- 参数控件所在页码,从1开始public Float getComponentPosX()
public void setComponentPosX(Float ComponentPosX)
ComponentPosX
- 参数控件X位置,单位pxpublic Float getComponentPosY()
public void setComponentPosY(Float ComponentPosY)
ComponentPosY
- 参数控件Y位置,单位pxpublic String getComponentExtra()
public void setComponentExtra(String ComponentExtra)
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 – 手写签名
BORDERLESS_ESIGN – 自动生成无边框腾讯体
OCR_ESIGN -- AI智能识别手写签名
ESIGN -- 个人印章类型
如:{“ComponentTypeLimit”: [“BORDERLESS_ESIGN”]}public String getComponentValue()
public void setComponentValue(String ComponentValue)
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/
地址控件:
同单行文本控件约束
省市区控件:
同单行文本控件约束
性别控件:
同单行文本控件约束,填写选择值中的字符串
学历控件:
同单行文本控件约束,填写选择值中的字符串public Long getComponentDateFontSize()
public void setComponentDateFontSize(Long ComponentDateFontSize)
ComponentDateFontSize
- 日期签署控件的字号,默认为 12
签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小public String getDocumentId()
public void setDocumentId(String DocumentId)
DocumentId
- 控件所属文档的Id, 模块相关接口为空值public String getComponentDescription()
public void setComponentDescription(String ComponentDescription)
ComponentDescription
- 控件描述,不能超过30个字符public Float getOffsetX()
public void setOffsetX(Float OffsetX)
OffsetX
- 指定关键字时横坐标偏移量,单位ptpublic Float getOffsetY()
public void setOffsetY(Float OffsetY)
OffsetY
- 指定关键字时纵坐标偏移量,单位ptpublic String getChannelComponentId()
public void setChannelComponentId(String ChannelComponentId)
ChannelComponentId
- 平台企业控件ID。
如果不为空,属于平台企业预设控件;public String getKeywordOrder()
public void setKeywordOrder(String KeywordOrder)
KeywordOrder
- 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。public Long getKeywordPage()
public void setKeywordPage(Long KeywordPage)
KeywordPage
- 指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来public String getRelativeLocation()
public void setRelativeLocation(String RelativeLocation)
RelativeLocation
- 关键字位置模式,Middle-居中,Below-正下方,Right-正右方,LowerRight-右上角,UpperRight-右下角。示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方public Long[] getKeywordIndexes()
public void setKeywordIndexes(Long[] KeywordIndexes)
KeywordIndexes
- 关键字索引,可选参数,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。示例[0,2],说明使用PDF文件内第1个和第3个关键字位置。Copyright © 2023. All rights reserved.