Home » Developer Solutions » Interfaces » IPageFormat

IPageFormat

The interface is designed to provide access to the page format settings for formats from the list of formats supported by Universal Document Converter. Please, note that the page formats cannot be changed. The only option is to create new formats using the AddPageFormat method of Interface IUDC.

Properties

Float Height

Defines page height for a format out of the list of formats supported by Universal Document Converter. The unit of measure is defined by the Units property. Valid range is between 10 and 3,251 mm. For reading only.

Integer ID

Contains the system ID of a format from the list of formats supported by Universal Document Converter. For reading only.

Boolean IsCustom

Determines whether the current format was created using the AddPageFormat method or is a built-in Universal Document Converter format. For reading only.

Value	Description
FALSE	Built-in format
TRUE	Format created using AddPageFormat method

String Name

Contains the page format name of a format from the list of supported by Universal Document Converter. For reading only.

Enum Units

Defines the units of measure used for page width and height for a format out of the list of formats supported by Universal Document Converter. For reading only.

Constant	Value	Description
UNIT_IN	0	Inches
UNIT_MM	1	Millimeters
UNIT_PX	2	Pixels

Float Width

Defines page width for a format from the list of formats supported by Universal Document Converter. The unit of measure is defined by the Units property. For reading only.

Examples

Visual Basic 6

  Dim objUDC As IUDC
  Dim itfPageFormat As IPageFormat
  Dim sMsg As String

  Set objUDC = New UDC.APIWrapper
  Set itfPageFormat = objUDC.PageFormats("A4")
   
  sMsg = "Page format name is: " + itfPageFormat.Name 
  sMsg = sMsg & Chr(10) & Chr(13)
  sMsg = sMsg & "Page format ID = " & itfPageFormat.ID
  sMsg = sMsg & Chr(10) & Chr(13)

  If itfPageFormat.IsCustom Then
    sMsg = sMsg & itfPageFormat.Name + " format is created by user"
    sMsg = sMsg & Chr(10) & Chr(13)
  Else
    sMsg = sMsg & itfPageFormat.Name + " format is system"
    sMsg = sMsg & Chr(10) & Chr(13)
  End If
  
  Select Case itfPageFormat.Units
    Case UNIT_IN
      sMsg = sMsg & "Page Height = " & itfPageFormat.Height & " inches"
      sMsg = sMsg & Chr(10) & Chr(13)
      sMsg = sMsg & "Page Width = " & itfPageFormat.Width & " inches"
    Case UNIT_MM
      sMsg = sMsg & "Page Height = " & itfPageFormat.Height & " millimeters"
      sMsg = sMsg & Chr(10) & Chr(13)
      sMsg = sMsg & "Page Width = " & itfPageFormat.Width & " millimeters"
    Case UNIT_PX
      sMsg = sMsg & "Page Height = " & itfPageFormat.Height & " pixels"
      sMsg = sMsg & Chr(10) & Chr(13)
      sMsg = sMsg & "Page Width = " & itfPageFormat.Width & " pixels"
  End Select
 
  Call MsgBox (sMsg)