DataGate Print File Designer® - Build 8.0.355 and above

ASNA.DataGate Controls Properties

This document contains a list of all the public properties in Print File Designer.  These properties only apply to those controls shown in the "Applies To" column.

These public properties may refer to the following control objects: PrintFile, Format, AutoField, CharField, DateTimeField, DecField, Label, Line, or Shape.

Public Properties

Property
 Description
 Class
Applies To

public propertyAccessibleDescriptiom

Not Applicable.

public propertyAccessibleName

Not Applicable.

public propertyAccessibleRole

Not Applicable.

public propertyAlignment
(inherited from BaseField)

Gets or sets one of the Alignment enumeration values indicating whether to align data in the control to the left, right, or center.  The default is Left.

AutoField, CharField, DateTimeField, DecField, Label

public propertyAllowDrop

Not Applicable.

public propertyAnchor
(inherited from Control)

Gets or sets which edges of the control are anchored to the edges of its container.

AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

public propertyBackColor
(inherited from Control)

Gets or sets the background color for the control.

Format, AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

public propertyBackgroundImage
(inherited from Control)

Gets or sets the background image displayed in the control.

Format, AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

public propertyBold
(Inherited from BaseField)

Gets or sets a Boolean value specifying whether the field output is to be bolded. The default is False.

AutoField, CharField, DateTimeField, DecField, Label

public propertyBorderColor

Gets or sets the System.Drawing.Color enumeration value for the color of the border.  Black is the default.

Shape

public propertyBorderLineStyle

Gets or sets the LineStyles enumeration value for the line style of the border of a shape.   The default is Solid.

Shape

BorderUnit

Gets or sets the ASNA.DataGate.PrintControls.Units enumeration value for the unit of measurement for the width of the border.  The default is Millimeters.

Shape

BorderWidth

Gets or sets the width of the border using the unit of measurement specified in BorderUnit.  The default is .01.

Shape

public propertyCausesValidation

Not Applicable.

CheckFormatLevels

Gets or sets the boolean value indicating whether the print file format ID's at run-time are to be compared to the format ID's of the print file at compile-time.

PrintFile

Collate

Gets or sets a boolean value indicating if collation of multiple copies will be performed. The default is False.

PrintFile

ComputerName

Gets or sets the name of the local computer.

AutoField

public propertyContextMenu

Not Applicable.

public propertyCopies

Gets or sets an integer value indicating the number of copies to print.

PrintFile

public propertyCurrentShape

Gets or sets the Shapes enumeration value to define the shape.

Shape

public propertyCursor

Not Applicable.

DataBindings

Not Applicable.

public propertyDecimals

Gets or sets the number of decimal positions in the field control. The default is 0.

DecField

public propertyDigits

Gets or sets the total number of digits in the field control. The default is 0.

DecField

public propertyDock
(inherited from Control)

Gets or sets which edge of the parent container a control is docked to.

AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

DrawGrid

Gets or sets a value indicating whether a grid should be drawn on the control for this designer.

PrintFile

Duplex

Gets or sets the  System.Drawing.Printing.Duplex enumeration value for the duplex print setting. The default is Default.

PrintFile

public propertyEditCode

Gets or sets the value providing the punctuation for a numeric field control.  The default is None.  See the Edit Code Table.

DecField

public propertyEditWord

Gets or sets the value containing punctuation for a numeric field control according to the standard RPG rules for edit words.  See the Edit Word Table.

DecField

public propertyEnabled
(inherited from Control)

Gets or sets a value indicating whether the control can respond to user interaction.

AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

public propertyEndPage

Gets or sets the value indicating whether a new page is started after this format is written to the printer.  The default is False.

Format

public propertyFieldBottom

The distance, in inches or millimeters, from the top of the format to the bottom of the control.

AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

public propertyFieldFormat

Gets or sets the DateTimeFormat enumeration value describing the source field format for the field. The default is ISO.

DateTimeField

public propertyFieldLeft

The distance, in inches or millimeters, from the left of the format to the left of the control.

AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

public propertyFieldRight

The distance, in inches or millimeters, from the left of the format to the right of the control.

AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

public propertyFieldTop

The distance, in inches or millimeters, from the top of the format to the top of the control.

AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

public propertyFieldType

DecField: Gets or sets the FieldTypes enumeration value for the type of the numeric data in the control.  The default is BinaryField.

DateTimeField: Gets or sets the DateTimeType enumeration value describing the type of date field.  The default is DateField.

DecField, DateTimeField

FileText

Gets or sets the text for the file.

PrintFile

public propertyFillColor

Gets or sets the System.Drawing.Color enumeration value for the color used to fill the shape.  The default is Transparent.

Shape

public propertyFillStyle

Gets or sets the FillStyles enumeration value for the pattern used to fill the shape.  The default is Solid.

Shape

public propertyFont
(inherited from Control)

Gets or sets the font of the text displayed by the control.

PrintFile, Format, AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

public propertyForecolor
(inherited from Control)

Gets or sets the foreground color of the control.

PrintFile, Format, AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

public propertyFormatHeight

Gets or sets the height of the format control in print file units, inches or millimeters.

Format

GridSize

Gets or sets the size of each square of the grid that is drawn when the designer is in grid draw mode.

PrintFile

public propertyImeMode

Not Applicable.

Language

 

PrintFile

LeftMargin

Gets or sets an integer value indicating the width of the nonprintable area on the left side of the page, in inches or millimeters.  The printer's default left margin is the default value.

PrintFile

public propertyLength

Gets or sets the number of characters in the field.

CharField

public propertyLineCap

Gets or sets the LineCaps enumeration value for the graphic shape to use on the end of a line.  Round is the default.

Line

public propertyLineColor

Gets or sets the System.Drawing.Color enumeration value for the color of a line.  Black is the default.

Line

public propertyLineStyle

Gets or sets the LineStyles enumeration value for the style of the line.  Solid is the default.

Line

Localizable

Determines if localizable code will be generated for this object.  The default is False.

PrintFile

public propertyLocation
(inherited from Control)

Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.

AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

Locked

Not Applicable.

public propertyModifiers

Not Applicable.

public property Name
(inherited from Control)

Gets or sets the name of the control.

Format, AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

Orientation

PrintFile: Gets or sets the ASNA.DataGate.Common.PaperOrientation enumeration value indicating the orientation of the paper.
Line: Gets or sets the Orientations enumeration value representing the orientation of a line.

PrintFile, Line

OutFormat

Gets or sets the format for the printed field.

AutoField, DateTimeField

Overflow

Gets or sets an integer value indicating the length of the overflow area.

PrintFile

PaperLength

Gets or sets an integer value indicating the length of the paper.  The default is 11.

PrintFile

PageNumber

Gets or sets the page number of the page currently being printed.

AutoField

PaperSize

Gets or sets the System.Drawing.Printing.PaperKind enumeration value indicating the type (size) of the paper.  The default is Letter.

PrintFile

PageTotal

Gets or sets the total number of pages to be printed for the print file.

AutoField

PaperWidth

Gets or sets an integer value indicating the width of the paper, in inches or millimeters, based upon the PaperSize and Orientation properties.  The default is 8.5.

PrintFile

PaperSource

Gets or sets the System.Drawing.Printing.PaperSourceKind enumeration value indicating the paper tray to use as the source of the paper.

PrintFile

PenUnit

Gets or sets the ASNA.DataGate.PrintControls.Units enumeration value to define the unit of measurement for the PenWidth.  Millimeters is the default.

Line

PenWidth

Gets or sets the width of the pen using the unit of measurement specified in PenUnit.  .01 is the default.

Line

PrintableLength

Gets or sets an integer value indicating the length of the printable area, in inches or millimeters, based upon the page Orientation and Units property.

PrintFile

public propertyPrintCondition

Gets or sets the logic statement with indicator values that will allow the control to print only when the statement evaluates as true.

AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

Printer

Gets or sets the name (complete path and name) of the accessible printer device.

PrintFile

PrintSetup

Gets or sets a boolean value indicating if the print setup dialog is to display before printing.  The default is False.

PrintFile

ProcessStamp

Gets or sets the report's processing system date and time for the print file.

AutoField

Quality

Gets or sets the System.Drawing.Printing.PrinterResolutionKind enumeration value indicating the printer resolution setting.  The default is Custom which indicates the print quality used will be the printer's default resolution preference setting.

PrintFile

ReportName

Gets or sets the name of the document for the print file.

PrintFile

ReportStamp

Gets or sets the report's system date and time for the print file.

AutoField

public propertyRightToLeft
(inherited from Control)

Gets or sets a value indicating whether a control's elements are aligned to support locales using right-to-left fonts.

AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

Scale

Gets or sets an integer value containing the percentage factor by  which the printed output is to be scaled.

PrintFile

public propertySize
(inherited from Control)

Gets or sets the height and width of the control in pixels.

AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

public propertySkipToAfter

Gets or sets the line number to skip to after this format is written to the printer.

Format

public propertySkipToBefore

Gets or sets the line number to skip to before this format is written to the printer.

Format

SnapToGrid

Determines if controls should snap to the positioning grid.

PrintFile

public propertyStartPage

Gets or sets the boolean value indicating whether a new page is started before this format is written to the printer.  The default is False.

Format

public property TabIndex
(inherited from Control)

Gets or sets the tab order of the control within its container.

AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

public property TabStop
(inherited from Panel)

Gets or sets a value indicating whether the user can give the focus to this control using the TAB key.

AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

public propertyTag

Not Applicable.

public property Text
(inherited from Panel)

Gets or sets the text associated with this control.  See Control.Text.

AutoField, CharField, DecField, DateTimeField, Label, Line, Shape

TopMargin

Gets or sets an integer value indicating the size of the nonprintable area at the top of the page, in inches or millimeters.

PrintFile

public propertyUnderline
(inherited from BaseField)

Gets or sets a boolean value specifying whether the field output is underlined. The default is False.

AutoField, CharField, DateTimeField, DecField, Label

Units

Gets or sets the ASNA.DataGate.PrintFileDesigner.Controls.Units enumeration value for the unit of measurement within the control; either inches or millimeters.  The default is Inches.

PrintFile

UseColor

Gets or sets a boolean value indicating whether the printed output will be printed in color, for color capable printers.  The default is False.

PrintFile

public property Value

Gets or sets the value of the field.

CharField, DecField, DateTimeField

public propertyValueType

Gets or sets the ValueType enumeration value that indicates the content value the control will contain.

AutoField

public propertyVisible
(inherited from Control)

Gets or sets a value indicating whether the control is visible or hidden. The default is True.

AutoField, CharField, DateTimeField, DecField, Label, Line, Shape

See Also

PrintFile Members | Format Members | AutoField Members | BaseField Members | CharField Members | DateTimeField Members | DecField Members | Label Members | Line Members | Shape Members