Difference between revisions of "XML Script"

From OCAD Wiki - English
Jump to navigation Jump to search
Line 211: Line 211:
 
     </loop>
 
     </loop>
 
     </export>                                              // second export section
 
     </export>                                              // second export section
 
 
     <export id="1">
 
     <export id="1">
 
     <file>c:\export\PartialMap2.ocd</file>
 
     <file>c:\export\PartialMap2.ocd</file>

Revision as of 09:25, 5 October 2011

(This function is only available in OCAD Professional!)

Choose this command to execute functions whose settings are defined in a XML file.

http://www.ocad.com/Whitepaper/Ocad10_Xml_Script_Specification.pdf

Example of XML script file:

<ocadScript>
<exportScript>
<export id="3">
<file>c:\export\exportfile.bmp</file>
<format>BMP</format>
<resolution>300</resolution>
<anti-alias>true</anti-alias>
<colorCorrection>true</colorCorrection>
<partialMap>
<enabled>false</enabled>
</partialMap>
<tiles>
<enabled>true</enabled>
<width>500</width>
<height>500</height>
</tiles>
</export>
</exportScript>
</ocadScript>



1. Introduction

Select Execute XML Script from File menu.


2. XML Script General

File

Node <OcadScript> Parameter Data type Values / Description
File.Open File String ocd file name
File.Close Enable Boolean true, false
File.Save Enable Boolean true, false
File.SaveAs File String ocd file name
File.MultipleFileImport Directory
New Offset
Horizontally
Vertically
Angle
MapScale

Grid Distance
Layer Field

String
Enum. types
Ingeger
Integer
Double
Integer
Double
String
Directory of import files enabled, disabled
File.ExportOIM File String html file name
File.Exit Enabled Boolean true, false Close OCAD Program


View

Node <OcadScript> Parameter Data type Values / Description
View.EntireMap Enable Boolean true, false
View.MoveTo X
Y
Double
Double
 


Map

Node <OcadScript> Parameter Data type Values / Description
Map. OptimizeRepair Enable Boolean true, false
Map.ChangeScale NewScale Integer e. g. 10 000
  EnlargeReduceSymbols Boolean true, false
Map.ConvertLayer CrtFile String crt file name
Symbol.LoadSymbolsFrom File String ocd file name (with symbols to be loaded)
The option replace existing colors and symbols is used


Database

Node <OcadScript> Parameter Data type Values / Description
Database.Dataset.Remove Dataset String
Integer
all for all databases
3, 2, 1, ... for only one or several
Database.Assign.Symbols Dataset
 
CntFile
String
Integer
String
all for all databases
1, 2, 3, ... for only one database
 
ex. 101.0
true, false (Default)
Database.Assign.Texts Dataset
 
TextField
Symbol
ReplaceExistingObjects
String
Integer
String
String
Boolean
all for all databases
1, 2, 3, ... for only one database
 
ex. 101.0
true, false (Default)
Database.Assign.Angles Dataset
 
AngleField
String
Integer
String
all for all databases
1, 2, 3, ... for only one database
 
Database.CreateObjects Dataset
SelectSymbol
Condition
HorizontalCoordinate
VerticalCoordinate
Unit
TextField
HorizontalOffset
VerticalOffset
Integer
Double
String
String
String
Enum. types
String
Double
Double
1, 2, 3, ... Number of dataset
Symbol numer. ex. 207,0
SQL String (ex. SYMBOL LIKE 207,0)
Database fieldname
Database fieldname
m, km
Database fieldname
 
 


Example xml file:

<OcadScript>
 <File.Open>
   <File>C:\Albis\albis_leer.ocd</File>
</File.Open>
<File.MultipleFileImport>
   <Directory>C:\Albis\shp</Directory>
  <NewOffset>enabled</NewOffset>
  <Horizontally>670000</Horizontally>
  <Vertically>230000</Vertically>
  <Angle>20</Angle>
  <MapScale>20000</MapScale>
  <GridDistance>500</GridDistance>
   <LayerField>OBJECTVAL/LayerField>
</File.MultipleFileImport>
 <Database.Assign.Texts>
  <Dataset>all</Dataset>
   <TextField>ID</TextField>
   <Symbol>101.0</Symbol>
   <ReplaceExistingObjects>true</ReplaceExistingObjects >
 </Database.Assign.Texts>
<Database.Assign.Angles>
  <Dataset>all</Dataset>  
   <AngleField>ID</AngleField>
</Database.Assign.Angles>
 
<Database.Assign.Symbols>
  <Dataset>all</Dataset>
  <CntFile>C:\Albis\cnt\Landeskarte.cnt</CntFile>
</Database.Assign.Symbols>
 <Database.Dataset.Remove>
  <Dataset>all</Dataset>
</Database.Dataset.Remove>
 <Map.OptimizeRepair>
<Enabled>true</Enabled>
 </Map.OptimizeRepair>
 <View.EntireMap>
 <Enabled>true</Enabled>
</View.EntireMap>
<File.Save>
  <Enabled>false</Enabled>
</File.Save>
 <File.SaveAs>
  <File>C:\Albis\Albis2.ocd</File>
 </File.SaveAs>
 <File.Close>
  <Enabled>true</Enabled>
</File.Close>
 <File.Exit>
  <Enabled>false</Enabled>
 </File.Exit>
</OcadScript>


XML Script Partial Map

Node <OcadScript> Parameter Data type Values / Description
export file String eg.: ‚ c:\export\PartialMap1.ocd ‘
OCAD creates files PartialMap1_1_1.ocd,
PartialMap1_1_2.ocd,
export coordSystem Enumerated types mm (paper), m (real world)
export T, L, B, R Float top, left, bottom, right
export.loop enabled
horizontalPages
verticalpages
horizontalOverlap
verticalOverlap
Bool
Integer
Integer
Float
Float
true, false
number of pages in horizontal direction
number of pages in vertical direction
horizontal overlap in mm or m
vertical overlap in mm or m


Example xml file:

<ocadScript>                                               // comment   
<partialMapScript>
   <export id="0">                                         // first export section
    <file>c:\export\PartialMap1.ocd</file>                 // export file
    <coordSystem>mm</coordSystem>                          // paper oder real world coordinates
    <T>100</T>                                             // export rectangle with Top Left point and Bottom Right point 
    <L>0</L>
  50
    <R>50</R>
      <loop>                                               // the loop export several ocd files. For this example 21 files.
      <enabled>true</enabled>
      <horizontalPages>7</horizontalPages>              
      <verticalPages>3</verticalPages>
      <horizontalOverlap>10</horizontalOverlap>            // horizontal and vertical overlap. 
      <verticalOverlap>10</verticalOverlap>
    </loop>
    </export>                                              // second export section
    <export id="1">
    <file>c:\export\PartialMap2.ocd</file>
    <coordSystem>mm</coordSystem>
    <L>0</L>
  <R>50</R>
  50
    <T>100</T>
      <loop>
      <enabled>false</enabled>
    </loop>                                                // export only one ocd file
    </export>
  </partialMapScript>
</ocadScript>


Previous Chapter: Chapter 17: Database

Next Chapter: Chapter 19: Course Settings for Orienteering

Back to Help:Contents