VPF Info Reader - Reference


Object: Data
Version 1.0
DLL: VPFInfo.dll
 
See also: Collection Object,Reader Object  
 
 

PROPERTIES
 
AdditionalKerning
    long AdditionalKerning
 
Author
    BSTR Author
 
BgColor
    long BgColor
 
CharString
    BSTR CharString
 
ContainsGrid
    VARIANT_BOOL ContainsGrid
 
Copyright
    BSTR Copyright
 
CreatedDate
    BSTR CreatedDate
 
Description
    BSTR Description
 
Email
    BSTR Email
 
FilePath
    BSTR FilePath
 
FileVersion
    BSTR FileVersion
 
FontHeight
    long FontHeight
 
FontID
    BSTR FontID
 
FontName
    BSTR FontName
 
GridLineHeight
    long GridLineHeight
 
GridLineWidth
    long GridLineWidth
 
HomePage
    BSTR HomePage
 
IgnoreCase
    VARIANT_BOOL IgnoreCase
 
ImagePath
    BSTR ImagePath
 
ModifiedDate
    BSTR ModifiedDate
 
Protected
    VARIANT_BOOL Protected
 
SpaceWidth
    long SpaceWidth
 
 
 
   
AdditionalKerning
 
Name AdditionalKerning
   
Description Returns the Additional Kerningvalue of the font
   
Type Property
   
Interface
long AdditionalKerning  
   
Parameters
None
   
Returning value Additional kerningvalue of the font
   
Example JScript:

var addkerning = dataobj.AdditionalKerning;

VBScript:

addkerning = dataobj.AdditionalKerning
 
goto top  
Author
 
Name Author
   
Description Returns the creator of the font
   
Type Property
   
Interface
BSTR Author  
   
Parameters
None
   
Returning value Creator of the font
   
Example JScript:

var createdBy = dataobj.Author;

VBScript:

createdBy = dataobj.Author
 
goto top  
BgColor
 
Name BgColor
   
Description Returns the BG-Color of the font
   
Type Property
   
Interface
long BgColor  
   
Parameters
None
   
Returning value BG-Color of the font
   
Example JScript:

var bgColor = dataobj.BgColor;

VBScript:

bgColor = dataobj.BgColor
 
goto top  
CharString
 
Name CharString
   
Description Returns a string, containing the characters of the font
   
Type Property
   
Interface
BSTR CharString  
   
Parameters
None
   
Returning value String of characters
   
Example JScript:

var characters = dataobj.CharString;

VBScript:

characters = dataobj.CharString
 
goto top  
ContainsGrid
 
Name ContainsGrid
   
Description Returns the status of the grid
   
Type Property
   
Interface
VARIANT_BOOL ContainsGrid  
   
Parameters
None
   
Returning value Gridflag status (true/false)
   
Example JScript:

var gridflag = dataobj.ContainsGrid

VBScript:

gridflag = dataobj.ContainsGrid
 
goto top  
Copyright
 
Name Copyright
   
Description Returns the Copyright © of the font
   
Type Property
   
Interface
BSTR Copyright  
   
Parameters
None
   
Returning value Copyright © of the font
   
Example JScript:

var copyright = dataobj.Copyright;

VBScript:

copyright = dataobj.Copyright
 
goto top  
CreatedDate
 
Name CreatedDate
   
Description Returns the font's date of creation
   
Type Property
   
Interface
BSTR CreatedDate  
   
Parameters
None
   
Returning value Created Date of the font
   
Example JScript:

var created = dataobj.CreatedDate;

VBScript:

created = dataobj.CreatedDate
 
goto top  
Description
 
Name Description
   
Description Returns the description of the font
   
Type Property
   
Interface
BSTR Description  
   
Parameters
None
   
Returning value Font's description (Ex. "My experimental font")
   
Example JScript:

var desc = dataobj.Description;

VBScript:

desc = dataobj.Description
 
goto top  
Email
 
Name Email
   
Description Returns the email associated with the font
   
Type Property
   
Interface
BSTR Email  
   
Parameters
None
   
Returning value Email associated with the font
   
Example JScript:

var email = dataobj.Email;

VBScript:

email = dataobj.Email
 
goto top  
FilePath
 
Name FilePath
   
Description Returns the path of the fontfile
   
Type Property
   
Interface
BSTR FilePath  
   
Parameters
None
   
Returning value Path to the .vpf file
   
Example JScript:

var filepath = dataobj.FilePath;

VBScript:

filepath = dataobj.FilePath
 
goto top  
FileVersion
 
Name FileVersion
   
Description Returns the Fileversion of the .vpf file
   
Type Property
   
Interface
BSTR FileVersion  
   
Parameters
None
   
Returning value Fileversion of the file
   
Example JScript:

var fileversion = dataobj.FileVersion;

VBScript:

fileversion = dataobj.FileVersion
 
goto top  
FontHeight
 
Name FontHeight
   
Description Returns the max height of the font
   
Type Property
   
Interface
long FontHeight  
   
Parameters
None
   
Returning value Height of the font
   
Example JScript:

var fHeight = dataobj.FontHeight

VBScript:

fHeight = dataobj.FontHeight
 
goto top  
FontID
 
Name FontID
   
Description Returns the unique ID of the font (GUID)
   
Type Property
   
Interface
BSTR FontID  
   
Parameters
None
   
Returning value The unique ID of the font   "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"
   
Example JScript:

var fontid = dataobj.FontID;

VBScript:

fontid = dataobj.FontID
 
goto top  
FontName
 
Name FontName
   
Description Returns the name of the font
   
Type Property
   
Interface
BSTR FontName  
   
Parameters
None
   
Returning value Font's name
   
Example JScript:

var fontname = dataobj.FontName

VBScript:

fontname = dataobj.FontName
 
goto top  
GridLineHeight
Note: Reserved for future versions of the VPF Heading Composer
Supported in the VPF file format v1.0
Name GridLineHeight
   
Description Returns the height of the gridline
   
Type Property
   
Interface
long GridLineHeight  
   
Parameters
None
   
Returning value Height of gridline in pixels
   
Example JScript:

var gridheight = dataobj.GridLineHeight

VBScript:

gridheight = dataobj.GridLineHeight
 
goto top  
GridLineWidth
 
Name GridLineWidth
   
Description Returns the width of the gridline
   
Type Property
   
Interface
long GridLineWidth  
   
Parameters
None
   
Returning value Width of gridline in pixels
   
Example JScript:

var gridwidth = dataobj.GridLineWidth

VBScript:

gridwidth = dataobj.GridLineWidth
 
goto top  
HomePage
 
Name HomePage
   
Description Returns the hompage associated with the font
   
Type Property
   
Interface
BSTR HomePage  
   
Parameters
None
   
Returning value Homepage assoiated with the font
   
Example JScript:

var homepage = dataobj.HomePage

VBScript:

homepage = dataobj.HomePage
 
goto top  
IgnoreCase
Note: Reserved for future versions of the VPF Heading Composer
Supported in the VPF file format v1.0
Name IgnoreCase
   
Description Returns the case sensitivity status
   
Type Property
   
Interface
VARIANT_BOOL IgnoreCase  
   
Parameters
None
   
Returning value Case sensitivity (true/false)
   
Example JScript:

var ignorecase = dataobj.IgnoreCase

VBScript:

ignorecase = dataobj.IgnoreCase
 
goto top  
ImagePath
 
Name ImagePath
   
Description Returns the path to the image used by the font
   
Type Property
   
Interface
BSTR ImagePath  
   
Parameters
None
   
Returning value Path to image used by the font
   
Example JScript:

var imagepath = dataobj.ImagePath

VBScript:

imagepath = dataobj.ImagePath
 
goto top  
ModifiedDate
 
Name ModifiedDate
   
Description Returns the date when the font was last modified
   
Type Property
   
Interface
BSTR ModifiedDate  
   
Parameters
None
   
Returning value Last modified date of the font
   
Example JScript:

var modified = dataobj.ModifiedDate

VBScript:

modified = dataobj.ModifiedDate
 
goto top  
Protected
Note: Reserved for future versions of the VPF Heading Composer
Supported in the VPF file format v1.0
Name Protected
   
Description Returns the status of the font's protected flag
   
Type Property
   
Interface
VARIANT_BOOL Protected  
   
Parameters
None
   
Returning value Status of protected flag (true/false)
   
Example JScript:

var protected = dataobj.Protected

VBScript:

protected = dataobj.Protected
 
goto top  
SpaceWidth
 
Name SpaceWidth
   
Description Returns the space width in pixels
   
Type Property
   
Interface
long SpaceWidth  
   
Parameters
None
   
Returning value Space width in pixels
   
Example JScript:

var spWidth = dataobj.SpaceWidth

VBScript:

spWidth = dataobj.SpaceWidth
 
goto top