Foxit PDF SDK
Public 类型 | Public 成员函数 | 所有成员列表
foxit::ofd::Attachments类 参考
类 foxit::ofd::Attachments 继承关系图:
foxit::Base

Public 类型

enum  ElectronicBillsType {
  e_ElectronicUnknown = 0, e_ElectronicRAIIssuer = 1, e_ElectronicRAIReceiver = 2, e_ElectronicInvoiceOrdIssuer = 3,
  e_ElectronicInvoiceOrdReceiver = 4, e_ElectronicInvoiceSpclIssuer = 5, e_ElectronicInvoiceSpclReceiver = 6, e_ElectronicBkerIssuer = 7,
  e_ElectronicBkerReceiver = 8, e_ElectronicBkrs = 9, e_ElectronicEinvOrd = 10, e_ElectronicEinvSpcl = 11,
  e_ElectronicATRIssuer = 12, e_ElectronicATRReceiver = 13, e_ElectronicNTREVIssuer = 14, e_ElectronicNTREVReceiver = 15,
  e_ElectronicEFI = 16
}
 OFD电子凭证定义枚举类型。 更多...
 

Public 成员函数

 Attachments (const Attachments &other)
 构造函数，通过另一个附件集合对象。 更多...
 
 ~Attachments ()
 析构函数。
 
Attachment AddAttachment ()
 添加一个新的附件对象。 更多...
 
AttachmentDirectory CreateAttachmentDirectory ()
 创建附件目录对象。 更多...
 
bool ExportElectronicBillsFile (int index, const String &file_path)
 导出指定索引的电子凭证文件到指定路径。 更多...
 
bool ExportElectronicBillsFile (int index, const WString &file_path)
 导出指定索引的电子凭证文件到指定路径。 更多...
 
Attachment GetAttachment (int index)
 获取指定索引的附件对象。 更多...
 
Attachment GetAttachmentByID (foxit::uint32 id)
 通过ID获取附件对象。 更多...
 
int GetAttachmentCount ()
 获取附件的数量。 更多...
 
AttachmentDirectory GetAttachmentDirectory ()
 获取附件目录对象。 更多...
 
Attachment GetAttachmentDirectoryExtAttribute (int index)
 获取指定索引的附件目录扩展属性。 更多...
 
int GetAttachmentDirectoryExtAttributeCount ()
 获取附件目录扩展属性数量。 更多...
 
String GetAttachmentDirectoryExtInfoFile ()
 获取附件目录扩展信息，格式为xml。 更多...
 
bool GetAttachmentDirectoryExtInfoFile (const String &file_path)
 导出附件目录扩展信息到文件，格式为xml。 更多...
 
bool GetAttachmentDirectoryExtInfoFile (const WString &file_path)
 导出附件目录扩展信息到文件，格式为xml。 更多...
 
int GetElectronicBillsCount ()
 获取电子凭证的数量。 更多...
 
ElectronicBillsType GetElectronicBillsType (int index)
 获取指定索引的电子凭证类型。 更多...
 
bool IsEmpty () const
 检查当前对象是否为空。 更多...
 
bool operator != (const Attachments &other) const
 不相等操作符。 更多...
 
Attachments & operator= (const Attachments &other)
 赋值操作符。 更多...
 
bool operator== (const Attachments &other) const
 相等操作符。 更多...
 
bool RemoveAllAttachments ()
 删除所有附件对象。 更多...
 
bool RemoveAttachment (int index)
 删除指定索引的附件对象。 更多...
 
bool SetAttachmentDirectoryExtInfoFile (const String &file_path)
 通过文件设置附件目录扩展信息，格式为xml。 更多...
 
bool SetAttachmentDirectoryExtInfoFile (const WString &file_path)
 通过文件设置附件目录扩展信息，格式为xml。 更多...
 
- Public 成员函数 继承自 foxit::Base
FS_HANDLE Handle () const
 获取当前对象的句柄。 更多...
 

详细描述

此类表示和OFD附件集合相关的操作。

成员枚举类型说明

◆ ElectronicBillsType

enum foxit::ofd::Attachments::ElectronicBillsType

OFD电子凭证定义枚举类型。

该枚举值应单独使用。

枚举值
e_ElectronicUnknown 

电子凭证类型：未知。

e_ElectronicRAIIssuer 

电子凭证类型：铁路电子客票开具方。

e_ElectronicRAIReceiver 

电子凭证类型：铁路电子客票接收方。

e_ElectronicInvoiceOrdIssuer 

电子凭证类型：增值税电子普通发票开具方。

e_ElectronicInvoiceOrdReceiver 

电子凭证类型：增值税电子普通发票接收方 。

e_ElectronicInvoiceSpclIssuer 

电子凭证类型：增值税电子专用发票开具方。

e_ElectronicInvoiceSpclReceiver 

电子凭证类型：增值税电子专用发票接收方。

e_ElectronicBkerIssuer 

电子凭证类型：银行电子回单开具方。

e_ElectronicBkerReceiver 

电子凭证类型：银行电子回单接收方。

e_ElectronicBkrs 

电子凭证类型：银行电子对账单。

e_ElectronicEinvOrd 

电子凭证类型：数电票普通发票。

e_ElectronicEinvSpcl 

电子凭证类型：数电票专用发票。

e_ElectronicATRIssuer 

电子凭证类型：电子客票行程单开具方。

e_ElectronicATRReceiver 

电子凭证类型：电子客票行程单接收方。

e_ElectronicNTREVIssuer 

电子凭证类型：电子非税收入一般缴款书开具方。

e_ElectronicNTREVReceiver 

电子凭证类型：电子非税收入一般缴款书接收方。

e_ElectronicEFI 

电子凭证类型：财政电子票据。

构造及析构函数说明

◆ Attachments()

foxit::ofd::Attachments::Attachments ( const Attachments &  other)

构造函数，通过另一个附件集合对象。

参数
[in]other另一个附件集合对象。

成员函数说明

◆ AddAttachment()

Attachment foxit::ofd::Attachments::AddAttachment ( )

添加一个新的附件对象。

返回
新的附件对象。

◆ CreateAttachmentDirectory()

AttachmentDirectory foxit::ofd::Attachments::CreateAttachmentDirectory ( )

创建附件目录对象。

返回
附件目录对象。

◆ ExportElectronicBillsFile() [1/2]

bool foxit::ofd::Attachments::ExportElectronicBillsFile ( int  index,
const String &  file_path 
)

导出指定索引的电子凭证文件到指定路径。

参数
[in]index指定的索引。有效范围：从0到(count - 1)。 count由函数 foxit::ofd::Attachments::GetElectronicBillsCount 返回。
[in]file_path指定的文件路径。
返回
true 表示成功，false 表示失败。

◆ ExportElectronicBillsFile() [2/2]

bool foxit::ofd::Attachments::ExportElectronicBillsFile ( int  index,
const WString &  file_path 
)

导出指定索引的电子凭证文件到指定路径。

参数
[in]index指定的索引。有效范围：从0到(count - 1)。 count由函数 foxit::ofd::Attachments::GetElectronicBillsCount 返回。
[in]file_path指定的文件路径。
返回
true 表示成功，false 表示失败。

◆ GetAttachment()

Attachment foxit::ofd::Attachments::GetAttachment ( int  index)

获取指定索引的附件对象。

参数
[in]index指定的索引。有效范围：从0到(count - 1)。 count由函数 foxit::ofd::Attachments::GetAttachmentCount 返回。
返回
指定索引的附件对象。

◆ GetAttachmentByID()

Attachment foxit::ofd::Attachments::GetAttachmentByID ( foxit::uint32  id)

通过ID获取附件对象。

参数
[in]index指定的ID。
返回
指定ID的附件对象。

◆ GetAttachmentCount()

int foxit::ofd::Attachments::GetAttachmentCount ( )

获取附件的数量。

返回
附件的数量。

◆ GetAttachmentDirectory()

AttachmentDirectory foxit::ofd::Attachments::GetAttachmentDirectory ( )

获取附件目录对象。

返回
附件目录对象。

◆ GetAttachmentDirectoryExtAttribute()

Attachment foxit::ofd::Attachments::GetAttachmentDirectoryExtAttribute ( int  index)

获取指定索引的附件目录扩展属性。

参数
[in]index指定的索引。有效范围：从0到(count - 1)。 count由函数 foxit::ofd::Attachments::GetAttachmentDirectoryExtAttributeCount 返回。
返回
指定索引的附件目录扩展属性对象。

◆ GetAttachmentDirectoryExtAttributeCount()

int foxit::ofd::Attachments::GetAttachmentDirectoryExtAttributeCount ( )

获取附件目录扩展属性数量。

返回
附件目录扩展属性数量。

◆ GetAttachmentDirectoryExtInfoFile() [1/3]

String foxit::ofd::Attachments::GetAttachmentDirectoryExtInfoFile ( )

获取附件目录扩展信息，格式为xml。

返回
附件目录扩展信息文件信息。

◆ GetAttachmentDirectoryExtInfoFile() [2/3]

bool foxit::ofd::Attachments::GetAttachmentDirectoryExtInfoFile ( const String &  file_path)

导出附件目录扩展信息到文件，格式为xml。

参数
[in]file_path指定的文件路径。
返回
true 表示成功，false 表示失败。

◆ GetAttachmentDirectoryExtInfoFile() [3/3]

bool foxit::ofd::Attachments::GetAttachmentDirectoryExtInfoFile ( const WString &  file_path)

导出附件目录扩展信息到文件，格式为xml。

参数
[in]file_path指定的文件路径。
返回
true 表示成功，false 表示失败。

◆ GetElectronicBillsCount()

int foxit::ofd::Attachments::GetElectronicBillsCount ( )

获取电子凭证的数量。

返回
电子凭证的数量。

◆ GetElectronicBillsType()

ElectronicBillsType foxit::ofd::Attachments::GetElectronicBillsType ( int  index)

获取指定索引的电子凭证类型。

参数
[in]index指定的索引。有效范围：从0到(count - 1)。 count由函数 foxit::ofd::Attachments::GetElectronicBillsCount 返回。
返回
指定索引的电子凭证类型。

◆ IsEmpty()

bool foxit::ofd::Attachments::IsEmpty ( ) const

检查当前对象是否为空。

当前对象为空时，表示当前对象是无用的。

返回
true 表示当前对象为空，false 表示不为空。

◆ operator !=()

bool foxit::ofd::Attachments::operator != ( const Attachments &  other) const

不相等操作符。

参数
[in]other另一个附件集合对象。此函数将检查当前对象是否不等于这个对象。
返回
true 表示不相等，false 表示相等。

◆ operator=()

Attachments& foxit::ofd::Attachments::operator= ( const Attachments &  other)

赋值操作符。

参数
[in]other另一个附件集合对象，其值将被赋给当前对象。
返回
当前对象自身的引用。

◆ operator==()

bool foxit::ofd::Attachments::operator== ( const Attachments &  other) const

相等操作符。

参数
[in]other另一个附件集合对象。此函数将检查当前对象是否等于这个对象。
返回
true 表示相等，false 表示不相等。

◆ RemoveAllAttachments()

bool foxit::ofd::Attachments::RemoveAllAttachments ( )

删除所有附件对象。

返回
true 表示成功，false 表示失败。

◆ RemoveAttachment()

bool foxit::ofd::Attachments::RemoveAttachment ( int  index)

删除指定索引的附件对象。

参数
[in]index指定的索引。有效范围：从0到(count - 1)。 count由函数 foxit::ofd::Attachments::GetAttachmentCount 返回。
返回
true 表示成功，false 表示失败。

◆ SetAttachmentDirectoryExtInfoFile() [1/2]

bool foxit::ofd::Attachments::SetAttachmentDirectoryExtInfoFile ( const String &  file_path)

通过文件设置附件目录扩展信息，格式为xml。

参数
[in]file_path指定的文件路径。
返回
true 表示成功，false 表示失败。

◆ SetAttachmentDirectoryExtInfoFile() [2/2]

bool foxit::ofd::Attachments::SetAttachmentDirectoryExtInfoFile ( const WString &  file_path)

通过文件设置附件目录扩展信息，格式为xml。

参数
[in]file_path指定的文件路径。
返回
true 表示成功，false 表示失败。