FaxImage Object
The FaxImage object contains a description of the fax
image, including image type, size, resolution, and font
attributes. The FaxImage object identifies the fax message
image and defines the actions that can be performed on the
image.
Properties
* - Read/write properties marked with an asterisk are
Read-Only when the image object is contained within a "Sent"
message.
Methods
|
Name |
Input Parameters |
Return Values |
|
Close |
(None) |
|
|
Copy |
NewFilename as String |
|
|
Open |
FileName as String |
|
|
Reset |
(None) |
|
Close Method
The Close method closes the FaxImage object.
Syntax
ObjImage.Close( )
Back to Top
ColorBits Property
The ColorBits property returns or sets the number of
color bits used in the image. Read/write*.
Syntax
ObjImage.ColorBits
Data Type
Long
Remarks
*The ColorBits property is Read-Only when the image
object is contained within a "sent" message. After the fax
message has been sent, any change to this property is
ignored.
Back to Top
Compression Property
The Compression property returns or sets the image
compression type. Read/write*.
Syntax
ObjImage.Compression
Data Type
Long
Remarks
Valid values for this property are defined by the
FaxMsg_ImgComp enumeration.
*The Compression property is Read-Only when the image
object is contained within a "sent" message. After the fax
message has been sent, any change to this property is
ignored.
Back to Top
Copy Method
The Copy method copies the FaxImage object to the
NewFileName parameter you supply.
Syntax
ObjImage.Copy(NewFileName)
Back to Top
EndPage Property
The EndPage property returns or sets the last image page
to be copied. Read/write.
Syntax
ObjImage.EndPage
Data Type
Long
Back to Top
FileName Property
The FileName property returns the name of the image file.
Read-only.
Syntax
ObjImage.FileName
Data Type
String
Back to Top
Font Property
The Font property returns or sets the name of the font
used in the image. Read/write*.
Syntax
ObjImage.Font
Data Type
String
Remarks
*The Font property is Read-Only when the image object is
contained within a "sent" message. After the fax message has
been sent, any change to this property is ignored.
Back to Top
Length Property
The Length property returns or sets the length of the
image in pixels. Read/write*.
Syntax
ObjImage.Length
Data Type
Long
Remarks
*The Length property is Read-Only when the image object
is contained within a "sent" message. After the fax message
has been sent, any change to this property is ignored.
Back to Top
Open Method
The Open method opens the FaxImage object.
Syntax
ObjImage.Open(FileName)
Back to Top
Options Property
The Options property returns or sets the image conversion
options. Read/write*.
Syntax
ObjImage.Options
Data Type
Long
Remarks
Valid values for this property are defined by the
FaxMsg_ImgOption enumeration.
*The Options property is Read-Only when the image object
is contained within a "sent" message. After the fax message
has been sent, any change to this property is ignored.
Back to Top
Pages Property
The Pages property returns the total number of pages in
the image. Read-only.
Syntax
ObjImage.Pages
Data Type
Long
Back to Top
PointSize Property
The PointSize property returns or sets the point size of
the image text to be copied. Read/write.
Syntax
ObjImage.PointSize
Data Type
Long
Back to Top
Reset Method
The Reset method reloads the FaxImage object from the fax
server and resets the original image properties.
Syntax
ObjImage.Reset ( )
Back to Top
ResolutionX Property
The ResolutionX property returns or sets the horizontal
resolution (pixels/inch) of the image. Read/write*.
Syntax
ObjImage.ResolutionX
Data Type
Long
Remarks
*The ResolutionX property is Read-Only when the image
object is contained within a "sent" message. After the fax
message has been sent, any change to this property is
ignored.
Back to Top
ResolutionY Property
The ResolutionY property returns or sets the vertical
resolution (pixels/inch) of the image. Read/write*.
Syntax
ObjImage.ResolutionY
Data Type
Long
Remarks
*The ResolutionY property is Read-Only when the image
object is contained within a "sent" message. After the fax
message has been sent, any change to this property is
ignored.
Back to Top
StartPage Property
The StartPage property returns or sets the first image
page to be copied. Read/write.
Syntax
ObjImage.StartPage
Data Type
Long
Back to Top
Type Property
The Type property returns or sets the file type of the
image object. Read/write*.
Syntax
ObjImage.Type
Data Type
Long
Remarks
*The Type property is Read-Only when the image object is
contained within a "sent" message. After the fax message has
been sent, any change to this property is ignored.
Back to Top
Width Property
The Width property returns or sets the width of the image
in pixels. Read/write*.
Syntax
ObjImage.Width
Data Type
Long
Remarks
*The Width property is Read-Only when the image object is
contained within a "sent" message. After the fax message has
been sent, any change to this property is ignored.
Back to Top
|
