Actions YAML Reference
Properties | List of all members
MediaHandling Class Reference

Specifies the media handling settings for the printer, which vary depending on the printer's capability. More...

Properties

MediaHandlingAction Action [get, set]
 Specifies one of the following options: More...
 
MediaHandlingOccurrence Occurrence [get, set]
 Specifies one of the following options: More...
 
MediaHandlingItemType DataItemType [get, set]
 Specifies one of the following options. Valid only when the value of Occurrence is AfterDataChange. More...
 
string DataItemName [get, set]
 Specifies the item name of the data that is changed, as follows:
More...
 
bool IgnoreCase [get, set]
 Specifies whether to ignore case when comparing the DataItemName. The default value is false. More...
 
int NumberLabels [get, set]
 Specifies the number of labels when the value of Occurrence is AfterNumberOfLabels. More...
 

Detailed Description

Specifies the media handling settings for the printer, which vary depending on the printer's capability.

Example:

MediaHandling:
Action: PageBreak
Occurrence: AfterEveryPage
MediaHandlingOccurrence Occurrence
Specifies one of the following options:
Definition: MediaHandling.Properties.cs:80
MediaHandlingAction Action
Specifies one of the following options:
Definition: MediaHandling.Properties.cs:67

Example of Occurrence set to AfterNumberOfLabels:

MediaHandling:
Action: WaitForLabelTakenSensor
Occurrence: AfterNumberOfLabels
int NumberLabels
Specifies the number of labels when the value of Occurrence is AfterNumberOfLabels.
Definition: MediaHandling.Properties.cs:115

Example of DataItemType set to ObjectValue:

MediaHandling:
Action: CutAndPause
Occurrence: AfterDataChange
DataItemType: ObjectValue
DataItemName: Text1
IngoreCase: true
MediaHandlingItemType DataItemType
Specifies one of the following options. Valid only when the value of Occurrence is AfterDataChange.
Definition: MediaHandling.Properties.cs:90
string DataItemName
Specifies the item name of the data that is changed, as follows:
Definition: MediaHandling.Properties.cs:100

Property Documentation

◆ Action

MediaHandlingAction Action
getset

Specifies one of the following options:

  • DriverSettings (default)
  • PageBreak
  • Pause
  • WaitForLabelTakenSensor
  • Cut
  • CutAndPause
  • PartialCut
  • PartialCutAndPause

◆ Occurrence

MediaHandlingOccurrence Occurrence
getset

Specifies one of the following options:

  • AtEndOfPrintJob (default)
  • AfterEveryPage
  • AfterEveryRecord
  • AfterAllIdenticalCopies
  • AfterDataChange
  • AfterNumberOfLabels

◆ DataItemType

MediaHandlingItemType DataItemType
getset

Specifies one of the following options. Valid only when the value of Occurrence is AfterDataChange.

  • DatabaseField (default)
  • NamedDataSource
  • ObjectValue

◆ DataItemName

string DataItemName
getset

Specifies the item name of the data that is changed, as follows:

  • When the value of DataItem is DatabaseField, the item name is a database field name.
  • When the value of DataItem is NamedDataSource, the item name is the name of the named data source.
  • When the value of DataItem is ObjectValue, the item name is the name of the object.

◆ IgnoreCase

bool IgnoreCase
getset

Specifies whether to ignore case when comparing the DataItemName. The default value is false.

◆ NumberLabels

int NumberLabels
getset

Specifies the number of labels when the value of Occurrence is AfterNumberOfLabels.


The documentation for this class was generated from the following file: