PrintFileBase class | QSYS API Reference Guide
Estimated reading time: 14 minutes
Base class for Database print files. Contains the print file setup information and some output operations.
Namespace: ASNA.QSys.Runtime Assembly: ASNA.QSys.Runtime.dll
Inheritance: Object
Constructors
| Name | Description |
|---|---|
| PrintFileBase(String, String, String, Boolean, Action) | Initializes a new instance of the PrintFileBase class. |
| PrintFileBase(String, String, String, Boolean) | Initializes a new instance of the PrintFileBase class. |
| PrintFileBase(String, String, ShareTypes, Boolean, Action) | Initializes a new instance of the PrintFileBase class. |
| PrintFileBase(String, String, ShareTypes, Boolean) | Initializes a new instance of the PrintFileBase class. |
PrintFileBase(String, String, String, Boolean, Action)
Initializes a new instance of the PrintFileBase class.
PrintFileBase(String, String, String, Boolean, Action)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | dclPrintFileName | Field name for this file in the program. |
| String | filePath | Path to the file in the Database, given as “library/filename”. |
| String | shareType | String value that selects the type of file sharing. |
| Boolean | isFormatID | True to check format ID. |
| Action | infSR | Method called when there is an error in a file operation. Pass null if there is no infSR. |
PrintFileBase(String, String, String, Boolean)
Initializes a new instance of the PrintFileBase class.
PrintFileBase(String, String, String, Boolean)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | dclPrintFileName | Field name for this file in the program. |
| String | filePath | Path to the file in the Database, given as “library/filename”. |
| String | shareType | String value that selects the type of file sharing. |
| Boolean | isFormatID | True to check format ID. |
PrintFileBase(String, String, ShareTypes, Boolean, Action)
Initializes a new instance of the PrintFileBase class.
PrintFileBase(String, String, ShareTypes, Boolean, Action)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | dclPrintFileName | Field name for this file in the program. |
| String | filePath | Path to the file in the Database, given as “library/filename”. |
| ShareTypes | shareType | ShareTypes value that selects the type of file sharing. |
| Boolean | isFormatID | True to check format ID. |
| Action | infSR | Method called when there is an error in a file operation. Pass null if there is no infSR. |
PrintFileBase(String, String, ShareTypes, Boolean)
Initializes a new instance of the PrintFileBase class.
PrintFileBase(String, String, ShareTypes, Boolean)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | dclPrintFileName | Field name for this file in the program. |
| String | filePath | Path to the file in the Database, given as “library/filename”. |
| ShareTypes | shareType | ShareTypes value that selects the type of file sharing. |
| Boolean | isFormatID | True to check format ID. |
Properties
| Type | Name | Description |
|---|---|---|
| Boolean | CheckFormatID | Gets or sets the value that specifies if the Format IDs of the file should be checked when the file is opened. |
| Boolean | Collate | Gets or sets whether collation will be used when printing multiple copies. This property is of type *Boolean. |
| Int32 | Copies | Gets or sets the number of copies to print. This property is of type *Integer4. |
| Int32 | CursorY | Gets the position, in Print Units, that the printer is from the top of the page. This property is of type *Integer4. |
| AdgDataSet | DataSet | Gets the AdgDataSet that moves data between the program and the database. |
| String | DclFileName | Gets the name of this file field in the program. |
| String | DclPrintFileName | Gets the name of this file field in the program. |
| Duplex | Duplex | Gets or sets whether the printer file is to print duplex (prints on both sides of the paper). This property is of type ASNA.DataGate.Common.PrintDuplex. |
| String | FilePath | A string that specifies the path of the file. |
| Int32 | FooterSize | Gets the size of the page footer. This property is of type *Integer4. |
| Dictionary<String, String> | formatIDs | When overriden in a derived class, gets the mapping from record format names to formatIDs. |
| String | FormName | Gets or sets the customized page size to use. |
| String | FormType | Gets or sets the type of forms used in the printer for printed output. |
| Boolean | InOverflow | Return whether the printer has entered the overflow area of the page. |
| Boolean | IsFormatID | Obsolete. Use CheckFormatID. |
| Boolean | IsOpen | Gets a value indicating whether the file is open. |
| RuntimeException | LastException | Gets the last exception thrown for this file. This is a protected public field of type ASNA.QSys.RuntimeException. |
| String | ManuscriptPath | Gets or sets the path and file name for the manuscript. |
| PaperOrientation | Orientation | Gets or sets the printer’s paper orientation (Horizontal or Vertical). This property is of type ASNA.DataGate.Common.PaperOrientation. |
| Int32 | PageCount | Gets the count of pages already printed. This property is of type *Integer4. |
| Int32 | PaperLength | Gets or sets the paper length. This property is of type *Integer4. |
| PaperKind | PaperSize | Gets or sets the paper size. This property is of type ASNA.DataGate.Common.PaperSize. |
| PaperSourceKind | PaperSource | Gets or sets the paper source. This property is of type ASNA.DataGate.Common.PaperSource. |
| Int32 | PaperWidth | Gets or sets the paper width. This property is of type *Integer4. |
| AccessMode | Preview | Gets or sets whether the print preview dialog is to be displayed before printing. This property is of type ASNA.DataGate.Common.AccessMode. |
| Int32 | PrintableLength | Gets the printer’s printable Length. This property is of type *Integer4. |
| Int32 | PrintableWidth | Gets the printer’s printable width. This property is of type *Integer4. |
| String | Printer | Gets or sets the name of the printer to be used. This property is of type *string. |
| Boolean | PrintSetup | Gets or sets whether the print setup dialog is to display before printing. This property is of type *Boolean. |
| String | PrintToFileName | Gets or sets the system file name, with path, where the report will be rendered.Setting the value to something other than *NOTHING will direct the printer to print to a file. This is particularly useful with the Microsoft Print To printers. |
| Boolean | ProcessMacro | Gets or sets the whether DataGate is to search for “macros” and replace them with appropriate information before printing. This property is of type *Boolean. |
| PrinterResolutionKind | Quality | Gets or sets the print quality. This property is of type ASNA.DataGate.Common.PrintQuality. |
| String | ReportName | Gets or sets the name of the report. If not assigned, the default name is the name given when the print file was declared. This property is of type *string. This is the name of the print file seen on the printer spool. |
| Boolean | SaveAfter | Gets or sets the value that specifies whether the manuscript is saved after output is produced |
| Int32 | Scale | Gets or sets the percentage factor by which the printed document is to be scaled. This property is of type *Integer4. |
| String | ShareType | A string defining how a file will be shared. |
| Int32 | StatusCode | Gets the status code resulting from a file operation. |
| PrintTrueType | TTOption | Gets or sets how true type fonts are to be printed. This property is of type ASNA.DataGate.Common.PrintTrueType. |
| Boolean | UseColor | Gets or sets whether to use color when a color printer is specified. This property is of type *Boolean. |
| String | UserData | Gets or sets a user defined string |
| Int32 | YResolution | Gets or sets the Y-Resolution in dot per inch. This property is of type *Integer4. |
Methods
| Signature | Description |
|---|---|
| allocateBuffer() | Allocates a DataSet Buffer. |
| close() | Close a file. |
| Close() | Close a file. |
| Dispose() | Releases resources. |
| Dispose(Boolean) | Releases resources. |
| feod(String, Boolean) | Force end of data on the given record. |
| Feod(String, Boolean) | Force end of data on the given record. |
| Finalize() | Releases resources when the instance is garbage-collected. |
| GetPrintFieldPropertyValue(String, String, String) | Get a field property value. |
| open(Database) | Open the print file. |
| Open(Database) | Open the print file. |
| populateBuffer(String) | Calls the delegate to populate buffer from fields. |
| SetPrintFieldPropertyValue(String, String, String, Object) | Set a field property value. |
| write(String, String) | Write a record. |
| write(String, Char[]) | Write a record given its record format name. |
| Write(String, String) | Write a record. |
| Write(String, Char[]) | Write a record given its record format name. |
AdgDataSet allocateBuffer()
Allocates a DataSet Buffer.
AdgDataSet allocateBuffer()
void close()
Close a file.
void close()
void Close()
Close a file.
void Close()
void Dispose()
Releases resources.
void Dispose()
void Dispose(bool isDisposing)
Releases resources.
void Dispose(bool isDisposing)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Boolean | isDisposing | True when this method is called during nomral execution, when resources are guarantedd to be available to release. False when called from the garbage collector. |
void feod(string formatName, bool reset)
Force end of data on the given record.
void feod(string formatName, bool reset)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Name of the record format. |
| Boolean | reset | True to reset the print attributes. |
void Feod(string formatName, bool reset)
Force end of data on the given record.
void Feod(string formatName, bool reset)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Name of the record format. |
| Boolean | reset | True to reset the print attributes. |
void Finalize()
Releases resources when the instance is garbage-collected.
void Finalize()
object GetPrintFieldPropertyValue(string formatName, string fieldName, string propertyName)
Get a field property value.
object GetPrintFieldPropertyValue(string formatName, string fieldName, string propertyName)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Name of the record format. |
| String | fieldName | Name of the field. |
| String | propertyName | Name of the property to get. |
Returns
| Type | Description |
|---|---|
| Object | The property value. Throws exception if file is not open. |
void open(Database database)
Open the print file.
void open(Database database)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Database | database | Database where the file is located. |
void Open(Database database)
Open the print file.
void Open(Database database)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Database | database | Database where the file is located. |
void populateBuffer(string formatName)
Calls the delegate to populate buffer from fields.
void populateBuffer(string formatName)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Input record format name. |
void SetPrintFieldPropertyValue(string formatName, string fieldName, string propertyName, object value)
Set a field property value.
void SetPrintFieldPropertyValue(string formatName, string fieldName, string propertyName, object value)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Name of the record format. |
| String | fieldName | Name of the field. |
| String | propertyName | Name of the property to set. |
| Object | value | Value to set on the property. |
void write(string formatName, string indDsString)
Write a record.
void write(string formatName, string indDsString)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Name of the record format to write. |
| String | indDsString | String of 100 character representing the indicator data structure. |
void write(string formatName, Char[] optionIndicators)
Write a record given its record format name.
void write(string formatName, Char[] optionIndicators)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Name of the record format to write. |
| Char[] | optionIndicators | Indicator array to use in the write operation. |
void Write(string formatName, string indDsString)
Write a record.
void Write(string formatName, string indDsString)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Name of the record format to write. |
| String | indDsString | String of 100 character representing the indicator data structure. |
void Write(string formatName, Char[] optionIndicators)
Write a record given its record format name.
void Write(string formatName, Char[] optionIndicators)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | Name of the record format to write. |
| Char[] | optionIndicators | Indicator array to use in the write operation. |