FSDK::SchemaField类 参考

Public 成员函数
	constructor ()
	构造函数。
	GetDisplayName ()
	获取显示名称。 更多...
	GetKeyName ()
	获取键名字符串。 更多...
	GetSubtypeName ()
	获取子类型名称字符串。 更多...
	IsEmpty ()
	检查当前对象是否为空。 更多...
	IsVisible ()
	检查当前字段在应用程序中是否初始可见。 更多...
	SetDisplayName (display_name)
	设置显示名称。 更多...
	SetKeyName (key_name)
	设置键名字符串。 更多...
	SetSubtypeName (subtype_name)
	设置子类型名称字符串。 更多...
	SetVisibility (is_visible)
	设置当前字段在应用程序中的初始可见性。 更多...

详细描述

架构字段可用于决定节点的哪些信息在应用程序中显示或隐藏。

成员函数说明

GetDisplayName()

FSDK::SchemaField::GetDisplayName

(

)

获取显示名称。

显示名称用于显示。可以不同于架构字段的键名。

返回

显示名称字符串。

GetKeyName()

FSDK::SchemaField::GetKeyName

(

)

获取键名字符串。

每个架构字段都由唯一的键名存储。 架构字段的键名可用于:

• 在类 FSDK.Portfolio 中作为排序的字段名。
• 当架构字段的子类型表示数据类型时,作为文件或文件夹节点字典中条目的键名。

返回

键名字符串。

GetSubtypeName()

FSDK::SchemaField::GetSubtypeName

(

)

获取子类型名称字符串。

子类型名称可用于直接指定文件节点和文件夹节点的某些属性:

• "F",表示嵌入文件的文件名或文件夹节点的名称。
• "Desc",表示嵌入文件的描述或文件夹节点的描述。
• "ModDate",表示嵌入文件的修改日期或文件夹节点的修改日期。
• "CreationDate",表示嵌入文件的创建日期或文件夹节点的创建日期。
• "Size",表示嵌入文件的未压缩大小;文件夹节点没有大小。
• "CompressedSize",表示嵌入文件的压缩大小;文件夹节点没有压缩大小。

对于其他情况,子类型名称用于指定文件或文件夹节点字典中指定条目的数据类型。 条目的键由当前架构字段的键名指定,数据类型由以下内容指定:

• "S",表示字段数据应存储为 PDF 文本字符串。
• "D",表示字段数据应存储为 PDF 日期字符串。
• "N",表示字段数据应存储为 PDF 数字。

返回

子类型名称字符串。

IsEmpty()

FSDK::SchemaField::IsEmpty

(

)

检查当前对象是否为空。

当当前对象为空时,这意味着当前对象无用。

返回

true 表示当前对象为空,而 false 表示不为空。

IsVisible()

FSDK::SchemaField::IsVisible

(

)

检查当前字段在应用程序中是否初始可见。

返回

true 表示当前字段在应用程序中初始可见, 而 false 表示当前字段在应用程序中初始不可见。

SetDisplayName()

FSDK::SchemaField::SetDisplayName

(

display_name

)

设置显示名称。

显示名称用于显示。可以不同于架构字段的键名。

参数

[in]

display_name

显示名称字符串。不应为空字符串。

返回

无。

SetKeyName()

FSDK::SchemaField::SetKeyName

(

key_name

)

设置键名字符串。

每个架构字段都由唯一的键名存储。 架构字段的键名可用于:

• 在类 FSDK.Portfolio 中作为排序的字段名。
• 当架构字段的子类型表示数据类型时,作为文件或文件夹节点字典中条目的键名。

参数

[in]

key_name

新键名字符串。不应为空字符串。

返回

无。

SetSubtypeName()

FSDK::SchemaField::SetSubtypeName

(

subtype_name

)

设置子类型名称字符串。

子类型名称可用于直接指定文件节点和文件夹节点的某些属性:

• "F",表示嵌入文件的文件名或文件夹节点的名称。
• "Desc",表示嵌入文件的描述或文件夹节点的描述。
• "ModDate",表示嵌入文件的修改日期或文件夹节点的修改日期。
• "CreationDate",表示嵌入文件的创建日期或文件夹节点的创建日期。
• "Size",表示嵌入文件的未压缩大小;文件夹节点没有大小。
• "CompressedSize",表示嵌入文件的压缩大小;文件夹节点没有压缩大小。

对于其他情况,子类型名称用于指定文件或文件夹节点字典中指定条目的数据类型。 条目的键由当前架构字段的键名指定,数据类型由以下内容指定:

• "S",表示字段数据应存储为 PDF 文本字符串。
• "D",表示字段数据应存储为 PDF 日期字符串。
• "N",表示字段数据应存储为 PDF 数字。

参数

[in]

subtype_name

子类型名称字符串。不应为空字符串。 请参阅"详细信息"部分以获取更多信息。

返回

无。

SetVisibility()

FSDK::SchemaField::SetVisibility

(

is_visible

)

设置当前字段在应用程序中的初始可见性。

参数

[in]

is_visible

true 表示当前字段在应用程序中初始可见, 而 false 表示当前字段在应用程序中初始不可见。

返回

无。