BRCustomPaperInfoCommand

BRCustomPaperInfoCommand class contains the custom paper information parameters.

Instance Methods

initWithPrinterNameForRoll

Initialize the BRCustomPaperInfoCommand object, when you use Roll paper.

Declaration

- (id) initWithPrinterNameForRoll: (NSString *) printerName
                        tapeWidth: (float) tapeWidth
                      rightMargin: (float) rightMargin
                        leftMagin: (float) leftMagin
                        topMargin: (float) topMargin
                     unitOfLength: (UnitOfLengthParameter) unitOfLengthParameter;

or

- (id) initWithPrinterNameForRoll: (NSString *) printerName
                        tapeWidth: (float) tapeWidth
                      rightMargin: (float) rightMargin
                        leftMagin: (float) leftMagin
                        topMargin: (float) topMargin
                     unitOfLength: (UnitOfLengthParameter) unitOfLengthParameter
                       energyRank: (unsigned int) energyRank;

Return Value

BRCustomPaperInfoCommand object

initWithPrinterNameForDieCut

Initialize the BRCustomPaperInfoCommand object, when you use DieCut paper.

Declaration

- (id) initWithPrinterNameForDieCut: (NSString *) printerName
                          tapeWidth: (float) tapeWidth
                         tapeLength: (float) tapeLength
                        rightMargin: (float) rightMargin
                          leftMagin: (float) leftMagin
                          topMargin: (float) topMargin
                       bottomMargin: (float) bottomMargin
                         labelPitch: (float) labelPitch
                       unitOfLength: (UnitOfLengthParameter) unitOfLengthParameter;

or

- (id) initWithPrinterNameForDieCut: (NSString *) printerName
                          tapeWidth: (float) tapeWidth
                         tapeLength: (float) tapeLength
                        rightMargin: (float) rightMargin
                          leftMagin: (float) leftMagin
                          topMargin: (float) topMargin
                       bottomMargin: (float) bottomMargin
                         labelPitch: (float) labelPitch
                       unitOfLength: (UnitOfLengthParameter) unitOfLengthParameter
                         energyRank: (unsigned int) energyRank;

Return Value

BRCustomPaperInfoCommand object

initWithPrinterNameForMarkRoll

Initialize the BRCustomPaperInfoCommand object, when you use MarkRoll paper.

Declaration

- (id) initWithPrinterNameForMarkRoll: (NSString *) printerName
                            tapeWidth: (float) tapeWidth
                           tapeLength: (float) tapeLength
                          rightMargin: (float) rightMargin
                            leftMagin: (float) leftMagin
                            topMargin: (float) topMargin
                         bottomMargin: (float) bottomMargin
                         markPosition: (float) markPosition
                           markHeight: (float) markHeight
                         unitOfLength: (UnitOfLengthParameter) unitOfLengthParameter;

or

- (id) initWithPrinterNameForMarkRoll: (NSString *) printerName
                            tapeWidth: (float) tapeWidth
                           tapeLength: (float) tapeLength
                          rightMargin: (float) rightMargin
                            leftMagin: (float) leftMagin
                            topMargin: (float) topMargin
                         bottomMargin: (float) bottomMargin
                         markPosition: (float) markPosition
                           markHeight: (float) markHeight
                         unitOfLength: (UnitOfLengthParameter) unitOfLengthParameter
                           energyRank: (unsigned int) energyRank;

Return Value

BRCustomPaperInfoCommand object

valueOfErrorParameter

Convert from ErrorParameterName to NSString*.

Declaration

- (NSString *) valueOfErrorParameter:(ErrorParameterName)errorParameterName;

Return Value

NSString* object (meaning ErrorParameterName)

valueOfErrorParameterDetail

Convert from ErrorParameterDetail to NSString*.

Declaration

- (NSString *) valueOfErrorParameterDetail:(ErrorParameterDetail)errorParameterDetail;

Return Value

NSString* object (meaning ErrorParameterName)

Properties

printerName_

Declaration

@property(nonatomic, strong, readonly) NSString *printerName_;

tapeWidth_

Declaration

@property(readonly) float tapeWidth_;

tapeLength_

Declaration

@property(readonly) float tapeLength_;

rightMargin_

Declaration

@property(readonly) float rightMargin_;

leftMagin_

Declaration

@property(readonly) float leftMagin_;

topMargin_

Declaration

@property(readonly) float topMargin_;

bottomMargin_

Declaration

@property(readonly) float bottomMargin_;

labelPitch_

Declaration

@property(readonly) float labelPitch_;

markPosition_

Declaration

@property(readonly) float markPosition_;

markHeight_

Declaration

@property(readonly) float markHeight_;

unitOfLengthParameter_

Declaration

@property(readonly) UnitOfLengthParameter unitOfLengthParameter_;

paperKindParameter_

Declaration

@property(readonly) PaperKindParameter paperKindParameter_;

energyRank_

If no value was specified in the initializer, it contains -1. If the value is -1, the default value is used internally. If you set value larger than max value in the printer, max value in the printer is used internally.

Declaration

@property(readonly) int energyRank_;

displayName

Warning

This property is under development. Setting a value will have no effect.

Declaration

@property(nonatomic, strong) NSString *displayName;

dieStartRevPlus

Warning

This property is under development. Setting a value will have no effect.

Declaration

@property(readwrite) float dieStartRevPlus

dieStartFwdPlus

Warning

This property is under development. Setting a value will have no effect.

Declaration

@property(readwrite) float dieStartFwdPlus

afterFeedPlus

Warning

This property is under development. Setting a value will have no effect.

Declaration

@property(readwrite) float afterFeedPlus

mediaSensorSensitivity

Warning

This property is under development. Setting a value will have no effect.

Declaration

@property(readwrite) float mediaSensorSensitivity

mediaSensorIntensity

Warning

This property is under development. Setting a value will have no effect.

Declaration

@property(readwrite) float mediaSensorIntensity

Types

UnitOfLengthParameter

enum to indicate inch or mm.

Declaration

typedef enum {
Inch = 1,
Mm = 2
}UnitOfLengthParameter;

ErrorParameterName

enum to indicate error parameter name.

Declaration

typedef enum  {
InternalError = -1,
NoErrorParameters = 0,
// Basic
TapeWidth = 1,
TapeLength = 2,
RightMargin = 3,
LeftMargin = 4,
TopMargin = 5,
BottomMargin = 6,
LabelPitch = 7,
MarkPosition = 8,
MarkHeight = 9,
DisplayName = 10,
}ErrorParameterName;

ErrorParameterDetail

enum to indicate error detail for each parameters.

Declaration

typedef enum  {
NoError = 0,
ExceptionError = 1,
OverTheUpperLimit = 2,
BelowTheLowerLimit = 3,
FailToCreateCommand = 4,
FailToReadPTDFile = 5,
}ErrorParameterDetail;

Notes

Supported Model

Model	Printer
RJ-3200 series	RJ-3230B, RJ-3250WB
RJ-4000 series	RJ-4030, RJ-4030Ai, RJ-4040
RJ-4200 series	RJ-4250WB, RJ-4230B
TD-4000 series	TD-4100N, TD-4000
TD-4000D series	TD-4410D, TD-4510D, TD-4420DN, TD-4520DN, TD-4550NWB
TD-2300 series	TD-2310D_203, TD-2310D_300, TD-2320D_203, TD-2320D_300, TD-2320DF_203, TD-2320DF_300, TD-2320DSA_203, TD-2320DSA_300, TD-2350D_203, TD-2350D_300, TD-2350DF_203, TD-2350DF_300, TD-2350DSA_203, TD-2350DSA_300, TD-2350DFSA_203, TD-2350DFSA_300