LayoutSDK UsersGuide en
LayoutSDK UsersGuide en
Revision history
Date Description
2009.06.01 1.0.0.0 release
2009.11.19 1.0.1.0 release
- Changed to hide the printing dialog in Layout Print Engine.
2013.11.22 1.1.0.0 release
- Added support OS:
Windows 7, Windows 8, Windows 8.1,
Windows Server 2008, Windows Server 2008R2, Windows Server 2012
- Supports the creation of 64-bit user applications.
- Supports multi-threaded user applications for printing.
- Added support barcode:
MaxiCode, Data Matrix, GS1 Composite, GS1 Databar (RSS), iQR
- Support for dot-by-dot print of the image.
And, Changed the property name from [FixedAspect] to [SizeMode].
- Added speed up method for the first printing:
PreparePrint(), HidePreview()
- Support for snapping the inserted parts on the hid grid. (Layout Editor)
- Added the vs90_piaredist.exe to the installer.
The vs90_piaredist.exe ( Microsoft Primary Interoperability Assemblies 2005 ) is
"Distributable Code" by Microsoft.
- Fixed some bugs.
2014.09.08 1.2.0.0 release
- Supported the mobile terminal (Android).
- Added the printer font mode for the mobile terminal in Layout Editor.
- Added the CLFX layout file export function for the mobile terminal in Layout Editor.
- Added the Layout Print Engine for Android using the CLFX layout file.
2016.08.16 1.3.0.0 release
- Added support OS: Windows 10
- Changed to .Net Framework 4.0 based.
- Supported "Straight Line" and "Rectangle" on the layout for the mobile terminal.
- Changed the layout file from CLFX to XML for the mobile terminal.
- Added the XML layout file import funcition for mobile terminal in Layout Editor.
- Change the designation from "Layout Print Engine" to "Layout SDK". (Library name is
no change)
- Fixed some bugs.
Permission Notice
1. Unauthorized use of all or any part of this document is prohibited.
2. The information in this document is subject to change without prior notice.
3. This document has been created with full attention. If, however, you find an error or question,
Please contact us.
4. We shall not be liable for any effect resulting from operation regardless of the above item 3.
5. If you do not agree with the above terms, you are not permitted to use this library.
Copyright / Trademarks
The copyright for this Users Guide belongs to Citizen Systems Japan Co., Ltd.
CITIZEN is a registered trademark of Citizen Watch Co., Ltd.
Windows and Windows Server are either registered trademarks or trademarks of Microsoft
Corporation in the United States and/or other countries.
Pentium is a trademark or registered trademark of Intel Corporation or its subsidiaries in the United
States and other countries.
QR Code and iQR Code are registered trademarks of DENSO WAVE INCORPORATED in Japan
and in other countries.
Android is a trademark of Google Inc.
IOS is a trademark or registered trademark of Cisco in the U.S. and other countries and is used
under license.
Oracle and JavaScript are registered trademarks of Oracle and/or its affiliates.
All other company and/or brand/product names are trademarks and/or registered trademarks of their
respective owners.
Table of Contents
1. Preparation .............................................................................6
1.1 Operating Environment ............................................................................................... 7
1. Preparation
1 Preparation
To enjoy all the benefits of Layout SDK, the host system needs to satisfy the following requirements;
Please be sure to check before installation.
– Reference –
To print from Android terminal must meet the following configuration.
Android terminal ( Execution environment )
OS : Android 2.3.3(API 10) or newer for Wi-Fi, Bluetooth interface
Android 3.1(API 12) or newer for Wi-Fi, Bluetooth, USB Host interface
Software : Android POS Print SDK Version 1.14 or newer
* Requires a Windows PC for creating the layout.
To print from iOS terminal must meet the following configuration. ( Preliminary )
iOS terminal ( Execution environment )
Web browser : HTML5 supported
Software : iOS POS Print SDK Version 1.16 or newer
* Requires a Windows PC for creating the layout.
Layout SDK is a basic set of all platforms, and it consists of Layout Editor, Layout File Manager,
Windows Layout SDK.
Output can be transmitted only to a Citizen Systems printer. Layout SDK are also resourceful in
preparing/designing labels and receipts.
Layout Editor
Prepares the print layout.
The display window consists of tools necessary for layout editing process.
- Note -
Please do not create a layout file with the new version of the Layout Editor than the Layout SDK.
The Layout SDK may fail to load the layout file.
System diagram
Layout SDK Basic set
- Notes -
The difference due to the operation environment - General
* 3: For more information, please refer to the "Windows Layout SDK Programming Manual".
* 4: For more information, please refer to the "Android Layout SDK Programming Manual".
* 5: For more information, please refer to the "iOS Layout SDK programming manual".
* 6: on the specifications of interface, there is a case where the data transfer rate is insufficient. Please take sufficient
verification.
* 7: For more information, please refer to the "Android POS Print SDK Programming Manual".
* 8: For more information, please refer to the "iOS POS Print SDK Programming Manual".
Layout printing
High Some restrictions
reproducibility
Printer function
·Cutter
·Buzzer Yes *1 Yes *2
·Drawer
·NV logo
Print completion
No Yes *3 Yes*4
detection
*3 : This library is using the print completion detection function of Android POS Print SDK.
*4 : This library is using the print completion detection function of iOS POS Print SDK.
Some limitations
Supported :
Unsupported :
Numbering,
No Unsupported
Numbering barcode
Figures ( Circle,
Polygon, Arc, Polyline,
No Unsupported
Free Line, Bezier
Curve )
1.3 Installation
Procedure for installing Layout SDK ( Layout Editor, Layout File Manager, Windows Layout SDK ) on the
PC:
Please check if the operating environment requirements are satisfied and terminate all other programs
on the PC before installation.
1. Double-click [Setup_en].
3. Read the License Agreement and check “I accept the terms of the license agreement.”
4. Click the [Next] button.
1.4 Uninstallation
- Note -
The PC may request for rebooting of Windows after completion of uninstallation.
Follow the message and reboot the system.
2. Layout Editor
2 Layout Editor
- In other Windows
1. Click the [Start] button displayed at the bottom left of the Desktop.
2. Click “All Programs”
3. Click “CITIZEN”
4. Click “Layout SDK”
5. Click “Layout Editor”
6. Layout Editor will start up.
- Note -
If you want to print by the mobile terminal ( Android, iOS ), please click "Printer
font" in preferences and put a check on it.
- Note -
The “Information” dialog box will be displayed at Layout Editor start up.
If you prefer not to receive this message in the future, please check the "Don't
show this message again" option and click the [OK] button.
- Note -
If any changes have been made to the displayed file, a saving confirmation
dialog will be displayed.
This section describes the terms and functions of the Layout Editor display screen.
Status Bar
Functions
Name Function
Menu Bar Provides access to various functions.
Main Toolbar Displays the default tools for Windows applications.
Displays the tools that are most often used in layout editing.
Layout Toolbar
(See 2.7 Changing the Layout).
The Main Toolbar shows the most commonly used tools in the application
Print Preview Displays the print preview for the file that is being edited.
Cut Cuts the selected part and copies it onto the clipboard.
This section describes the basic operation procedures for Layout Editor by preparing a sample layout.
Sample layout
Frame1
(image + text)
Layout Editor
Frame2
(numbering barcode)
Frame3 (figure)
Layout specifications
Paper size: 80 х 297mm
Frame length: 20mm
[Logo mark image]
Format: Bitmap
Frame1
[Text]
Size: 9pt
Font: Times New Roman
Frame length: 20mm
[Numbering barcode]
Type: Code39 Frame2
・ The number starts from 1234 and is incremented by 1.
・ Displays the legible character set below the barcode.
Frame length: 5mm
[Straight line]
Line width: 1mm Frame3
Shape: Broken
- Note -
The initial zoom setting on the screen is 100%.
Set up the zoom magnification from the Zoom menu on the Main Toolbar if
necessary.
(See 2.8.2 Display settings).
1. Select “File” -“Layout Properties” on the Menu Bar or click the [Layout Properties] button on the
Main Toolbar.
2. Only the Citizen printers that are installed will be displayed on the list. Select the printer to be
used from the list.
3. Select the paper. Here, select “A4 length 80×297mm 42c” (select to suit your printer).
4. Click the [OK] button.
(See 2.4.1 Setting up the Layout Properties).
3. Highlight the area for the image to be assigned by dragging the cursor in the right and
downward direction.
- Note -
Inserting can be canceled by pressing the [ESC] key during the procedure.
Prepare the assignment area within the print area. The print area is indicated as
the red line on the Layout editing area.
(See 3.5 Display Settings).
- Note-
To delete the inserted assignment area, click the image to be deleted and press
the [Delete] key.
Insert Frame2.
1. Right-click on “Frame1” of the frame tab.
Add Frame3.
2. Click the beginning point of the broken line and drag to the ending point while pressing the [Shift]
key.
- Note -
A horizontal straight line can be inserted by dragging while pressing the [Shift] key.
Select "Dash" from the pull down menu [Stroke Dash Style] for altering the style.
Enter "1" for line width under [Stroke Width].
3. A broken line will be inserted.
4. Click the “Close” button and close the “Print Preview” dialog box.
1. Click “File” -“Layout Properties” of the Menu Bar or click the [Layout Properties] button on Main
Toolbar.
- Note -
The “Layout Properties” dialog box is displayed first when a new file is created.
The changes made to the default settings on the first dialog box will be saved.
To change the settings during layout, the dialog box can be displayed according
to the pre-defined steps.
Layout editor can prepare layouts by dividing the input into frames along the vertical direction of the
paper.
This section describes the relationship between the output image and the frame along with frame
operation procedures.
FrameA
FrameB
….Sample image….
FrameC
Adding a frame
Deleting a frame
3. A confirmation message for deletion will be displayed. Click the [Yes] button.
- Note -
When a frame is deleted, all parts laid out in the frame will also be deleted.
3. The name of the frame will be highlighted. Input the new frame name.
4. Press the [Enter] key to confirm.
- Note -
It is also possible to change the frame name from [(Name)] in the Frame
Properties editing area.
Copying a frame
- Note -
Frame copying will copy all parts laid out on the original frame as well as the
frame attributes.
Moving a frame
Frame properties
Layout Editor enables properties to be set up for each frame.
Click the blank section in the Layout editing area to display the frame properties.
This section describes the basic operation procedures for moving, rotating etc. of the inserted parts.
Moves the configuration point for the part. Part configuration point (●)
Scales up/down the part frame (part) simultaneously in Four corners of the part frame
vertical and horizontal directions. (□)
- Note -
When a part is selected, □ markers are displayed around the part as shown in
the figure.
Press the [A] key while pressing the [Ctrl] key to select all inserted parts.
To cancel selection, click in the blank space or press the [ESC] key.
The size of an inserted part is changed or the size of a text frame is changed to an appropriate size.
There are 2 ways to change the size of an inserted part.
1. Click the part to be changed and drag □ (the marker) on the outer frame. Dragging any of the
markers on four corners can change the size simultaneously in vertical and horizontal
directions.
- Note -
It is possible to scale up/down while maintaining the aspect ratio by pressing the
[Shift] key while dragging a corner marker.
1. Click inside the part to be moved and drag it to the desired position.
<Dragging to rotate>
2.4.4 Save As
- Note -
The files prepared by Layout Editor will be saved with “.CLF” extensions.
"CLF" file can be used from the application on Windows PC.
2.4.5 Save
2.4.6 Print
2. “Print” dialog box will be displayed. The settings specified in layout properties will be displayed
in the dialog box.
(See 2.4.1 Setting up the Layout Properties).
3. To check details, change the zoom magnification from the pull-down menu of the Zoom Menu.
4. Click the [Close] button.
2.4.8 Export
To export the edited file for the mobile terminal ( Android, iOS ):
- Note -
Export is disabled at default. If you want to use the export, please click "Printer
font" in preferences and put a check on it.
- Note -
XML file format by the export does not include all of the layout information. If the
re-editing of the layout is required, please save in CLF file format always.
- Note -
The layout is saved with the extension "XML".
"XML" file can be used from the app on the mobile terminal ( Android, iOS ).
2.4.9 Import
To import the saved file for the mobile terminal ( Android, iOS ):
- Note -
Import is disabled at default. If you want to use the export, please click "Printer
font" in preferences and put a check on it.
- Note -
In the mobile terminal to use the printer fonts, the print results might be different
from the display.
3. Input the character series to be displayed in [Default Text] of the Properties editing area.
4. Change the attributes in the Properties editing area if necessary.
Text properties
Name Description
Misc
Set text flip.
IsReversal
(No: False, Yes: True)
Text frame
CharacterSpacing Set text.
Set row alignment.
LineAlignment
(Top: Top, Center: Middle, Bottom: Bottom)
LineSpacing Set line spacing.
Set text alignment.
TextAlignment*1
(Left: Left, Center: Center, Right: Right, Justify: Justify)
Set text orientation.
TextDirection
(Horizontal: Horizontal, Vertical: Vertical)
Set text auto return.
TextWrapping
(Yes: Wrap, No: NoWrap)
Design
(Name) *1 Set name to part.
DefaultText*1 Input the text to be displayed.
Font
Font Set text font (Typeface/Size/Style).
FontColor Set text color.
FontColorAlpha Set text opacity (0: transparent - 255: solid).
FontStretchX Set text horizontal scale.
FontStretchY Set text vertical scale.
Printer Font
Bold*1 Set the emphasized characters. (No: False, Yes: True)
*1
Font Set printer font (FontA/FontB/FontC).
*1
Height Set magnification of characters height (1-8 times).
Reverse*1 Set the black/white inverted printing. (No: False, Yes: True)
*1
Underline Set underline. (No: False, Yes: True)
*1
Width Set magnification of characters width (1-8 times).
Behavior
Set part flip.
FlipType (No: None, Horizontal: Horizontal, Vertical: Vertical,
Horizontal and vertical: Both)
Location*1 Set part position (X, Y).
Locked Set part lock. (No: False, Yes: True)
- Note -
Image formats that can be used : BMP, GIF, JPG, JPEG, PNG, ICO, EMF, WMF
Recommended image formats : Monochrome (1bpp) PNG
- Note -
In the mobile terminal to use the printer fonts, the print results might be different
from the display.
5. “Open” dialog box will be displayed. Select the image file to be inserted.
6. Click the [Open] button.
7. Change the attributes in the Properties editing area if necessary.
Image properties
Name Description
Design
(Name) *1 Set name to part.
DefaultPath*1 Set image file.
Set how the image is displayed.
(Dot by dot: Normal,
SizeMode*1,*2
Fit to part: StretchImage (FixedAspect = False),
Fit to part with fixed aspect ratio: Zoom (FixedAspect = True))
Adjustment
Brightness*1 Set brightness (-100 – 100).
Contrast*1 Set contrast (-100 – 100).
*1
GammaCorrection Set gamma correction (0.01 – 5.00).
Set monochrome.
*1
Monochrome (None, Threshold, Dither1, Dither2,
ErrorDiffusion1, ErrorDiffusion2)
ThresholdValue*1 Set threshold for monochrome.
Operation
Set part flip.
FlipType (No: None, Horizontal: Horizontal, Vertical: Vertical,
Horizontal and vertical: Both)
*1
Location Set part position (X, Y).
Locked Set part lock. (No: False, Yes: True)
Rotation*1 Set part rotate angle (0/90/180/270).
*1
Size Set part size (width, height).
SkewAngleX Set part horizontal slant angle.
SkewAngleY Set part vertical slant angle.
Frame
IsFrame Set frame line. (No: False, Yes: True)
StrokeAlpha Set frame line color opacity (0: transparent – 255: solid).
StrokeColor Set frame line color.
StrokeDashCap Set dashed line end style.
StrokeDashStyle Set frame line style.
StrokeLineJoin Set frame line combine shape.
StrokeWidth Set frame line width.
*1
: This property supports the mobile terminal ( Android, iOS ).
*2
: StretchImage of SizeMode is not supported in Android, iOS. It will operate as a " Normal ".
- Note -
In the mobile terminal ( Android, iOS ) to use the printer fonts, the print results
might be different from the display.
3. Input the code to be generated in [DefaultCode] under the Properties editing area.
4. Select the type of barcode to be generated from the pull-down menu of [CodeType] under the
Properties editing area.
5. Change the attributes from the Properties editing area if necessary.
Barcode properties
Name Description
Design
(Name) *1 Set name to part.
*1
DefaultCode Set barcode data.
Barcode
CellAdjust Set correction level by dot for 2D cell size and barcode bar width.
*1
CellPitch Set cell pitch for 2D, bar pitch for 1D barcode.
Set symbology.
(QR Code, EAN-13, EAN-8, UPC-A, UPC-E, Codabar, ITF, Code 39, Code 93,
CodeType*1
Code 128, GS1-128, MaxiCode, PDF417, Data Matrix, GS1 Composite, GS1
Databar, iQR)
FontName Set font for human readable interpretation.
*1
QuietZone Set margin for barcode.
Set error correction for QR Code.
EccLevel*1
(L (7%), M (15%), Q (25%), H (30%), S (50%))
Set model version for QR Code.
ModelNo
(Model 1, Model 2, Micro QR, Model 2 (GS1 format))
Version Set barcode version, “0” to auto.
*1
BarHeight Set barcode height.
- Note -
The displayed details will vary depending on the type of barcode to be inserted.
- Note -
Numbering parts are not supported in the mobile terminal ( Android, iOS ) and
export.
3. Input the increment value in [Increment] under the Properties editing area.
4. Input the initial value in [Initial] under the Properties editing area.
5. Change the attributes in the Properties editing area if necessary.
Numbering properties
Name Description
Others
Set text flip.
IsReversal
(Yes: True, No: False)
Text frame
CharacterSpacing Set text tracking.
Set row alignment.
LineAlignment
(Top: Top, Center: Middle, Bottom: Bottom)
LineSpacing Set line spacing.
Set text alignment.
TextAlignment
(Left: Left, Center: Center, Right: Right, Justify: Justify)
Set text orientation.
TextDirection
(Horizontal: Horizontal, Vertical: Vertical)
Set text auto return.
TextWrapping
(Yes: Wrap, No: NoWrap)
Design
(Name) Set name to part.
Numbering
DecimalDigits Set the limit for number of digits after the decimal point.
Set hexadecimal notation.
Hexadecimal
(No: True, Yes: False)
Increment Set increment/decrement.
Index Set index of numbering.
Initial Set init value.
IntegralDigits Set the number of digit to be displayed.
PrefixText Set prefix character for Numbering.
SuffixText Set suffix character for Numbering.
Set 1000 separator (,).
ThousandsSeparator
(Yes: True, No: False)
Set zero-fill when fewer than the minimum number of digit.
ZeroFill
(Yes: True, No: False)
Font
Font Set text font (Typeface/Size/Style).
FontColor Set text color.
FontColorAlpha Set text opacity (0: transparent – 255: solid).
FontStretchX Set text horizontal scale.
FontStretchY Set text vertical scale.
Operation
Set part flip.
FlipType (No: None, Horizontal: Horizontal, Vertical: Vertical,
Horizontal and vertical: Both)
Location Set part position (X, Y).
Locked Set part lock. (No: False, Yes: True)
Rotation Set part rotate angle (0/90/180/270).
Size Set part size (width, height).
SkewAngleX Set part horizontal slant angle.
SkewAngleY Set part vertical slant angle.
Outline
Set outline.
IsOutline
(No: False, Yes: True)
OutlineColor Set outline color.
OutlineColorAlpha Set outline opacity (0: transparent – 255: solid).
OutlineLineJoin Set outline combine shape.
OutlineWidth Set outline width.
- Note -
Numbering (barcode) parts are not supported in the mobile terminal ( Android,
iOS ) and export.
3. Input the increment value in [Increment] under the Properties editing area.
4. Input the initial value in [Initial] under the Properties editing area.
5. Select the type of barcode to be generated from the pull-down menu of [CodeType] under the
Properties editing area.
6. Change the attributes in the Properties editing area if necessary.
(See 2.5.3 Inserting a Barcode/2.5.4 Inserting Numbering).
Barcode
CellAdjust Set correction level by dot for 2D cell size and barcode bar width.
CellPitch Set cell pitch for 2D, bar pitch for 1D barcode.
Set symbology.
(QR Code, EAN-13, EAN-8, UPC-A, UPC-E, Codabar, ITF, Code 39, Code
CodeType
93, Code 128, GS1-128, MaxiCode, PDF417, Data Matrix, GS1 Composite,
GS1 Databar, iQR)
FontName Set the font for human readable interpretation.
QuietZone Set margin for barcode.
Set error correction for QR Code.
EccLevel
(L (7%), M (15%), Q (25%), H (30%), S (50%))
Set model version for QR Code.
ModelNo
(Model 1, Model 2, Micro QR, Model 2 (GS1 format))
Version Set barcode version, “0” to auto.
BarHeight Set barcode height.
Set for human readable interpretation.
ChrDisplay (No: DspOff, Yes: DspOn, Indication with 3mm fixing: DspOn3mm,
Indication with user-defined fonts: DspOnUser)
Set add-on for EAN-8/13, UPC-A/E.
OptEANUPC
(No: StandardE, Yes: AddOn)
Set check digit.
ChkDigit
(Yes: On, No: Off)
NwRatio Set ratio of wide and narrow bar space.
Set bearer bar for ITF.
OptITF
(No: StandardI, Yes: BearerBar)
Set codeset for CODE128, GS1-128 (EAN-128).
OptCODE128
(A: SetA, B: SetB, C: SetC, Automatic: SetAuto)
Set number of column.
PDF417Column
(Automatic: 0 or Standard/Truncated: 1 – 30, MicroPDF417: 1 – 4)
Set correction level for PDF417.
PDF417Ecc (Auto, PDF0, PDF1, PDF2, PDF3, PDF4, PDF5, PDF6, PDF7, PDF8 and
MicroPDF417: Auto only)
Set model version for PDF417.
PDF417Model
(Standard, Truncated, MicroPDF417)
Set number of row.
PDF417Row
(Automatic: 0 or Standard/Truncated: 3 – 90, MicroPDF417: 4 – 44)
PDF417XYratio Set row height by ratio.
AtMark Set @ sequence interpretation. (ON, OFF)
- Note -
Date and time parts are not supported in the mobile terminal ( Android, iOS ) and
export.
- Note -
The calendar will be displayed by clicking the pull-down menu of [Date].
It is also possible to input the date by clicking on a desired date in the calendar.
- Note -
In the mobile terminal ( Android, iOS ) to use the printer fonts, the print results
might be different from the display.
3. Click the starting point for the straight line and drag to the ending point.
(See 2.3 Using Layout Editor).
- Note -
It is possible to draw the straight line horizontally or vertically from the starting
point by dragging while pressing the [Shift] key.
- Note -
In the mobile terminal ( Android, iOS ) to use the printer fonts, the print results
might be different from the display.
3. Click at the desired position to assign the rectangle and drag the mouse in the right and
downward direction.
(See 2.3 Using Layout Editor).
- Note -
It is possible to insert a square by dragging while pressing the [Shift] key.
In addition, it is possible to scale up/down the rectangle while maintaining the
aspect ratio by dragging the mouse while pressing the [Shift] key when changing
its size.
The corners can be rounded by dragging the green □ marker displayed on top
left of the rectangle. The position of the green marker changes when the ratio for
rounded corner is set up.
The rounded corner ration can also be changed from [RadiusX][RadiusY] in the
Properties editing area.
4. Change the attributes from the Properties editing area if necessary.
Rectangle properties
Name Description
Design
(Name) *1 Set name to part.
Shape Shape
RadiusX Set horizontal ratio for rounded rectangle corner.
RadiusY Set vertical ratio for rounded rectangle corner.
Line
StrokeAlpha Set line color opacity (0: transparent – 255: solid).
StrokeColor Set line color.
StrokeDashCap Set dashed line end style.
*1
StrokeDashStyle Set line style.
StrokeLineJoin Set line combine style.
*1,*2
StrokeWidth Set line width.
Fill
FillAlpha Set fill color opacity (0: transparent – 255: solid).
FillColor Set fill color.
Operation
Set part flip.
FlipType (No: None, Horizontal: Horizontal, Vertical: Vertical,
Horizontal and vertical: Both)
*1
Location Set part position (X, Y).
Locked Set part lock. (No: False, Yes: True)
*1
Rotation Set part rotate angle (0/90/180/270).
*1,*2
Size Set part size (width, height).
SkewAngleX Set part horizontal slant angle.
SkewAngleY Set part vertical slant angle.
*1
: This property supports the mobile terminal ( Android, iOS ).
*2
: Please observe the following conditions if you want to use in the mobile terminal ( Android, iOS ).
- Size (width, height ), please specified in 1.00mm units.
- In upside down printing, StrokeWidth, please specify more than 0.25mm.
- In non-upside down printing, StrokeWidth, please specify more than 0.13mm.
3. Click at the desired position to assign the rectangle and drag the mouse in the right and
downward direction.
(See 2.3 Using Layout Editor).
- Note -
It is possible to insert a perfect circle by dragging while pressing the [Shift] key.
It is also possible to scale up/down the circle/oval while maintaining the aspect
ratio by dragging the mouse while pressing the [Shift] key when changing its
size.
Circle/oval properties
Name Description
Design
(Name) Set name to part.
Line
StrokeAlpha Set line color opacity (0: transparent – 255: solid).
StrokeColor Set line color.
StrokeDashCap Set dashed line end style.
StrokeDashStyle Set line style.
StrokeWidth Set line width.
Fill
FillAlpha Set fill color opacity (0: transparent – 255: solid).
FillColor Set fill color.
Operation
Set part flip.
FlipType
(No: None, Horizontal: Horizontal, Vertical: Vertical, Horizontal and vertical: Both)
Location Set part position (X, Y).
Locked Set part lock. (No: False, Yes: True)
Rotation Set part rotate angle (0/90/180/270).
Size Set part size (width, height).
SkewAngleX Set part horizontal slant angle.
SkewAngleY Set part vertical slant angle.
3. Click at the desired position to assign the rectangle and drag the mouse in the right and
downward direction.
- Note -
It is possible to insert a regular polygon by dragging while pressing the [Shift]
key.
It is also possible to scale up/down the polygon while maintaining the aspect
ratio by dragging the mouse while pressing the [Shift] key when changing its
size.
4. Input the number of corners in [Corner] under the Properties editing area.
“Polygon” “Star”
5. To insert a star shape, select “Star” from the pull-down menu of [Shape] under the Properties
editing area.
6. Change the attributes from the Properties editing area if necessary.
Polygon properties
Name Description
Design
(Name) Set name to part.
Shape Shape
Corner Set number of corner (3 – 60) for polygon.
Set polygon ratio (0 – 100).
Ratio
(Valid only when [Shape] is set to “Star”)
Set polygon shape.
Shape
(Polygon: Polygon, Star: Star)
Line
StrokeAlpha Set line color opacity (0: transparent – 255: solid).
StrokeColor Set line color.
StrokeDashCap Set dashed line end style.
StrokeDashStyle Set line style.
StrokeLineJoin Set the figure edge format style.
StrokeWidth Set line width.
Fill
FillAlpha Set fill color opacity (0: transparent – 255: solid).
FillColor Set fill color.
Operation
Set part flip.
FlipType
(No: None, Horizontal: Horizontal, Vertical: Vertical, Horizontal and vertical: Both)
Location Set part position (X, Y).
Locked Set part lock. (No: False, Yes: True)
Rotation Set part rotate angle (0/90/180/270).
Size Set part size (width, height).
SkewAngleX Set part horizontal slant angle.
SkewAngleY Set part vertical slant angle.
- Note -
It is possible to make a perfect reference circle by dragging the mouse while
pressing the [Shift] key.
[Shift]
4. Specify the arc section to be used. Click the starting point on the displayed dotted circle and drag
to the ending point. It is possible to switch the arc section to be used by pressing the [Shift] key
while dragging.
5. Select the shape from the pull-down menu of [Shape] under the Properties editing area.
6. Change the attributes from the Properties editing area if necessary.
Arc properties
Name Description
Design
(Name) Set name to part.
Shape
EndAngle Set end angle for arc, clockwise from x axis.
Set clockwise/counterclockwise for arc.
IsClockwise
(Clockwise: True, Counterclockwise: False)
Set arc shape.
Shape
(Arc: Arc, Pie: Pie, Chord: Chord)
StartAngle Set start angle for arc, clockwise from x axis.
Line
StrokeAlpha Set line color opacity (0: transparent – 255: solid).
StrokeColor Set line color.
StrokeDashCap Set dashed line end style.
StrokeDashStyle Set line style.
StrokeLineJoin Set the figure edge format style.
StrokeWidth Set line width.
Fill
FillAlpha Set fill color opacity (0: transparent – 255: solid).
FillColor Set fill color.
Operation
Set part flip.
FlipType
(No: None, Horizontal: Horizontal, Vertical: Vertical, Horizontal and vertical: Both)
Location Set part position (X, Y).
Locked Set part lock. (No: False, Yes: True)
Rotation Set part rotate angle (0/90/180/270).
Size Set part size (width, height).
SkewAngleX Set part horizontal slant angle.
SkewAngleY Set part vertical slant angle.
- Note -
[Space]
Polyline properties
Name Description
Design
(Name) Set name to part.
Shape
Set closed line.
Closed
(Yes: True/No: False)
Line
StrokeAlpha Set line color opacity (0: transparent – 255: solid).
StrokeColor Set line color.
StrokeDashCap Set dashed line end style.
StrokeDashStyle Set line style.
StrokeEndCap Set line end style.
StrokeLineJoin Set the figure edge format style.
StrokeStartCap Set line start style.
StrokeWidth Set line width.
Fill
Set fill color opacity (0: transparent – 255: solid).
FillAlpha
(Valid only when Shape: [Closed] is set to “True”)
Set fill color.
FillColor
(Valid only when Shape: [Closed] is set to “True”)
Operation
Set part flip.
FlipType
(No: None, Horizontal: Horizontal, Vertical: Vertical, Horizontal and vertical: Both)
Location Set part position (X, Y).
Set part lock.
Locked
(No: False, Yes: True)
Rotation Set part rotate angle (0/90/180/270).
Size Set part size (width, height).
SkewAngleX Set part horizontal slant angle.
SkewAngleY Set part vertical slant angle.
3. Click at the starting point, and make the mouse track curve to be dragged. The point where the
mouse button is released is the ending point.
- Note -
[Space]
It is possible to switch the starting point and ending point (whether it is closed or
not) by pressing the [Space] key while drawing a polyline, as well as changing
from the pull-down menu of [Closed] in the Properties editing area.
The component points of the free line will be indicated after the figure has been
inserted. It is possible to adjust the curve by dragging the component points with
the pointer.
- Note -
[Space]
It is possible to switch the starting point and ending point (whether it is closed or
not) by pressing the [Space] key while drawing a polyline, as well as changing
from the pull-down menu of [Closed] in the Properties editing area.
Handle
Component point
6. The Bezier curve and the handle will be indicated. The curve can be adjusted by dragging the
handle.
7. Change the attributes from the Properties editing area if necessary.
1. Select a part.
2. Click the Center button on Layout Toolbar.
Aligns all the selected parts by matching the centers of their outer frames.
Aligns all the selected parts by matching the right sides of their outer frames.
Aligns all the selected parts so that the outer frames of the parts are equally spaced
horizontally within the outer frame of the selected parts.
Aligns all the selected parts by matching the top sides of their outer frames.
Aligns all the selected parts so that the outer frames of the parts are equally spaced
vertically within the outer frame of the selected parts.
Aligns all the selected parts by matching the bottom sides of their outer frames.
Aligns all the selected parts so that the outer frames of the parts are equally spaced
vertically within the outer frame of the selected parts.
It is possible to copy multiple parts at once or move them together without breaking the alignment by
grouping the parts.
- Note -
To edit grouped parts, cancel grouping using the [Ungroup] button.
2.7.5 Locking
3. The color of the □ mark will change for the locked parts, and all operations will be disabled.
- Note -
To edit a locked part, cancel the lock using the [Unlock] button.
Each individual part can be locked through [Locked] function under the
Properties editing area.
2.8 Preferences
2.8.1 Preferences
Preferences such as the units used in layout and grids can be set up.
- Note -
With Layout Editor, scale unit can be selected from mm and inch.
While it is possible to change the unit during layout preparation, it may cause
conversion errors as the unit is changed.
It is recommended to begin the layout after setting up the scale unit beforehand.
- Note -
Layout Editor, you can export the layout of the mobile terminal for printing using
the printer font. If you want to use the export, click "Printer font" and put a check
on it.
2. “Color Setting” dialog box will be displayed when the button is clicked.
3. Click the color to set up from the basic colors and click the [OK] button.
- Note -
It is also possible to create the color of your choice by selecting the [Define
Custom Colors] button.
<Setting up AutoSave>
1. Click “AutoSave” and put a check on it.
2. Input the saving interval.
3. Click [Browse…] button to display the “Browse folder” dialog box.
4. Set up the folder to save files and click the [OK] button.
- Note -
Files saved automatically are saved as files with extension “autosave”.
To disable AutoSave, de-select the option for “AutoSave”.
- Note -
If the Ruler is displayed in the Layout editing area, it is possible to add a Guide
Bar by clicking and dragging the horizontal or vertical Ruler.
To move a Guide Bar, click and drag the displayed Guide Bar to the desired
position.
- Note -
To delete only the desired Guide Bar among the Guide Bars displayed, click the
Guide Bar to be deleted in the Layout editing area and drag it to the horizontal or
vertical Ruler.
Setting up Zoom
1. Click the pull-down menu of the Zoom Menu on the Main Toolbar and select the zoom
magnification.
- Note -
It is also possible to change the zoom magnification by clicking the
buttons.
button: Zooms in by 25% from the current zoom each time.
button: Zooms out by 25% from the current zoom each time.
- In other Windows
1. Click the [Start] button displayed at the bottom left portion of the screen.
2. Click “All Programs”
3. Click “CITIZEN”
4. Click “Layout SDK”
5. Click “Layout File Manager”
6. Layout File Manager will start up.
This section describes the names and functions of the parts of Layout File Manager screen.
List view
Explorer view
Thumbnail view
Bookmark view
Status Bar
Part functions
Name Function
Menu Bar Executes various functions.
Toolbar Displays the frequently used functions.
Explorer view Displays the Explorer.
Recently used files view Displays up to 10 files that have been used by Layout Editor.
Bookmark view Displays the folder that is registered in bookmark.
Displays the folders and files in the folder specified in Explorer view or
Bookmark view.
List view
The file that has been recently used will be displayed when Recently
used files view is selected.
Thumbnail view Displays the thumbnail for a CLF-format file and its layout properties.
Status bar Displays the status.
Print Preview Displays the print preview for the selected file.
Up One Level Moves the folder up by one layer from the selected folder.
Make New Folder Creates a new folder directly below the selected folder.
This section describes the procedures for selecting folders on the Explorer view.
When a folder displayed in Explorer view is selected, the folders stored in the selected folder and the
files created by Layout Editor will be displayed on List view.
If there is a folder(s) in the layer underneath the displayed folder, [+] mark will be displayed beside the
folder icon.
Click [+] to expand the tree and display the lower folders.
Click [-] to fold the lower folders that are displayed.
- Note -
The location for saving displayed on “Save As” dialog box will be the folder
selected in step 1.
Layout Editor is started directly from Layout File Manager to open a CLF file.
1. Specify the folder the file is saved from Explorer view or Bookmark view.
2. Click the CLF file displayed on List view.
3. Click the [Open] button on the Toolbar.
4. Layout Editor will start up and the file will be opened.
(See 2.1 Starting up and Exiting Layout Editor).
- Note -
It is also possible to open a file by the following methods;
1. Double-clicking the file on List view, or
2. Right-clicking the file on List view and selecting “Open.”
3.3.4 Rename
- Note -
It is impossible to change or delete the extension “.CLF” at the end of a file
name.
It is also possible to change the name by the following methods;
With a folder or file selected,
1. Right-click and select “Rename,” or
2. Press the [F2] button.
3.3.5 Print
A new folder is created in the folder specified in Explorer view or Bookmark view.
1. Select the upper folder to create a new folder in Explorer view or Bookmark view (in the above
case, a folder will be created in My Documents).
2. Click the [Make New Folder] button on Toolbar.
3. Input the folder name and press the [Enter] key.
3.3.8 Moving
- Note -
It is possible to move a folder using similar procedures.
The source file will be deleted when it is pasted.
Nothing will happen to the source file if it is only cut.
Cut and Paste can also be selected from the menu displayed by right-clicking the file.
3.3.9 Copy
- Note -
It is possible to copy a folder using similar procedures.
Copy and Paste can also be selected from the menu displayed by right-clicking
the file.
3.3.10 Delete
- Note -
It is also possible to delete a folder from “File” — “Delete” on the Menu Bar.
3.4 Bookmark
It is possible to keep a frequently used folder constantly displayed on Bookmark view by registering the
folder as a bookmark.
Add Bookmark
Remove Bookmark
Layout SDK
Layout Editor / Layout File Manager
Users Guide
for Version 1.3.0