Class: TencentCloud::Ess::V20201111::Component

Inherits:

Common::AbstractModel

Object
Common::AbstractModel
TencentCloud::Ess::V20201111::Component

show all

Defined in:: lib/v20201111/models.rb

Overview

在通过文件发起合同时，对应的component有三种定位方式

绝对定位方式（可以通过 PDF坐标计算助手计算控件的坐标）
表单域(FIELD)定位方式
关键字(KEYWORD)定位方式，使用关键字定位时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找

Instance Attribute Summary collapse

#ChannelComponentId ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#ChannelComponentSource ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#ComponentDateFontSize ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#ComponentExtra ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#ComponentHeight ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#ComponentId ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#ComponentName ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#ComponentPage ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#ComponentPosX ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#ComponentPosY ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#ComponentRecipientId ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#ComponentRequired ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#ComponentType ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#ComponentValue ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#ComponentWidth ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#FileIndex ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#ForbidMoveAndDelete ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#GenerateMode ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#IsFormType ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#KeywordIndexes ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#KeywordOrder ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#KeywordPage ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#LockComponentValue ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#OffsetX ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#OffsetY ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.
#RelativeLocation ⇒ Object
注意：关键字索引是从0开始计数的
- false（默认）：不锁定控件值，允许在页面编辑控件值
- true：锁定控件值，在页面无法编辑控件值
- false（默认） :可以移动和删除控件
- true : 禁止移动和删除控件
- 0 :平台指定；
- 1 :用户自定义
.

Instance Method Summary collapse

Constructor Details

#initialize(componenttype = nil, componentheight = nil, componentwidth = nil, componentpage = nil, componentposx = nil, componentposy = nil, fileindex = nil, generatemode = nil, componentid = nil, componentname = nil, componentrequired = nil, componentrecipientid = nil, componentextra = nil, isformtype = nil, componentvalue = nil, offsetx = nil, offsety = nil, keywordorder = nil, keywordpage = nil, relativelocation = nil, keywordindexes = nil, lockcomponentvalue = nil, forbidmoveanddelete = nil, componentdatefontsize = nil, channelcomponentid = nil, channelcomponentsource = nil) ⇒ `Component`

Returns a new instance of Component.

# File 'lib/v20201111/models.rb', line 1663

def initialize(componenttype=nil, componentheight=nil, componentwidth=nil, componentpage=nil, componentposx=nil, componentposy=nil, fileindex=nil, generatemode=nil, componentid=nil, componentname=nil, componentrequired=nil, componentrecipientid=nil, componentextra=nil, isformtype=nil, componentvalue=nil, offsetx=nil, offsety=nil, keywordorder=nil, keywordpage=nil, relativelocation=nil, keywordindexes=nil, lockcomponentvalue=nil, forbidmoveanddelete=nil, componentdatefontsize=nil, channelcomponentid=nil, channelcomponentsource=nil)
  @ComponentType = componenttype
  @ComponentHeight = componentheight
  @ComponentWidth = componentwidth
  @ComponentPage = componentpage
  @ComponentPosX = componentposx
  @ComponentPosY = componentposy
  @FileIndex = fileindex
  @GenerateMode = generatemode
  @ComponentId = componentid
  @ComponentName = componentname
  @ComponentRequired = componentrequired
  @ComponentRecipientId = componentrecipientid
  @ComponentExtra = componentextra
  @IsFormType = isformtype
  @ComponentValue = componentvalue
  @OffsetX = offsetx
  @OffsetY = offsety
  @KeywordOrder = keywordorder
  @KeywordPage = keywordpage
  @RelativeLocation = relativelocation
  @KeywordIndexes = keywordindexes
  @LockComponentValue = lockcomponentvalue
  @ForbidMoveAndDelete = forbidmoveanddelete
  @ComponentDateFontSize = componentdatefontsize
  @ChannelComponentId = channelcomponentid
  @ChannelComponentSource = channelcomponentsource
end

Instance Attribute Details

#ChannelComponentId ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def ChannelComponentId
  @ChannelComponentId
end

#ChannelComponentSource ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def ChannelComponentSource
  @ChannelComponentSource
end

#ComponentDateFontSize ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def ComponentDateFontSize
  @ComponentDateFontSize
end

#ComponentExtra ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def ComponentExtra
  @ComponentExtra
end

#ComponentHeight ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def ComponentHeight
  @ComponentHeight
end

#ComponentId ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def ComponentId
  @ComponentId
end

#ComponentName ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def ComponentName
  @ComponentName
end

#ComponentPage ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def ComponentPage
  @ComponentPage
end

#ComponentPosX ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def ComponentPosX
  @ComponentPosX
end

#ComponentPosY ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def ComponentPosY
  @ComponentPosY
end

#ComponentRecipientId ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def ComponentRecipientId
  @ComponentRecipientId
end

#ComponentRequired ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def ComponentRequired
  @ComponentRequired
end

#ComponentType ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def ComponentType
  @ComponentType
end

#ComponentValue ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def ComponentValue
  @ComponentValue
end

#ComponentWidth ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def ComponentWidth
  @ComponentWidth
end

#FileIndex ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def FileIndex
  @FileIndex
end

#ForbidMoveAndDelete ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def ForbidMoveAndDelete
  @ForbidMoveAndDelete
end

#GenerateMode ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def GenerateMode
  @GenerateMode
end

#IsFormType ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def IsFormType
  @IsFormType
end

#KeywordIndexes ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def KeywordIndexes
  @KeywordIndexes
end

#KeywordOrder ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def KeywordOrder
  @KeywordOrder
end

#KeywordPage ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def KeywordPage
  @KeywordPage
end

#LockComponentValue ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def LockComponentValue
  @LockComponentValue
end

#OffsetX ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def OffsetX
  @OffsetX
end

#OffsetY ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def OffsetY
  @OffsetY
end

#RelativeLocation ⇒ `Object`

注意：关键字索引是从0开始计数的

false（默认）：不锁定控件值，允许在页面编辑控件值
true：锁定控件值，在页面无法编辑控件值

false（默认） :可以移动和删除控件
true : 禁止移动和删除控件

0 :平台指定；
1 :用户自定义

Parameters:

LockComponentValue: —
web嵌入发起合同场景下，是否锁定填写和签署控件值不允许嵌入页面进行编辑
ForbidMoveAndDelete: —
web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件
ComponentDateFontSize: (font color="red">【暂未使用】日期签署控件的字号，默认为 12) —
omponentDateFontSize: 【暂未使用】日期签署控件的字号，默认为 12
ChannelComponentId: (font color="red">【暂未使用】第三方应用集成平台模板控件 ID 标识) —
hannelComponentId: 【暂未使用】第三方应用集成平台模板控件 ID 标识
ChannelComponentSource: (font color="red">【暂未使用】第三方应用集成中子客企业控件来源。) —
hannelComponentSource: 【暂未使用】第三方应用集成中子客企业控件来源。



1661
1662
1663

# File 'lib/v20201111/models.rb', line 1661

def RelativeLocation
  @RelativeLocation
end

Instance Method Details

#deserialize(params) ⇒ `Object`

# File 'lib/v20201111/models.rb', line 1692

def deserialize(params)
  @ComponentType = params['ComponentType']
  @ComponentHeight = params['ComponentHeight']
  @ComponentWidth = params['ComponentWidth']
  @ComponentPage = params['ComponentPage']
  @ComponentPosX = params['ComponentPosX']
  @ComponentPosY = params['ComponentPosY']
  @FileIndex = params['FileIndex']
  @GenerateMode = params['GenerateMode']
  @ComponentId = params['ComponentId']
  @ComponentName = params['ComponentName']
  @ComponentRequired = params['ComponentRequired']
  @ComponentRecipientId = params['ComponentRecipientId']
  @ComponentExtra = params['ComponentExtra']
  @IsFormType = params['IsFormType']
  @ComponentValue = params['ComponentValue']
  @OffsetX = params['OffsetX']
  @OffsetY = params['OffsetY']
  @KeywordOrder = params['KeywordOrder']
  @KeywordPage = params['KeywordPage']
  @RelativeLocation = params['RelativeLocation']
  @KeywordIndexes = params['KeywordIndexes']
  @LockComponentValue = params['LockComponentValue']
  @ForbidMoveAndDelete = params['ForbidMoveAndDelete']
  @ComponentDateFontSize = params['ComponentDateFontSize']
  @ChannelComponentId = params['ChannelComponentId']
  @ChannelComponentSource = params['ChannelComponentSource']
end

Class: TencentCloud::Ess::V20201111::Component

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

Instance Attribute Details

#ChannelComponentId ⇒ Object

#ChannelComponentSource ⇒ Object

#ComponentDateFontSize ⇒ Object

#ComponentExtra ⇒ Object

#ComponentHeight ⇒ Object

#ComponentId ⇒ Object

#ComponentName ⇒ Object

#ComponentPage ⇒ Object

#ComponentPosX ⇒ Object

#ComponentPosY ⇒ Object

#ComponentRecipientId ⇒ Object

#ComponentRequired ⇒ Object

#ComponentType ⇒ Object

#ComponentValue ⇒ Object

#ComponentWidth ⇒ Object

#FileIndex ⇒ Object

#ForbidMoveAndDelete ⇒ Object

#GenerateMode ⇒ Object

#IsFormType ⇒ Object

#KeywordIndexes ⇒ Object

#KeywordOrder ⇒ Object

#KeywordPage ⇒ Object

#LockComponentValue ⇒ Object

#OffsetX ⇒ Object

#OffsetY ⇒ Object

#RelativeLocation ⇒ Object

Instance Method Details

#deserialize(params) ⇒ Object

#ChannelComponentId ⇒ `Object`

#ChannelComponentSource ⇒ `Object`

#ComponentDateFontSize ⇒ `Object`

#ComponentExtra ⇒ `Object`

#ComponentHeight ⇒ `Object`

#ComponentId ⇒ `Object`

#ComponentName ⇒ `Object`

#ComponentPage ⇒ `Object`

#ComponentPosX ⇒ `Object`

#ComponentPosY ⇒ `Object`

#ComponentRecipientId ⇒ `Object`

#ComponentRequired ⇒ `Object`

#ComponentType ⇒ `Object`

#ComponentValue ⇒ `Object`

#ComponentWidth ⇒ `Object`

#FileIndex ⇒ `Object`

#ForbidMoveAndDelete ⇒ `Object`

#GenerateMode ⇒ `Object`

#IsFormType ⇒ `Object`

#KeywordIndexes ⇒ `Object`

#KeywordOrder ⇒ `Object`

#KeywordPage ⇒ `Object`

#LockComponentValue ⇒ `Object`

#OffsetX ⇒ `Object`

#OffsetY ⇒ `Object`

#RelativeLocation ⇒ `Object`

#deserialize(params) ⇒ `Object`