Foxit PDF SDK
fsdk.AuditSpaceSize Class Reference

Structure of audit space, the unit is byte type. More...

Public Member Functions

def GetAcroforms ()
 Get total size of AcroForm data in bytes. More...
 
def GetBookmarks ()
 Get total size of bookmarks data in bytes. More...
 
def GetColor_space ()
 Get total size of color space definitions in bytes. More...
 
def GetComments_and_3d_contents ()
 Get total size of comments and 3D contents in bytes. More...
 
def GetContent_streams ()
 Get total size of all page content streams in bytes. More...
 
def GetCross_ref_tables ()
 Get total size of the cross-reference table in bytes. More...
 
def GetEmbed_files ()
 Get total size of embedded file streams in bytes. More...
 
def GetExtend_graphics_states ()
 Get total size of extended graphics states in bytes. More...
 
def GetFonts ()
 Get total size of embedded fonts in bytes. More...
 
def GetImages ()
 Get total size of embedded images in bytes. More...
 
def GetLink_annots ()
 Get total size of link annotations in bytes. More...
 
def GetNamed_destnations ()
 Get total size of named destinations in bytes. More...
 
def GetPattern_infos ()
 Get total size of pattern objects in bytes. More...
 
def GetPiece_infos ()
 Get total size of piece information in bytes. More...
 
def GetShading_pattern_infos ()
 Get total size of shading pattern information in bytes. More...
 
def GetStructure_infos ()
 Get total size of structural information in bytes. More...
 
def GetThumbs ()
 Get total size of page thumbnails in bytes. More...
 
def GetWeb_infos ()
 Get total size of web-related metadata in bytes. More...
 
def GetX_object_forms ()
 Get total size of XObject Forms in bytes. More...
 
def SetAcroforms (value)
 Set total size of AcroForm data in bytes. More...
 
def SetBookmarks (value)
 Set total size of bookmarks data in bytes. More...
 
def SetColor_space (value)
 Set total size of color space definitions in bytes. More...
 
def SetComments_and_3d_contents (value)
 Set total size of comments and 3D contents in bytes. More...
 
def SetContent_streams (value)
 Set total size of all page content streams in bytes. More...
 
def SetCross_ref_tables (value)
 Set total size of the cross-reference table in bytes. More...
 
def SetEmbed_files (value)
 Set total size of embedded file streams in bytes. More...
 
def SetExtend_graphics_states (value)
 Set total size of extended graphics states in bytes. More...
 
def SetFonts (value)
 Set total size of embedded fonts in bytes. More...
 
def SetImages (value)
 Set total size of embedded images in bytes. More...
 
def SetLink_annots (value)
 Set total size of link annotations in bytes. More...
 
def SetNamed_destnations (value)
 Set total size of named destinations in bytes. More...
 
def SetPattern_infos (value)
 Set total size of pattern objects in bytes. More...
 
def SetPiece_infos (value)
 Set total size of piece information in bytes. More...
 
def SetShading_pattern_infos (value)
 Set total size of shading pattern information in bytes. More...
 
def SetStructure_infos (value)
 Set total size of structural information in bytes. More...
 
def SetThumbs (value)
 Set total size of page thumbnails in bytes. More...
 
def SetWeb_infos (value)
 Set total size of web-related metadata in bytes. More...
 
def SetX_object_forms (value)
 Set total size of XObject Forms in bytes. More...
 

Detailed Description

Structure of audit space, the unit is byte type.

Member Function Documentation

◆ GetAcroforms()

fsdk.AuditSpaceSize.GetAcroforms ( )

Get total size of AcroForm data in bytes.

AcroForms define interactive form fields in PDF documents.

Returns
Total size of AcroForm data in bytes.

◆ GetBookmarks()

fsdk.AuditSpaceSize.GetBookmarks ( )

Get total size of bookmarks data in bytes.

Bookmarks (or outlines) help navigate a PDF document's content hierarchy.

Returns
Total size of bookmarks data in bytes.

◆ GetColor_space()

fsdk.AuditSpaceSize.GetColor_space ( )

Get total size of color space definitions in bytes.

Includes all color space objects like ICC profiles, CalRGB, DeviceN, etc.

Returns
Total size of color space definitions in bytes.

◆ GetComments_and_3d_contents()

fsdk.AuditSpaceSize.GetComments_and_3d_contents ( )

Get total size of comments and 3D contents in bytes.

Includes PDF comments and embedded 3D object data, such as U3D or PRC models.

Returns
Total size of comments and 3D contents in bytes.

◆ GetContent_streams()

fsdk.AuditSpaceSize.GetContent_streams ( )

Get total size of all page content streams in bytes.

Content streams include the actual PDF instructions for rendering page content.

Returns
Total size of all page content streams in bytes.

◆ GetCross_ref_tables()

fsdk.AuditSpaceSize.GetCross_ref_tables ( )

Get total size of the cross-reference table in bytes.

The cross-reference table maps object numbers to byte offsets in the PDF file.

Returns
Total size of the cross-reference table in bytes.

◆ GetEmbed_files()

fsdk.AuditSpaceSize.GetEmbed_files ( )

Get total size of embedded file streams in bytes.

Embedded files include attachments such as spreadsheets, text files, or other documents.

Returns
Total size of embedded file streams in bytes.

◆ GetExtend_graphics_states()

fsdk.AuditSpaceSize.GetExtend_graphics_states ( )

Get total size of extended graphics states in bytes.

Extended graphics states control rendering properties like transparency, blend modes, and line styles.

Returns
Total size of extended graphics states in bytes.

◆ GetFonts()

fsdk.AuditSpaceSize.GetFonts ( )

Get total size of embedded fonts in bytes.

Includes both fully and partially embedded font programs.

Returns
Total size of embedded fonts in bytes.

◆ GetImages()

fsdk.AuditSpaceSize.GetImages ( )

Get total size of embedded images in bytes.

Includes all raster images used across the document.

Returns
Total size of embedded images in bytes.

◆ GetLink_annots()

fsdk.AuditSpaceSize.GetLink_annots ( )

Get total size of link annotations in bytes.

Includes all hyperlink and navigation annotations within the document.

Returns
Total size of link annotations in bytes.

◆ GetNamed_destnations()

fsdk.AuditSpaceSize.GetNamed_destnations ( )

Get total size of named destinations in bytes.

Named destinations are predefined navigation targets used by links and outlines.

Returns
Total size of named destinations in bytes.

◆ GetPattern_infos()

fsdk.AuditSpaceSize.GetPattern_infos ( )

Get total size of pattern objects in bytes.

Includes tiling and shading patterns used for fills and strokes.

Returns
Total size of pattern objects in bytes.

◆ GetPiece_infos()

fsdk.AuditSpaceSize.GetPiece_infos ( )

Get total size of piece information in bytes.

PieceInfo is used by some workflows to store private application data.

Returns
Total size of piece information in bytes.

◆ GetShading_pattern_infos()

fsdk.AuditSpaceSize.GetShading_pattern_infos ( )

Get total size of shading pattern information in bytes.

Covers all shading patterns used for gradient fills.

Returns
Total size of shading pattern information in bytes.

◆ GetStructure_infos()

fsdk.AuditSpaceSize.GetStructure_infos ( )

Get total size of structural information in bytes.

Structural information includes tagged PDF structures used for accessibility and reflow.

Returns
Total size of structural information in bytes.

◆ GetThumbs()

fsdk.AuditSpaceSize.GetThumbs ( )

Get total size of page thumbnails in bytes.

Thumbnails are small preview images associated with pages.

Returns
Total size of page thumbnails in bytes.

◆ GetWeb_infos()

fsdk.AuditSpaceSize.GetWeb_infos ( )

Get total size of web-related metadata in bytes.

Web info may include additional metadata used for web viewing or cataloging.

Returns
Total size of web-related metadata in bytes.

◆ GetX_object_forms()

fsdk.AuditSpaceSize.GetX_object_forms ( )

Get total size of XObject Forms in bytes.

XObject Forms are reusable content streams that can be drawn multiple times.

Returns
Total size of XObject Forms in bytes.

◆ SetAcroforms()

fsdk.AuditSpaceSize.SetAcroforms (   value)

Set total size of AcroForm data in bytes.

AcroForms define interactive form fields in PDF documents.

Parameters
[in]valueTotal size of AcroForm data in bytes.
Returns
None.

◆ SetBookmarks()

fsdk.AuditSpaceSize.SetBookmarks (   value)

Set total size of bookmarks data in bytes.

Bookmarks (or outlines) help navigate a PDF document's content hierarchy.

Parameters
[in]valueTotal size of bookmarks data in bytes.
Returns
None.

◆ SetColor_space()

fsdk.AuditSpaceSize.SetColor_space (   value)

Set total size of color space definitions in bytes.

Includes all color space objects like ICC profiles, CalRGB, DeviceN, etc.

Parameters
[in]valueTotal size of color space definitions in bytes.
Returns
None.

◆ SetComments_and_3d_contents()

fsdk.AuditSpaceSize.SetComments_and_3d_contents (   value)

Set total size of comments and 3D contents in bytes.

Includes PDF comments and embedded 3D object data, such as U3D or PRC models.

Parameters
[in]valueTotal size of comments and 3D contents in bytes.
Returns
None.

◆ SetContent_streams()

fsdk.AuditSpaceSize.SetContent_streams (   value)

Set total size of all page content streams in bytes.

Content streams include the actual PDF instructions for rendering page content.

Parameters
[in]valueTotal size of all page content streams in bytes.
Returns
None.

◆ SetCross_ref_tables()

fsdk.AuditSpaceSize.SetCross_ref_tables (   value)

Set total size of the cross-reference table in bytes.

The cross-reference table maps object numbers to byte offsets in the PDF file.

Parameters
[in]valueTotal size of the cross-reference table in bytes.
Returns
None.

◆ SetEmbed_files()

fsdk.AuditSpaceSize.SetEmbed_files (   value)

Set total size of embedded file streams in bytes.

Embedded files include attachments such as spreadsheets, text files, or other documents.

Parameters
[in]valueTotal size of embedded file streams in bytes.
Returns
None.

◆ SetExtend_graphics_states()

fsdk.AuditSpaceSize.SetExtend_graphics_states (   value)

Set total size of extended graphics states in bytes.

Extended graphics states control rendering properties like transparency, blend modes, and line styles.

Parameters
[in]valueTotal size of extended graphics states in bytes.
Returns
None.

◆ SetFonts()

fsdk.AuditSpaceSize.SetFonts (   value)

Set total size of embedded fonts in bytes.

Includes both fully and partially embedded font programs.

Parameters
[in]valueTotal size of embedded fonts in bytes.
Returns
None.

◆ SetImages()

fsdk.AuditSpaceSize.SetImages (   value)

Set total size of embedded images in bytes.

Includes all raster images used across the document.

Parameters
[in]valueTotal size of embedded images in bytes.
Returns
None.

◆ SetLink_annots()

fsdk.AuditSpaceSize.SetLink_annots (   value)

Set total size of link annotations in bytes.

Includes all hyperlink and navigation annotations within the document.

Parameters
[in]valueTotal size of link annotations in bytes.
Returns
None.

◆ SetNamed_destnations()

fsdk.AuditSpaceSize.SetNamed_destnations (   value)

Set total size of named destinations in bytes.

Named destinations are predefined navigation targets used by links and outlines.

Parameters
[in]valueTotal size of named destinations in bytes.
Returns
None.

◆ SetPattern_infos()

fsdk.AuditSpaceSize.SetPattern_infos (   value)

Set total size of pattern objects in bytes.

Includes tiling and shading patterns used for fills and strokes.

Parameters
[in]valueTotal size of pattern objects in bytes.
Returns
None.

◆ SetPiece_infos()

fsdk.AuditSpaceSize.SetPiece_infos (   value)

Set total size of piece information in bytes.

PieceInfo is used by some workflows to store private application data.

Parameters
[in]valueTotal size of piece information in bytes.
Returns
None.

◆ SetShading_pattern_infos()

fsdk.AuditSpaceSize.SetShading_pattern_infos (   value)

Set total size of shading pattern information in bytes.

Covers all shading patterns used for gradient fills.

Parameters
[in]valueTotal size of shading pattern information in bytes.
Returns
None.

◆ SetStructure_infos()

fsdk.AuditSpaceSize.SetStructure_infos (   value)

Set total size of structural information in bytes.

Structural information includes tagged PDF structures used for accessibility and reflow.

Parameters
[in]valueTotal size of structural information in bytes.
Returns
None.

◆ SetThumbs()

fsdk.AuditSpaceSize.SetThumbs (   value)

Set total size of page thumbnails in bytes.

Thumbnails are small preview images associated with pages.

Parameters
[in]valueTotal size of page thumbnails in bytes.
Returns
None.

◆ SetWeb_infos()

fsdk.AuditSpaceSize.SetWeb_infos (   value)

Set total size of web-related metadata in bytes.

Web info may include additional metadata used for web viewing or cataloging.

Parameters
[in]valueTotal size of web-related metadata in bytes.
Returns
None.

◆ SetX_object_forms()

fsdk.AuditSpaceSize.SetX_object_forms (   value)

Set total size of XObject Forms in bytes.

XObject Forms are reusable content streams that can be drawn multiple times.

Parameters
[in]valueTotal size of XObject Forms in bytes.
Returns
None.