Scribd
Upload
265 views

User Manual and Programmers' Reference

No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, without the written permission of the publisher. Products that are referred to in this document may be either trademarks and / or registered trademarks of the respective owners. The publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document.

Uploaded by

Lythithuy Lythithuytrieuducbinh
Copyright
© Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online on Scribd
265 views

User Manual and Programmers' Reference

No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, without the written permission of the publisher. Products that are referred to in this document may be either trademarks and / or registered trademarks of the respective owners. The publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document.

Uploaded by

Lythithuy Lythithuytrieuducbinh
Copyright
© Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 1442

User Manual and Programmers' Reference

Altova XMLSpy 2011 User & Reference Manual

All rights reserved. No parts of this work may be reproduced in any form or by any means
- graphic, electronic, or mechanical, including photocopying, recording, taping, or
information storage and retrieval systems - without the written permission of the publisher.

Products that are referred to in this document may be either trademarks and/or registered
trademarks of the respective owners. The publisher and the author make no claim to
these trademarks.

While every precaution has been taken in the preparation of this document, the publisher
and the author assume no responsibility for errors or omissions, or for damages resulting
from the use of information contained in this document or from the use of programs and
source code that may accompany it. In no event shall the publisher and the author be
liable for any loss of profit or any other commercial damage caused or alleged to have
been caused directly or indirectly by this document.

Published: 2010

© 2010 Altova GmbH


Table of Contents

Welcome to XMLSpy 3

User Manual 6

1 New Features 8

2 Introduction 9
2.1 .........................................................................................................................................10
The Graphical User Interface (GUI)
2.1.1 Main Window ............................................................................................................................11
2.1.2 Project Window............................................................................................................................12
2.1.3 Info Window ............................................................................................................................14
2.1.4 Entry Helpers ............................................................................................................................14
2.1.5 Output Window:............................................................................................................................15
Messages
2.1.6 Output Window:............................................................................................................................16
XPath
2.1.7 Output Window:............................................................................................................................21
XSL Outline
2.1.8 Output Window:............................................................................................................................21
Find in Files
2.1.9 Output Window:............................................................................................................................23
Find in Schemas
2.1.10 Output Window:............................................................................................................................23
Find in XBRL
2.1.11 Output Window:............................................................................................................................24
Charts
2.1.12 Menu Bar, ............................................................................................................................26
Toolbars, Status Bar
2.2 .........................................................................................................................................28
The Application Environment
2.2.1 Settings, ............................................................................................................................28
Customization, and Menus
2.2.2 Tutorials,............................................................................................................................30
Projects, Examples
2.2.3 XMLSpy............................................................................................................................30
Features and Help, and Altova Products

3 XMLSpy Tutorial 32
3.1 XMLSpy .........................................................................................................................................33
Interface
3.2 .........................................................................................................................................34
XML Schemas: Basics
3.2.1 Creating ............................................................................................................................34
a New XML Schema File
3.2.2 Defining............................................................................................................................37
Namespaces
3.2.3 Defining............................................................................................................................38
a Content Model

Altova XMLSpy 2011 1


3.2.4 Adding Elements
............................................................................................................................42
with Drag-and-Drop
3.2.5 Configuring ............................................................................................................................43
the Content Model View
3.2.6 Completing ............................................................................................................................45
the Basic Schema
3.3 .........................................................................................................................................49
XML Schemas: Advanced
3.3.1 Working............................................................................................................................49
with Complex Types and Simple Types
3.3.2 Referencing ............................................................................................................................56
Global Elements
3.3.3 Attributes............................................................................................................................58
and Attribute Enumerations
3.4 .........................................................................................................................................62
XML Schemas: XMLSpy Features
3.4.1 Schema Navigation
............................................................................................................................62
3.4.2 Schema Documentation
............................................................................................................................64
3.5 .........................................................................................................................................68
XML Documents
3.5.1 Creating ............................................................................................................................68
a New XML File
3.5.2 Specifying ............................................................................................................................70
the Type of an Element
3.5.3 Entering ............................................................................................................................72
Data in Grid View
3.5.4 Entering ............................................................................................................................72
Data in Text View
3.5.5 Validating ............................................................................................................................76
the Document
3.5.6 Adding Elements
............................................................................................................................80
and Attributes
3.5.7 Editing in............................................................................................................................82
Database/Table View
3.5.8 Modifying ............................................................................................................................86
the Schema
3.6 .........................................................................................................................................89
XSLT Transformations
3.6.1 Assigning............................................................................................................................89
an XSLT File
3.6.2 Transforming ............................................................................................................................90
the XML File
3.6.3 Modifying ............................................................................................................................91
the XSL File
3.7 .........................................................................................................................................93
Project Management
3.7.1 Benefits ............................................................................................................................93
of Projects
3.7.2 Building ............................................................................................................................93
a Project
3.8 That's It .........................................................................................................................................95

4 Editing Views 96
4.1 Text View.........................................................................................................................................97
4.1.1 Formatting ............................................................................................................................97
in Text View
4.1.2 Displaying ............................................................................................................................99
the Document
4.1.3 Editing ............................................................................................................................102
in Text View
4.1.4 Entry Helpers
............................................................................................................................104
in Text View
4.2 .........................................................................................................................................106
Grid View
4.2.1 Editing ............................................................................................................................107
in Grid View
4.2.2 Grid View ............................................................................................................................108
Tables
4.2.3 Entry Helpers
............................................................................................................................112
in Grid View
4.3 .........................................................................................................................................114
Schema View
4.3.1 Schema............................................................................................................................114
Overview
4.3.2 Content............................................................................................................................118
Model View
4.3.3 Entry Helpers
............................................................................................................................129
in Schema View
4.3.4 Identity............................................................................................................................132
Constraints
4.3.5 Smart Restrictions
............................................................................................................................136

2 Altova XMLSpy 2011


4.3.6 xml:base, ............................................................................................................................140
xml:id, xml:lang, xml:space
4.3.7 Back and ............................................................................................................................142
Forward: Moving through Positions
4.4 .........................................................................................................................................143
WSDL View
4.4.1 Main Window ............................................................................................................................144
4.4.2 Overview ............................................................................................................................148
Entry Helper
4.4.3 Details ............................................................................................................................152
Entry Helper
4.5 .........................................................................................................................................153
XBRL View
4.5.1 Main Window:............................................................................................................................153
Elements Tab
4.5.2 Main Window:............................................................................................................................157
Definitions, Presentation, Calculation Tabs
4.5.3 Entry Helpers
............................................................................................................................160
in XBRL View
4.6 .........................................................................................................................................164
Authentic View
4.6.1 Overview ............................................................................................................................164
of the GUI
4.6.2 Authentic ............................................................................................................................165
View Toolbar Icons
4.6.3 Authentic ............................................................................................................................167
View Main Window
4.6.4 Authentic ............................................................................................................................169
View Entry Helpers
4.6.5 Authentic ............................................................................................................................173
View Context Menus
4.7 Browser.........................................................................................................................................176
View
4.8 Archive .........................................................................................................................................177
View

5 XML 179
5.1 Creating,.........................................................................................................................................180
Opening, and Saving XML Documents
5.2 .........................................................................................................................................182
Assigning Schemas and Validating
5.3 .........................................................................................................................................184
Editing XML in Text View
5.4 .........................................................................................................................................186
Editing XML in Grid View
5.5 .........................................................................................................................................189
Editing XML in Authentic View
5.6 .........................................................................................................................................191
Entry Helpers for XML Documents
5.7 .........................................................................................................................................193
Processing with XSLT and XQuery
5.8 Charts .........................................................................................................................................195
5.8.1 Creating............................................................................................................................196
a Chart
5.8.2 Source XPath............................................................................................................................200
5.8.3 X-Axis ............................................................................................................................203
Selection
5.8.4 Y-Axis ............................................................................................................................207
Selection
5.8.5 Chart Data ............................................................................................................................211
5.8.6 Chart Type ............................................................................................................................212
5.8.7 Chart Appearance
............................................................................................................................213
5.8.8 Export ............................................................................................................................214
5.8.9 Chart Example:
............................................................................................................................215
Simple
5.8.10 Chart Example:
............................................................................................................................217
Advanced
5.9 .........................................................................................................................................224
Additional Features

6 DTDs and XML Schemas 226


6.1 DTDs .........................................................................................................................................227

Altova XMLSpy 2011 3


6.2 .........................................................................................................................................229
XML Schemas
6.3 Schema .........................................................................................................................................230
Subsets
6.4 .........................................................................................................................................234
Schema Rules
6.4.1 Managing ............................................................................................................................234
Rule Sets
6.4.2 Defining............................................................................................................................236
a Rule Set
6.5 Catalogs.........................................................................................................................................241
in XMLSpy
6.6 Working.........................................................................................................................................245
with SchemaAgent
6.6.1 Connecting ............................................................................................................................246
to SchemaAgent Server
6.6.2 Opening............................................................................................................................248
Schemas Found in the Search Path
6.6.3 Using IIRs ............................................................................................................................249
6.6.4 Viewing............................................................................................................................253
Schemas in SchemaAgent
6.6.5 SchemaAgent ............................................................................................................................253
Validation
6.7 .........................................................................................................................................255
Find in Schemas
6.7.1 Search Term ............................................................................................................................256
6.7.2 Components ............................................................................................................................258
6.7.3 Properties ............................................................................................................................259
6.7.4 Scope ............................................................................................................................262
6.7.5 Find and............................................................................................................................263
Replace Commands
6.7.6 Results ............................................................................................................................265
and Information

7 XSLT and XQuery 266


7.1 XSLT .........................................................................................................................................267
7.1.1 XSLT Documents
............................................................................................................................267
7.1.2 XSLT Processing
............................................................................................................................269
7.1.3 XSL Outline
............................................................................................................................271
– XSL ............................................................................................................................
Outline Window 272
............................................................................................................................
– Info Window 275
7.2 XQuery .........................................................................................................................................278
7.2.1 XQuery............................................................................................................................279
Documents
7.2.2 XQuery............................................................................................................................280
Entry Helpers
7.2.3 XQuery............................................................................................................................280
Syntax Coloring
7.2.4 XQuery............................................................................................................................282
Intelligent Editing
7.2.5 XQuery............................................................................................................................283
Validation and Execution
7.2.6 XQuery............................................................................................................................284
and XML Databases
7.3 .........................................................................................................................................288
XSLT and XQuery Debugger
7.3.1 Mechanism ............................................................................................................................289
and Interface
7.3.2 Commands ............................................................................................................................290
and Toolbar Icons
7.3.3 XSLT/XQuery ............................................................................................................................293
Settings
7.3.4 Starting............................................................................................................................295
a Debugging Session
7.3.5 Information ............................................................................................................................297
Windows
............................................................................................................................
– Context Window 298
– Variables ............................................................................................................................
Window 298
............................................................................................................................
– XPath-Watch Window 299
– Call Stack............................................................................................................................
Window 299

4 Altova XMLSpy 2011


– Messages ............................................................................................................................
Window 300
............................................................................................................................
– Templates Window 300
............................................................................................................................ 300
– Info Window
– Trace............................................................................................................................
Window 301
– Arranging ............................................................................................................................
the Info Windows 301
7.3.6 Breakpoints ............................................................................................................................302
7.3.7 Tracepoints ............................................................................................................................305
7.4 .........................................................................................................................................311
XSLT and XQuery Profiler
7.4.1 XSLT Profiling
............................................................................................................................315
7.4.2 XQuery............................................................................................................................318
Profiling
7.4.3 Profiler............................................................................................................................321
Charts

8 Authentic 324
8.1 .........................................................................................................................................326
Authentic View Tutorial
8.1.1 Opening............................................................................................................................327
an XML Document in Authentic View
8.1.2 The Authentic
............................................................................................................................328
View Interface
8.1.3 Node Operations
............................................................................................................................330
8.1.4 Entering............................................................................................................................333
Data in Authentic View
8.1.5 Entering............................................................................................................................335
Attribute Values
8.1.6 Adding ............................................................................................................................335
Entities
8.1.7 Printing............................................................................................................................336
the Document
8.2 .........................................................................................................................................338
Editing in Authentic View
8.2.1 Basic Editing
............................................................................................................................338
8.2.2 Tables in ............................................................................................................................341
Authentic View
– SPS Tables............................................................................................................................ 341
– XML............................................................................................................................
Tables 342
............................................................................................................................
– XML Table Editing Icons 345
8.2.3 Editing ............................................................................................................................347
a DB
............................................................................................................................
– Navigating a DB Table 348
............................................................................................................................ 348
– DB Queries
............................................................................................................................
– Modifying a DB Table 352
8.2.4 Working ............................................................................................................................353
with Dates
– Date ............................................................................................................................
Picker 354
– Text Entry............................................................................................................................ 354
8.2.5 Defining............................................................................................................................355
Entities
8.2.6 Images ............................................................................................................................356
in Authentic View
8.2.7 Keystrokes ............................................................................................................................357
in Authentic View
8.3 .........................................................................................................................................358
Authentic Scripting

9 HTML, CSS, JSON 360


9.1 HTML .........................................................................................................................................361
9.2 CSS .........................................................................................................................................363

Altova XMLSpy 2011 5


9.3 JSON .........................................................................................................................................367

10 WSDL and SOAP 370


.........................................................................................................................................371
10.1 WSDL Tutorial
10.1.1
Creating............................................................................................................................371
a New Document
10.1.2
Creating............................................................................................................................372
a PortType
10.1.3
Creating............................................................................................................................373
a Binding
10.1.4
Creating............................................................................................................................375
a Service and Ports
10.1.5
Validating ............................................................................................................................376
the WSDL Document
10.1.6
Connecting ............................................................................................................................376
to a Web Service and Opening Files
10.1.7
Sending............................................................................................................................377
a SOAP Request from the WSDL File
10.1.8
Creating............................................................................................................................378
WSDL Documentation
10.1.9
Converting ............................................................................................................................379
to WSDL 2.0
10.2 SOAP .........................................................................................................................................381
10.2.1 SOAP Validation
............................................................................................................................381
10.2.2 SOAP Communications
............................................................................................................................382
Process
10.2.3 Using SOAP ............................................................................................................................383
Debugger
10.2.4 Breakpoints ............................................................................................................................389
in SOAP Debugger

11 XBRL 392
11.1 .........................................................................................................................................393
Taxonomies: New and Existing
11.2 Taxonomy.........................................................................................................................................394
Files Overview
11.3 .........................................................................................................................................396
Creating a New Taxonomy
11.4 .........................................................................................................................................401
Namespaces in the Taxonomy
11.5 .........................................................................................................................................403
Importing a Taxonomy
11.6 .........................................................................................................................................405
Setting Up the Taxonomy Files
11.7 .........................................................................................................................................408
Adding Elements to a Taxonomy
11.8 .........................................................................................................................................412
Relationships and Linkroles
11.9 Creating.........................................................................................................................................414
Relationships: Part 1
11.10 Creating.........................................................................................................................................417
Relationships: Part 2
11.11 .........................................................................................................................................420
Find in XBRL
11.11.1 Search Term
............................................................................................................................420
11.11.2 Command ............................................................................................................................422
Execution
11.11.3 Results ............................................................................................................................424
and Information

12 Office Open XML and ZIP 425


12.1 Working.........................................................................................................................................427
with OOXML Files
12.2 OOXML.........................................................................................................................................429
Example Files
12.3 ZIP Files.........................................................................................................................................430

6 Altova XMLSpy 2011


13 Databases 432
.........................................................................................................................................433
13.1 Connecting to a Data Source
13.1.1
Connection ............................................................................................................................434
Wizard
13.1.2
Existing............................................................................................................................435
Connections
13.1.3
ADO Connections
............................................................................................................................436
13.1.4
ODBC Connections
............................................................................................................................440
13.1.5
Global Resources
............................................................................................................................443
.........................................................................................................................................445
13.2 Supported Databases

14 Altova Global Resources 446


14.1 Defining.........................................................................................................................................447
Global Resources
14.1.1
Files ............................................................................................................................449
14.1.2
Folders............................................................................................................................451
14.1.3
Databases ............................................................................................................................452
14.1.4
Copying............................................................................................................................453
Configurations
.........................................................................................................................................454
14.2 Using Global Resources
14.2.1 Assigning ............................................................................................................................454
Files and Folders
14.2.2 Assigning ............................................................................................................................457
Databases
14.2.3 Changing ............................................................................................................................458
Configurations

15 Projects 459
15.1 Creating.........................................................................................................................................460
and Editing Projects
.........................................................................................................................................463
15.2 Using Projects

16 File/Directory Comparisons 465


.........................................................................................................................................466
16.1 File Comparisons
16.2 Directory.........................................................................................................................................467
Comparisons

17 Source Control 468


17.1 Supported .........................................................................................................................................470
Source Control Systems
17.2 Installing.........................................................................................................................................475
Source Control Systems
17.3 SCSs and .........................................................................................................................................482
Altova DiffDog Differencing

18 XMLSpy in Visual Studio 488


18.1 Installing.........................................................................................................................................489
the XMLSpy Plugin
.........................................................................................................................................491
18.2 Differences with XMLSpy Standalone

Altova XMLSpy 2011 7


.........................................................................................................................................493
18.3 XMLSpy's Debuggers in Visual Studio
.........................................................................................................................................494
18.4 Known Issues

19 XMLSpy in Eclipse 495


19.1 Installing.........................................................................................................................................496
the XMLSpy Plugin for Eclipse
19.2 XMLSpy.........................................................................................................................................500
Entry Points in Eclipse
19.3 XMLSpy's .........................................................................................................................................503
Debugger Perspectives

20 Code Generator 504


20.1 .........................................................................................................................................505
Introduction to code generator
20.2 .........................................................................................................................................507
What's new ...
20.3 .........................................................................................................................................509
Generating source code from a schema
20.4 .........................................................................................................................................511
Using the generated code library
20.4.1 Example............................................................................................................................512
schema
20.4.2 Using the
............................................................................................................................513
generated Java library
20.4.3 Using the
............................................................................................................................519
generated C++ library
20.4.4 Using the
............................................................................................................................526
generated C# library
20.4.5 Using generated
............................................................................................................................532
code compatible to old versions
............................................................................................................................
– Creating XML files (XMLSpy 2006) 533
............................................................................................................................
– Creating XML files (XMLSpy 2005) 535
............................................................................................................................
– Opening and parsing existing XML files (XMLSpy 2006) 537
............................................................................................................................
– Opening and parsing existing XML files (XMLSpy 2005) 540
.........................................................................................................................................543
20.5 Code generation tips
.........................................................................................................................................545
20.6 Code generator options
20.7 The way.........................................................................................................................................546
to SPL (Spy Programming Language)
20.7.1 Basic SPL
............................................................................................................................546
structure
20.7.2 Declarations
............................................................................................................................547
20.7.3 Variables
............................................................................................................................548
20.7.4 Predefined
............................................................................................................................549
variables
20.7.5 Creating............................................................................................................................550
output files
20.7.6 Operators
............................................................................................................................551
20.7.7 Conditions
............................................................................................................................551
20.7.8 foreach ............................................................................................................................552
20.7.9 Subroutines
............................................................................................................................553
............................................................................................................................
– Subroutine declaration 553
............................................................................................................................
– Subroutine invocation 554
............................................................................................................................
– Subroutine example 555
20.7.10 Built in............................................................................................................................556
Types
............................................................................................................................ 556
– Library
............................................................................................................................ 556
– Namespace
– Type............................................................................................................................ 557
– Member............................................................................................................................ 557

8 Altova XMLSpy 2011


............................................................................................................................ 558
– NativeBinding
– Facets ............................................................................................................................ 558
– Old object............................................................................................................................
model (up to v2007) 559
Namespace ....................................................................................................................... 559
Class ....................................................................................................................... 559
Member....................................................................................................................... 560
Facet ....................................................................................................................... 562
Enumeration ....................................................................................................................... 562
Pattern ....................................................................................................................... 562
.........................................................................................................................................563
20.8 Error Codes

21 User Reference 564


.........................................................................................................................................565
21.1 File Menu
21.1.1
New ............................................................................................................................565
21.1.2
Open ............................................................................................................................569
21.1.3
Reload ............................................................................................................................573
21.1.4
Encoding ............................................................................................................................573
21.1.5
Close, Close............................................................................................................................573
All
21.1.6
Save, Save ............................................................................................................................574
As, Save All
21.1.7
Send by............................................................................................................................579
Mail
21.1.8
Print ............................................................................................................................580
21.1.9
Print Preview,
............................................................................................................................581
Print Setup
21.1.10
Recent Files,
............................................................................................................................581
Exit
.........................................................................................................................................583
21.2 Edit Menu
21.2.1 Undo, Redo ............................................................................................................................584
21.2.2 Cut, Copy, ............................................................................................................................584
Paste, Delete
21.2.3 Copy as............................................................................................................................584
XML-Text
21.2.4 Copy as............................................................................................................................585
Structured Text
21.2.5 Insert File ............................................................................................................................587
Path
21.2.6 Insert XInclude
............................................................................................................................587
21.2.7 Copy XPath ............................................................................................................................589
21.2.8 Copy XPointer ............................................................................................................................589
21.2.9 Pretty-Print ............................................................................................................................590
XML Text
21.2.10 Select All ............................................................................................................................590
21.2.11 Find, Find ............................................................................................................................590
Next
21.2.12 Replace............................................................................................................................593
21.2.13 Find in ............................................................................................................................595
Files
21.2.14 Bookmark ............................................................................................................................597
Commands
21.2.15 Comment ............................................................................................................................597
In/Out
.........................................................................................................................................599
21.3 Project Menu
21.3.1 New Project ............................................................................................................................601
21.3.2 Open Project ............................................................................................................................601
21.3.3 Reload ............................................................................................................................601
Project
21.3.4 Close Project ............................................................................................................................601

Altova XMLSpy 2011 9


21.3.5 Save Project
............................................................................................................................601
21.3.6 Source Control
............................................................................................................................601
– Open............................................................................................................................
from Source Control 602
............................................................................................................................
– Enable Source Control 603
............................................................................................................................
– Get Latest Version 603
– Get ............................................................................................................................ 604
............................................................................................................................ 604
– Get Folders
– Check............................................................................................................................
Out 605
............................................................................................................................
– Check In 606
– Undo............................................................................................................................
Check Out 607
............................................................................................................................
– Add to Source Control 608
............................................................................................................................
– Remove from Source Control 608
– Share............................................................................................................................
from Source Control 609
............................................................................................................................
– Show History 610
– Show............................................................................................................................
Differences 611
............................................................................................................................
– Show Properties 612
............................................................................................................................
– Refresh Status 613
............................................................................................................................
– Source Control Manager 613
............................................................................................................................
– Change Source Control 613
21.3.7
Add Files ............................................................................................................................614
to Project
21.3.8
Add Global ............................................................................................................................614
Resource to Project
21.3.9
Add URL ............................................................................................................................614
to Project
21.3.10
Add Active ............................................................................................................................615
File to Project
21.3.11
Add Active ............................................................................................................................615
And Related Files to Project
21.3.12
Add Project ............................................................................................................................615
Folder to Project
21.3.13
Add External............................................................................................................................615
Folder to Project
21.3.14
Add External............................................................................................................................618
Web Folder to Project
21.3.15
Script Settings
............................................................................................................................622
21.3.16
Properties ............................................................................................................................622
21.3.17
Most Recently
............................................................................................................................624
Used Projects
.........................................................................................................................................625
21.4 XML Menu
21.4.1 Insert ............................................................................................................................625
– Insert............................................................................................................................
Attribute 626
............................................................................................................................
– Insert Element 626
– Insert............................................................................................................................
Text 626
............................................................................................................................
– Insert CDATA 627
– Insert............................................................................................................................
Comment 627
– Insert............................................................................................................................
XML 627
............................................................................................................................
– Insert Processing Instruction 627
– Insert............................................................................................................................
XInclude 627
............................................................................................................................
– Insert DOCTYPE 629
– Insert............................................................................................................................
ExternalID 630
............................................................................................................................
– Insert ELEMENT 630
– Insert............................................................................................................................
ATTLIST 631
– Insert............................................................................................................................
ENTITY 631

10 Altova XMLSpy 2011


– Insert............................................................................................................................
NOTATION 631
21.4.2 Append............................................................................................................................631
............................................................................................................................
– Append Attribute 632
............................................................................................................................
– Append Element 632
............................................................................................................................
– Append Text 632
............................................................................................................................
– Append CDATA 633
............................................................................................................................
– Append Comment 633
............................................................................................................................
– Append XML 633
............................................................................................................................
– Append Processing Instruction 633
............................................................................................................................
– Append XInclude 633
............................................................................................................................
– Append DOCTYPE 635
............................................................................................................................
– Append ExternalID 636
............................................................................................................................
– Append ELEMENT 636
............................................................................................................................
– Append ATTLIST 637
............................................................................................................................
– Append ENTITY 637
............................................................................................................................
– Append NOTATION 637
21.4.3 Add Child
............................................................................................................................637
............................................................................................................................
– Add Child Attribute 638
............................................................................................................................
– Add Child Element 638
............................................................................................................................
– Add Child Text 638
............................................................................................................................
– Add Child CDATA 638
............................................................................................................................
– Add Child Comment 639
............................................................................................................................
– Add Child XML 639
............................................................................................................................
– Add Child Processing Instruction 639
............................................................................................................................
– Add Child XInclude 639
............................................................................................................................
– Add Child DOCTYPE 641
............................................................................................................................
– Add Child ExternalID 641
............................................................................................................................
– Add Child ELEMENT 642
............................................................................................................................
– Add Child ATTLIST 642
............................................................................................................................
– Add Child ENTITY 642
............................................................................................................................
– Add Child NOTATION 642
21.4.4 Convert............................................................................................................................643
To
............................................................................................................................
– Convert To Attribute 643
............................................................................................................................
– Convert To Element 643
............................................................................................................................
– Convert To Text 643
............................................................................................................................
– Convert To CDATA 643
............................................................................................................................
– Convert To Comment 644
............................................................................................................................
– Convert To XML 644
............................................................................................................................
– Convert To Processing Instruction 644
............................................................................................................................
– Convert To DOCTYPE 644
............................................................................................................................
– Convert To ExternalID 644
............................................................................................................................
– Convert To ELEMENT 644
............................................................................................................................
– Convert To ATTLIST 644
............................................................................................................................
– Convert To ENTITY 644
............................................................................................................................
– Convert To NOTATION 645

Altova XMLSpy 2011 11


21.4.5 Table ............................................................................................................................645
............................................................................................................................
– Display as Table 645
– Insert............................................................................................................................
Row 646
............................................................................................................................
– Append Row 646
............................................................................................................................
– Ascending Sort 646
............................................................................................................................
– Descending Sort 647
21.4.6
Move Left ............................................................................................................................647
21.4.7
Move Right ............................................................................................................................647
21.4.8
Enclose............................................................................................................................648
in Element
21.4.9
Evaluate............................................................................................................................648
XPath
21.4.10
Check Well-Formedness
............................................................................................................................648
21.4.11
Validate............................................................................................................................649
XML
21.4.12
Validating ............................................................................................................................652
WSDL Files
21.4.13
Update ............................................................................................................................653
Entry Helpers
21.4.14
Namespace ............................................................................................................................653
Prefix.
.........................................................................................................................................655
21.5 DTD/Schema Menu
21.5.1 Assign DTD ............................................................................................................................655
21.5.2 Assign Schema ............................................................................................................................656
21.5.3 Include ............................................................................................................................656
Another DTD
21.5.4 Go to DTD ............................................................................................................................656
21.5.5 Go to Schema ............................................................................................................................656
21.5.6 Go to Definition
............................................................................................................................657
21.5.7 Generate ............................................................................................................................657
DTD/Schema
21.5.8 Convert............................................................................................................................659
DTD/Schema
21.5.9 Convert............................................................................................................................661
to UML
21.5.10 Generate ............................................................................................................................663
XML from DB, Excel, EDI with MapForce
21.5.11 Design ............................................................................................................................663
HTML/PDF/Word Output in StyleVision...
21.5.12 Generate ............................................................................................................................663
Sample XML File
21.5.13 Generate ............................................................................................................................664
Program Code
21.5.14 Flush Memory ............................................................................................................................665
Cache
21.6 Schema .........................................................................................................................................666
Design Menu
21.6.1 Schema............................................................................................................................666
Settings
21.6.2 Save Diagram ............................................................................................................................668
21.6.3 Generate ............................................................................................................................668
Documentation
21.6.4 Configure ............................................................................................................................671
View
21.6.5 Zoom ............................................................................................................................674
21.6.6 Display............................................................................................................................675
All Globals
21.6.7 Display............................................................................................................................675
Diagram
21.6.8 Schema............................................................................................................................675
Extensions for Databases
– Enable ............................................................................................................................
Oracle Schema Extensions 675
............................................................................................................................
– Oracle Schema Settings 676
– Enable ............................................................................................................................
Microsoft SQL Server Schema Extensions 676
............................................................................................................................
– Named Schema Relationships 677
– Unnamed ............................................................................................................................
Element Relationships 678
21.6.9 Connect............................................................................................................................678
to SchemaAgent Server

12 Altova XMLSpy 2011


21.6.10
Disconnect ............................................................................................................................679
from SchemaAgent Server
21.6.11
Show in............................................................................................................................679
SchemaAgent
21.6.12
SchemaAgent ............................................................................................................................680
Validation
21.6.13
Create Schema
............................................................................................................................680
Subset
21.6.14
Flatten Schema
............................................................................................................................681
.........................................................................................................................................683
21.7 XSL/XQuery Menu
21.7.1 XSL Transformation
............................................................................................................................684
21.7.2 XSL-FO............................................................................................................................685
Transformation
21.7.3 XSL Parameters............................................................................................................................686
/ XQuery Variables
21.7.4 XQuery............................................................................................................................690
Execution
21.7.5 Enable XSLT/XQuery
............................................................................................................................690
Profiling
21.7.6 Assign XSL ............................................................................................................................690
21.7.7 Assign XSL-FO ............................................................................................................................691
21.7.8 Assign Sample ............................................................................................................................691
XML File
21.7.9 Go to XSL ............................................................................................................................691
21.7.10 Start Debugger
............................................................................................................................691
/ Go
21.7.11 Stop Debugger............................................................................................................................692
21.7.12 Restart ............................................................................................................................692
Debugger
21.7.13 End Debugger ............................................................................................................................692
Session
21.7.14 Step Into ............................................................................................................................692
21.7.15 Step Out............................................................................................................................692
21.7.16 Step Over ............................................................................................................................692
21.7.17 Show Current ............................................................................................................................693
Execution Node
21.7.18 Insert/Remove............................................................................................................................693
Breakpoint
21.7.19 Insert/Remove............................................................................................................................693
Tracepoint
21.7.20 Enable/Disable
............................................................................................................................693
Breakpoint
21.7.21 Enable/Disable
............................................................................................................................694
Tracepoint
21.7.22 Breakpoints/Tracepoints
............................................................................................................................694
21.7.23 Debug Windows............................................................................................................................695
21.7.24 XSLT/XQuery ............................................................................................................................695
Settings
.........................................................................................................................................696
21.8 Authentic Menu
21.8.1 New Document ............................................................................................................................696
21.8.2 Edit Database ............................................................................................................................697
Data
21.8.3 Assign/Edit ............................................................................................................................698
a StyleVision Stylesheet
21.8.4 Select New ............................................................................................................................698
Row with XML Data for Editing
21.8.5 Define XML ............................................................................................................................699
Entities
21.8.6 Hide Markup, ............................................................................................................................701
Show Small/Large/Mixed Markup
21.8.7 Append/Insert/Duplicate/Delete
............................................................................................................................701
Row
21.8.8 Move Row ............................................................................................................................702
Up/Down
21.9 DB Menu .........................................................................................................................................703
21.9.1 Connecting ............................................................................................................................703
to a Data Source
– Connection............................................................................................................................
Wizard 705
............................................................................................................................
– Existing Connections 706
– ADO............................................................................................................................
Connections 707
– ODBC ............................................................................................................................
Connections 711

Altova XMLSpy 2011 13


............................................................................................................................
– Global Resources 714
21.9.2 Query Database
............................................................................................................................714
– Data ............................................................................................................................
Sources 716
............................................................................................................................
– Browser Pane: Viewing the DB Objects 717
– Query............................................................................................................................
Pane: Description and Features 721
– Query............................................................................................................................
Pane: Working with Queries 724
............................................................................................................................
– Results and Messages 724
21.9.3 IBM DB2
............................................................................................................................727
............................................................................................................................
– Manage XML Schemas 727
............................................................................................................................
– Assign XML Schema 730
21.9.4 SQL Server
............................................................................................................................732
............................................................................................................................
– Manage XML Schemas 732
21.9.5 Oracle XML
............................................................................................................................734
DB
............................................................................................................................
– Manage XML Schemas 735
............................................................................................................................
– Browse Oracle XML documents 737
21.10 Convert .........................................................................................................................................739
Menu
21.10.1
Import Text ............................................................................................................................739
File
21.10.2
Import Database
............................................................................................................................741
Data
21.10.3
Import Microsoft
............................................................................................................................745
Word Document
21.10.4
Create XML ............................................................................................................................746
Schema from DB Structure
21.10.5
DB Import ............................................................................................................................750
Based on XML Schema
21.10.6
Create DB ............................................................................................................................751
Structure from XML Schema
21.10.7
Export to ............................................................................................................................754
Text Files
21.10.8
Export to ............................................................................................................................757
a Database
21.10.9
Convert............................................................................................................................759
XML to/from JSON
.........................................................................................................................................761
21.11 View Menu
21.11.1 Text View ............................................................................................................................761
21.11.2 Grid View ............................................................................................................................761
21.11.3 Schema............................................................................................................................761
Design View
21.11.4 WSDL ............................................................................................................................762
Design View
21.11.5 XBRL Taxonomy............................................................................................................................762
View
21.11.6 Authentic ............................................................................................................................762
View
21.11.7 Browser............................................................................................................................762
View
21.11.8 Expand............................................................................................................................762
21.11.9 Collapse............................................................................................................................763
21.11.10 Expand............................................................................................................................763
Fully
21.11.11 Collapse............................................................................................................................763
Unselected
21.11.12 Optimal............................................................................................................................763
Widths
21.11.13 Word Wrap ............................................................................................................................763
21.11.14 Go to Line/Character
............................................................................................................................764
21.11.15 Go to File ............................................................................................................................764
21.11.16 Text View ............................................................................................................................764
Settings
21.12 Browser.........................................................................................................................................766
Menu
21.12.1 Back ............................................................................................................................766
21.12.2 Forward............................................................................................................................766

14 Altova XMLSpy 2011


21.12.3
Stop ............................................................................................................................766
21.12.4
Refresh............................................................................................................................766
21.12.5
Fonts ............................................................................................................................766
21.12.6
Separate............................................................................................................................766
Window
.........................................................................................................................................768
21.13 WSDL Menu
21.13.1 WSDL ............................................................................................................................768
1.1 Components
– Messages ............................................................................................................................ 768
– Operations............................................................................................................................ 769
– PortType ............................................................................................................................ 769
– Binding ............................................................................................................................ 769
– Service ............................................................................................................................ 770
21.13.2 WSDL ............................................................................................................................770
2.0 Components
............................................................................................................................ 770
– Interface
............................................................................................................................ 772
– Binding
............................................................................................................................ 772
– Service
21.13.3
Types ............................................................................................................................773
21.13.4
Save Diagram,
............................................................................................................................773
Generate Documentation
21.13.5
Reparse............................................................................................................................775
WSDL Document
21.13.6
Convert............................................................................................................................775
to WSDL 2.0
21.13.7
Generate ............................................................................................................................775
WSDL Program Code with MapForce
.........................................................................................................................................776
21.14 SOAP Menu
21.14.1 Create New ............................................................................................................................776
SOAP Request
21.14.2 Send Request ............................................................................................................................778
to Server
21.14.3 Change............................................................................................................................779
SOAP Request Parameters
21.14.4 Soap Debugger............................................................................................................................780
Session
21.14.5 Go ............................................................................................................................781
21.14.6 Single Step ............................................................................................................................781
21.14.7 Break on ............................................................................................................................781
Next Request
21.14.8 Break on ............................................................................................................................782
Next Response
21.14.9 Stop the............................................................................................................................782
Proxy Server
21.14.10 Soap Debugger
............................................................................................................................782
Options
.........................................................................................................................................783
21.15 XBRL Menu
21.15.1 Arcroles............................................................................................................................783
21.15.2 Linkroles ............................................................................................................................785
21.15.3 Namespace ............................................................................................................................786
Prefixes
21.15.4 Set Target ............................................................................................................................787
Namespace
21.15.5 Import/Reference
............................................................................................................................787
21.15.6 Generate ............................................................................................................................788
Documentation
21.15.7 View Settings............................................................................................................................790
21.15.8 Generate ............................................................................................................................791
XBRL from DB, Excel, CSV with MapForce
21.15.9 Present ............................................................................................................................791
XBRL as HTML/PDF/Word with StyleVision
.........................................................................................................................................792
21.16 Tools Menu
21.16.1 Spelling............................................................................................................................792
21.16.2 Spelling............................................................................................................................794
Options
21.16.3 Scripting ............................................................................................................................798
Editor

Altova XMLSpy 2011 15


21.16.4 Macros............................................................................................................................798
21.16.5 Comparisons
............................................................................................................................798
............................................................................................................................
– Compare Open File With 798
............................................................................................................................
– Compare Directories 800
............................................................................................................................
– Compare Options 803
21.16.6 Global Resources
............................................................................................................................805
21.16.7 Active Configuration
............................................................................................................................805
21.16.8 Customize
............................................................................................................................806
............................................................................................................................ 806
– Commands
............................................................................................................................ 807
– Toolbars
............................................................................................................................ 808
– Keyboard
– Menu............................................................................................................................ 813
............................................................................................................................ 815
– Macros
............................................................................................................................ 816
– Plug-Ins
............................................................................................................................ 817
– Options
............................................................................................................................
– Customize Context Menu 818
21.16.9 Restore............................................................................................................................820
Toolbars and Windows
21.16.10 Options............................................................................................................................820
– File ............................................................................................................................ 820
............................................................................................................................ 822
– File Types
............................................................................................................................ 823
– Editing
– View............................................................................................................................ 824
– Grid ............................................................................................................................
Fonts 825
............................................................................................................................
– Schema Fonts 826
............................................................................................................................
– WSDL Fonts 826
– XBRL ............................................................................................................................
Fonts 827
............................................................................................................................
– Text Fonts 828
............................................................................................................................ 829
– Colors
............................................................................................................................ 831
– Encoding
– XSL ............................................................................................................................ 831
............................................................................................................................ 833
– Scripting
............................................................................................................................
– Source Control 834
21.17 Window.........................................................................................................................................836
Menu
21.17.1
Cascade............................................................................................................................836
21.17.2
Tile Horizontally
............................................................................................................................836
21.17.3
Tile Vertically
............................................................................................................................836
21.17.4
Project ............................................................................................................................836
Window
21.17.5
Info Window ............................................................................................................................836
21.17.6
Entry Helpers
............................................................................................................................837
21.17.7
Output Windows
............................................................................................................................837
21.17.8
Project ............................................................................................................................837
and Entry Helpers
21.17.9
All On/Off ............................................................................................................................837
21.17.10
Currently ............................................................................................................................837
Open Window List
.........................................................................................................................................838
21.18 Help Menu
21.18.1 Table of............................................................................................................................838
Contents

16 Altova XMLSpy 2011


21.18.2 Index ............................................................................................................................838
21.18.3 Search ............................................................................................................................838
21.18.4 Keyboard
............................................................................................................................839
Map
21.18.5 Activation,
............................................................................................................................839
Order Form, Registration, Updates
21.18.6 Support............................................................................................................................840
Center, FAQ, Downloads
21.18.7 On the Internet
............................................................................................................................841
21.18.8 About ............................................................................................................................841

Programmers' Reference 844

1 Release Notes 845

2 Scripting 847
2.1 .........................................................................................................................................849
Overview
2.1.1 Scripting ............................................................................................................................849
Projects in XMLSpy
2.1.2 The Scripting
............................................................................................................................851
Editor GUI
2.1.3 Components ............................................................................................................................854
of a Scripting Project
2.2 Creating.........................................................................................................................................856
a Scripting Project
2.3 .........................................................................................................................................857
Global Declarations
2.4 Forms .........................................................................................................................................859
2.4.1 Creating............................................................................................................................859
a New Form
2.4.2 Form Design ............................................................................................................................860
and Form Objects
2.4.3 Form Events ............................................................................................................................862
2.5 Events .........................................................................................................................................865
2.6 Macros .........................................................................................................................................868
2.6.1 Creating............................................................................................................................868
and Editing a Macro
2.6.2 Running............................................................................................................................869
a Macro
2.6.3 Debugging ............................................................................................................................871
a Macro
2.7 .........................................................................................................................................872
Programming Points
2.7.1 Built-in............................................................................................................................872
Commands
– Form............................................................................................................................
usage and commands 874
2.8 .........................................................................................................................................876
Migrating to Scripting Editor 2010 and Later

3 Plugins 879
3.1 .........................................................................................................................................880
Registration of IDE PlugIns
3.2 ActiveX.........................................................................................................................................881
Controls
3.3 .........................................................................................................................................882
Configuration XML
3.4 .........................................................................................................................................885
ATL sample files

Altova XMLSpy 2011 17


3.4.1 Interface ............................................................................................................................885
description (IDL)
3.4.2 Class definition
............................................................................................................................887
3.4.3 Implementation
............................................................................................................................887
3.5 .........................................................................................................................................890
IXMLSpyPlugIn
3.5.1 OnCommand ............................................................................................................................890
3.5.2 OnUpdateCommand
............................................................................................................................891
3.5.3 OnEvent............................................................................................................................891
3.5.4 GetUIModifications
............................................................................................................................893
3.5.5 GetDescription
............................................................................................................................894

4 The XMLSpy API 895


4.1 .........................................................................................................................................896
Overview
4.1.1 Object model............................................................................................................................896
4.1.2 Simple ............................................................................................................................897
document access
4.1.3 Error handling
............................................................................................................................898
4.1.4 Events ............................................................................................................................900
4.1.5 Import and ............................................................................................................................903
export of data
4.1.6 Using XMLData
............................................................................................................................906
to modify document structure
4.1.7 The DOM ............................................................................................................................909
and XMLData
4.1.8 Obsolete ............................................................................................................................911
Authentic View Row operations
4.1.9 Obsolete ............................................................................................................................912
Authentic View Editing operations
4.2 .........................................................................................................................................914
Usage Examples
4.2.1 JScript:............................................................................................................................914
Bubble Sort Dynamic Tables
4.2.2 VBScript: ............................................................................................................................915
Using object-level events
4.3 .........................................................................................................................................918
Interfaces
4.3.1 Application ............................................................................................................................918
– Events ............................................................................................................................ 920
OnBeforeOpenDocument
....................................................................................................................... 920
OnBeforeOpenProject
....................................................................................................................... 920
OnDocumentOpened
....................................................................................................................... 921
OnProjectOpened
....................................................................................................................... 921
............................................................................................................................
– ActiveDocument 922
............................................................................................................................ 922
– AddMacroMenuItem
............................................................................................................................ 922
– Application
............................................................................................................................ 922
– ClearMacroMenu
............................................................................................................................ 923
– CreateXMLSchemaFromDBStructure
............................................................................................................................ 923
– CurrentProject
– Dialogs ............................................................................................................................ 923
– Documents ............................................................................................................................ 924
– Edition ............................................................................................................................ 924
............................................................................................................................ 924
– FindInFiles
............................................................................................................................ 924
– GetDatabaseImportElementList
............................................................................................................................ 925
– GetDatabaseSettings
............................................................................................................................ 925
– GetDatabaseTables

18 Altova XMLSpy 2011


............................................................................................................................ 926
– GetExportSettings
............................................................................................................................ 926
– GetTextImportElementList
............................................................................................................................ 927
– GetTextImportExportSettings
............................................................................................................................ 927
– ImportFromDatabase
............................................................................................................................ 928
– ImportFromSchema
............................................................................................................................ 929
– ImportFromText
............................................................................................................................ 930
– ImportFromWord
............................................................................................................................ 930
– IsAPISupported
............................................................................................................................ 930
– MajorVersion
............................................................................................................................ 930
– MinorVersion
............................................................................................................................ 931
– NewProject
............................................................................................................................ 931
– OpenProject
............................................................................................................................ 931
– Parent
– Quit ............................................................................................................................ 932
............................................................................................................................ 932
– ReloadSettings
............................................................................................................................ 932
– RunMacro
............................................................................................................................ 933
– ScriptingEnvironment
............................................................................................................................ 933
– ServicePackVersion
............................................................................................................................ 933
– ShowApplication
............................................................................................................................ 933
– ShowFindInFiles
............................................................................................................................ 934
– ShowForm
– Status............................................................................................................................ 934
............................................................................................................................ 934
– URLDelete
............................................................................................................................ 935
– URLMakeDirectory
............................................................................................................................ 935
– Visible
............................................................................................................................ 935
– WarningNumber
............................................................................................................................ 935
– WarningText
4.3.2 AuthenticContextMenu
............................................................................................................................936
............................................................................................................................ 936
– CountItems
............................................................................................................................ 936
– DeleteItem
............................................................................................................................ 936
– GetItemText
............................................................................................................................ 936
– InsertItem
............................................................................................................................ 937
– SetItemText
4.3.3 AuthenticDataTransfer
............................................................................................................................937
............................................................................................................................ 938
– dropEffect
............................................................................................................................ 938
– getData
............................................................................................................................ 938
– ownDrag
– type ............................................................................................................................ 938
4.3.4 AuthenticEventContext
............................................................................................................................939
............................................................................................................................ 939
– EvaluateXPath
............................................................................................................................ 939
– GetEventContextType
............................................................................................................................ 940
– GetNormalizedTextValue
............................................................................................................................ 940
– GetVariableValue
............................................................................................................................ 940
– GetXMLNode
............................................................................................................................ 940
– IsAvailable

Altova XMLSpy 2011 19


............................................................................................................................ 941
– SetVariableValue
4.3.5 AuthenticRange
............................................................................................................................941
............................................................................................................................ 943
– AppendRow
............................................................................................................................ 943
– Application
............................................................................................................................ 943
– CanPerformAction
............................................................................................................................ 944
– CanPerformActionWith
– Clone............................................................................................................................ 944
............................................................................................................................ 945
– CollapsToBegin
............................................................................................................................ 945
– CollapsToEnd
– Copy............................................................................................................................ 945
– Cut ............................................................................................................................ 945
............................................................................................................................ 946
– Delete
............................................................................................................................ 946
– DeleteRow
............................................................................................................................ 946
– DuplicateRow
............................................................................................................................ 947
– EvaluateXPath
............................................................................................................................ 947
– ExpandTo
............................................................................................................................ 948
– FirstTextPosition
............................................................................................................................ 948
– FirstXMLData
............................................................................................................................ 949
– FirstXMLDataOffset
............................................................................................................................ 950
– GetElementAttributeNames
............................................................................................................................ 950
– GetElementAttributeValue
............................................................................................................................ 951
– GetElementHierarchy
............................................................................................................................ 952
– GetEntityNames
............................................................................................................................ 952
– GetVariableValue
– Goto............................................................................................................................ 952
............................................................................................................................ 953
– GotoNext
............................................................................................................................ 953
– GotoNextCursorPosition
............................................................................................................................ 954
– GotoPrevious
............................................................................................................................ 954
– GotoPreviousCursorPosition
............................................................................................................................ 955
– HasElementAttribute
............................................................................................................................ 955
– InsertEntity
............................................................................................................................ 956
– InsertRow
............................................................................................................................ 956
– IsCopyEnabled
............................................................................................................................ 956
– IsCutEnabled
............................................................................................................................ 957
– IsDeleteEnabled
............................................................................................................................ 957
– IsEmpty
............................................................................................................................ 957
– IsEqual
............................................................................................................................ 957
– IsFirstRow
............................................................................................................................ 958
– IsInDynamicTable
............................................................................................................................ 958
– IsLastRow
............................................................................................................................ 958
– IsPasteEnabled
............................................................................................................................ 958
– IsSelected
............................................................................................................................ 959
– IsTextStateApplied
............................................................................................................................ 959
– LastTextPosition
............................................................................................................................ 960
– LastXMLData

20 Altova XMLSpy 2011


............................................................................................................................ 960
– LastXMLDataOffset
............................................................................................................................ 961
– MoveBegin
............................................................................................................................ 962
– MoveEnd
............................................................................................................................ 962
– MoveRowDown
............................................................................................................................ 962
– MoveRowUp
............................................................................................................................ 963
– Parent
– Paste............................................................................................................................ 963
............................................................................................................................ 963
– PerformAction
– Select............................................................................................................................ 964
............................................................................................................................ 964
– SelectNext
............................................................................................................................ 965
– SelectPrevious
............................................................................................................................ 966
– SetElementAttributeValue
............................................................................................................................ 967
– SetFromRange
............................................................................................................................ 967
– SetVariableValue
– Text ............................................................................................................................ 967
4.3.6 AuthenticView
............................................................................................................................968
............................................................................................................................ 969
– Events
OnBeforeCopy
....................................................................................................................... 969
OnBeforeCut
....................................................................................................................... 969
OnBeforeDelete
....................................................................................................................... 970
OnBeforeDrop
....................................................................................................................... 970
OnBeforePaste
....................................................................................................................... 971
OnBeforeSave
....................................................................................................................... 972
OnDragOver....................................................................................................................... 972
OnKeyboardEvent
....................................................................................................................... 973
OnLoad....................................................................................................................... 974
OnMouseEvent
....................................................................................................................... 975
OnSelectionChanged
....................................................................................................................... 976
OnToolbarButtonClicked
....................................................................................................................... 977
OnToolbarButtonExecuted
....................................................................................................................... 978
OnUserAddedXMLNode
....................................................................................................................... 978
– ............................................................................................................................
Application 979
– ............................................................................................................................ 979
AsXMLString
– ............................................................................................................................ 979
ContextMenu
– ............................................................................................................................ 979
CreateXMLNode
– ............................................................................................................................ 980
DisableAttributeEntryHelper
– ............................................................................................................................ 980
DisableElementEntryHelper
– ............................................................................................................................ 980
DisableEntityEntryHelper
– ............................................................................................................................ 980
DocumentBegin
– ............................................................................................................................ 981
DocumentEnd
– ............................................................................................................................ 981
DoNotPerformStandardAction
– ............................................................................................................................ 981
EvaluateXPath
– Event............................................................................................................................ 981
– ............................................................................................................................ 982
EventContext
– ............................................................................................................................ 982
GetToolbarButtonState

Altova XMLSpy 2011 21


– Goto............................................................................................................................ 982
............................................................................................................................ 983
– IsRedoEnabled
............................................................................................................................ 983
– IsUndoEnabled
............................................................................................................................ 983
– MarkupVisibility
............................................................................................................................ 984
– Parent
– Print............................................................................................................................ 984
– Redo............................................................................................................................ 984
............................................................................................................................ 985
– Selection
............................................................................................................................ 985
– SetToolbarButtonState
– Undo............................................................................................................................ 986
............................................................................................................................ 986
– UpdateXMLInstanceEntities
............................................................................................................................ 986
– WholeDocument
............................................................................................................................ 987
– XMLDataRoot
4.3.7 CodeGeneratorDlg
............................................................................................................................987
............................................................................................................................ 988
– Application
............................................................................................................................ 988
– CompatibilityMode
............................................................................................................................ 988
– CPPSettings_DOMType
............................................................................................................................ 989
– CPPSettings_GenerateVC6ProjectFile
............................................................................................................................ 989
– CPPSettings_GenerateGCCMakefile
............................................................................................................................ 989
– CPPSettings_GenerateVSProjectFile
............................................................................................................................ 989
– CPPSettings_LibraryType
............................................................................................................................ 990
– CPPSettings_UseMFC
............................................................................................................................ 990
– CSharpSettings_ProjectType
............................................................................................................................ 990
– OutputPath
............................................................................................................................ 990
– OutputPathDialogAction
............................................................................................................................ 991
– OutputResultDialogAction
............................................................................................................................ 991
– Parent
............................................................................................................................ 991
– ProgrammingLanguage
............................................................................................................................ 992
– PropertySheetDialogAction
............................................................................................................................ 992
– TemplateFileName
4.3.8 DatabaseConnection
............................................................................................................................992
............................................................................................................................ 993
– ADOConnection
............................................................................................................................ 993
– AsAttributes
............................................................................................................................ 994
– CommentIncluded
............................................................................................................................ 994
– CreateMissingTables
............................................................................................................................ 994
– CreateNew
............................................................................................................................ 994
– DatabaseKind
............................................................................................................................ 995
– DatabaseSchema
............................................................................................................................ 995
– ExcludeKeys
– File ............................................................................................................................ 995
............................................................................................................................ 995
– ForeignKeys
............................................................................................................................ 996
– ImportColumnsType
............................................................................................................................ 996
– IncludeEmptyElements
............................................................................................................................ 996
– NullReplacement
............................................................................................................................ 996
– NumberDateTimeFormat

22 Altova XMLSpy 2011


............................................................................................................................ 997
– ODBCConnection
............................................................................................................................ 997
– PrimaryKeys
............................................................................................................................ 997
– SchemaExtensionType
............................................................................................................................ 997
– SchemaFormat
............................................................................................................................ 998
– SQLSelect
............................................................................................................................ 998
– TextFieldLen
............................................................................................................................ 998
– UniqueKeys
4.3.9 Dialogs............................................................................................................................998
............................................................................................................................ 999
– Application
............................................................................................................................ 999
– CodeGeneratorDlg
............................................................................................................................ 999
– FileSelectionDlg
............................................................................................................................ 1000
– Parent
............................................................................................................................ 1000
– SchemaDocumentationDlg
............................................................................................................................ 1000
– GenerateSampleXMLDlg
............................................................................................................................ 1000
– DTDSchemaGeneratorDlg
............................................................................................................................ 1001
– FindInFilesDlg
............................................................................................................................ 1001
– WSDLDocumentationDlg
............................................................................................................................ 1001
– WSDL20DocumentationDlg
............................................................................................................................ 1001
– XBRLDocumentationDlg
4.3.10 Document
............................................................................................................................1002
............................................................................................................................ 1003
– Events
OnBeforeSaveDocument
....................................................................................................................... 1003
OnBeforeCloseDocument
....................................................................................................................... 1004
OnBeforeValidate
....................................................................................................................... 1005
OnCloseDocument
....................................................................................................................... 1005
OnViewActivation
....................................................................................................................... 1006
– ............................................................................................................................
Application 1006
– ............................................................................................................................ 1006
AssignDTD
– ............................................................................................................................ 1007
AssignSchema
– ............................................................................................................................ 1007
AssignXSL
– ............................................................................................................................ 1007
AssignXSLFO
– ............................................................................................................................ 1007
AsXMLString
– ............................................................................................................................ 1008
AuthenticView
– ............................................................................................................................ 1008
Close
– ............................................................................................................................ 1009
ConvertDTDOrSchema
– ............................................................................................................................ 1009
ConvertDTDOrSchemaEx
– ............................................................................................................................ 1010
ConvertToWSDL20
– ............................................................................................................................ 1010
CreateChild
– ............................................................................................................................ 1010
CreateDBStructureFromXMLSchema
– ............................................................................................................................ 1011
CreateSchemaDiagram
– ............................................................................................................................ 1011
CurrentViewMode
– ............................................................................................................................ 1011
DataRoot
– ............................................................................................................................ 1012
DocEditView
– ............................................................................................................................ 1012
Encoding
– ............................................................................................................................ 1013
EndChanges

Altova XMLSpy 2011 23


............................................................................................................................ 1013
– ExecuteXQuery
............................................................................................................................ 1013
– ExportToDatabase
............................................................................................................................ 1014
– ExportToText
............................................................................................................................ 1015
– FullName
............................................................................................................................ 1015
– GenerateDTDOrSchema
............................................................................................................................ 1016
– GenerateDTDOrSchemaEx
............................................................................................................................ 1016
– GenerateProgramCode
............................................................................................................................ 1016
– GenerateSampleXML
............................................................................................................................ 1016
– GenerateSchemaDocumentation
............................................................................................................................ 1017
– GenerateWSDL20Documentation
............................................................................................................................ 1017
– GenerateWSDLDocumentation
............................................................................................................................ 1018
– GenerateXBRLDocumentation
............................................................................................................................ 1018
– GetDBStructureList
............................................................................................................................ 1018
– GetExportElementList
............................................................................................................................
– GetPathName (obsolete) 1019
............................................................................................................................
– GridView 1019
............................................................................................................................ 1019
– IsModified
............................................................................................................................ 1020
– IsValid
............................................................................................................................ 1021
– IsWellFormed
– Name............................................................................................................................ 1021
............................................................................................................................ 1022
– Parent
– Path............................................................................................................................ 1022
............................................................................................................................ 1022
– RootElement
– Save............................................................................................................................ 1022
............................................................................................................................ 1023
– SaveAs
............................................................................................................................ 1023
– Saved
............................................................................................................................ 1023
– SaveInString
............................................................................................................................ 1024
– SaveToURL
............................................................................................................................ 1024
– SetActiveDocument
............................................................................................................................
– SetEncoding (obsolete) 1024
............................................................................................................................ 1026
– SetExternalIsValid
............................................................................................................................
– SetPathName (obsolete) 1026
............................................................................................................................ 1026
– StartChanges
............................................................................................................................ 1027
– Suggestions
............................................................................................................................ 1027
– SwitchViewMode
............................................................................................................................ 1027
– TextView
– Title............................................................................................................................ 1027
............................................................................................................................ 1028
– TransformXSL
............................................................................................................................ 1028
– TransformXSLEx
............................................................................................................................ 1028
– TransformXSLFO
............................................................................................................................
– TreatXBRLInconsistencies AsErrors 1028
............................................................................................................................ 1029
– UpdateViews
............................................................................................................................ 1029
– UpdateXMLData
4.3.11 Documents
............................................................................................................................1029
............................................................................................................................ 1030
– Count

24 Altova XMLSpy 2011


– Item............................................................................................................................ 1030
............................................................................................................................ 1030
– NewFile
............................................................................................................................ 1031
– NewFileFromText
............................................................................................................................ 1031
– OpenFile
............................................................................................................................ 1031
– OpenURL
............................................................................................................................ 1032
– OpenURLDialog
4.3.12 DTDSchemaGeneratorDlg
............................................................................................................................1033
............................................................................................................................ 1033
– Application
............................................................................................................................ 1033
– AttributeTypeDefinition
............................................................................................................................ 1033
– DTDSchemaFormat
............................................................................................................................ 1034
– FrequentElements
............................................................................................................................ 1034
– GlobalAttributes
............................................................................................................................ 1034
– MaxEnumLength
............................................................................................................................ 1034
– MergeAllEqualNamed
............................................................................................................................ 1035
– OnlyStringEnums
............................................................................................................................ 1035
– OutputPath
............................................................................................................................ 1035
– OutputPathDialogAction
............................................................................................................................ 1035
– Parent
............................................................................................................................ 1035
– ResolveEntities
............................................................................................................................ 1036
– TypeDetection
............................................................................................................................ 1036
– ValueList
4.3.13 ElementList
............................................................................................................................1036
............................................................................................................................ 1037
– Count
– Item............................................................................................................................ 1037
............................................................................................................................ 1037
– RemoveElement
4.3.14 ElementListItem
............................................................................................................................1037
............................................................................................................................ 1037
– ElementKind
............................................................................................................................ 1038
– FieldCount
– Name............................................................................................................................ 1038
............................................................................................................................ 1038
– RecordCount
4.3.15 ExportSettings
............................................................................................................................1038
............................................................................................................................ 1039
– CreateKeys
............................................................................................................................ 1039
– ElementList
............................................................................................................................ 1039
– EntitiesToText
............................................................................................................................ 1039
– ExportAllElements
............................................................................................................................ 1039
– ExportCompleteXML
............................................................................................................................ 1040
– FromAttributes
............................................................................................................................ 1040
– FromSingleSubElements
............................................................................................................................ 1040
– FromTextValues
............................................................................................................................ 1040
– IndependentPrimaryKey
............................................................................................................................ 1040
– Namespace
............................................................................................................................ 1040
– StartFromElement
............................................................................................................................ 1041
– SubLevelLimit
4.3.16 FileSelectionDlg
............................................................................................................................1041
............................................................................................................................ 1041
– Application

Altova XMLSpy 2011 25


............................................................................................................................ 1042
– DialogAction
............................................................................................................................ 1042
– FullName
............................................................................................................................ 1042
– Parent
4.3.17 FindInFilesDlg
............................................................................................................................1042
............................................................................................................................ 1043
– AdvancedXMLSearch
............................................................................................................................ 1043
– Application
............................................................................................................................ 1043
– DoReplace
............................................................................................................................ 1044
– FileExtension
– Find............................................................................................................................ 1044
............................................................................................................................ 1044
– IncludeSubfolders
............................................................................................................................ 1044
– MatchCase
............................................................................................................................ 1044
– MatchWholeWord
............................................................................................................................ 1045
– Parent
............................................................................................................................ 1045
– RegularExpression
............................................................................................................................ 1045
– Replace
............................................................................................................................ 1045
– ReplaceOnDisk
............................................................................................................................ 1045
– SearchInProjectFilesDoExternal
............................................................................................................................ 1046
– SearchLocation
............................................................................................................................ 1046
– ShowResult
............................................................................................................................ 1046
– StartFolder
............................................................................................................................ 1046
– XMLAttributeContents
............................................................................................................................ 1046
– XMLAttributeNames
............................................................................................................................ 1047
– XMLCData
............................................................................................................................ 1047
– XMLComments
............................................................................................................................ 1047
– XMLElementContents
............................................................................................................................ 1047
– XMLElementNames
............................................................................................................................ 1048
– XMLPI
............................................................................................................................ 1048
– XMLRest
4.3.18 FindInFilesResult
............................................................................................................................1048
............................................................................................................................ 1048
– Application
............................................................................................................................ 1049
– Count
............................................................................................................................ 1049
– Document
– Item............................................................................................................................ 1049
............................................................................................................................ 1049
– Parent
– Path............................................................................................................................ 1049
4.3.19 FindInFilesResultMatch
............................................................................................................................1049
............................................................................................................................ 1050
– Application
............................................................................................................................ 1050
– Length
– Line............................................................................................................................ 1050
............................................................................................................................ 1050
– LineText
............................................................................................................................ 1051
– Parent
............................................................................................................................ 1051
– Position
............................................................................................................................ 1051
– Replaced
4.3.20 FindInFilesResults
............................................................................................................................1051
............................................................................................................................ 1052
– Application

26 Altova XMLSpy 2011


............................................................................................................................ 1052
– Count
– Item............................................................................................................................ 1052
............................................................................................................................ 1052
– Parent
4.3.21 GenerateSampleXMLDlg
............................................................................................................................1052
............................................................................................................................ 1053
– Application
............................................................................................................................ 1053
– Parent
............................................................................................................................ 1053
– NonMandatoryAttributes
............................................................................................................................
– NonMandatoryElements - obsolete 1053
............................................................................................................................
– TakeFirstChoice - obsolete 1054
............................................................................................................................ 1054
– RepeatCount
............................................................................................................................
– FillWithSampleData - obsolete 1054
............................................................................................................................ 1054
– FillElementsWithSampleData
............................................................................................................................ 1054
– FillAttributesWithSampleData
............................................................................................................................ 1055
– ContentOfNillableElementsIsNonMandatory
............................................................................................................................ 1055
– TryToUseNonAbstractTypes
............................................................................................................................ 1055
– Optimization
............................................................................................................................ 1055
– SchemaOrDTDAssignment
............................................................................................................................ 1055
– LocalNameOfRootElement
............................................................................................................................ 1056
– NamespaceURIOfRootElement
............................................................................................................................ 1056
– OptionsDialogAction
4.3.22 GridView
............................................................................................................................1056
............................................................................................................................ 1056
– Events
OnBeforeDrag
....................................................................................................................... 1056
OnBeforeDrop
....................................................................................................................... 1057
OnBeforeStartEditing
....................................................................................................................... 1057
OnEditingFinished
....................................................................................................................... 1058
OnFocusChanged
....................................................................................................................... 1058
– ............................................................................................................................ 1059
CurrentFocus
– ............................................................................................................................ 1059
Deselect
– ............................................................................................................................ 1059
IsVisible
– ............................................................................................................................ 1059
Select
– ............................................................................................................................ 1059
SetFocus
4.3.23 SchemaDocumentationDlg
............................................................................................................................1060
............................................................................................................................ 1061
– AllDetails
............................................................................................................................ 1061
– Application
............................................................................................................................ 1061
– CreateDiagramsFolder
............................................................................................................................ 1062
– DiagramFormat
............................................................................................................................ 1062
– EmbedCSSInHTML
............................................................................................................................ 1062
– EmbedDiagrams
............................................................................................................................ 1062
– GenerateRelativeLinks
............................................................................................................................ 1063
– IncludeAll
............................................................................................................................ 1063
– IncludeAttributeGroups
............................................................................................................................ 1063
– IncludeComplexTypes
............................................................................................................................ 1064
– IncludeGlobalAttributes
............................................................................................................................ 1064
– IncludeGlobalElements

Altova XMLSpy 2011 27


............................................................................................................................ 1064
– IncludeGroups
............................................................................................................................ 1064
– IncludeIndex
............................................................................................................................ 1065
– IncludeLocalAttributes
............................................................................................................................ 1065
– IncludeLocalElements
............................................................................................................................ 1065
– IncludeRedefines
............................................................................................................................ 1065
– IncludeReferencedSchemas
............................................................................................................................ 1066
– IncludeSimpleTypes
............................................................................................................................ 1066
– MultipleOutputFiles
............................................................................................................................ 1066
– OptionsDialogAction
............................................................................................................................ 1067
– OutputFileDialogAction
............................................................................................................................ 1067
– OutputFormat
............................................................................................................................ 1067
– Parent
............................................................................................................................ 1067
– SetOutputFile
............................................................................................................................ 1068
– ShowAnnotations
............................................................................................................................ 1068
– ShowAttributes
............................................................................................................................ 1068
– ShowChildren
............................................................................................................................ 1069
– ShowDiagram
............................................................................................................................ 1069
– ShowEnumerations
............................................................................................................................ 1069
– ShowIdentityConstraints
............................................................................................................................ 1069
– ShowNamespace
............................................................................................................................ 1070
– ShowPatterns
............................................................................................................................ 1070
– ShowProgressBar
............................................................................................................................ 1070
– ShowProperties
............................................................................................................................ 1071
– ShowResult
............................................................................................................................ 1071
– ShowSingleFacets
............................................................................................................................ 1071
– ShowSourceCode
............................................................................................................................ 1071
– ShowType
............................................................................................................................ 1072
– ShowUsedBy
4.3.24 SpyProject
............................................................................................................................1072
............................................................................................................................ 1072
– CloseProject
............................................................................................................................ 1073
– ProjectFile
............................................................................................................................ 1073
– RootItems
............................................................................................................................ 1073
– SaveProject
............................................................................................................................ 1073
– SaveProjectAs
4.3.25 SpyProjectItem
............................................................................................................................1073
............................................................................................................................ 1074
– ChildItems
............................................................................................................................ 1074
– FileExtensions
............................................................................................................................ 1074
– ItemType
– Name............................................................................................................................ 1074
– Open............................................................................................................................ 1075
............................................................................................................................ 1075
– ParentItem
– Path............................................................................................................................ 1075
............................................................................................................................ 1075
– ValidateWith
............................................................................................................................ 1075
– XMLForXSLTransformation
............................................................................................................................ 1075
– XSLForXMLTransformation

28 Altova XMLSpy 2011


............................................................................................................................ 1076
– XSLTransformationFileExtension
............................................................................................................................ 1076
– XSLTransformationFolder
4.3.26 SpyProjectItems
............................................................................................................................1076
............................................................................................................................ 1076
– AddFile
............................................................................................................................ 1077
– AddFolder
............................................................................................................................ 1077
– AddURL
............................................................................................................................ 1077
– Count
– Item............................................................................................................................ 1077
............................................................................................................................ 1078
– RemoveItem
4.3.27 TextImportExportSettings
............................................................................................................................1078
............................................................................................................................ 1078
– CommentIncluded
............................................................................................................................ 1078
– DestinationFolder
............................................................................................................................ 1079
– EnclosingCharacter
............................................................................................................................ 1079
– Encoding
............................................................................................................................ 1079
– EncodingByteOrder
............................................................................................................................ 1079
– FieldDelimiter
............................................................................................................................ 1079
– FileExtension
............................................................................................................................ 1079
– HeaderRow
............................................................................................................................ 1080
– ImportFile
............................................................................................................................ 1080
– RemoveDelimiter
............................................................................................................................ 1080
– RemoveNewline
4.3.28 TextView
............................................................................................................................1080
............................................................................................................................ 1081
– Events
OnBeforeShowSuggestions
....................................................................................................................... 1081
OnChar ....................................................................................................................... 1081
............................................................................................................................ 1082
– Application
............................................................................................................................ 1082
– GetRangeText
............................................................................................................................ 1082
– GoToLineChar
............................................................................................................................ 1083
– Length
............................................................................................................................ 1083
– LineCount
............................................................................................................................ 1083
– LineFromPosition
............................................................................................................................ 1083
– LineLength
............................................................................................................................ 1083
– MoveCaret
............................................................................................................................ 1084
– Parent
............................................................................................................................ 1084
– PositionFromLine
............................................................................................................................ 1084
– ReplaceText
............................................................................................................................ 1084
– SelectionEnd
............................................................................................................................ 1084
– SelectionStart
............................................................................................................................ 1085
– SelectText
............................................................................................................................ 1085
– SelText
– Text............................................................................................................................ 1085
4.3.29 WSDL20DocumentationDlg
............................................................................................................................1085
............................................................................................................................ 1086
– AllDetails
............................................................................................................................ 1086
– Application
............................................................................................................................ 1087
– CreateDiagramsFolder

Altova XMLSpy 2011 29


............................................................................................................................ 1087
– DiagramFormat
............................................................................................................................ 1087
– EmbedCSSInHTML
............................................................................................................................ 1088
– EmbedDiagrams
............................................................................................................................ 1088
– IncludeAll
............................................................................................................................ 1088
– IncludeBinding
............................................................................................................................ 1088
– IncludeImportedWSDLFiles
............................................................................................................................ 1089
– IncludeInterface
............................................................................................................................ 1089
– IncludeOverview
............................................................................................................................ 1089
– IncludeService
............................................................................................................................ 1089
– IncludeTypes
............................................................................................................................ 1090
– MultipleOutputFiles
............................................................................................................................ 1090
– OptionsDialogAction
............................................................................................................................ 1090
– OutputFile
............................................................................................................................ 1091
– OutputFileDialogAction
............................................................................................................................ 1091
– OutputFormat
............................................................................................................................ 1091
– Parent
............................................................................................................................ 1091
– ShowBindingDiagram
............................................................................................................................ 1092
– ShowEndpoint
............................................................................................................................ 1092
– ShowExtensibility
............................................................................................................................ 1092
– ShowFault
............................................................................................................................ 1093
– ShowInterfaceDiagram
............................................................................................................................ 1093
– ShowOperation
............................................................................................................................ 1093
– ShowProgressBar
............................................................................................................................ 1093
– ShowResult
............................................................................................................................ 1094
– ShowServiceDiagram
............................................................................................................................ 1094
– ShowSourceCode
............................................................................................................................ 1094
– ShowTypesDiagram
............................................................................................................................ 1095
– ShowUsedBy
4.3.30 WSDLDocumentationDlg
............................................................................................................................1095
............................................................................................................................ 1096
– AllDetails
............................................................................................................................ 1096
– Application
............................................................................................................................ 1096
– CreateDiagramsFolder
............................................................................................................................ 1097
– DiagramFormat
............................................................................................................................ 1097
– EmbedCSSInHTML
............................................................................................................................ 1097
– EmbedDiagrams
............................................................................................................................ 1098
– IncludeAll
............................................................................................................................ 1098
– IncludeBinding
............................................................................................................................ 1098
– IncludeImportedWSDLFiles
............................................................................................................................ 1098
– IncludeMessages
............................................................................................................................ 1099
– IncludeOverview
............................................................................................................................ 1099
– IncludePortType
............................................................................................................................ 1099
– IncludeService
............................................................................................................................ 1099
– IncludeTypes
............................................................................................................................ 1100
– MultipleOutputFiles
............................................................................................................................ 1100
– OptionsDialogAction

30 Altova XMLSpy 2011


............................................................................................................................ 1100
– OutputFile
............................................................................................................................ 1101
– OutputFileDialogAction
............................................................................................................................ 1101
– OutputFormat
............................................................................................................................ 1101
– Parent
............................................................................................................................ 1101
– ShowBindingDiagram
............................................................................................................................ 1102
– ShowExtensibility
............................................................................................................................ 1102
– ShowMessageParts
............................................................................................................................ 1102
– ShowPort
............................................................................................................................ 1103
– ShowPortTypeDiagram
............................................................................................................................ 1103
– ShowPortTypeOperations
............................................................................................................................ 1103
– ShowProgressBar
............................................................................................................................ 1103
– ShowResult
............................................................................................................................ 1104
– ShowServiceDiagram
............................................................................................................................ 1104
– ShowSourceCode
............................................................................................................................ 1104
– ShowTypesDiagram
............................................................................................................................ 1105
– ShowUsedBy
4.3.31 XBRLDocumentationDlg
............................................................................................................................1105
............................................................................................................................ 1106
– AllDetails
............................................................................................................................ 1106
– Application
............................................................................................................................ 1106
– CreateDiagramsFolder
............................................................................................................................ 1107
– DiagramFormat
............................................................................................................................ 1107
– EmbedCSSInHTML
............................................................................................................................ 1107
– EmbedDiagrams
............................................................................................................................ 1108
– IncludeAll
............................................................................................................................ 1108
– IncludeCalculationLinkroles
............................................................................................................................ 1108
– IncludeDefinitionLinkroles
............................................................................................................................ 1108
– IncludeGlobalElements
............................................................................................................................ 1109
– IncludeNamespacePrefixes
............................................................................................................................ 1109
– IncludeOverview
............................................................................................................................ 1109
– IncludePresentationLinkroles
............................................................................................................................ 1109
– OptionsDialogAction
............................................................................................................................ 1110
– OutputFile
............................................................................................................................ 1110
– OutputFileDialogAction
............................................................................................................................ 1110
– OutputFormat
............................................................................................................................ 1111
– Parent
............................................................................................................................ 1111
– ShortQualifiedName
............................................................................................................................ 1111
– ShowAbstract
............................................................................................................................ 1111
– ShowBalance
............................................................................................................................ 1112
– ShowDiagram
............................................................................................................................ 1112
– ShowImportedElements
............................................................................................................................ 1112
– ShowItemtype
............................................................................................................................ 1113
– ShowLabels
............................................................................................................................ 1113
– ShowLinkbaseReferences
............................................................................................................................ 1113
– ShowNillable
............................................................................................................................ 1113
– ShowPeriod

Altova XMLSpy 2011 31


............................................................................................................................ 1114
– ShowProgressBar
............................................................................................................................ 1114
– ShowReferences
............................................................................................................................ 1114
– ShowResult
............................................................................................................................ 1115
– ShowSubstitutiongroup
4.3.32 XMLData
............................................................................................................................1115
............................................................................................................................ 1116
– AppendChild
............................................................................................................................ 1117
– CountChildren
............................................................................................................................ 1117
– CountChildrenKind
............................................................................................................................ 1117
– EraseAllChildren
............................................................................................................................ 1118
– EraseChild
............................................................................................................................ 1118
– EraseCurrentChild
............................................................................................................................ 1119
– GetChild
............................................................................................................................ 1119
– GetChildAttribute
............................................................................................................................ 1119
– GetChildElement
............................................................................................................................ 1119
– GetChildKind
............................................................................................................................ 1120
– GetCurrentChild
............................................................................................................................ 1120
– GetFirstChild
............................................................................................................................ 1121
– GetNamespacePrefixForURI
............................................................................................................................ 1121
– GetNextChild
............................................................................................................................ 1122
– GetTextValueXMLDecoded
............................................................................................................................ 1122
– HasChildren
............................................................................................................................ 1122
– HasChildrenKind
............................................................................................................................ 1123
– InsertChild
............................................................................................................................ 1123
– InsertChildAfter
............................................................................................................................ 1123
– InsertChildBefore
............................................................................................................................ 1124
– IsSameNode
– Kind............................................................................................................................ 1124
............................................................................................................................ 1124
– MayHaveChildren
– Name............................................................................................................................ 1124
............................................................................................................................ 1125
– Parent
............................................................................................................................ 1125
– SetTextValueXMLDecoded
............................................................................................................................ 1125
– TextValue
4.4 .........................................................................................................................................1126
Interfaces (obsolete)
4.4.1 AuthenticEvent
............................................................................................................................1126
(obsolete)
............................................................................................................................
– altKey (obsolete) 1127
............................................................................................................................
– altLeft (obsolete) 1128
............................................................................................................................
– button (obsolete) 1129
............................................................................................................................
– cancelBubble (obsolete) 1130
............................................................................................................................
– clientX (obsolete) 1131
............................................................................................................................
– clientY (obsolete) 1132
............................................................................................................................
– ctrlKey (obsolete) 1133
............................................................................................................................
– ctrlLeft (obsolete) 1134
............................................................................................................................
– dataTransfer (obsolete) 1135
............................................................................................................................
– fromElement (obsolete) 1136
............................................................................................................................
– keyCode (obsolete) 1136

32 Altova XMLSpy 2011


............................................................................................................................
– propertyName (obsolete) 1137
............................................................................................................................
– repeat (obsolete) 1137
............................................................................................................................
– returnValue (obsolete) 1137
............................................................................................................................
– shiftKey (obsolete) 1138
............................................................................................................................
– shiftLeft (obsolete) 1139
............................................................................................................................
– srcElement (obsolete) 1140
............................................................................................................................
– type (obsolete) 1141
4.4.2 AuthenticSelection
............................................................................................................................1142
(obsolete)
............................................................................................................................
– End (obsolete) 1143
............................................................................................................................
– EndTextPosition (obsolete) 1143
............................................................................................................................
– Start (obsolete) 1144
............................................................................................................................
– StartTextPosition (obsolete) 1144
4.4.3 OldAuthentictView
............................................................................................................................1145
(obsolete)
............................................................................................................................
– ApplyTextState (obsolete) 1147
............................................................................................................................
– CurrentSelection (obsolete) 1148
............................................................................................................................
– EditClear (obsolete) 1148
............................................................................................................................
– EditCopy (obsolete) 1149
............................................................................................................................
– EditCut (obsolete) 1149
............................................................................................................................
– EditPaste (obsolete) 1150
............................................................................................................................
– EditRedo (obsolete) 1150
............................................................................................................................
– EditSelectAll (obsolete) 1151
............................................................................................................................
– EditUndo (obsolete) 1151
............................................................................................................................
– event (obsolete) 1152
............................................................................................................................
– GetAllowedElements (obsolete) 1152
............................................................................................................................
– GetNextVisible (obsolete) 1155
............................................................................................................................
– GetPreviousVisible (obsolete) 1156
............................................................................................................................
– IsEditClearEnabled (obsolete) 1157
............................................................................................................................
– IsEditCopyEnabled (obsolete) 1157
............................................................................................................................
– IsEditCutEnabled (obsolete) 1158
............................................................................................................................
– IsEditPasteEnabled (obsolete) 1158
............................................................................................................................
– IsEditRedoEnabled (obsolete) 1159
............................................................................................................................
– IsEditUndoEnabled (obsolete) 1159
............................................................................................................................
– IsRowAppendEnabled (obsolete) 1160
............................................................................................................................
– IsRowDeleteEnabled (obsolete) 1160
............................................................................................................................
– IsRowDuplicateEnabled (obsolete) 1161
............................................................................................................................
– IsRowInsertEnabled (obsolete) 1161
............................................................................................................................
– IsRowMoveDownEnabled (obsolete) 1162
............................................................................................................................
– IsRowMoveUpEnabled (obsolete) 1162
............................................................................................................................
– IsTextStateApplied (obsolete) 1163
............................................................................................................................
– IsTextStateEnabled (obsolete) 1163
............................................................................................................................
– LoadXML (obsolete) 1164
............................................................................................................................
– MarkUpView (obsolete) 1164
............................................................................................................................
– RowAppend (obsolete) 1166
............................................................................................................................
– RowDelete (obsolete) 1166
............................................................................................................................
– RowDuplicate (obsolete) 1167

Altova XMLSpy 2011 33


............................................................................................................................
– RowInsert (obsolete) 1167
............................................................................................................................
– RowMoveDown (obsolete) 1168
............................................................................................................................
– RowMoveUp (obsolete) 1168
............................................................................................................................
– SaveXML (obsolete) 1169
............................................................................................................................
– SelectionMoveTabOrder (obsolete) 1170
............................................................................................................................
– SelectionSet (obsolete) 1171
............................................................................................................................
– XMLRoot (obsolete) 1172
4.5 .........................................................................................................................................1174
Enumerations
4.5.1 ENUMApplicationStatus
............................................................................................................................1174
4.5.2 SPYAttributeTypeDefinition
............................................................................................................................1174
4.5.3 SPYAuthenticActions
............................................................................................................................1174
4.5.4 SPYAuthenticDocumentPosition
............................................................................................................................1174
4.5.5 SPYAuthenticElementActions
............................................................................................................................1175
4.5.6 SPYAuthenticElementKind
............................................................................................................................1175
4.5.7 SPYAuthenticMarkupVisibility
............................................................................................................................1175
4.5.8 SPYAuthenticToolbarButtonState
............................................................................................................................1175
4.5.9 SPYDatabaseKind
............................................................................................................................1176
4.5.10 SPYDialogAction
............................................................................................................................1176
4.5.11 SPYDOMType ............................................................................................................................1176
4.5.12 SPYDTDSchemaFormat
............................................................................................................................1176
4.5.13 SPYEncodingByteOrder
............................................................................................................................1176
4.5.14 SPYExportNamespace
............................................................................................................................1177
4.5.15 SPYFindInFilesSearchLocation
............................................................................................................................1177
4.5.16 SPYFrequentElements
............................................................................................................................1177
4.5.17 SPYImageKind............................................................................................................................1177
4.5.18 SPYImportColumnsType
............................................................................................................................1177
4.5.19 SPYKeyEvent ............................................................................................................................1178
4.5.20 SPYKeyStatus............................................................................................................................1178
4.5.21 SPYLibType ............................................................................................................................1178
4.5.22 SPYLoading ............................................................................................................................1178
4.5.23 SPYMouseEvent
............................................................................................................................1178
4.5.24 SPYNumberDateTimeFormat
............................................................................................................................1179
4.5.25 SPYProgrammingLanguage
............................................................................................................................1179
4.5.26 SPYProjectItemTypes
............................................................................................................................1179
4.5.27 SPYProjectType
............................................................................................................................1180
4.5.28 SPYSampleXMLGenerationOptimization
............................................................................................................................1180
4.5.29 SPYSampleXMLGenerationSchemaOrDTDAssignment
............................................................................................................................1180
4.5.30 SPYSchemaDefKind
............................................................................................................................1180
4.5.31 SPYSchemaDocumentationFormat
............................................................................................................................1181
4.5.32 SPYSchemaExtensionType
............................................................................................................................1181
4.5.33 SPYSchemaFormat
............................................................................................................................1181
4.5.34 SPYTextDelimiters
............................................................................................................................1181
4.5.35 SPYTextEnclosing
............................................................................................................................1182
4.5.36 SPYTypeDetection
............................................................................................................................1182
4.5.37 SPYURLTypes ............................................................................................................................1182

34 Altova XMLSpy 2011


4.5.38 SPYViewModes
............................................................................................................................1182
4.5.39 SPYVirtualKeyMask
............................................................................................................................1183
4.5.40 SPYXMLDataKind
............................................................................................................................1183

5 Using the XMLSpy API with Java 1185


5.1 Sample.........................................................................................................................................1187
source code
5.2 .........................................................................................................................................1189
SpyApplication
5.3 .........................................................................................................................................1190
SpyCodeGeneratorDlg
5.4 .........................................................................................................................................1191
SpyDatabaseConnection
5.5 .........................................................................................................................................1192
SpyDialogs
5.6 SpyDoc.........................................................................................................................................1193
5.7 .........................................................................................................................................1195
SpyDocuments
5.8 .........................................................................................................................................1196
SpyDTDSchemaGeneratorDlg
5.9 .........................................................................................................................................1197
SpyElementList
5.10 .........................................................................................................................................1198
SpyElementListItem
5.11 .........................................................................................................................................1199
SpyExportSettings
5.12 .........................................................................................................................................1200
SpyFileSelectionDlg
5.13 .........................................................................................................................................1201
SpyFindInFilesDlg
5.14 .........................................................................................................................................1202
SpyFindInFilesMatch
5.15 .........................................................................................................................................1203
SpyFindInFilesResult
5.16 .........................................................................................................................................1204
SpyFindInFilesResults
5.17 .........................................................................................................................................1205
SpyGenerateSampleXMLDlg
5.18 .........................................................................................................................................1206
SpyGridView
5.19 .........................................................................................................................................1207
SpyProject
5.20 .........................................................................................................................................1208
SpyProjectItem
5.21 .........................................................................................................................................1209
SpyProjectItems
5.22 .........................................................................................................................................1210
SpySchemaDocumentationDlg
5.23 .........................................................................................................................................1212
SpyTextImportExportSettings
5.24 .........................................................................................................................................1213
SpyTextView
5.25 .........................................................................................................................................1214
SpyWSDL20DocumentationDlg
5.26 .........................................................................................................................................1216
SpyWSDLDocumentationDlg
5.27 .........................................................................................................................................1218
SpyXBRLDocumentationDlg
5.28 .........................................................................................................................................1220
SpyXMLData
5.29 .........................................................................................................................................1221
Authentic
5.29.1
SpyAuthenticRange
............................................................................................................................1221
5.29.2
SpyAuthenticView
............................................................................................................................1222
5.29.3
SpyDocEditSelection
............................................................................................................................1222
5.29.4
SpyDocEditView
............................................................................................................................1222
.........................................................................................................................................1224
5.30 Predefined constants
5.30.1 SPYApplicationStatus
............................................................................................................................1224
5.30.2 SPYAttributeTypeDefinition
............................................................................................................................1224
5.30.3 SPYAuthenticActions
............................................................................................................................1224
5.30.4 SPYAuthenticDocumentPosition
............................................................................................................................1224
5.30.5 SPYAuthenticElementKind
............................................................................................................................1225

Altova XMLSpy 2011 35


5.30.6 SPYAuthenticMarkupVisibility
............................................................................................................................1225
5.30.7 SPYDatabaseKind
............................................................................................................................1225
5.30.8 SPYDialogAction
............................................................................................................................1226
5.30.9 SPYDOMType
............................................................................................................................1226
5.30.10 SPYDTDSchemaFormat
............................................................................................................................1226
5.30.11 SPYEncodingByteOrder
............................................................................................................................1226
5.30.12 SPYExportNamespace
............................................................................................................................1227
5.30.13 SPYFindInFilesSearchLocation
............................................................................................................................1227
5.30.14 SPYFrequentElements
............................................................................................................................1227
5.30.15 SPYImageKind
............................................................................................................................1227
5.30.16 SPYImportColumnsType
............................................................................................................................1227
5.30.17 SPYLibType
............................................................................................................................1227
5.30.18 SPYLoading
............................................................................................................................1228
5.30.19 SPYNumberDateTimeFormat
............................................................................................................................1228
5.30.20 SPYProgrammingLanguage
............................................................................................................................1228
5.30.21 SPYProjectItemTypes
............................................................................................................................1228
5.30.22 SPYProjectType
............................................................................................................................1228
5.30.23 SPYSampleXMLGenerationOptimization
............................................................................................................................1229
5.30.24 SPYSampleXMLGenerationSchemaOrDTDAssignment
............................................................................................................................1229
5.30.25 SPYSchemaDefKind
............................................................................................................................1229
5.30.26 SPYSchemaDocumentationFormat
............................................................................................................................1230
5.30.27 SPYSchemaExtensionType
............................................................................................................................1230
5.30.28 SPYSchemaFormat
............................................................................................................................1230
5.30.29 SPYTextDelimiters
............................................................................................................................1230
5.30.30 SPYTextEnclosing
............................................................................................................................1231
5.30.31 SPYTypeDetection
............................................................................................................................1231
5.30.32 SPYURLTypes
............................................................................................................................1231
5.30.33 SpyViewModes
............................................................................................................................1231
5.30.34 SPYWhitespaceComparison
............................................................................................................................1232
5.30.35 SPYXMLDataKind
............................................................................................................................1232

6 XMLSpy Integration 1234


6.1 .........................................................................................................................................1235
Integration at Application Level
6.1.1 Example:
............................................................................................................................1235
HTML
............................................................................................................................
– Instantiate the Control 1235
............................................................................................................................
– Add Button to Open Default Document 1235
– Add............................................................................................................................
Buttons for Code Generation 1236
............................................................................................................................
– Connect to Custom Events 1237
6.2 .........................................................................................................................................1238
Integration at Document Level
6.2.1 Use XMLSpyControl
............................................................................................................................1238
6.2.2 Use XMLSpyControlDocument
............................................................................................................................1239
6.2.3 Use XMLSpyControlPlaceHolder
............................................................................................................................1239
6.2.4 Query ............................................................................................................................1239
XMLSpy Commands
6.2.5 Examples
............................................................................................................................1239

36 Altova XMLSpy 2011


– C# ............................................................................................................................ 1239
Introduction
....................................................................................................................... 1240
Placing.......................................................................................................................
the XMLSpyControl 1240
Adding.......................................................................................................................
the Document Control 1240
Adding.......................................................................................................................
the Placeholder Control 1240
Retrieving Command Information
....................................................................................................................... 1241
Handling Events
....................................................................................................................... 1242
Testing.......................................................................................................................
the Example 1243
– HTML ............................................................................................................................ 1244
Instantiate the XMLSpyControl
....................................................................................................................... 1244
Create.......................................................................................................................
Editor Window 1244
Create.......................................................................................................................
Project Window 1244
Create.......................................................................................................................
Placeholder for Helper Windows 1245
Create.......................................................................................................................
a Custom Toolbar 1245
Create.......................................................................................................................
More Buttons 1246
Create.......................................................................................................................
Event Handler to Update Button Status 1247
6.3 Command.........................................................................................................................................1249
Table for XMLSpy
6.3.1 File Menu ............................................................................................................................1249
6.3.2 Edit Menu ............................................................................................................................1250
6.3.3 Project............................................................................................................................1250
Menu
6.3.4 XML menu ............................................................................................................................1251
6.3.5 DTD/Schema............................................................................................................................1253
Menu
6.3.6 Schema ............................................................................................................................1253
Design Menu
6.3.7 XSL/XQuery............................................................................................................................1254
Menu
6.3.8 Authentic ............................................................................................................................1255
Menu
6.3.9 Convert ............................................................................................................................1256
Menu
6.3.10 View Menu ............................................................................................................................1256
6.3.11 Browser ............................................................................................................................1257
Menu
6.3.12 WSDL............................................................................................................................1257
Menu
6.3.13 SOAPMenu ............................................................................................................................1259
6.3.14 Tools ............................................................................................................................1259
Menu
6.3.15 Window ............................................................................................................................1260
Menu
6.3.16 Help Menu ............................................................................................................................1260
6.4 .........................................................................................................................................1261
Accessing XMLSpyAPI
6.5 .........................................................................................................................................1262
Object Reference
6.5.1 XMLSpyCommand
............................................................................................................................1262
............................................................................................................................ 1262
– Accelerator
– ID ............................................................................................................................ 1262
............................................................................................................................ 1263
– IsSeparator
– Label ............................................................................................................................ 1263
............................................................................................................................ 1263
– StatusText
............................................................................................................................ 1263
– SubCommands
– ToolTip ............................................................................................................................ 1263
6.5.2 XMLSpyCommands
............................................................................................................................1263
............................................................................................................................ 1264
– Count

Altova XMLSpy 2011 37


– Item............................................................................................................................ 1264
6.5.3 XMLSpyControl
............................................................................................................................1264
............................................................................................................................ 1265
– Properties
Appearance
....................................................................................................................... 1265
Application
....................................................................................................................... 1265
BorderStyle
....................................................................................................................... 1265
CommandsList
....................................................................................................................... 1265
EnableUserPrompts
....................................................................................................................... 1266
IntegrationLevel
....................................................................................................................... 1266
MainMenu ....................................................................................................................... 1266
Toolbars ....................................................................................................................... 1266
............................................................................................................................ 1267
– Methods
Exec ....................................................................................................................... 1267
Open ....................................................................................................................... 1267
QueryStatus
....................................................................................................................... 1267
............................................................................................................................
– Events 1268
OnCloseEditingWindow
....................................................................................................................... 1268
OnContextChanged
....................................................................................................................... 1268
OnDocumentOpened
....................................................................................................................... 1268
OnFileChangedAlert
....................................................................................................................... 1269
OnLicenseProblem
....................................................................................................................... 1269
OnOpenedOrFocused
....................................................................................................................... 1269
OnToolWindowUpdated
....................................................................................................................... 1269
OnUpdateCmdUI
....................................................................................................................... 1270
OnValidationWindowUpdated
....................................................................................................................... 1270
6.5.4 XMLSpyControlDocument
............................................................................................................................1270
............................................................................................................................ 1271
– Properties
Appearance
....................................................................................................................... 1271
BorderStyle
....................................................................................................................... 1271
Document ....................................................................................................................... 1271
IsModified
....................................................................................................................... 1271
Path ....................................................................................................................... 1272
ReadOnly ....................................................................................................................... 1272
............................................................................................................................
– Methods 1272
Exec ....................................................................................................................... 1272
New ....................................................................................................................... 1272
Open ....................................................................................................................... 1273
QueryStatus
....................................................................................................................... 1273
Reload....................................................................................................................... 1273
Save ....................................................................................................................... 1273
SaveAs....................................................................................................................... 1274
............................................................................................................................ 1274
– Events
OnActivate
....................................................................................................................... 1274
OnContextChanged
....................................................................................................................... 1274
OnDocumentClosed
....................................................................................................................... 1275

38 Altova XMLSpy 2011


OnDocumentOpened
....................................................................................................................... 1275
OnDocumentSaveAs
....................................................................................................................... 1275
OnFileChangedAlert
....................................................................................................................... 1275
OnModifiedFlagChanged
....................................................................................................................... 1275
OnSetEditorTitle
....................................................................................................................... 1276
6.5.5 XMLSpyControlPlaceHolder
............................................................................................................................1276
............................................................................................................................ 1276
– Properties
Label ....................................................................................................................... 1276
PlaceholderWindowID
....................................................................................................................... 1276
Project....................................................................................................................... 1277
............................................................................................................................ 1277
– Methods
OpenProject
....................................................................................................................... 1277
CloseProject
....................................................................................................................... 1277
............................................................................................................................
– Events 1277
OnModifiedFlagChanged
....................................................................................................................... 1278
OnSetLabel
....................................................................................................................... 1278
6.5.6 Enumerations
............................................................................................................................1278
............................................................................................................................ 1278
– ICActiveXIntegrationLevel
............................................................................................................................ 1278
– XMLSpyControlPlaceholderWindow

Appendices 1282

1 Engine Information 1283


1.1 .........................................................................................................................................1284
XSLT 1.0 Engine: Implementation Information
1.2 .........................................................................................................................................1286
XSLT 2.0 Engine: Implementation Information
1.2.1 General ............................................................................................................................1286
Information
1.2.2 XSLT ............................................................................................................................1288
2.0 Elements and Functions
1.3 XQuery.........................................................................................................................................1289
1.0 Engine: Implementation Information
1.4 .........................................................................................................................................1292
XPath 2.0 and XQuery 1.0 Functions
1.4.1 General ............................................................................................................................1292
Information
1.4.2 Functions ............................................................................................................................1293
Support
1.5 .........................................................................................................................................1296
Extensions
1.5.1 Java Extension
............................................................................................................................1296
Functions
............................................................................................................................
– User-Defined Class Files 1297
............................................................................................................................
– User-Defined Jar Files 1300
– Java: ............................................................................................................................
Constructors 1301
– Java: ............................................................................................................................
Static Methods and Static Fields 1301
............................................................................................................................
– Java: Instance Methods and Instance Fields 1302
............................................................................................................................
– Datatypes: XPath/XQuery to Java 1302
............................................................................................................................
– Datatypes: Java to XPath/XQuery 1303

Altova XMLSpy 2011 39


1.5.2 .NET Extension
............................................................................................................................1304
Functions
............................................................................................................................
– .NET: Constructors 1306
............................................................................................................................
– .NET: Static Methods and Static Fields 1306
............................................................................................................................
– .NET: Instance Methods and Instance Fields 1307
............................................................................................................................
– Datatypes: XPath/XQuery to .NET 1308
............................................................................................................................
– Datatypes: .NET to XPath/XQuery 1309
1.5.3 MSXSL ............................................................................................................................1309
Scripts for XSLT
1.5.4 Altova............................................................................................................................1311
Extension Functions
............................................................................................................................
– General Functions 1312
............................................................................................................................
– Chart Functions 1315
............................................................................................................................
– Chart Data XML Structure 1317
............................................................................................................................
– Example: Chart Functions 1322

2 Datatypes in DB-Generated XML Schemas 1325


2.1 .........................................................................................................................................1326
MS Access
2.2 MS SQL .........................................................................................................................................1327
Server
2.3 MySQL.........................................................................................................................................1328
2.4 Oracle .........................................................................................................................................1329
2.5 ODBC .........................................................................................................................................1330
2.6 ADO .........................................................................................................................................1331
2.7 Sybase .........................................................................................................................................1332

3 Datatypes in DBs Generated from XML Schemas 1333


3.1 .........................................................................................................................................1334
MS Access
3.2 MS SQL .........................................................................................................................................1336
Server
3.3 MySQL.........................................................................................................................................1338
3.4 Oracle .........................................................................................................................................1340

4 Technical Data 1342


4.1 OS and.........................................................................................................................................1343
Memory Requirements
4.2 Altova .........................................................................................................................................1344
XML Parser
4.3 Altova .........................................................................................................................................1345
XSLT and XQuery Engines
4.4 Unicode.........................................................................................................................................1346
Support
4.4.1 Windows ............................................................................................................................1346
XP
4.4.2 Right-to-Left
............................................................................................................................1347
Writing Systems
4.5 Internet.........................................................................................................................................1348
Usage

5 License Information 1349


5.1 .........................................................................................................................................1350
Electronic Software Distribution
5.2 .........................................................................................................................................1351
Software Activation and License Metering

40 Altova XMLSpy 2011


5.3 .........................................................................................................................................1352
Intellectual Property Rights
5.4 Altova .........................................................................................................................................1353
End User License Agreement

Index 1369

Altova XMLSpy 2011 41


Altova XMLSpy 2011

Welcome to XMLSpy
3

Welcome to XMLSpy

Altova XMLSpy® 2011 Enterprise Edition is the industry standard XML Development
Environment for designing, editing and debugging enterprise-class applications involving XML,
XML Schema, XSLT, XQuery, SOAP, WSDL and Web service technologies. It is the ultimate
productivity enhancer for J2EE, .NET and database developers. XMLSpy is available in 64-bit
and 32-bit versions.

This documentation is organized into the following sections:


 User Manual
 Programmers' Reference
 Appendices

It is available in the following formats:


 As the built-in Help system of XMLSpy (Help menu or F1)
 In HTML and PDF formats, and for purchase as a book, these formats being available
via the Altova website

Last updated: 9/2/2010

© 2010 Altova GmbH Welcome to XMLSpy


Altova XMLSpy 2011

User Manual
6

User Manual

The User Manual part of this documentation contains all the information you need to get started
using XMLSpy and to learn the various XMLSpy features. It is organized into four broad parts:
(i) an Introduction; (ii) a Tutorial; (iii) a Working With part; and (iv) a User Reference.

We suggest that you start by reading the Introduction in order to get a feel for the GUI and to
understand key application settings. If you are new to XML, the XMLSpy tutorial will help you not
only to get to know XMLSpy but also to easily create and use your first XML documents. After
that, you should read the Editing Views section and then the sections in the Working With part
that are of most interest to you. The User Reference part can be used thereafter as a reference.

Introduction
The introduction describes the GUI, important settings in the Options dialog, and the application
environment.

Tutorial
The XMLSpy tutorial helps you get started and shows you how to use the most common
XMLSpy features.

Working With
The Working With part of the documentation describes the functionality that XMLSpy offers for
working with various XML and XML-related technologies. It starts with a description of XMLSpy
's multiple editing views. The sections that immediately follow explain the functionality for each
technology separately. The Working With part concludes with a series of descriptions of
application-wide XMLSpy features, such as Altova Global Resources and projects. The sections
in the Working With part are:
 Editing Views: Describes the various editing views in XMLSpy
 XML: Explains the various features available for working with XML documents in
XMLSpy
 DTDs and XML Schemas: Shows how schemas (DTDs and XML Schemas) can be
edited and leveraged in XMLSpy
 XSLT and XQuery: Presents the range of features available for XSLT and XQuery
development
 Authentic: Explains the utility of Altova's graphical XML editor, and shows how it is used
 HTML, CSS, and JSON: Explores XMLSpy's support for HTML, CSS, and JSON
 WSDL and SOAP: Describes XMLSpy's mechanisms for working with these protocols
 XBRL: Describes how to work with the Taxonomy Editor in the XBRL View of XMLSpy
 Office Open XML and ZIP files: Presents and explains Archive View, in which
documents using these standards can be edited and managed
 Databases: Explores the wide range of features XMLSpy offers for interfacing XML with
databases
 Global Resources: Describes a unique Altova mechanism that can be used to boost
development efficiency when using Altova products, especially as a suite of products
 Projects: Explains XMLSpy's project mechanism, which enables increased efficiency
and additional development options
 File/Directory Comparisons: Presents XMLSpy's inbuilt comparison engine
 XMLSpy in Visual Studio: Describes integration in the Visual Studio developer platform
 XMLSpy in Eclipse: Describes integration in the Eclipse developer platform

Altova XMLSpy 2011 © 2010 Altova GmbH


7

 Code Generator: Explains the working of the built-in code-generator, which produces
program code for schema definitions

User Reference
The User Reference part is organized according to the menus in XMLSpy and describes each
menu command in detail.

© 2010 Altova GmbH User Manual


8 New Features

1 New Features
Features that are new in XMLSpy Version 2011 are listed below. Features that were new in
older versions are listed further below.

Version 2011
 In Schema View, creating Schema Subsets from the components of a single schema
file. A schema file can therefore easily be split up into subsets. The reverse process of
assimilating components from included schema subsets into the active file that is also
supported.
 Charts (such as pie charts and bar charts) that represent data in an XML document can
be generated for documents viewed in Text View and Grid View (Enterprise edition only
). Also, XSLT/XQuery Profiler results can also be reported in the form of charts (
Enterprise edition only).
 Validation of SOAP messages against WSDL. SOAP messages can be checked for
validity not only against the SOAP specification but as well as against any XML
Schemas referenced in the corresponding WSDL definition (Enterprise edition only).

Version 2010 Release 3


 Creating Schema Rules in Schema View for specifying additional schema constraints. (
Enterprise edition only.)
 Generate sample values in sample files that are generated from an XML Schema. (
Enterprise and Professional editions only.)
 Integration in Microsoft Visual Studio 2010. This extends support to the latest version of
Visual Studio, which is in addition to support for versions 2005 and 2008. Support for
Visual Studio 2003 has been discontinued. (Enterprise and Professional editions only.)

Version 2010 Release 2


 Optimizations for working with large files in Text View and Grid View
 Validation against XML Schemas up to three times faster in Text View
 SharePoint® server support enables files to be checked out and checked in directly
from within the XMLSpy interface.
 CSS and HTML Info windows provide a quick way, via the GUI, to link CSS and HTML
files and open them in various browsers and editors.
 Support for Linux in generated C++ code.
 64-bit versions of XMLSpy available in Enterprise and Professional Editions.

Altova XMLSpy 2011 © 2010 Altova GmbH


Introduction 9

2 Introduction
This introduction describes:
 The application GUI, and
 The application environment.

The GUI section starts off by presenting an overview of the GUI and then goes on to describe
each of the the various GUI windows in detail. It also shows you how to re-size, move, and
otherwise work with the windows and the GUI.

The Application Environment section points out the various settings that control how files are
displayed and can be edited. It also explains how and where you can customize your
application. In this section, you will learn where important example and tutorial files have been
installed on your machine, and, later in the section, you are linked to the Altova website, where
you can explore the feature matrix of your application, learn about the multiple formats of your
user manual, find out about the various support options available to you, and discover other
products in the Altova range.

© 2010 Altova GmbH User Manual


10 Introduction The Graphical User Interface (GUI)

2.1 The Graphical User Interface (GUI)


The Graphical User Interface (GUI) consists of a Main Window and several sidebars (see
illustration below). By default, the sidebars are located around the Main Window and are
organized into the following groups:
 Project Window
 Info Window
 Entry Helpers: Elements, Attributes, Entities, etc (depending upon the type of document
currently active)
 Output Windows: Messages, XPath, XSL Outline, Find in Files, Find in Schemas

The main window and sidebars are described in the sub-sections of this section.

The GUI also contains a menu bar, status bar, and toolbars, all of which are described in a
subsection of this section.

Switching on and off the display of sidebars


Sidebar groups (Project Window, Info Window, Entry Helpers, Output Windows) can be
displayed or hidden by toggling them on and off via the commands in the Window menu. A
displayed sidebar (or a group of tabbed sidebars) can also be hidden by right-clicking the title
bar of the displayed sidebar (or tabbed-sidebar group) and selecting the command Hide.

Floating and docking the sidebars


An individual sidebar window can either float free of the GUI or be docked within the GUI. When
a floating window is docked, it docks into its last docked position. A window can also be docked
as a tab within another window.

A window can be made to float or dock using one of the following methods:
 Right-click the title bar of a window and choose the required command (Floating or
Docking).

Altova XMLSpy 2011 © 2010 Altova GmbH


Introduction The Graphical User Interface (GUI) 11

 Double-click the title bar of the window. If docked, the window will now float. If floating,
the window will now dock in the last position in which it was docked.
 Drag the window (using its title bar as a handle) out of its docked position so that it
floats. Drag a floating window (by its title bar) to the location where it is to be docked.
Two sets of blue arrows appear. The outer set of four arrows enables docking relative
to the application window (along the top, right, bottom, or left edge of the GUI). The
inner set of arrows enables docking relative to the window over which the cursor is
currently placed. Dropping a dragged window on the button in the center of the inner set
of arrows (or on the title bar of a window) docks the dragged window as a tabbed
window within the window in which it is dropped.

To float a tabbed window, double-click its tab. To drag a tabbed window out of a group of
tabbed windows, drag its tab.

Auto-hiding sidebars
The Auto-hide feature enables you to minimize docked sidebars to buttons along the edges of
the application window. This gives you more screen space for the Main Window and other
sidebars. Scrolling over a minimized sidebar rolls out that sidebar.

To auto-hide and restore sidebars click the drawing pin icon in the title bar of the sidebar
window (or right-click the title bar and select Auto-Hide).

2.1.1 Main Window


The Main Window (screenshot below) is where you view and edit documents.

Files in the Main Window


 Any number of files can be opened and edited at once.
 Each open document has its own window and a tab with its name at the bottom of the
Main Window. To make an open document active, click its tab.
 If several files are open, some document tabs might not be visible for lack of space in
the document tabs bar. Document tabs can be brought into view by: (i) using the scroll
buttons at the right of the document tab bar, or (ii) selecting the required document from
the list at the bottom of the Window menu.
 When the active document is maximized, its Minimize, Restore, and Close buttons are
located at the right side of the Menu Bar. When a document is cascaded, tiled, or

© 2010 Altova GmbH User Manual


12 Introduction The Graphical User Interface (GUI)

minimized, the Maximize, Restore, and Close buttons are located in the title bar of the
document window.
 When you maximize one file, all open files are maximized.
 Open files can be cascaded or tiled using commands in the Window menu.
 You can also activate open files in the sequence in which they were opened by using
Ctrl+Tab or Ctrl+F6.
 Right-clicking a document tab opens a context-menu with a selection of File
commands, such as Print and Close.

Views in the Main Window


The active document can be displayed and edited in multiple views. The available views are
displayed in a bar above the document tabs (see illustration above), and the active view is
highlighted. A view is selected by clicking the required view button or by using the commands in
the View menu.

The available views are either editing or browser views:


 Text View: An editing view with syntax-coloring for source-level work.
 Grid View: For structured editing. The document is displayed as a structured grid,
which can be manipulated graphically. This view also contains an embedded Table
view, which shows repeating elements in a tabular format.
 Schema View: For viewing and editing XML Schemas.
 WSDL View: For viewing and editing WSDL documents.
 Authentic View: For editing XML documents that are based on StyleVision Power
Stylesheets
 Browser View: An integrated browser view that supports both CSS and XSL
stylesheets.

Note: The default view for individual file extensions can be customized in the Tools | Options
dialog: in the Default View pane of the File Types tab.

2.1.2 Project Window


A project is a collection of files that are related to each other in some way you determine. For
example, in the screenshot below, a project named Examples collects the files for various
examples in separate example folders, each of which can be further organized into sub-folders.
Within the Examples project, for instance, the OrgChart example folder is further organized into
sub-folders for XML, XSL, and Schema files.

Altova XMLSpy 2011 © 2010 Altova GmbH


Introduction The Graphical User Interface (GUI) 13

Projects thus enable you to gather together files that are used together and to access them
quicker. Additionally, you can define schemas and XSLT files for individual folders, thus
enabling the batch processing of files in a folder.

Project operations
Commands for folder operations are available in the Project menu, and some commands are
available in the context menus of the project and its folders (right-click to access).
 One project is open at a time in the Project Window. When a new project is created or
an existing project opened, it replaces the project currently open in the Project Window.
 After changes have been made to a project, the project must be saved (by clicking the
Project | Save Project command).
 The project has a tree structure composed of folders, files, and other resources. Such
resources can be added at any level and to an unlimited depth.
 Project folders are semantic folders that represent a logical grouping of files. They do
not need to correspond to any hierarchical organization of files on your hard disk.
 Folders can correspond to, and have a direct relationship to, physical directories on
your file system. We call such folders external folders, and they are indicated in the
Project Window by a yellow folder icon (as opposed to normal project folders, which are
green). External project folders must be explicitly synchronized by using the Refresh
command.
 A folder can contain an arbitrary mix of file-types. Alternatively, you can define file-type
extensions for each folder (in the Properties dialog of that folder) to keep common files
in one convenient place. When a file is added to the parent folder, it is automatically
added to the sub-folder that has been defined to contain files of that file extension.
 In the Project Window, a folder can be dragged to another folder or to another location
within the same folder, while a file can be dragged to another folder but cannot be
moved within the same folder (within which files are arranged alphabetically).
Additionally, files and folders can be dragged from Windows File Explorer to the Project
Window.
 Each folder has a set of properties that are defined in the Properties dialog of that

© 2010 Altova GmbH User Manual


14 Introduction The Graphical User Interface (GUI)

folder. These properties include file extensions for the folder, the schema by which to
validate XML files, the XSLT file with which to transform XML files, etc.
 Batch processing of files in a folder is done by right-clicking the folder and selecting the
relevant command from the context menu.

For a more detailed description of projects, see the section Projects.

Note: The display of the Project Window can be turned on and off in the Window menu.

2.1.3 Info Window


The Info Window (screenshot below) shows information about the element or attribute in which
the cursor is currently positioned.
 When an XSLT document is active, additional XSLT-specific information and
commands are available in the XSLT tab of the Info window (see XSLT tab in
screenshot below). How to read the information and use the commands in the XSLT
tab is explained in the section XSLT and XQ | XSLT | XSL Outline.
 When an XML Schema document (.xsd file) is active, options for enabling extended
validation are available in the Schema tab of the Info window. How to set up extended
validation is described in the section, Schema Rules.

Information is available in the Info Window in Text View, Grid View, and Authentic View.

Note: The display of the Info Window can be turned on and off in the Window menu.

2.1.4 Entry Helpers


Entry helpers are an intelligent editing feature that helps you to create valid XML documents
quickly. When you are editing a document, the entry helpers display structural editing options
according to the current location of the cursor. The entry helpers get the required information
from the underlying DTD, XML Schema, and/or StyleVision Power Stylesheet. If, for example,
you are editing an XML data document, then elements, attributes, and entities that can be
inserted at the current cursor position are displayed in the relevant entry helpers windows.

The entry helpers that are available depend upon:


1. The kind of document being edited. For example, XML documents will have different
entry helpers than XQuery documents: elements, attributes, and entities entry helpers in
the former case, but XQuery keywords, variables, and functions entry helpers in the
latter case. The available entry helpers for each document type are described in the
description of that document type.
2. The current view. Since the editing mechanisms in the different views are different, the
entry helpers are designed so as to be compatible with the editing mechanism in the
relevant views. For example: In Text View, an element can only be inserted at the

Altova XMLSpy 2011 © 2010 Altova GmbH


Introduction The Graphical User Interface (GUI) 15

cursor location point, so the entry helper is designed to insert an element when the
element is double-clicked. But in Grid View, an element can be inserted before the
selected node, appended after it, or added as a child node, so the Elements entry
helper in Grid View has three tabs for Insert, Append, and Add as Child, with each tab
containing the elements available for that particular operation.

A general description of entry helpers in each type of view is given in Editing Views. Further
document-type-related differences within a view are noted in the description of the individual
document types, for example XML entry helpers and XQuery entry helpers.

Note the following:


 You can turn the display of entry helpers on or off with the menu option Window | Entry
Helpers.
 In Visual Studio .NET, entry helper windows have a prefix that is the application name.

2.1.5 Output Window: Messages


The Messages Window displays messages about actions carried out in XMLSpy as well as
errors and other output. For example, if an XML, XML Schema, DTD, or XQuery document is
validated and is valid, a successful validation message (screenshot below) is displayed in the
Messages Window:

Otherwise, a message that describes the error (screenshot below) is displayed. Notice that
there are links (black link text) to nodes and node content in the XML document, as well as links
(blue link text) to the sections in the relevant specification on the Internet that describe the rule
in question. Clicking the purple Def buttons, opens the relevant schema definition in Schema
View.

© 2010 Altova GmbH User Manual


16 Introduction The Graphical User Interface (GUI)

The Messages Window is enabled in all views, but clicking a link to content in an XML
document highlights that node in the XML document in Text View. However, when an XML
Schema has been validated in Schema View, clicking a Def button does not change the view.

Note: The Validate command (in the XML menu) is normally applied to the active document.
But you can also apply the command to a file, folder, or group of files in the active
project. Select the required file or folder in the Project Window (by clicking on it), and
click XML | Validate or F8. Invalid files in a project will be opened and made active in
the Main Window, and the File Is Invalid error message will be displayed.

2.1.6 Output Window: XPath


The XPath Window enables you to evaluate up to nine XPath expressions, each in the context
of the currently active XML document. Additionally, an expression can be evaluated in: (i) all
currently open XML documents; (ii) XML files of the currently active XMLSpy project; and (iii)
XML files of a selected folder. This means that you can enter different XPath expressions in
different tabs and then evaluate each expression on multiple XML files at once.

Altova XMLSpy 2011 © 2010 Altova GmbH


Introduction The Graphical User Interface (GUI) 17

The XPath Window shows, in a single view: (i) the XML document; (ii) the XPath expression;
and (iii) the result of evaluating the XPath expression on the active XML document. The benefits
are that you can: (i) navigate the XML document while keeping the XPath expression and its
results in view; (ii) navigate the XML document by clicking items in the result; and (iii) modify the
XPath expression while keeping the XML document in view.

Steps for evaluating an XPath expression


Given below are the main steps required to use the XPath Window.
1. Depending on where the XPath expression is to be evaluated, select from one of the
options in the Where options list (screenshot below): Current file; Open files; (XMLSpy)
Project; or Folder.

If Current file is selected, the file that is currently active is used. Selecting Open files
causes the XPath expression to be evaluate against all the files currently open in
XMLSpy. Project refers to the currently active XMLSpy project. The external folders in
a XMLSpy project can be excluded by checking the Skip external folders check box.
The Folder option enables you to browse for the required folder; the XPath expression
will be evaluated against XML files in this folder.
2. Select the XPath version you wish to use (1.0 or 2.0) by clicking the appropriate icon in
the toolbar of the output window (see screenshot below).
3. Select the type of XPath expression from the dropdown list in the combo box. Allow

© 2010 Altova GmbH User Manual


18 Introduction The Graphical User Interface (GUI)

Complete XPath is the usually required option. The XML Schema Selector and XML
Schema Field options can be used for a narrow subset of specific XPath 1.0 cases and
are useful when unique identity constraints have been defined in the XML Schema.
When either of these options is selected, only name tests (and the wildcard *) are
allowed in the XPath expression, and predicates and XPath functions may not be used.
Furthermore, for the XML Schema Selector option, only expressions on the child axis
are allowed; for the XML Schema Field option, expressions on the child axis and
attribute axis are allowed. For more information, see the W3C's XML Schema:
Structures Recommendation.
4. Toggle the Evaluate XPath Expression On Typing icon on if you want the XPath
expression to be evaluated while you are typing it in. If this icon is toggled off, the
expression will be evaluated only when you click the Evaluate XPath Expression icon
.
5. Toggle the Show Header In Output icon on if, in the output, you wish to show the
location of the XML file and the XPath expression (as in screenshot below).
6. If the XPath expression will returns nodes—such as elements or attributes—you can
select whether the entire contents of the selected nodes should be shown. This is done
by switching the Show Complete Results icon on. In the screenshot below, both the
element and its content are displayed (in the right-hand column).

7. To set an XPath expression relative to a selection in the XML document, toggle the Set
Current Selection As Origin icon on.
8. Enter the XPath expression. The intelligent XPath editing feature will pop up a list of
XPath functions, XPath axes, and document elements and attributes, from which you
can choose. If you wish to create the expression over multiple lines, press the Return
key.
9. To evaluate the expression (if Evaluate on Typing is toggled off or when a new XML
document is made active), click the Evaluate XPath Expression icon.

Features of the Result Pane


The Result Pane has the following useful features:
 When the result contains a node (including a text node)—as opposed to expression-
generated literals—clicking on that node in the Result Pane highlights the

Altova XMLSpy 2011 © 2010 Altova GmbH


Introduction The Graphical User Interface (GUI) 19

corresponding node in the XML document in the Main Window.


 When a node in the XML document is selected, clicking the Copies XPath of Current
Selection to Edit Field icon does the following: (i) generates an XPath expression to
specifically locate the selected node; (ii) overwrites the expression currently in the edit
field with the newly generated XPath expression.
 The Copies XPath from Current Result Tab to Edit Field icon copies the XPath
expression of the currently open result tab to the XPath expression edit field. This is
useful if (i) the expression in the edit field is different than one that was used to
generate the result in one of the result tabs, and (ii) you wish to re-evaluate the
expression used in that result tab. In this case, you make the result tab active and then
use this command to copy the result tab's XPath expression to the edit field. The XPath
expression can then be re-evaluated.

XPath expressions in the edit field


The following general points about XPath expressions should be noted. Issues specific to XPath
1.0 and XPath 2.0, respectively, are treated separately below.
 When you enter an expression in the edit field, it is displayed in black if the syntax is
correct and in red if the syntax is incorrect. Note that correct syntax does not ensure
that the expression is error-free. Error messages are displayed in the results pane.
 An error might be caused because of incorrectly set options. So set the options
correctly, especially the XPath Version and the XPath Origin (absolute, or relative to the
current selection in the currently active XML document).
 Only namespaces that are in scope on the element where the XPath expression
originates (i.e. on the context node) are evaluated.

XPath 1.0 expressions


 XPath 1.0 functions must be entered without any namespace prefix.
 The four node tests by type are supported: node(), text(), comment(), and
processing-instruction().

XPath 2.0 expressions


 String (e.g. 'Hello') and numeric literals (e.g. 256) are supported. To create other literals
based on XML Schema types, you use a namespace-prefixed constructor (e.g.
xs:date('2004-09-02')). The namespace prefix that you use for XML Schema
types must be bound to the XML Schema namespace:
http://www.w3.org/2001/XMLSchema, and this namespace must be declared in
your XML file.
 XPath 2.0 functions used by the XPath Evaluator belong to the namespace
http://www.w3.org/2005/xpath-functions. Conventionally, the prefix fn: is
bound to this namespace. However, since this namespace is the default functions
namespace used by the XPath Evaluator, you do not need to specify a prefix on
functions. If you do use a prefix, make sure that the prefix is bound to the XPath 2.0
Functions namespace, which you must declare in the XML document. Examples of
function usage: current-date() (with Functions namespace not declared in XML
document); fn:current-date() (with Functions namespace not declared in XML
document, or declared in XML document and bound to prefix fn:). You can omit the
namespace prefix even if the Functions namespace has been declared in the XML
document with or without a prefix; this is because a function so used in an XPath
expression is in the default namespace—which is the default namespace for functions.
 When using the two duration datatypes (yearMonthDuration and
dayTimeDuration), the XML Schema namespace (

© 2010 Altova GmbH User Manual


20 Introduction The Graphical User Interface (GUI)

http://www.w3.org/2001/XMLSchema) must be declared in the XML file and the


namespace prefix must be used on these types in the XPath expression. Example:
years-from-yearMonthDuration(xs:yearMonthDuration('P22Y18M')).

Please note: To summarize the namespace issue: If you use constructors or types from the
XML Schema namespace, you must declare the XML Schema namespace in the XML
document and use the correct namespace prefixes in the XPath expression. You do not need to
use a prefix for XPath functions.

Datatypes in XPath 2.0


If you are evaluating an XPath 2.0 expression for an XML document that references an XML
Schema and is valid according to this schema, you must explicitly construct or cast datatypes
that are not implicitly converted to the required datatype by an operation. In the XPath 2.0 Data
Model used by the built-in XPath engine, all atomized node values from the XML document are
assigned the xs:untypedAtomic datatype. The xs:untypedAtomic type works well with
implicit type conversions. For example, the expression xs:untypedAtomic("1") + 1
results in a value of 2 because the xs:untypedAtomic value is implicitly promoted to
xs:double by the addition operator. Arithmetic operators implicitly promote operands to
xs:double. Comparison operators promote operands to xs:string before comparing.

In some cases, however, it is necessary to explicitly convert to the required datatype. For
example, if you have two elements, startDate and endDate, that are defined as being of
type xs:date in the XML Schema, then using the XPath 2.0 expression endDate -
startDate will show an error. On the other hand, if you use xs:date(endDate) -
xs:date(startDate) or (endDate cast as xs:date) - (startDate cast as
xs:date), the expression will correctly evaluate to a singleton sequence of type
xs:dayTimeDuration.

Please note: The XPath Engines used by the XPath Evaluator are also used by the Altova
XSLT Engine, so XPath 2.0 expressions in XSLT stylesheets that are not implicitly converted to
the required datatype must be explicitly constructed as or cast to the required datatype.

String length of character and entity references


When character and entity references are used as the input string for the string-length()
function, the references cannot be resolved, and the length of the unresolved text string is
returned. Within an XSLT environment, however, these references would have meaning, and
the length of the resolved string is returned.

Troubleshooting
If your XPath expression returns an error, do the following:
1. Check whether the options have been correctly set (XPath version, origin, etc).
2. Check that the spelling of function names, constructor names, node names, etc., are
correct.
3. Check whether prefixes are required and correctly set on functions, constructors, and
arguments in the XPath expression.
4. If namespaces are declared in the XML document check that they are correct. The
correct namespaces are:
XML Schema: http://www.w3.org/2001/XMLSchema
XPath 2.0 Functions: http://www.w3.org/2005/xpath-functions

XPath 2.0 Functions Support

Altova XMLSpy 2011 © 2010 Altova GmbH


Introduction The Graphical User Interface (GUI) 21

See the appendices.

2.1.7 Output Window: XSL Outline


The XSL Outline Window (screenshot below) lists all the templates and functions in an XSLT
stylesheet, and, optionally, in all included and imported XSLT stylesheets as well. The XSL
Outline Window is located by default docked with the Output Windows at the bottom of the
XMLSpy window. It can be undocked, or docked along another edge of the XMLSpy window.

The XSL Outline Window provides information about templates and functions in the stylesheet.
This information can be sorted and searched, and the window's toolbar contains commands
that enable you to easily insert calls to named templates and to set named templates as the
starting point of transformations. How to work with the XSL Outline Window is described in the
section XSLT and XQuery | XSLT | XSL Outline | XSL Outline Window.

Note: File-related information about the stylesheet and file-related commands are available in
the XSLT tab of the Info Window. How to use these commands is described in the
section XSLT and XQuery | XSLT | XSL Outline | Info Window.

2.1.8 Output Window: Find in Files


The Find in Files Window (screenshot below) enables you to carry out find-and-replace
operations quickly within several documents at a time, and provides mechanisms that help you
to quickly navigate among the found instances. The results of each find-and-replace action are
presented in one of the tabs numbered 1 to 9. Clicking on a found item in the results takes you
to that item in the Text View of that document.

© 2010 Altova GmbH User Manual


22 Introduction The Graphical User Interface (GUI)

Find criteria
There are two broad find criteria: (i) what to find, and (ii) where to look?

What to find: The string to find is entered in the Find What text box. If that string must match a
whole word, then the Match Whole Word check box must be clicked. For example, for the find
string fit, with Match Whole Word checked, only the word fit will match the find string; the
fit in fitness, for example, would not. You can specify whether casing is significant using the
Match Case check box. If the text entered in the Find What text box is a regular expression,
then the Regular Expression check box must be checked. An entry helper for regular
expressions can be accessed by clicking the button. The use of regular expressions for
searching is explained in the section, Find. The More button opens the Find in Files dialog,
where you can set advanced search conditions and actions. For more information, see Edit |
Find in Files.

Where to look: The search can be conducted in: (i) all the files that are open in the GUI; (ii) the
files of the current project; and (iii) the files of a selected folder. You can set additional
conditions in the Find in Files dialog (accessed by clicking More).

Replace with
The string with which the found string is to be replaced is entered in the Replace With text box.
Note that if the Replace With text box is empty and you click the Replace button, the found text
will be replaced by an empty string.

The results
After you click the Find or Replace buttons, the results of the find or replace are displayed in the
Find in Files output window. The results are divided into four parts:
 A summary of the search parameters, which lists the search string and what files were
searched.
 A listing of the found or replaced strings (according to whether the Find or Replace
button was pressed). The items in this listing are links to the found/replaced text in the

Altova XMLSpy 2011 © 2010 Altova GmbH


Introduction The Graphical User Interface (GUI) 23

Text View of the document. If the document is not open, it will be opened in Text View
and the found/replaced text will be highlighted.
 A list of the files which were searched but in which no matches were found.
 A summary of statics for the search action, including the number of matches and
number of files checked.

Note: Note that the Find in Files feature executes the Find and the Replace commands on
multiple files at once and displays the results in the Find in Files output window. To do a
find so that you go from one found item to the next, use the Find command.

2.1.9 Output Window: Find in Schemas


When an XML Schema is active in Schema View, it can be searched intelligently using XMLSpy
's Find and Replace in Schema View feature. The Find and Replace in Schema View feature is
accessed via: (i) the Find and Replace commands in the Edit menu; and (ii) the Find and
Replace buttons in the Find in Schemas Window (screenshot below).

The results of the Find and Replace in Schema View feature (i.e. each time a Find or Replace
command is executed) are displayed in the Find in Schemas window. The term that was
searched for is displayed in green; (in the screenshot above, it can be seen that email was the
search term, with no case restriction specified). Notice that the location of the schema file is
also given.

Results are displayed in nine separate tabs (numbered 1 to 9). So you can keep the results of
one search in one tab, do a new search in a new tab, and compare results. To show the results
of a new search in a new tab, select the new tab before starting the search. Clicking on a result
in the Find In Schemas window pops up and highlights the relevant component in the Main
Window of Schema View. In this way you can search and navigate quickly to the desired
component, as well as copy messages to the clipboard. For more details, see the Results and
Information section in the description of the Find in Schemas feature.

2.1.10 Output Window: Find in XBRL


The Find in XBRL Window (screenshot below) displays the results of searching an XBRL
taxonomy document. There are nine tabs in this window, so results in one tab can be compared
with the results in another tab.

The Find in XBRL can be performed when an XBRL taxonomy document is open in XBRL View.
How to carry out the search is described in the section Find in XBRL in the XBRL section of the

© 2010 Altova GmbH User Manual


24 Introduction The Graphical User Interface (GUI)

user manual.

The Find button pops up the Search dialog. The Find Next button finds the next instance of the
search term in the document starting from the cell immediately after the cell in XBRL View in
which the cursor is currently placed.

The following Find In XBRL toolbar commands are available:


 The Next and Previous icons select, respectively, the next and previous find results to
the currently selected result.
 The Copy Messages commands copy, respectively, the selected message, the
selected message and its children messages, and all messages, to the clipboard.
 The Find commands find text strings in the Find In XBRL window.
 The Clear command deletes all messages in the currently active tab.

2.1.11 Output Window: Charts


When an XML document is open in Text View or Grid View, a chart (pie chart, bar chart, etc)
representing selected data in the XML document can be generated in the Charts Window (
screenshot below).

Altova XMLSpy 2011 © 2010 Altova GmbH


Introduction The Graphical User Interface (GUI) 25

Creating the chart


The broad steps for creating a chart are as follows:
1. Place the cursor in the XML document to select a context node.
2. Click the New Chart button in the Charts Window (see screenshot above) or right-click
in the Main Window and select New Chart from the context menu.
3. In the Select Columns dialog that pops up, select data for the chart data table and click
OK. The chart will be created in the Charts Window (screenshot above).

For more information, see the section Charts in the XML section of the user manual.

Modifying and managing charts


A chart can be created in any of the nine Charts Window tabs (numbered along the left side of
the window). In this way charts in different tabs can be compared. A chart created in a tab can
only be overwritten when a new chart is created in that tab. A chart cannot be otherwise deleted.
Even when the XML document that was used to generate a chart is closed, the chart remains in
the tab in which it was created.

The buttons at the top of the window do the following:


 New Chart: Pops up the Select Columns dialog, in which the chart data table is
configured.
 Change Type: Enables the chart type to be changed, for example, from a bar chart to a
pie chart.
 Change Appearance: Enables settings, like the chart's fonts sizes and color schemes,
to be changed.
 Select Data: Pops up the Select Data dialog, which contains the chart data table and
the final selection of data that will be presented in the chart. Data for the series, the X-
Axis and Y-Axis can be modified in this dialog. The X-Axis and Y-Axis data can be
graphically selected from the chart data table. Clicking OK generates the modified chart
in the Charts Window.

© 2010 Altova GmbH User Manual


26 Introduction The Graphical User Interface (GUI)

 Export: the chart can be exported as an image file, or as an XSLT or XQuery fragment
to the clipboard. The XSLT or XQuery fragment can be used in an XSLT or XQuery
document, which when processed with the Altova XSLT 2.0 Engine or the Altova
XQuery Engine, will correctly render the chart.
 Reload/Auto: If the Auto button is toggled on, then any change in the underlying XML
document will automatically refresh a chart in the Charts Window that is based on the
XML document. Otherwise a chart will only be updated when the Reload button is
pressed.

2.1.12 Menu Bar, Toolbars, Status Bar


Menu Bar
The menu bar (see illustration) contains the various application menus. The following
conventions apply:
 If commands in a menu are not applicable in a view or at a particular location in the
document, they are unavailable.
 Some menu commands pop up a submenu with a list of additional options. Menu
commands with submenus are indicated with a right-pointing arrowhead to the right of
the command name.
 Some menu commands pop up a dialog that prompts you for further information
required to carry out the selected command. Such commands are indicated with an
ellipsis (...) after the name of the command.
 To access a menu command, click the menu name and then the command. If a
submenu is indicated for a menu item, the submenu opens when you mouseover the
menu item. Click the required sub-menu item.
 A menu can be opened from the keyboard by pressing the appropriate key combination.
The key combination for each menu is Alt+KEY, where KEY is the underlined letter in
the menu name. For example, the key combination for the File menu is Alt+F.
 A menu command (that is, a command in a menu) can be selected by sequentially
selecting (i) the menu with its key combination (see previous point), and then (ii) the key
combination for the specific command (Alt+KEY, where KEY is the underlined letter in
the command name). For example, to create a new file (File | New), press Alt+F and
then Alt+N.
 Some menu commands can be selected directly by pressing a special shortcut key or
key combination (Ctrl+KEY). Commands which have shortcuts associated with them
are indicated with the shortcut key or key combination listed to the right of the
command. For example, you can use the shortcut key combination Ctrl+N to create a
new file; the shortcut key F8 to validate an XML file. You can create your own shortcuts
in the Keyboard tab of the Customize dialog (Tools | Customize).

Toolbars
The toolbars (see illustration) contain icons that are shortcuts for selecting menu commands.
The name of the command appears when you place your mouse pointer over the icon. To
execute the command, click the icon.

Toolbar buttons are arranged in groups. In the Tools | Customize | Toolbars dialog, you can
specify which toolbar groups are to be displayed. These settings apply to the current view. To
make a setting for another view, change to that view and then make the setting in the Tools |
Customize | Toolbars. In the GUI, you can also drag toolbar groups by their handles (or title
bars) to alternative locations on the screen. Double-clicking the handle causes the toolbar to
undock and to float; double-clicking its title bar causes the toolbar to dock at its previous
location.

Altova XMLSpy 2011 © 2010 Altova GmbH


Introduction The Graphical User Interface (GUI) 27

Status Bar
The Status Bar is located at the bottom of the application window (see illustration) and displays
(i) status information about the loading of files, and (ii) information about menu commands and
command shortcuts in the toolbars when the mouse cursor is placed over these. If you are
using the 64-bit version of XMLSpy, this is indicated in the status bar with the suffix (x64) after
the application name. There is no suffix for the 32-bit version.

© 2010 Altova GmbH User Manual


28 Introduction The Application Environment

2.2 The Application Environment


In this section we describe various aspects of the application that are important for getting
started. Reading through this section will help you familiarize yourself with XMLSpy and get you
off to a confident start. It contains important information about settings and customization, which
you should read for a general idea of the range of settings and customization options available
to you and how these can be changed.

This section is organized as follows:


 Settings, Customization and Menus: Describes how and where important settings and
customization options can be defined.
 Tutorials, Projects, Examples: notes the location of the various non-program files
included in the application package.
 Product features and documentation, and Altova products: provides links to the Altova
website, where you can find information about product features, additional Help
formats, and other Altova products.

2.2.1 Settings, Customization, and Menus


In XMLSpy, there are several settings and customization options that you can select. In this
section, we point you to these options and also briefly discuss some aspects of XMLSpy menus.
This section is organized into the following parts.
 Settings
 Customization
 Menus

Settings
Several important XMLSpy settings are defined in different tabs in the Options dialog (
screenshot below, accessed via the menu command Tools | Options). You should look
through the various options to familiarize yourself with what's available.

Given below is a summary of the most important settings. For details, see the description of the
Options dialog in the User Reference section.

Altova XMLSpy 2011 © 2010 Altova GmbH


Introduction The Application Environment 29

 File types and default views: In the File Types tab, you can add a file type that XMLSpy
will recognize. You do this by adding a file extension to the list of file extensions. For
each file type, you can then specify to what specification files of this file type should
conform and in what XMLSpy view files of this file type should open (the default view for
this file type).
 File validation: In the File tab, you can specify whether files should be validated
automatically on opening and/or saving. In the File Types tab, file validation can then be
disabled for specific file types.
 Editing features: In the Editing tab, you can specify how entry helpers should be
organized, how new elements are generated, and whether auto-completion is enabled.
Additional options are available for individual views in the View tab. In the Fonts tabs for
various views, you can specify the font characteristics of individual node types in each
of these views.
 XSLT and FO Engines: In the XSL tab, you can specify that an external XSL engine be
used for transformations made from within the GUI. You must also specify the location
of the FO processor executable to be used for FO processing within XMLSpy. For more
information, see the XSLT Processing section.
 Encoding: Default encodings for XML and non-XML files are specified in the Encoding
tab.

Customization
You can also customize various aspects of XMLSpy, including the appearance of the GUI.
These customization options are available in the Customize dialog (screenshot below, accessed
via the menu command Tools | Customize).

The various customization options are described in the User Reference section.

Menus
Menu commands are enabled/disabled depending upon three factors: (i) file type, (ii) active
view, and (iii) current cursor location or current document status. For example:

© 2010 Altova GmbH User Manual


30 Introduction The Application Environment

 File type: The command DTD/Schema | Include Another DTD is enabled only when
the active file is a DTD. Similarly, commands in the WSDL menu will be enabled only
when a WSDL file is active.
 Active view: Most commands in the Schema Design menu will be active only when the
active view is Schema View.
 Current cursor location, document status: In Grid View, whether the command to add
an attribute as a child node (XML | Add Child | Attribute) is enabled will depend on
whether the selected item in Grid View is an element or not (current cursor location).
When an XSLT document is active the Stop Debugger command will not be active till
after a debugger session has been started (current document status).

Note also that you can customize menus (Tools | Customize) as well as drag and reorganize
them within the GUI (see Menu Bar, Toolbars, Status Bar).

2.2.2 Tutorials, Projects, Examples


The XMLSpy installation package contains tutorials, projects, and example files.

Location of tutorials, projects, and example files


The XMLSpy tutorials, projects, and example files are installed in the folder:
C:\Documents and Settings\<username>\My Documents\
Altova\XMLSpy2011\Examples\
The My Documents\Altova\XMLSpy2011 folder will be installed for each user registered on a
PC within that user's <username> folder. Under this installation system, therefore, each user will
have his or her own ExamplesAuthenticExamples folder in a separate working area.

Note about the master XMLSpy folder


When XMLSpy is installed on a machine, a master Altova\XMLSpy2011 folder is created at the
following folder location:
C:\Documents and Settings\All Users\Application Data\
When a user on that machine starts XMLSpy for the first time, XMLSpy creates a copy of this
master folder in the user's <username>\My Documents\ folder. It is therefore important not to
use the master folder when working with tutorial or example files, otherwise these edited files
will be copied to the user folder of a user subsequently using XMLSpy for the first time.

Location of tutorial, project, and examples files


All tutorial, project, and example files are located in the Examples folder. Specific locations are
as follows:
 XMLSpy tutorial: Tutorial folder.
 Authentic View tutorial: Examples folder.
 WSDL tutorial: Examples folder.
 Project file: The Examples project with which XMLSpy opens is defined in the file
Examples.spp, which is located in the Examples folder.
 Examples files: are in the Examples folder and in sub-folder of the Examples folder.

2.2.3 XMLSpy Features and Help, and Altova Products


The Altova website, www.altova.com, has a wealth of XMLSpy-related information and
resources. Among these are the following.

Altova XMLSpy 2011 © 2010 Altova GmbH


Introduction The Application Environment 31

XMLSpy feature listing


The Altova website carries an up-to-date list of XMLSpy features, which also compares the
support of various features across XMLSpy editions (Enterprise, Professional, and Standard).
On the website, you can also obtain a listing of features that are new since any previous
release.

XMLSpy Help
This documentation is the Altova-supplied Help for XMLSpy. It is available as the built-in Help
system of XMLSpy, which is accessible via the Help menu or by pressing F1. Additionally, the
user manuals for all Altova products are available in the following formats:
 Online HTML manuals, accessed via the Support page at the Altova website
 Printable PDFs, which you can download from the Altova website and print locally
 Printed books that you can buy via a link at the Altova website

Support options
If you require additional information to what is available in the user manual (this documentation)
or have a query about Altova products, visit our Support Center at the Altova website. Here you
will find:
 Links to our FAQ pages
 Discussion forums on Altova products and general XML subjects
 Online Support Forms that enable you to make support requests, should you have a
support package. Your support request will be processed by our support team.

Altova products
For a list of all Altova products, see the Altova website.

© 2010 Altova GmbH User Manual


32 XMLSpy Tutorial

3 XMLSpy Tutorial
This tutorial provides an overview of XML and takes you through a number of key XML tasks. In
the process you will learn how to use some of XMLSpy's most powerful features.

The tutorial is divided into the following parts:


 Creating an XML Schema. You will learn how to create an XML Schema in XMLSpy's
intuitive Schema View, how to create complex content models using drag-and-drop
mechanisms, and how to configure Schema View.
 Using Schema View features to create complex and simple types, global element
references, and attribute enumerations.
 Learning how to navigate schemas in Schema View, and how to generate
documentation of schemas.
 Creating an XML document. You will learn how to assign a schema for an XML
document, edit an XML document in Grid View and Text View, and validate XML
documents using XMLSpy's built-in validator.
 Transforming an XML file using an XSLT stylesheet. This involves assigning an XSLT
file and carrying out the transformation using XMLSpy's built-in XSLT engines.
 Working with XMLSpy projects, which enable you to easily organize your XML
documents.

Installation and configuration


This tutorial assumes that you have successfully installed XMLSpy on your computer and
received a free evaluation key-code, or are a registered user. The evaluation version of XMLSpy
is fully functional but limited to a 30-day period. You can request a regular license from our
secure web server or through any one of our resellers.

Tutorial example files


The tutorial files are available in the application folder:
C:\Documents and Settings\<username>\My Documents\Altova\XMLSpy2011\
Examples\Tutorial
The Examples folder contains various XML files for you to experiment with, while the
Tutorial folder contains all the files used in this tutorial.

The Template folder in the application folder (typically in c:\Program Files\Altova) contains
all the XML template files that are used whenever you select the menu option File | New. These
files supply the necessary data (namespaces and XML declarations) for you to start working
with the respective XML document immediately.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XMLSpy Interface 33

3.1 XMLSpy Interface


The XMLSpy interface is structured into three vertical areas. The central area provides you with
multiple views of your XML document. The areas on either side of this central area contain
windows that provide information, editing help, and file management features.
 The left area consists of the Project and Info windows.
 The central area, called the Main window, is where you edit and view all types of XML
documents. You can switch between different views: Text View, Grid View, Schema
View, WSDL View, Authentic View, and Browser View. These views are described in
detail in the individual sections about them in the User Manual.
 The right-hand area contains the three Entry Helper windows, which enable you to
insert or append elements, attributes, and entities. What entries are displayed in the
Entry Helper windows depends on the current selection or cursor location in the XML
file.

The details of the interface are explained as we go along. Note that the interface changes
dynamically according to the document that is active in the Main Window and according to the
view selected.

© 2010 Altova GmbH User Manual


34 XMLSpy Tutorial XML Schemas: Basics

3.2 XML Schemas: Basics


An XML Schema describes the structure of an XML document. An XML document can be
validated against an XML Schema to check whether it conforms to the requirements specified in
the schema. If it does, it is said to be valid; otherwise it is invalid. XML Schemas enable
document designers to specify the allowed structure and content of an XML document and to
check whether an XML document is valid.

The structure and syntax of an XML Schema document is complex, and being an XML
document itself, an XML Schema must be valid according to the rules of the XML Schema
specification. In XMLSpy, Schema View enables you to easily build valid XML Schemas by
using graphical drag-and-drop techniques. The XML Schema document you construct is also
editable in Text View and Grid View, but is much easier to create and modify in Schema View.

Objective
In this section of the tutorial, you will learn how to edit XML Schemas in Schema View.
Specifically, you will learn how to do the following:
 Create a new schema file
 Define namespaces for the schema
 Define a basic content model
 Add elements to the content model using context menus and drag-and-drop
 Configure the Content Model View

After you have completed creating the basic schema, you can go to the next section of the
tutorial, which teaches you how to work with the more advanced features of XML Schema in
XMLSpy. This advanced section is followed by a section about schema navigation and
documentation in XMLSpy.

Commands used in this section


In this section of the tutorial, you will use Schema View exclusively. The following commands
are used:

Display Diagram (or Display Content Model View). This icon is located to the left of all
global components in Schema Overview. Click this icon to display the content model of
the associated global component.

3.2.1 Creating a New XML Schema File


To create a new XML Schema file in XMLSpy, you must first start XMLSpy and then create a
new XML Schema (.xsd) document.

Starting XMLSpy
To start XMLSpy, double-click the XMLSpy icon on your desktop or use the Start | All
Programs menu to access the XMLSpy program. XMLSpy is started with no documents open
in the interface.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: Basics 35

Note the four main parts of the interface: (i) the Project and Info Windows on the left; (ii) the
Main Window in the middle; (iii) the Entry Helpers on the right; and (iv) the Output Windows at
the bottom.

© 2010 Altova GmbH User Manual


36 XMLSpy Tutorial XML Schemas: Basics

Creating a new XML Schema file


To create a new XML Schema file:
1. Select the menu option File | New. The Create new document dialog opens.

2. In the dialog, select the xsd entry (the document description and the list in the window
might vary from that in the screenshot) and confirm with OK. An empty schema file
appears in the Main Window in Schema View. You are prompted to enter the name of
the root element.

3. Double-click in the highlighted field and enter Company. Confirm with Enter. Company
is now the root element of this schema and is created as a global element. The view
you see in the Main Window (screenshot below) is called the Schema Overview. It
provides an overview of the schema by displaying a list of all the global components in
the top pane of the Main Window; the bottom pane displays the attributes and identity
constraints of the selected global component. (You can view and edit the content model
of individual global components by clicking the Display Diagram icon to the left of that
global component.)

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: Basics 37

4. In the Annotations field (ann) of the Company element, enter the description of the
element, in this case, Root element.
5. Click the menu option File | Save, and save your XML Schema with any name you like
(AddressFirst.xsd, for example).

3.2.2 Defining Namespaces


XML namespaces are an important issue in XML Schemas and XML documents. An XML
Schema document must reference the XML Schema namespace and, optionally, it can define a
target namespace for the XML document instance. As the schema designer, you must decide
how to define both these namespaces (essentially, with what prefixes.)

In the XML Schema you are creating, you will define a target namespace for XML document
instances. (The required reference to the XML Schema namespace is created automatically by
XMLSpy when you create a new XML Schema document.)

To create a target namespace:


1. Select the menu option Schema Design | Schema settings. This opens the Schema
Settings dialog.

© 2010 Altova GmbH User Manual


38 XMLSpy Tutorial XML Schemas: Basics

2. Click the Target Namespace radio button, and enter


http://my-company.com/namespace. In XMLSpy, the namespace you enter as
the target namespace is created as the default namespace of the XML Schema
document and displayed in the list of namespaces in the bottom pane of the dialog.
3. Confirm with the OK button.

Please note:
 The XML Schema namespace is automatically created by XMLSpy and given a prefix
of xs:.
 When the XML document instance is created, it must have the target namespace
defined in the XML Schema for the XML document to be valid.

3.2.3 Defining a Content Model


In the Schema Overview, you have already created a global element called Company. This
element is to contain one Address element and an unlimited number of Person elements—its
content model. Global components that can have content models are elements, complexTypes,
and element groups.

In XMLSpy, the content model of a global component is displayed in the Content Model View of
Schema View. To view and edit the content model of a global component, click the Display
Diagram icon located to the left of the global component.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: Basics 39

In this section, you will create the content model of the Company element.

Creating a basic content model


To create the content model of the Company element:
1. In the Schema Overview, click the Display Diagram icon of the Company element.
This displays the content model of the Company element, which is currently empty.
Alternatively, you can double-click the Company entry in the Components entry helper
to display its content model.

2. A content model consists of compositors and components. The compositors specify


the relationship between two components. At this point of the Company content model,
you must add a child compositor to the Company element in order to add a child
element. To add a compositor, right-click the Company element. From the context
menu that appears, select Add Child | Sequence. (Sequence, Choice, and All are the
three compositors that can be used in a content model.)

This inserts the Sequence compositor, which defines that the components that follow
must appear in the specified sequence.

© 2010 Altova GmbH User Manual


40 XMLSpy Tutorial XML Schemas: Basics

3. Right-click the Sequence compositor and select Add Child | Element. An unnamed
element component is added.
4. Enter Address as the name of the element, and confirm with Enter.

5. Right-click the Sequence compositor again, select Add Child | Element. Name the
newly created element component Person.

You have so far defined a schema which allows for one address and one person per
company. We need to increase the number of Person elements.
6. Right-click the Person element, and select Unbounded from the context menu. The
Person element in the diagram now shows the number of allowed occurrences: 1 to
infinity.

Alternatively, in the Details Entry Helper, you can edit the minOcc and maxOcc fields to
specify the allowed number of occurrences, in this case 1 and unbounded, respectively.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: Basics 41

Adding additional levels to the content model structure


The basic content model you have created so far contains one level: a child level for the
company element which contains the Address and Person elements. Now we will define the
content of the Address element so it contains Name, Street, and City elements. This is a
second level. Again we need to add a child compositor to the Address element, and then the
element components themselves.

Do this as follows:

1. Right-click the Address element to open the context menu, and select Add Child |
Sequence. This adds the Sequence compositor.
2. Right-click the Sequence compositor, and select Add Child | Element. Name the newly
created element component Name.

Complex types, simple types, and XML Schema data types


Till this point, we have not explicitly defined any element type. Click the Text tab to display the
Text View of your schema (listing below). You will notice that whenever a Sequence compositor
was inserted, the xs:sequence element was inserted within the xs:complexType element.
In short, the Company and Address elements, because they contain child elements, are
complex types. A complex type element is one which contains attributes or elements.

<xs:element name="Company">
<xs:annotation>
<xs:documentation>Root element</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Address">
<xs:complexType>
<xs:sequence>
<xs:element name="Name"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Person"/>
</xs:sequence>
</xs:complexType>
</xs:element>

Simple type elements, on the other hand, contain only text and have no attributes. Text can be
strings, dates, numbers, etc. We want the Name child of Address to contain only text. It is a
simple type, the text content of which we want to restrict to a string. We can do this using the
XML Schema data type xs:string.

To define the Name element to be of this datatype:


1. Click the Schema tab to return to Schema View.
2. Click the Name element to select it.

© 2010 Altova GmbH User Manual


42 XMLSpy Tutorial XML Schemas: Basics

3. In the Details Entry Helper, from the dropdown menu of the type combo box, select
the xs:string entry.

Note that both minOcc and maxOcc have a value of 1, showing that this element
occurs only once.

The text representation of the Name element is as follows:


<xs:element name="Name" type="xs:string"/>

Please note: A simple type element can have any one of several XML Schema data types. In
all these cases, the icon indicating text-content appears in the element box.

3.2.4 Adding Elements with Drag-and-Drop


You have added elements using the context menu that appears when you right-click an element
or compositor. You can also create elements using drag-and-drop, which is quicker than using
menu commands. In this section, you will add more elements to the definition of the Address
element using drag-and-drop, thus completing this definition.

To complete the definition of the Address element using drag-and-drop:


1. Click the Name element of the Address element, hold down the Ctrl key, and drag the
element box with the mouse. A small "plus" icon appears in the element box, indicating
that you are about to copy the element. A copy of the element together with a connector
line also appears, showing where the element will be created.

2. Release the mouse button to create the new element in the Address sequence. If the
new element appears at an incorrect location, drag it to a location below the Name
element.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: Basics 43

3. Double-click in the element box, and type in Street to change the element name.
4. Use the same method to create a third element called City. The content model should
now look like this:

The Address element has a sequence of a Name, a Street, and a City element, in
that order.

3.2.5 Configuring the Content Model View


This is a good time to configure the Content Model View. We will configure the Content Model
View such that the type of the element is displayed for each element.

To configure the Content Model View:

1. Select the Content Model View (click the Content Model View icon ) of a component
in order to enable the Configure view command.
2. Select the menu option Schema Design | Configure view. The Schema Display
Configuration dialog appears.

© 2010 Altova GmbH User Manual


44 XMLSpy Tutorial XML Schemas: Basics

3. Click the Append icon (in the Element tab) to add a property descriptor line for
each element box.
4. From the dropdown menu, select type (or double-click in the line and enter "type").
This will cause the data type of each element to be displayed in the Content Model
View.
5. In the Single Line Settings pane, select Hide Line If No Value. This hides the description
of the datatype in the element box if the element does not have a datatype (for
example, if the element is a complex type).

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: Basics 45

Notice that the type descriptor line appears for the Name, Street, and City elements,
which are simple types of type xs:string, but not for the complex type elements. This
is because the Hide Line If No Value toggle is selected.
6. In the Single Line Settings group, select the Always Show Line radio button.
7. Click OK to confirm the changes.

Notice that the descriptor line for the data type is always shown—even in element
boxes of complex types, where they appear without any value.

Please note:
 The property descriptor lines are editable, so values you enter in them become part of
the element definition.
 The settings you define in the Schema display configuration dialog apply to the schema
documentation output as well as the printer output.

3.2.6 Completing the Basic Schema


You have defined the content of the Address element. Now you need to define the content of
the Person element. The Person element is to contain the following child elements, all of
which are simple types: First, Last, Title, PhoneExt, and Email. All these elements are
mandatory except Title (which is optional), and they must occur in the order just specified. All
should be of datatype xs:string except PhoneExt, which must be of datatype xs:integer
and limited to 2 digits.

To create the content model for Person:


1. Right-click the Person element to open the context menu, and select Add Child |
Sequence. This inserts the Sequence compositor.
2. Right-click the Sequence compositor, and select Add Child | Element.
3. Enter First as the name of the element, and press the Tab key. This automatically
places the cursor in the type field.

© 2010 Altova GmbH User Manual


46 XMLSpy Tutorial XML Schemas: Basics

4. Select the xs:string entry from the dropdown list or enter it into the type value field.
5. Use the drag-and-drop method to create four more elements. Name them Last, Title
, PhoneExt, and Email, respectively.

Please note: You can select multiple elements by holding down the Ctrl key and clicking each
of the required elements. This makes it possible to, e.g., copy several elements at once.

Making an element optional


Right-click the Title element and select Optional from the context menu. The frame of the

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: Basics 47

element box changes from solid to dashed; this is a visual indication that an element is
optional.

In the Details Entry Helper, you will see that minOcc=0 and maxOcc=1, indicating that the
element is optional. Alternatively to using the context menu to make an element optional, you
can set minOcc=0 in order to make the element optional.

Limiting the content of an element


To define the PhoneExt element to be of type xs:integer and have a maximum of two
digits:
1. Double-click in the type field of the PhoneExt element, and select (or enter) the
xs:integer entry from the dropdown list.

The items in the Facets Entry Helper change at this point.


2. In the Facets Entry Helper, double-click in the maxIncl field and enter 99. Confirm
with Enter.

© 2010 Altova GmbH User Manual


48 XMLSpy Tutorial XML Schemas: Basics

This defines that all phone extensions up to, and including 99, are valid.
3. Select the menu option File | Save to save the changes to the schema.

Please note:
 Selecting an XML Schema datatype that is a simple type (for example, xs:string or
xs:date), automatically changes the content model to simple in the Details Entry
Helper (content = simple).
 Adding a compositor to an element (sequence, choice, or all), automatically
changes the content model to complex in the Details Entry Helper (content =
complex).
 The schema described above is available as AddressFirst.xsd in the
C:\Documents and Settings\<username>\My Documents\Altova\XMLSpy2011\\
Examples\Tutorial folder of your XMLSpy application folder.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: Advanced 49

3.3 XML Schemas: Advanced


Now that you have created a basic schema, we can move forward to a few advanced aspects of
schema development.

Objective
In this section, you will learn how to:
 Work with complex types and simple types, which can then be used as the types of
schema elements.
 Create global elements and reference them from other elements.
 Create attributes and their properties, including enumerated values.

You will start this section with the basic AddressFirst.xsd schema you created in the first
part of this tutorial.

Commands used in this section


In this section of the tutorial, you will use Schema View exclusively. The following commands
are used:

Display Diagram (or Display Content Model View). This icon is located to the left of all
global components in Schema Overview. Clicking the icon causes the content model of
the associated global component to be displayed.

Display All Globals. This icon is located at the top left-hand corner of the Content Model
View. Clicking the icon switches the view to Schema Overview, which displays all global
components.

Append. The Append icon is located at the top left-hand corner of the Schema
Overview. Clicking the icon enables you to add a global component.

3.3.1 Working with Complex Types and Simple Types


Having defined the content model of an element, you may decide you want to reuse it
elsewhere in your schema. The way to do this is by creating that element definition as a global
complex type or as a global element. In this section, you will work with global complex types.
You will first create a complex type at the global level and then extend it for use in a content
model. You will learn about global elements later in this tutorial.

Creating a global complex type


The basic Address element that we defined (containing Name, Street, and City elements)
can be reused in various address formats. So let us create this element definition as a complex
type, which can be reused.

To create a global complex type:


1. In the Content Model View, right-click the Address element.
2. In the context menu that now appears, select Make Global | Complex type. A global
complex type called AddressType is created, and the Address element in the
Company content model is assigned this type. The content of the Address element is
the content model of AddressType, which is displayed in a yellow box. Notice that the
datatype of the Address element is now AddressType.

© 2010 Altova GmbH User Manual


50 XMLSpy Tutorial XML Schemas: Advanced

3. Click the Display All Globals icon. This takes you to the Schema Overview, in which
you can view all the global components of the schema.
4. Click the expand icons for the element and complexType entries in the Components
entry helper, to see the respective schema constructs.
The Schema Overview now displays two global components: the Company element and
the complex type AddressType. The Components Entry Helper also displays the
AddressType complex type.

5. Click on the Content Model View icon of AddressType to see its content model (
screenshot below). Notice the shape of the complex type container.

6. Click the Display All Globals icon to return to the Schema Overview.

Extending a complex type definition


We now want to use the global AddressType component to create two kinds of

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: Advanced 51

country-specific addresses. For this purpose we will define a new complex type based on the
basic AddressType component, and then extend that definition.

Do this as follows:
1. Switch to Schema Overview. (If you are in Content Model View, click the Display All
Globals icon .)

2. Click the Append icon at the top left of the component window. The following
menu opens:

3. Select ComplexType from the menu. A new line appears in the component list, and the
cursor is set for you to enter the component name.
4. Enter US-Address and confirm with Enter. (If you forget to enter the hyphen character
"-" and enter a space, the element name will appear in red, signalling an invalid
character.)

5. Click the Content Model View icon of US-Address to see the content model of the
new complex type. The content model is empty (see screenshot below).
6. In the Details entry helper, click the base combo box and select the AddressType
entry.

© 2010 Altova GmbH User Manual


52 XMLSpy Tutorial XML Schemas: Advanced

The Content Model View now displays the AddressType content model as the content
model of US-Address (screenshot below).

7. Now we can extend the content model of the US-Address complex type to take a ZIP
Code element. To do this, right-click the US-Address component, and, from the
context menu that appears, select Add Child | Sequence. A new sequence compositor
is displayed outside the AddressType box (screenshot below). This is a visual
indication that this is an extension to the element.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: Advanced 53

8. Right-click the new sequence compositor and select Add Child | Element.
9. Name the newly created element Zip, and then press the Tab key. This places the
cursor in the value field of the type descriptor line.
10. Select xs:positiveInteger from the dropdown menu that appears, and confirm
with Enter.

You now have a complex type called US-Address, which is based on the complex type
AddressType and extends it to contain a ZIP code.

Global simple types


Just as the complex type US-Address is based on the complex type AddressType, an
element can also be based on a simple type. The advantage is the same as for global complex
types: the simple type can be reused. In order to reuse a simple type, the simple type must be
defined globally. In this tutorial, you will define a content model for US states as a simple type.
This simple type will be used as the basis for another element.

Creating a global simple type


Creating a global simple type consists of appending a new simple type to the list of global

© 2010 Altova GmbH User Manual


54 XMLSpy Tutorial XML Schemas: Advanced

components, naming it, and defining its datatype.

To create a global simple type:


1. Switch to Schema Overview. (If you are in Content Model View, click the Display All
Globals icon .)
2. Click the Append icon, and in the context menu that appears, select SimpleType.
3. Enter US-State as the name of the newly created simpleType.
4. Press Enter to confirm. The simple type US-State is created and appears in the list of
simple types in the Components Entry Helper (Click the expand icon of the simpleType
entry to see it).

5. In the Details Entry Helper (screenshot below), place the cursor in the value field of
restr and enter xs:string, or select xs:string from the dropdown menu in the
restr value field.

This creates a simple type called US-State, which is of datatype xs:string. This
global component can now be used in the content model of US-Address.

Using a global simple type in a content model


A global simple type can be used in a content model to define the type of a component. We will
use US-State to define an element called State in the content model of US-Address.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: Advanced 55

Do the following:

1. In Schema Overview, click the Component Model View icon of US-Address.


2. Right-click the lower sequence compositor and select Add Child | Element.
3. Enter State for the element name.
4. Press the Tab key to place the cursor in the value field of the type descriptor line.
5. From the drop-down menu of this combo box, select US-State.

The State element is now based on the US-State simple type.

Creating a second complex type based on AddressType


We will now create a global complex type to hold UK addresses. The complex type is based on
AddressType, and is extended to match the UK address format.

Do the following:
1. In Schema Overview, create a global complex type called UK-Address, and base it on
AddressType (base=AddressType).
2. In the Content Model View of UK-Address, add a Postcode element and give it a
type of xs:string.
Your UK-Address content model should look like this:

© 2010 Altova GmbH User Manual


56 XMLSpy Tutorial XML Schemas: Advanced

Please note: In this section you created global simple and complex types, which you then used
in content model definitions. The advantage of global types is that they can be reused in
multiple definitions.

3.3.2 Referencing Global Elements


In this section, we will convert the locally defined Person element to a global element and
reference that global element from within the Company element.

1. Click (Display All Globals) to switch to Schema Overview.


2. Click the Display Diagram icon of the Company element.
3. Right-click the Person element, and select Make Global | Element. A small link arrow
icon appears in the Person element, showing that this element now references the
globally declared Person element. In the Details Entry Helper, the isRef check box is
now activated.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: Advanced 57

4. Click the Display All Globals icon to return to Schema Overview. The Person
element is now listed as a global element. It is also listed in the Components Entry
Helper.

© 2010 Altova GmbH User Manual


58 XMLSpy Tutorial XML Schemas: Advanced

5. In the Components Entry Helper, double-click the Person element to see the content
model of the global Person element.

Notice that the global element box does not have a link arrow icon. This is because it is
the referenced element, not the referencing element. It is the referencing element that
has the link arrow icon.

Please note:
 An element that references a global element must have the same name as the global
element it references.
 A global declaration does not describe where a component is to be used in an XML
document. It only describes a content model. It is only when a global declaration is
referenced from within another component that its location in the XML document is
specified.
A globally declared element can be reused at multiple locations. It differs from a globally
declared complex type in that its content model cannot be modified without also
modifying the global element itself. If you change the content model of an element that
references a global element, then the content model of the global element will also be
changed, and, with it, the content model of all other elements that reference that global
element.

3.3.3 Attributes and Attribute Enumerations


In this section, you will learn how to create attributes and enumerations for attributes.

Defining element attributes


1. In the Schema Overview, click the Person element to make it active.

2. Click the Append icon , in the top left of the Attributes/Identity Constraints tab group
(in the lower part of the Schema Overview window), and select the Attribute entry.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: Advanced 59

3. Enter Manager as the attribute name in the Name field.


4. Use the Type combo box to select xs:boolean.
5. Use the Use combo box to select required.

6. Use the same procedure to create a Programmer attribute with Type=xs:boolean


and Use=optional.

© 2010 Altova GmbH User Manual


60 XMLSpy Tutorial XML Schemas: Advanced

Defining enumerations for attributes


Enumerations are values allowed for a given attribute. If the value of the attribute in the XML
instance document is not one of the enumerations specified in the XML Schema, then the
document is invalid. We will create enumerations for the Degree attribute of the Person
element.

Do the following:
1. In the Schema Overview, click the Person element to make it active.

2. Click the Append icon in the top left of the Attributes window, and select the
Attribute entry.
3. Enter Degree as the attribute name, and select xs:string as its type.
4. With the Degree attribute selected, in the Facets Entry Helper, click the Enumerations
tab (see screenshot).

5. In the Enumerations tab, click the Append icon .


6. Enter BA, and confirm with Enter.
7. Use the same procedure to add two more enumerations: MA and PhD.
8. Click on the Content Model View icon of Person.

The previously defined attributes are visible in the Content Model View. Clicking the
expand icon displays all the attributes defined for that element. This display mode and
the Attributes tab can be toggled by selecting the menu option Schema Design |
Configure view, and checking and unchecking the Attributes check box in the Show
in diagram pane.
9. Click the Display all Globals icon to return to the Schema Overview.

Saving the completed XML Schema

Please note: Before saving your schema file, rename the AddressLast.xsd file that is
delivered with XMLSpy to something else (such as AddressLast_original.xsd), so as not

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: Advanced 61

to overwrite it.

Save the completed schema with any name you like (File | Save as). We recommend you save
it with the name AddressLast.xsd since the XML file you create in the next part of the tutorial
will be based on the AddressLast.xsd schema.

© 2010 Altova GmbH User Manual


62 XMLSpy Tutorial XML Schemas: XMLSpy Features

3.4 XML Schemas: XMLSpy Features


After having completed the XML Schema, we suggest you become familiar with a few
navigation shortcuts and learn about the schema documentation that you can generate from
within XMLSpy. These are described in the subsections of this section.

Commands used in this section


In this section of the tutorial, you will use Schema View exclusively. The following commands
are used:

Display Diagram (or Display Content Model View). This icon is located to the left of all
global components in Schema Overview. Clicking the icon causes the content model of
the associated global component to be displayed.

3.4.1 Schema Navigation


This section shows you how to navigate Schema View efficiently. We suggest that you try out
these navigation mechanisms to become familiar with them.

Displaying the content model of a global component


Global components that can have content models are complex types, elements, and element
groups. The Content Model View of these components can be opened in the following ways:

 In Schema Overview, click the Display Diagram icon to the left of the component
name.
 In either Schema Overview or Content Model View, double-click the element, complex
type, or element group in the Components Entry Helper (screenshot below).

If you double-click any of the other global components (simple type, attribute, attribute
group) in the Components Entry Helper, that component will be highlighted in Schema
Overview (since they do not have a content model).

In the Components Entry Helper, the double-clicking mechanism works from both the By Type
and By Namespace tabs.

Going to the definition of a global element from a referencing element


If a content model contains an element that references a global element, you can go directly to
the content model of that global element or to any of its contained components by holding down
Ctrl and double-clicking the required element.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: XMLSpy Features 63

For example, while viewing the Company content model, holding down Ctrl while
double-clicking Last opens the Person content model and highlights the Last element in it.

When the Last element is highlighted, all its properties are immediately displayed in the
relevant entry helpers and information window.

Going to the definition of a complex type


Complex types are often used as the type of some element within a content model. To go
directly to the definition of a complex type from within a content model, double-click the name of
the complex type in the yellow box (see mouse pointer in screenshot below).

This takes you to the Content Model View of the complex type.

© 2010 Altova GmbH User Manual


64 XMLSpy Tutorial XML Schemas: XMLSpy Features

Please note: Just as with referenced global elements, you can go directly to an element within
the complex type definition by holding down Ctrl and double-clicking the required element in the
content model that contains the complex type.

3.4.2 Schema Documentation


XMLSpy provides detailed documentation of XML Schemas in HTML and Microsoft Word (MS
Word) formats. You can select the components and the level of detail you want documented.
Related components are hyperlinked in both HTML and MS Word documents. In order to
generate MS Word documentation, you must have MS Word installed on your computer (or
network).

In this section, we will generate documentation for the AddressLast.xsd XML Schema.

Do the following:
1. Select the menu option Schema design | Generate documentation. This opens the
Schema Documentation dialog.

2. For the Output Format option, select HTML, and click OK.
3. In the Save As dialog, select the location where the file is to be saved and give the file a
suitable name (say AddressLast.html). Then click the Save button.

The HTML document appears in the Browser View of XMLSpy. Click on a link to go to
the corresponding linked component.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: XMLSpy Features 65

The diagram above shows the first page of the schema documentation in HTML form.
If components from other schemas have been included, then those schemas are also
documented.

© 2010 Altova GmbH User Manual


66 XMLSpy Tutorial XML Schemas: XMLSpy Features

The diagram above shows how complex types are documented.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Schemas: XMLSpy Features 67

The diagram above shows how elements and simple types are documented.

You can now try out the MS Word output option. The Word document will open in MS Word. To
use hyperlinks in the MS Word document, hold down Ctrl while clicking the link.

© 2010 Altova GmbH User Manual


68 XMLSpy Tutorial XML Documents

3.5 XML Documents


In this section you will learn how to create and work with XML documents in XMLSpy. You will
also learn how to use the various intelligent editing features of XMLSpy.

Objective
The objectives of this section are to learn how to do the following:
 Create a new XML document based on the AddressLast.xsd schema.
 Specify the type of an element so as to make an extended content model for that
element available to the element during validation.
 Insert elements and attributes and enter content for them in Grid View and Text View
using intelligent entry helpers.
 Copy XML data from XMLSpy to Microsoft Excel; add new data in MS Excel; and copy
the modified data from MS Excel back to XMLSpy. This functionality is available in the
Database/Table View of Grid View.
 Sort XML elements using the sort functionality of Database/Table View.
 Validate the XML document.
 Modify the schema to allow for three-digit phone extensions.

Commands used in this section


In this section of the tutorial, you will mostly use the Grid View and Text View, and in one
section Schema View. The following commands are used:

File | New. Creates a new type of XML file.

View | Text View. Switches to Text View.

View | Grid View. Switches to Enhanced Grid View.

XML | Table | Display as Table. Displays multiple occurrences of a single element


type at a single hierarchic level as a table. This view of the element is called the
Database/Table View (or simply Table View). The icon is used to switch between the
Table View and regular Grid View.

F7. Checks for well-formedness.

F8. Validates the XML document against the associated DTD or Schema.

Opens the associated DTD or XML Schema file.

3.5.1 Creating a New XML File


When you create a new XML file in XMLSpy, you are given the option of basing it on a schema
(DTD or XML Schema) or not. In this section you will create a new file that is based on the
AddressLast.xsd schema you created earlier in the tutorial.

To create the new XML file:


1. Select the menu option File | New. The Create new document dialog opens.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Documents 69

2. Select the Extensible Markup Language entry (or generic XML document entry) from
the dialog, and confirm with OK. A prompt appears, asking if you want to base the XML
document on a DTD or Schema.

3. Click the Schema radio button, and confirm with OK. A further dialog appears, asking
you to select the schema file your XML document is to be based on.
4. Use the Browse or Window buttons to find the schema file. The Window button lists all
files open in XMLSpy and projects. Select AddressLast.xsd (see Tutorial
introduction for location), and confirm with OK. An XML document containing the main
elements defined by the schema opens in the main window.
5. Click the Grid tab to select Grid View.
6. In Grid View, notice the structure of the document. Click on any element to reduce
selection to that element. Your document should look something like this:

© 2010 Altova GmbH User Manual


70 XMLSpy Tutorial XML Documents

7. Click on the icon next to Address, to view the child elements of Address. Your
document should look like this:

3.5.2 Specifying the Type of an Element


The child elements of Address are those defined for the global complex type AddressType (
the content model of which is defined in the XML Schema AddressLast.xsd shown in the Grid
View screenshot below).

We would, however, like to use a specific US or UK address type rather than the generic
address type. You will recall that, in the AddressLast.xsd schema, we created global
complex types for US-Address and UK-Address by extending the AddressType complex
type. The content model of US-Address is shown below.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Documents 71

In the XML document, in order to specify that the Address element must conform to one of the
extended Address types (US-Address or UK-Address) rather than the generic
AddressType, we must specify the required extended complex type as an attribute of the
Address element.

Do the following:
1. In the XML document, right-click the Name element, and select Insert | Attribute from
the context menu.

An attribute field is added to the Address element.


2. Ensure that xsi:type is entered as the name of the attribute (screenshot below).
3. Press Tab to move into the next (value) field.

4. Enter US-Address as the value of the attribute.

Please note: The xsi prefix allows you to use special XML Schema related commands in your
XML document instance. Notice that the the namespace for the xsi prefix was automatically

© 2010 Altova GmbH User Manual


72 XMLSpy Tutorial XML Documents

added to the document element when you assigned a schema to your XML file. In the above
case, you have specified a type for the Address element. See the XML Schema specification
for more information.

3.5.3 Entering Data in Grid View


You can now enter data into your XML document.

Do the following:
1. Double-click in the Name value field (or use the arrow keys) and enter US dependency
. Confirm with Enter.

2. Use the same method to enter a Street and City name (for example, Noble Ave
and Dallas).
3. Click the Person element and press Delete to delete the Person element. (We will
add it back in the next section of the tutorial.) After you do this, the entire Address
element is highlighted.
4. Click on any child element of the Address element to deselect all the child elements of
Address except the selected element. Your XML document should look like this:

3.5.4 Entering Data in Text View


Text View is ideal for editing the actual data and markup of XML files because of its DTD/XML
Schema-related intelligent editing features.

Structural layout features


In addition, Text View has a number of viewing and structural editing features that make editing

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Documents 73

large sections of text easy. These features can be switched on and off in the Text View Settings
dialog (View | Text View Settings, screenshot below).

The following margins in Text View can be switched on and off:


 Line number margins
 Bookmark margins, in which individual lines can be highlighted with a marker
 Source folding margins, which contain icons to expand and collapse the display of
elements

Additionally, visual aids such as indentation guides, end-of-line markers, and whitespace
markers can be switched on and off, by checking and unchecking, respectively, their check
boxes in the Visual Aid pane of the Text View Settings dialog (see screenshot above).

The bookmark feature is useful for setting up markers in your document. To insert a bookmark,
use the command Edit | Insert/Remove Bookmark. Once bookmarks have been inserted you
can navigate these bookmarks using commands in the Edit menu.

The screenshot below shows the current XML file in Text View with all structural editing features
enabled. For the sake of clarity, none of the line numbers, indentation guides, etc, will be shown
in Text View in rest of this tutorial. Please see the User Manual for more information on Text
View.

© 2010 Altova GmbH User Manual


74 XMLSpy Tutorial XML Documents

Editing in Text View


In this section, you will enter and edit data in Text View in order to become familiar with the
features of Text View.

Do the following:
1. Select the menu item View | Text view, or click on the Text tab. You now see the XML
document in its text form, with syntax coloring.

2. Place the text cursor after the end tag of the Address element, and press Enter to add
a new line.
3. Enter the less-than angular bracket < at this position. A dropdown list of all elements
allowed at that point (according to the schema) is displayed. Since only the Person
element is allowed at this point, it will be the only element displayed in the list.

4. Select the Person entry. The Person element, as well as its attribute Manager, are
inserted, with the cursor inside the value-field of the Manager attribute.

5. From the dropdown list for the Manager attribute, select true.

Press Enter to insert the value true at the cursor position.


6. Move the cursor to the end of the line (using the End key if you like), and press the
space bar. This opens a dropdown list, this time containing a list of attributes allowed at

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Documents 75

that point. Also, in the Attributes Entry Helper, the available attributes are listed in red.
The Manager attribute is grayed out because it has already been used.

7. Select Degree with the Down arrow key, and press Enter. This opens another list box,
from which you can select one of the predefined enumerations (BA, MA, or PhD).

8. Select BA with the Down arrow key and confirm with Enter. Then move the cursor to
the end of the line (with the End key), and press the space bar. Manager and Degree
are now grayed out in the Attributes Entry Helper.

9. Select Programmer with the Down arrow key and press Enter.

10. Enter the letter "f" and press Enter.


11. Move the cursor to the end of the line (with the End key), and enter the greater-than
angular bracket >. XMLSpy automatically inserts all the required child elements of
Person. (Note that the optional Title element is not inserted.) Each element has start
and end tags but no content.

© 2010 Altova GmbH User Manual


76 XMLSpy Tutorial XML Documents

You could now enter the Person data in Text View, but let's move to Grid View to see the
flexibility of moving between views when editing a document.

Switching to Grid View


To switch to Grid View, select the menu item View | Grid View, or click the Grid tab. The newly
added child elements of Person are highlighted.

Now let us validate the document and correct any errors that the validation finds.

3.5.5 Validating the Document


XMLSpy provides two evaluations of the XML document:
 A well-formedness check
 A validation check

If either of these checks fails, we will have to modify the document appropriately.

Checking well-formedness
An XML document is well-formed if starting tags match closing tags, elements are nested

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Documents 77

correctly, there are no misplaced or missing characters (such as an entity without its semi-colon
delimiter), etc.

You can do a well-formedness check in any editing view. Let us select Text View. To do a
well-formedness check, select the menu option XML | Check well-formedness, or press the

F7 key, or click . A message appears in the Messages window at the bottom of the Main
Window saying the document is well-formed.

Notice that the output of the Messages window has 9 tabs. The validation output is always
displayed in the active tab. Therefore, you can check well-formedness in Tab1 for one schema
file and keep the result by switching to Tab2 before validating the next schema document
(otherwise Tab1 is overwritten with the validation result ).

Please note: This check does not check the structure of the XML file for conformance with the
schema. Schema conformance is evaluated in the validity check.

Checking validity
An XML document is valid according to a schema if it conforms to the structure and content
specified in that schema.

To check the validity of your XML document, first select Grid View, then select the menu option

XML | Validate, or press the F8 key, or click . An error message appears in the Messages
window saying the file is not valid. Mandatory elements are expected after the City element in
Address. If you check your schema, you will see that the US-Address complex type (which
you have set this Address element to be with its xsi:type attribute) has a content model in
which the City element must be followed by a Zip element and a State element.

Fixing the invalid document


The point at which the document becomes invalid is highlighted, in this case the City element.

© 2010 Altova GmbH User Manual


78 XMLSpy Tutorial XML Documents

Now look at the Elements Entry Helper (at top right). Notice that the Zip element is prefixed
with an exclamation mark, which indicates that the element is mandatory in the current context.

To fix the validation error:


1. In the Elements Entry Helper, double-click the Zip element. This inserts the Zip
element after the City element (we were in the Append tab of the Elements Entry
Helper).
2. Press the Tab key, and enter the Zip Code of the State (04812), then confirm with
Enter. The Elements Entry Helper now shows that the State element is mandatory (it
is prefixed with an exclamation mark). See screenshot below.

3. In the Elements Entry Helper, double-click the State element. Then press Tab and
enter the name of the state (Texas). Confirm with Enter. The Elements Entry Helper
now contains only grayed-out elements. This shows that there are no more required
child elements of Address.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Documents 79

Completing the document and revalidating


Let us now complete the document (enter data for the Person element) before revalidating.

Do the following:
1. Click the value field of the element First, and enter a first name (say Fred). Then
press Enter.

2. In the same way enter data for all the child elements of Person, that is, for Last,
PhoneExt, and Email. Note that the value of PhoneExt must be an integer with a
maximum value of 99 (since this is the range of allowed PhoneExt values you defined
in your schema). Your XML document should then look something like this in Grid View:

© 2010 Altova GmbH User Manual


80 XMLSpy Tutorial XML Documents

3. Click again to check if the document is valid. A message appears in the Messages
window stating that the file is valid. The XML document is now valid against its schema.

4. Select the menu option File | Save and give your XML document a suitable name (for
example CompanyFirst.xml). Note that the finished tutorial file CompanyFirst.xml
is in the Tutorial folder, so you may need to rename it before you give that name to
the file you have created.

Please note: An XML document does not have to be valid in order to save it. Saving an invalid
document causes a prompt to appear warning you that you are about to save an invalid
document. You can select Save anyway, if you wish to save the document in its current invalid
state.

3.5.6 Adding Elements and Attributes


At this point, there is only one Person element in the document.

To add a new Person element:

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Documents 81

1. Click the gray sidebar to the left of the Address element to collapse the Address
element. This clears up some space in the view.
2. Select the entire Person element by clicking on or below the Person element text in
Grid View. Notice that the Person element is now available in the Append tab of the
Elements Entry Helper.

3. Double-click the Person element in the Elements Entry Helper. A new Person
element with all mandatory child elements is appended (screenshot below). Notice that
the optional Title child element of Person is not inserted.

4. Switch to Grid View and then press F12 to switch the new Person element from Table
View to normal Grid View.
5. Click on the Manager attribute of the new Person element. Take a look at the
Attributes Entry Helper. The Manager entry is grayed out because it has already been
entered. Also look at the Info Window, which now displays information about the
Manager attribute. It is a required attribute and has therefore been added. The
Programmer attribute has not been added.
6. In the Append tab of the Attributes Entry Helper, double-click the Programmer entry.
This inserts an empty Programmer attribute after the Manager attribute.

© 2010 Altova GmbH User Manual


82 XMLSpy Tutorial XML Documents

The Programmer attribute is now grayed out in the Attributes Entry Helper.

You could enter content for the Person element in this view, but let's switch to the
Database/Table View of Grid View since it is more suited to editing a structure with multiple
occurrences, such as Person.

3.5.7 Editing in Database/Table View


Grid View contains a special view called Database/Table View (hereafter called Table View),
which is convenient for editing elements with multiple occurrences. Individual element types can
be displayed as a table. When an element type is displayed as a table, its children (attributes
and elements) are displayed as columns, and the occurrences themselves are displayed as
rows.

To display an element type as a table, you select any one of the element type occurrences and
click the Display as Table icon in the toolbar (XML | Table | Display as table). This causes
that element type to be displayed as a table. Descendant element types that have multiple
occurrences are also displayed as tables. Table View is available in Enhanced Grid View, and
can be used to edit any type of XML file (XML, XSD, XSL, etc.).

Advantages of Table View


Table View provides the following advantages:
 You can drag-and-drop column headers to reposition the columns relative to each
other. This means that, in the actual XML document, the relative position of child
elements or attributes is modified for all the element occurrences that correspond to the
rows of the table.
 Tables can be sorted (in ascending or descending order) according to the contents of
any column using XML | Table | Ascending Sort or Descending Sort.
 Additional rows (i.e., element occurrences) can be appended or inserted using XML |
Table | Insert Row.
 You can copy-and-paste structured data to and from third party products
 The familiar intelligent editing feature is active in Table View also.

Displaying an element type as a Table


To display the Person element type as a table:
1. In Grid View, select either of the Person elements by clicking on or near the Person
text.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Documents 83

© 2010 Altova GmbH User Manual


84 XMLSpy Tutorial XML Documents

2. Select the menu option XML | Table | Display as table, or click the Display as Table
icon. Both Person elements are combined into a single table. The element and
attribute names are now the column headers, and the element occurrences are the
rows of the table.

3. Select the menu option View | Optimal widths, or click the Optimal Widths icon,
to optimize the column widths of the table.

Please note: Table View can be toggled off for individual element types in the document by
selecting that table (click the element name in the table) and clicking the Display As Table
icon. Note however that child elements which were displayed as tables will continue to be
displayed as tables.

Entering content in Table View


To enter content for the second Person element, double-click in each of the table cells in the
second row, and enter some data. Note, however, that PhoneExt must be an integer up to 99
in order for the file to be valid. The intelligent editing features are active also within cells of a
table, so you can select options from dropdown lists where options are available (Boolean
content and the enumerations for the Degree attribute).

Please note: The Entry Helpers are active also for the elements and attributes displayed as a
table. Double-clicking the Person entry in the Elements Entry Helper, for example, would add a
new row to the table (i.e., a new occurrence of the Person element).

Copying XML data to and from third party products


You can copy spreadsheet-type data between third party products and XML documents in
XMLSpy. This data can be used as XML data in XMLSpy and as data in the native format of the
application copied to/from. In this section you will learn how to copy data to and from an Excel
data sheet.

Do the following:
1. Click on the row label 1, hold down the Ctrl key, and click on row label 2. This selects
both rows of the table.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Documents 85

2. Select the menu option Edit | Copy as Structured text. This command copies
elements to the clipboard as they appear on screen.
3. Switch to Excel and paste (Ctrl+V) the XML data in an Excel worksheet.

4. Enter a new row of data in Excel. Make sure that you enter a three digit number for the
PhoneExt element (say, 444).

5. Mark the table data in Excel, and press Ctrl+C to copy the data to the clipboard.
6. Switch back to XMLSpy.
7. Click in the top left data cell of the table in XMLSpy, and select Edit | Paste.

8. The updated table data is now visible in the table.


9. Change the uppercase boolean values TRUE and FALSE to lowercase true and false
, respectively, using the menu option Edit | Replace (Ctrl+H).

Sorting the table by the contents of a column


A table in Table View can be sorted in ascending or descending order by any of its columns. In
this case, we want to sort the Person table by last names.

To sort a table by the contents of a column:


1. Select the Last column by clicking in its header.

© 2010 Altova GmbH User Manual


86 XMLSpy Tutorial XML Documents

2. Select the menu option XML | Table | Ascending sort or click on the Ascending Sort

icon . The column, and the whole table with it, are now sorted alphabetically. The
column remains highlighted.

The table is sorted not just in the display but also in the underlying XML document. That
is, the order of the Person elements is changed so that they are now ordered
alphabetically on the content of Last. (Click the Text tab if you wish to see the changes
in Text View.)
3. Select the menu option XML | Validate or press F8. An error message appears
indicating that the value '444' is not allowed for a PhoneExt element (see screenshot).
The invalid PhoneExt element is highlighted .
Expand "Details" to see that PhoneExt is not valid because it is not less than or equal
to the maximum value of 99.
Please Note: You can click on the links in the error message to jump to the spot in the
XML file where the error was found.

Since the value range we set for phone extension numbers does not cover this
extension number, we have to modify the XML Schema so that this number is valid.
You will do this in the next section.

3.5.8 Modifying the Schema


Since two-digit phone extension numbers do not cover all likely numbers, let's extend the range
of valid values to cover three-digit numbers. We therefore need to modify the XML Schema.
You can open and modify the XML Schema without having to close your XML document.

Do the following:
1. Select the menu option DTD/Schema | Go to definition or click the Go To Definition

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XML Documents 87

icon . The associated schema, in this case AddressLast.xsd is opened. Switch to


Schema View (screenshot below).

2. Click the Display Diagram icon of the global Person element, and then click the
PhoneExt element. The facet data in the Facets tab is displayed.

3. In the Facets tab, double-click the maxIncl value field, change the value 99 to 999,
and confirm with Enter.

4. Save the schema document.

© 2010 Altova GmbH User Manual


88 XMLSpy Tutorial XML Documents

5. Press Ctrl+Tab to switch back to the XML document.

6. Click to revalidate the XML document.

A message that the file is valid appears in the Validation window. The XML document
now conforms to the modified schema.
7. Select the menu option File | Save As... and save the file as CompanyLast.xml.
(Remember to rename the original CompanyLast.xml file that is delivered with
XMLSpy to something else, like CompanyLast_orig.xml).

Please note: The CompanyLast.xml file delivered with XMLSpy is in the in the Tutorial
folder.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XSLT Transformations 89

3.6 XSLT Transformations


Objective
To generate an HTML file from the XML file using an XSL stylesheet to transform the XML file.
You should note that a "transformation" does not change the XML file into anything else; instead
a new output file is generated. The word "transformation" is a convention.

Method
The method used to carry out the transformation is as follows:
 Assign a predefined XSL file, Company.xsl, to the XML document.
 Execute the transformation within the XMLSpy interface using one of the two built-in
Altova XSLT engines. (See note below.)

Commands used in this section


The following XMLSpy commands are used in this section:

XSL/XQuery | Assign XSL, which assigns an XSL file to the active XML document.

XSL/XQuery | Go to XSL, opens the XSL file referenced by the active XML document.

XSL/XQuery | XSL Transformation (F10), or the toolbar icon , transforms the active
XML document using the XSL stylesheet assigned to the XML file. If an XSL file has not been
assigned then you will be prompted for one when you select this command.

Please note: XMLSpy has two built-in XSLT engines, the Altova XSLT 1.0 Engine and Altova
XSLT 2.0 Engine. The Altova XSLT 1.0 Engine is used to process XSLT 1.0 stylesheets. The
Altova XSLT 2.0 Engine is used to process XSLT 2.0 stylesheets. The correct engine is
automatically selected by XMLSpy on the basis of the version attribute in the xsl:stylesheet
or xsl:transform element. In this tutorial transformation, we use XSLT 1.0 stylesheets. The
Altova XSLT 1.0 Engine will automatically be selected for transformations with these stylesheets
when the XSL Transformation command is invoked.

3.6.1 Assigning an XSLT File


To assign an XSLT file to the CompanyLast.xml file:
1. Click the CompanyLast.xml tab in the main window so that CompanyLast.xml
becomes the active document, and switch to Text View.
2. Select the menu command XSL/XQuery | Assign XSL.
3. Click the Browse button, and select the Company.xsl file from the Tutorial folder. In
the dialog, you can activate the option Make Path Relative to CompanyLast.xml if you
wish to make the path to the XSL file (in the XML document) relative.4. Click OK to
assign the XSL file to the XML document.
5. Switch to Grid View to see the assignment (screenshot below).

© 2010 Altova GmbH User Manual


90 XMLSpy Tutorial XSLT Transformations

An XML-stylesheet processing instruction is inserted in the XML document that


references the XSL file. If you activated the Make Path Relative to CompanyLast.xml
check box, then the path is relative; otherwise absolute (as in the screenshot above).

3.6.2 Transforming the XML File


To transform the XML document using the XSL file you have assigned to it:
1. Ensure that the XML file is the active document.
2. Select the menu option XSL/XQuery | XSL Transformation (F10) or click the icon.
This starts the transformation using the XSL stylesheet referenced in the XML
document. (Since the Company.xsl file is an XSLT 1.0 document, the built-in Altova
XSLT 1.0 Engine is automatically selected for the transformation.) The output document
is displayed in Browser View; it has the name XSL Output.html. (If the HTML output
file is not generated, ensure that, in the XSL tab of the Options dialog (Tools | Options
), the default file extension of the output file has been set to .html.) The HTML
document shows the Company data in one block down the left, and the Person data in
tabular form below.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial XSLT Transformations 91

Please note: Should you only see a table header and no table data in the output file,
make sure that you have defined the target namespace for your schema as detailed in
Defining your own namespace at the beginning of the tutorial. The namespace must be
identical in all three files (Schema, XML, and XSL).

3.6.3 Modifying the XSL File


You can change the output by modifying the XSL document. For example, let's change the
background-color of the table in the HTML output from lime to yellow.

Do the following:
1. Click the CompanyLast.xml tab to make it the active document, and make sure you
are in Grid View.
2. Select the menu option XSL/XQuery | Go to XSL.

© 2010 Altova GmbH User Manual


92 XMLSpy Tutorial XSLT Transformations

The command opens the Company.xsl file referenced in the XML document.
3. Find the line <table border="1" bgcolor="lime">, and change the entry
bgcolor="lime" to bgcolor="yellow".

4. Select the menu option File | Save to save the changes made to the XSL file.
5. Click the CompanyLast.xml tab to make the XML file active, and select XSL/XQuery |
XSL Transformation, or press F10. A new XSL Output.html file appears in the
XMLSpy GUI in Browser View. The background color of the table is yellow.

6. Select the menu option File | Save, and save the document as Company.html.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial Project Management 93

3.7 Project Management


This section introduces you to the project management features of XMLSpy. After learning
about the benefits of organizing your XML files into projects, you will organize the files you have
just created into a simple project.

3.7.1 Benefits of Projects


The benefits of organizing your XML files into projects are listed below.
 Files and URLs can be grouped into folders by common extension or any other criteria.
 Batch processing can be applied to specific folders or the project as a whole.
 A DTD or XML Schema can be assigned to specific folders, allowing validation of the
files in that folder.
 XSLT files can be assigned to specific folders, allowing transformations of the XML files
in that folder using the assigned XSLT.
 The destination folders of XSL transformation files can be specified for the folder as a
whole.

All the above project settings can be defined using the menu option Project | Project
Properties.... In the next section, you will create a project using the Project menu.

Additionally, the following advanced project features are available:


 XML files can be placed under source control using the menu option Project | Source
control | Add to source control.... (Please see the Source Control section in the
online help for more information.)
 Personal, network and web folders can be added to projects, allowing batch validation.

3.7.2 Building a Project


Having come to this point in the tutorial, you will have a number of tutorial-related files open in
the Main Window. You can group these files into a tutorial project. First you create a new project
and then you add the tutorial files into the appropriate sub-folders of the project.

Creating a basic project


To create a new project:
1. Select the menu option Project | New Project. A new project folder called New
Project is created in the Project Window. The new project contains empty folders for
typical categories of XML files in a project (screenshot below).

2. Click the CompanyLast.xml tab to make the CompanyLast.xml file the active file in
the Main Window.
3. Select the menu option Project | Add active and related files to project. Two files are
added to the project: CompanyLast.xml and AddressLast.xsd. Note that files

© 2010 Altova GmbH User Manual


94 XMLSpy Tutorial Project Management

referenced with Processing instructions (such as XSLT files) do not qualify as related
files.
4. Select the menu option Project | Save Project and save the project under the name
Tutorial.

Adding files to the project


You can add other files to the project as well. Do this as follows:
1. Click on any open XML file (with the .xml file extension) other than
CompanyLast.xml to make that XML file the active file. (If no other XML file is open,
open one or create a new XML file.)
2. Select the menu option Project | Add active file to project. The XML file is added to
the XML Files folder on the basis of its .xml file type.
3. In the same way, add an HTML file and XSD file (say, the Company.html and
AddressFirst.xsd files) to the project. These files will be added to the HTML Files
folder and DTD/Schemas folder, respectively.
4. Save the project, either by selecting the menu option Project | Save Project or by
selecting any file or folder in the Project Window and clicking the Save icon in the
toolbar (or File | Save).

Please note: Alternatively, you can right-click a project folder and select Add Active File to add
the active file to that specific folder.

Other useful commands


Here are some other commonly used project commands:
 To add a new folder to a project, select Project | Add Project folder to Project, and
insert the name of the project folder.
 To delete a folder from a project, right-click the folder and select Delete from the
context menu.
To delete a file from a project, select the file and press the Delete key.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Tutorial That's It 95

3.8 That's It
If you have come this far congratulations, and thank you!

We hope that this tutorial has been helpful in introducing you to the basics of XMLSpy. If you
need more information please use the context-sensitive online help system, or print out the PDF
version of the tutorial, which is available as tutorial.pdf in your XMLSpy application folder.

© 2010 Altova GmbH User Manual


96 Editing Views

4 Editing Views
XMLSpy contains powerful editing views. In addition to a Text View with intelligent editing
features, there are graphical views that greatly simplify the editing of documents. Depending on
what type of document is currently active in XMLSpy, the Main Window will have one or more
of XMLSpy's Editing Views. For example, when an Office Open XML file or ZIP file is active, the
Main Window will contain just one editing view: Archive View. When an HTML document is
active, there will be two editing views: Text View and Browser View. When an XML document is
active, there will be seven editing views: Text View, Grid View, Schema View, WSDL View,
XBRL View, Authentic View, and Browser View; of these Schema View will be enabled only for
XML Schema documents, and WSDL View only for WSDL documents.

In this section, we describe the various editing views available in XMLSpy:


 Text View
 Grid View
 Schema View
 WSDL View
 XBRL View
 Authentic View
 Browser View
 Archive View

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Text View 97

4.1 Text View


In Text View (screenshot below), you can type in the text of your document—both, markup and
content—directly. Any text file, including non-XML documents (such as XQuery and HTML
documents) can be edited in Text View. A number of features help you to quickly and accurately
type in your document.

In this section, we describe general Text View features that are available for all kinds of
documents. Specific document types, such as XML, XQuery, and CSS have certain
type-specific features, which are described in the respective sections for those document types.
For example, additional XML-specific features of Text View are described in the section XML |
Editing XML in Text View.

The general Text View features have been organized as follows:


 Formatting in Text View describes how the font properties, indentation, and
word-wrapping of the document can be specified.
 Document display contains information about the line-numbering, bookmarking,
expanding/collapsing of nodes, and other display-related features.
 Editing in Text View describes the features that are available while you edit, particularly
the intelligent editing features.
 Entry helpers are the windows that provide context-sensitive data-entry options. For
example, the elements or attributes that can be validly added at a given document
location are displayed in an entry helper and any one of these options can be inserted
by double-clicking it.

Switching to Text View


To open the Text View of a document, click the Text button at the bottom of the Document
Window or select View | Text View.

4.1.1 Formatting in Text View


Text View offers a number of text formatting options. These are listed below.

© 2010 Altova GmbH User Manual


98 Editing Views Text View

Fonts
The font-family, font-size, font-style, and text background-color can be customized separately
for the following groups of documents: (i) generic XML documents (including HTML); (ii) XQuery
documents; and (iii) CSS documents.

Text items in a document that have different semantics, can be colored differently. For example,
you can color element names, attribute names, and element content differently. When you set
different colors for different text items, the syntax-coloring feature is enabled. Text fonts are
customized in the Text Fonts tab of the Options dialog, and how to do this is described in the
section, User Reference | Options | Text Fonts section of this documentation.

Indentation
Well-formed XML documents can be pretty-printed. This means that the document can be
formatted so that the hierarchical structure of the document is displayed using new lines and
indentations (see screenshot below).

To display the document in this way, you need to do the following:


1. In the View Tab of the Options dialog, check the Use Indentation option for pretty
printing. This will cause the document to be pretty-printed with indents to indicate the
hierarchical structure. Each deeper level will be displayed with a deeper indent than its
parent element. If the Use Indentation option is not checked, every line in the document
will start with a zero indent.
2. In the Text View Settings dialog (screenshot below), select either Insert Tabs or Insert
Spaces. This determines whether tabs or spaces will be used for indentation when the
document is pretty-printed. If spaces are specified, each deeper level of the hierarchy is
indented with an additional number of spaces as specified in the Tab Size setting of the
Text View Settings dialog.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Text View 99

3. Click the Edit | Pretty-Print XML Text command or the Pretty Print icon in the Text
toolbar. This will cause the document text to be displayed (i) with or without indentation
as specified in the View Tab of the Options dialog; and (ii) if indentation is specified in
the View Tab of the Options dialog, then the the indentation is determined by the
settings in the Tabs pane of the Text View Settings dialog. Clicking the Pretty Print
command removes unnecessary leading or trailing whitespace.

Note: Pretty-printing is also used in the background when you save the document or switch
views. If the document is not well-formed, you will get an error message to that effect.
Correct the error and then pretty-print. The extent of indentation of a line is indicated by
indentation guides, which are vertical dotted lines (see screenshot at the start of this
section) that are toggled on and off with the Indentation Guides check box in the Visual
Aid pane of the Text View Settings dialog (see screenshot above).

Using tabs and spaces for formatting


You can use tabs and spaces for formatting text, especially for non-XML documents, where the
pretty-printing option is not available. When you press Return or Shift+Return, the cursor will
jump to a position on the next line that corresponds to the starting position of the previous line.

Word-wrapping
Lines of text that are longer than the breadth of the Main Window can be made to wrap by
toggling the View | Word Wrap command on; the corresponding icon is in the Text toolbar.

4.1.2 Displaying the Document


Text View has visual features to make the display and editing of large sections of text easier.
Some very useful features are: (i) Line Numbers, (ii) Bookmarks, (iii) Source Folding (expanding
and collapsing the display of nodes), (iv) Indentation Guides, and (v) End-of-Line and
Whitespace Markers. These commands are available in the Text View Settings dialog (first
screenshot below) and the Text toolbar (second screenshot below).

The Text View Settings dialog is accessed via the View | Text View Settings command or the
Text View Settings button in the Text toolbar. Settings in the Text View Settings dialog apply to

© 2010 Altova GmbH User Manual


100 Editing Views Text View

the entire application—not only to the active document.

Other useful features are the Zooming and Go-to-Line/Character features.

Line numbers
Line numbers are displayed in the line numbers margin (screenshot below), which can be
toggled on and off In the Text View Settings dialog (see screenshot above). When a section of
text is collapsed, the line numbers of the collapsed text are also hidden. A related command is
the Go-to-Line/Character command.

Bookmarks
Lines in the document can be separately bookmarked for quick reference and access. If the
bookmarks margin is toggled on, bookmarks are displayed in the bookmarks margin; otherwise,
bookmarked lines are highlighted in cyan.

The bookmarks margin can be toggled on or off in the Text View Settings dialog (screenshot
above).

You can edit and navigate bookmarks using commands in the Edit menu and Text toolbar.
Bookmarks can be inserted with the Edit | Insert/Remove Bookmark command, enabling you
to mark a line in the document for reference. A bookmark can be removed by selecting the
bookmarked line and then selecting the Edit | Insert/Remove Bookmark command. To
navigate through the bookmarks in a document, use the Edit | Next Bookmark and Edit |
Previous Bookmark commands. These bookmark commands are also available as icons in
the Text toolbar (screenshot above).

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Text View 101

Source folding
Source folding refers to the ability to expand and collapse nodes (screenshot below) and is
displayed in the source folding margin. The margin can be toggled on and off in the Text View
Settings dialog (see screenshot above). In the screenshot below, notice how the line numbering
at Lines 14 and 24 has been collapsed together with the collapsed nodes.

The Toggle All Folds command in the Text toolbar toggles all nodes to their expanded forms
or collapses all nodes to the top-level document element. After a node has been expanded, the
following options are available when clicking on the node's toggle icon (+/- icon):
 Plain click: Collapses the node. Clicking on it again expands the node so that
descendant nodes are shown expanded or collapsed according to how they were
before the node was collapsed.
 Ctrl+Click: Expands all descendant nodes recursively. This means that all descendant
nodes are expanded.
 Shift+Click: Collapses descendant nodes, but keeps the node itself open.

Indentation guides
Indentation guides are vertical dotted lines that indicate the extent of a line's indentation (see
screenshot above). They can be toggled on and off in the Text View Settings dialog.

End-of-line markers, whitespace markers


End-of-line (EOL) markers and whitespace markers can be toggled on in the Text View Settings
dialog. The screenshot below shows these markers in the document display; each dot
represents a whitespace.

Zooming in and out


You can zoom in and out of Text View by scrolling (with the scroll-wheel of the mouse) while

© 2010 Altova GmbH User Manual


102 Editing Views Text View

keeping the Ctrl key pressed. This enables you to magnify and reduce the size of text in Text
View. If you wish to increase the size of fonts, do this in the Options dialog.

Go to line/character
This command in the View menu and Text toolbar enables you to go to a specific line and
character in the document text.

4.1.3 Editing in Text View


The following text editing features are generally available in Text View for all document types.
These features are in addition to common features of editing applications, such as Cut, Copy,
Paste, Delete, and Select All (these commands are in the Edit menu).
 Syntax coloring
 Start-tag and end-tag matching
 Intelligent editing
 Auto-completion
 Moving siblings relative to each other
 Drag-and-drop and context menus
 Find and replace
 Unlimited undo

For some document types (such as XML and XQuery) additional specialized features are
available, and these are described, respectively, in the sections that deal with those document
types.

Note: For large files, Auto-completion and entry helpers can be disabled, thus enabling faster
loading and editing. The threshold file size is specified by the user. For more details,
see the reference section, Options | Editing.

Syntax coloring
Syntax coloring is applied according to the semantic value of the text. For example, in XML
documents, depending on whether the XML node is an element, attribute, content, CDATA
section, comment, or processing instruction, the node name (and in some cases the node's
content) is colored differently. Four groups of document type are distinguished: (i) generic XML
(which includes HTML); (ii) XQuery; (iii) CSS; and (iv) JSON. The text properties (including
color) of each group can be set in the Text Fonts tab of the Options dialog (Tools | Options).

Start-tag and end-tag matching


When you place the cursor inside a start or end tag of a markup element, pressing Ctrl+E
highlights the other member of the pair. Pressing Ctrl+E repeatedly enables you to switch
between the start and end tags. This is an excellent aid to locating the start and end tags of an
XML element.

Intelligent Editing
If you are working with an XML document based on a schema, XMLSpy provides you with
various intelligent editing capabilities in Text View. These allow you to quickly insert the correct
element, attribute, or attribute value according to the content model defined for the element you
are currently editing. For example, when you start typing the start tag of an element, the names
of all the elements allowed by the schema at this point are shown in a pop-up (screenshot
below). Selecting the required element name and pressing Enter inserts that element name in

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Text View 103

the start tag.

Popup windows also appears in the following cases:


 When the cursor is inside the start tag of an element that has an attribute defined for it
and the space bar is pressed. The popup will contain all available attributes.
 When the cursor is within the double-quotes delimiting an attribute value that has
enumerated values. The popup will contain the enumerated values.
 When you type </ (which signifies the start of a closing tag), the name of the element to
be closed appears in the popup.
 When you wish to write an empty element as a single tag or convert an empty element
of two tags to an empty element of one tag, type in the closing slash after the element
name: <element/. An empty element with a single tag is created; if a close tag exists, it
is removed: <element/>.

Auto-completion
Editing in Text View can easily result in XML and other marked-up documents (such as HTML)
that are not well-formed. For example, closing tags may be missing, mis-spelled, or structurally
mismatched. XMLSpy automatically completes the start and end tags of elements, as well as
inserts all required attributes as soon as you finish entering the element name on your
keyboard. The cursor is also automatically positioned between the start and end tags of the
element, so that you can immediately continue to add child elements or contents: <img src=""
alt=""> </img>

XMLSpy makes use of the XML rules for well-formedness and validity to support
auto-completion. The information about the structure of the document is obtained from the
schema on which the document is based. (In the case of well-used schemas, such as HTML
and XSLT, the schema information is built into XMLSpy.) Auto-completion uses not only
information about the structure of the document, but also the values stored in the document. For
example, enumerations and schema annotations in an XML Schema are actively used by the
Auto-Completion feature. If, in the schema, values are enumerated for a particular node, then
those enumerations will be displayed as auto-completion options when that node comes to be
edited. Similarly, if, for a node, annotations exist in the schema, then these annotations are
displayed when the node name is being typed in the document (screenshot below). (First
(given) name of person is the schema annotation of the First element.)

© 2010 Altova GmbH User Manual


104 Editing Views Text View

Auto-completion can be switched on and off in the Editing tab of the Options dialog (Tools |
Options | Editing).

Moving sibling elements relative to each other


When the cursor is within an element, pressing Alt+ArrowUp or Alt+ArrowDown moves the
selected element up or down relative to its siblings.

Drag-and-Drop and Context Menus


You can also use drag-and-drop to move a text block to a new location, as well as right-click to
directly access frequently used editing commands (such as Cut, Copy, Paste, Delete, Send by
Mail, and Go to line/char) in a context menu.

Find and Replace


You can use the Find and Replace commands to quickly locate and change text. These
commands also take regular expressions as input, thereby giving you powerful search
capabilities. (See Edit | Find for details.)

Unlimited Undo
XMLSpy offers unlimited levels of Undo and Redo for all editing operations.

4.1.4 Entry Helpers in Text View


What entry helpers are available in Text View depends upon the type of document being edited.
A list of entry helpers is given below for the most common document types. The general use of
entry helpers is described below. Additional features for specific document types, if any, are
described in the sections describing the respective document types.
 XML: Elements (screenshot below), Attributes, Entities

 HTML: Elements, Attributes, Entities


 CSS: CSS Outline, CSS Properties, HTML Elements
 DTD: None
 XQuery: XQuery Keywords, XQuery Variables, XQuery Functions
 WSDL: Overview, Details
 Text: Entities

Note that several document types, such as XSD, XSLT, XHTML, and RDF, are essentially XML
documents and will therefore have the Elements, Attributes, and Entities entry helpers.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Text View 105

Display and use of entry helper items


Different items in the various entry helpers are variously color-coded. These color codes are
explained in the Entry Helpers documentation of the respective document types. In general, the
following points should be noted about entry helpers:
 The entry helpers are context-sensitive and display items that may be inserted at that
point.
 If the item has already been inserted at the selected (or at another equivalent and valid
location) and may not be inserted again at that location (for example, an XML attribute),
it is displayed in gray.
 If the item is mandatory, an exclamation mark icon is displayed next to it.
 To insert an entry helper item at the cursor selection point in the text, double-click the
entry-helper item.
 When an element is inserted via the Elements entry helper, its start and end tags are
inserted in the document text. Mandatory elements are also inserted if this option has
been specified in the Options dialog (Tools | Options | Editing).
 When an attribute is inserted via the Attributes entry helper, the attribute is inserted at
the cursor point together with an equals-to sign and quotes to delimit the attribute value.
The cursor is placed between the quotes, so you can start typing in the attribute value
directly.

Note: For large files, Auto-completion and entry helpers can be disabled, thus enabling faster
loading and editing. The threshold file size is specified by the user. For more details,
see the reference section, Options | Editing.

© 2010 Altova GmbH User Manual


106 Editing Views Grid View

4.2 Grid View


Grid View (screenshot below) shows the hierarchical structure of XML documents and DTDs
through a set of nested containers, that can be easily expanded and collapsed to get a clear
picture of the document's structure. In Grid View contents and structure can both be easily
manipulated.

A hierarchical item (such as the XML declaration, document type declaration, or element
containing child elements) is represented with a gray bar on the left side containing a small
upwards-pointing arrow at the top. Clicking the side bar expands or collapses the item. An
element is denoted with the icon, an attribute with the icon.

Display and navigation


 The contents of an item depend on its kind. For example, in the case of elements, the
contents will typically be attributes, character data, comments, and child elements.
Attributes are always listed and are ordered as in the input file. Following the attributes,
items appear exactly in the order found in the source file. This order can be changed
using drag-and-drop, and the change will also be implemented in the source data.
 If an element contains only character data, the data will be shown in the same line as
the element and the element will not be considered hierarchical by nature. The
character data for any other element will be shown indented with the attributes and
potential child elements and will be labeled as "Text".
 If an element is collapsed, its attributes and their values are shown in the same line in
gray. This attribute preview is especially helpful, when editing XML documents that
contain a large number of elements of the same name that differ only in their contents
and attributes (for example, database-like applications).
 The arrow keys move the selection bar in the grid view
 The + and – keys on the numeric keypad allow you to expand and collapse items.

Customizing Grid View


 To resize columns, place the cursor over the appropriate border and drag so as to

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Grid View 107

achieve the desired width.


 To resize a column to the width of its largest entry, double-click on the grid line to the
right of that column.
 To adjust column widths to display all content, select the menu item View | Optimal

widths command, or click on the Optimal widths icon .


 The heights of cells are determined by their contents. They can be adjusted with the
menu option Tools | Options | View | Grid View, "Limit cell height to xx lines".

Please note: If you mark data in Grid View and switch to Text View, that data will be marked
also in Text View.

Intelligent editing
Grid View enables intelligent editing when the XML document is based on a schema. See
Editing in Grid View for details. The Entry Helpers used in Grid View are described below.

Grid View tables


Grid View allows you to display recurring elements in a table (Grid View tables). This function is
available for any type of XML file: XML, XSD, XSLT, etc.

4.2.1 Editing in Grid View


When editing an XML document based on a schema (DTD or XML Schema), Grid View
provides intelligent editing features based on information gathered from the schema. These
features are listed below.

Inserting or appending element or attribute names


To insert or append an element or attribute relative to a selected item, you can use either
commands in the XML menu or icons in the Attributes and Elements Toolbar

. If this toolbar is not visible, select the menu option Tools |


Customize, and, in the Toolbars tab, check the Attr & Elem entry. For a detailed explanation
of how to use the toolbar icon commands and XML menu commands, see the XML Menu
section.

To insert or append an element or attribute:


1. Select the item relative to which the element or attribute is to be inserted or appended.
2. Click on the appropriate icon in the Attributes and Elements toolbar, or select the
appropriate command from the XML menu (Insert, Append, or Add Child). This
creates a new entry in the grid and opens a popup with available element or attribute
options.
3 Select the desired element or attribute from the popup, and either click or press Enter.
Alternatively, you can type in the name of the desired element or attribute.

You will notice that the various Entry Helpers are constantly updated depending on the current
selection in the Grid View. The Info Window constantly shows important information regarding
the selected element or attribute.

Editing an element or attribute name


When you edit the name of an element or attribute, a popup menu containing the available
options opens. These options depend on the position of the element and the content model

© 2010 Altova GmbH User Manual


108 Editing Views Grid View

defined by the schema. A similar popup is displayed if the contents of an element or attribute
are restricted by an enumeration or choice of some sort.

To edit an element or attribute name:


1. Double-click the element or attribute name. A popup with the available options appears.
2. Select the required element or attribute from the popup menu.
3. Accept the selection by hitting Return or clicking the name. (Esc causes the change to
be abandoned.)

Adding namespace prefixes


The XML | Namespace Prefix command enables a namespace prefix to be added to the
selected node in Grid View and all its descendant element or attribute elements. The
namespace will have to be declared separately.

Grid View context menu


In addition to the commands available through the various menus and toolbars, Grid View also
provides a context menu that contains the most frequently used commands collected from
several menus in one convenient place. To open the context menu, right-click the item for which
you wish to perform an action.

4.2.2 Grid View Tables


Table View is integrated in the Grid View and allows you to view recurring elements in table
form. Table View is different from the normal Grid View in that it creates a column for each
child-type of the element displayed as a table. You can then modify properties for entire
columns or selections.

For instance, consider the following XML document:

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Grid View 109

The document element is article, and article has the following sequence of child
elements: one title element, four sect1 elements, and one appendix element. Each
sect1 and appendix element has one title element followed by any number of para or
simpara elements.

The normal Grid View of this document is as follows:

Now here is the Table View of this document—more correctly, that of the article element.
(To get this view: select the article element in normal Grid View (by clicking on it) and click
the Display as Table icon . Alternatively, select the menu item XML | Table | Display as
Table (F12).)

© 2010 Altova GmbH User Manual


110 Editing Views Grid View

Notice that each child element of article (the element displayed as a table)—that is, title,
sect1, and appendix—has been assigned a column and that each occurrence of each
child-type is listed in the appropriate column. Note also that the table structure extends only to
the child level (the sect1 elements themselves are not displayed as a table). In order to
display sect1 elements as a table, select any of the sect1 elements in the sect1 column,
and click . The sect1 elements are now displayed in a table (see screenshot below): each of
their child elements is assigned a column in the sect1 table.

In each column, if a child element (title, simpara, or para) exists for one of the four
occurrences of sect1, then that cell has a white background (e.g. simpara in the first sect1).
If a child does not exist for an occurrence then the corresponding cell has a gray background
(e.g. para in first sect1). It should be apparent, therefore, that columns were assigned by
taking a union of all child elements of all sect1 occurrences, and creating a column for each
unique child-type.

Please note:
 Attributes are also considered child nodes, and columns are also created for attributes.
 You can switch between normal Grid View and Table View by selecting the desired
element and clicking or F12.
 If you are viewing the document in Table View and you switch to Text View, when you
switch back to Grid View the document will display in normal Grid View.

Manipulating table data


You can manipulate table data in the following ways:
 Drag-and-drop column headers to move columns.
 Sort column data for text nodes using the menu command XML | Table | Ascending
Sort (also Descending Sort).
 Append (or insert) rows using the menu command XML | Table | Insert Row (also
Append Row).

Moving data between Table View and external applications


You can take advantage of the table structure of data in Table View to exchange data between

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Grid View 111

Table View and a spreadsheet application. To move data from Table View to another
application, select the required nodes in the table and use the Copy as Structured Text option to
copy/paste the data directly into, say, an Excel sheet. (You can select nodes in Table View by
clicking the cells themselves, column headers, row headers (shown below), or the entire table.
If you click the entire table or column headers, then the text of the column headers is also
copied; otherwise it is not.)

The screenshot above shows 11 book elements displayed as a table in Table View. To copy the
entire table into an Excel sheet, you would select the book (11) element, copy it as structured
text, and paste it into an Excel sheet. If you were to select cell A1 and paste, the result would be
as shown below.

© 2010 Altova GmbH User Manual


112 Editing Views Grid View

Data exchange works in both ways. So you can copy data from any spreadsheet-like application
and insert it directly into a table in Table View. Do this as follows:
1. Select a range in the external application and copy it (to the clipboard, in Windows
systems with Ctrl+C)
2. Select a single cell in Table View of your XML document.
3. Paste the copied data with Ctrl+V.

The data will be pasted into the table in XMLSpy with a cell structure corresponding to the
original structure and starting from the cell selected in Table View. The following points need to
be noted:
 If data already exists in these cells in Table View, the new data overwrites the original
data.
 If more rows are required to accommodate the new data, these are created.
 If more columns are required to accommodate the new data, these are not created.
 The data in the cells becomes the contents of the elements represented by the
respective cells.

For more complex data exchange tasks, XMLSpy also offers a set of unique conversion
functions that let you directly import or export XML data from any text file, Word document or
database.

4.2.3 Entry Helpers in Grid View


Elements Entry Helper
In Grid View, the Elements Entry Helper has three tabs: Append, Insert, and Add Child. The
Append tab displays elements that can be appended after all the siblings of the current
element; the Insert tab displays all elements that can be inserted before the current element;
and the Add Child tab displays those elements you can insert as a child of the current element.

To insert an element, select the appropriate tab and double-click the required element. Note
that mandatory elements are indicated with an exclamation mark. Siblings of allowed elements
that cannot themselves be inserted at the cursor point are unavailable.

Please note: In the Options dialog (Tools | Options | Editing), you can specify that
mandatory child elements are inserted when an element is inserted.

Attributes Entry Helper


The Attributes Entry Helper displays a list of available attributes for the element you are
currently editing. Mandatory attributes are indicated with an exclamation mark "!" before the
name of the attribute. If an attribute has already been entered for that element, that attribute is
shown in gray.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Grid View 113

 To use the attributes in the Append and Insert tabs, select, in Grid View, an existing
attribute or an element that is a child of the attribute's parent element, and double-click
the required attribute in the Entry Helper.
 To use the attributes in the Add Child tab, select the attribute's parent element in Grid
View and double-click the required attribute in the Entry Helper.

Please note: Existing attributes, which cannot legally be added to the current element a second
time, are shown in gray.

Entities Entry Helper


The Entities Entry Helper displays all parsed or unparsed entities that are declared inline or in
an external DTD. If a text node or attribute node is selected in Grid View, the Add Child tab will
appear empty—because, by definition, such nodes cannot have any children.

To use the cursor to insert an entity in Grid View, place the cursor at the required position in a
text field or select the required field; then select the appropriate tab, and double-click the entity.
Note the following rules:
 If the cursor is placed within a text field (including an attribute value field), the entity is
inserted at the cursor insertion point.
 If an element with a text-only child (i.e. #PCDATA or simpleType) is selected but the
cursor is not placed in the text field, then any existing text content is replaced by the
entity.
 If a non-text field is selected, then the entity is created as text at a location
corresponding to the Entry Helper tab that you select.

Please note: If you add an internal entity, you will need to save and reopen your document
before the entity appears in the Entities Entry Helper.

© 2010 Altova GmbH User Manual


114 Editing Views Schema View

4.3 Schema View


XML Schemas can be viewed and edited in Schema View. Schema View itself has two views:
 Schema Overview displays all global components, such as global elements and
complex types, in a simple tabular list (see screenshot)
 Content Model View shows the content models of individual global components (see
screenshot)

You can switch from Schema Overview to the content model of a specific global component by
clicking the icon of that global component. To return to Schema Overview, click the Show
Globals icon in Content Model View.

Organization of this section


This section has been organized into the following sub-sections
 Schema Overview describes how global components are displayed in Schema
Overview and how they are edited
 Content Model View describes how the content models of individual global components
are edited
 Entry Helpers explains the organization of the entry helpers in Schema View
 Identity Constraints describes how identity constraints are displayed and edited in
Schema View
 Smart Restrictions is a XMLSpy editing feature that facilitates the graphical creation and
editing of derived types from their base types; this section describes how the Smart
Restrictions feature is used
 A description of how the xml: prefixed attributes base, id, lang, and space can be
added graphically to schema components
 Back and Forward: Moving through Positions explains a Schema View feature that
enables you to move through previously viewed positions

Connecting to SchemaAgent
From XMLSpy you can also connect to SchemaAgent in order to display components from other
schemas in the GUI and to use these components in the schema being currently edited. How to
work with SchemaAgent in XMLSpy is described in the section Working with SchemaAgent.

Find in schemas
The Find in Schemas features enables intelligent searches in schemas, i.e., searches that are
restricted by various schema-related criteria. For example, searches may be restricted to
certain component types, thus making the search more efficient. Find in Schemas is described
in the DTDs and XML Schemas section.

4.3.1 Schema Overview


Schema Overview displays a list of all the global components of the schema (global elements,
complex types, etc).

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Schema View 115

You can insert, append, or delete global components, as well as modify their properties. To
insert, append, or delete, use the respective buttons at the top of Schema Overview. To modify
properties, select the required component in the Schema Overview list, and edit its properties in
either the entry helpers (at right of view) or the Attributes/Identity Constraints pane (at bottom of
view).

You can edit the content model of a global component in Content Model View, which is
accessed by clicking the Content Model View icon at the left of the global component.

Note the following editing features of Schema Overview:


 You can reposition components in the Schema Overview list using drag-and-drop.
 You can navigate using the arrow keys of your keyboard.
 You can copy or move global components, attributes, and identity constraints to a
different position and from one schema to another using cut/copy-and-paste.
 Right-clicking a component opens a context menu that allows you to cut, copy, paste,
delete, or edit the annotation data of that component.

Global components in Schema Overview


At the top level of an XML Schema document (i.e., at the level of children of the schema
element), the following five basic components can be defined:
 Annotation
 Type definition (simple or complex)
 Declaration (element or attribute)
 Attribute group
 Model group

These components are called global components. The Schema Overview displays a list of all
global components in your schema in a tabular form. Some global components (such as
complex types, element declarations, and model groups) can have a content model which
describes the component's structure and contents. Other global components (such as
annotations, simple types, and attribute groups) do not have a content model. Those
components for which content models are possible have a icon to the left of the component
name. Clicking on this icon opens the Content Model View for that global component.

© 2010 Altova GmbH User Manual


116 Editing Views Schema View

Key terms
 Simple type and complex type. A simple type is used to define all attributes and
elements that contain only text and that have no associated attribute. A simple type,
therefore, has no content model—only text (which can be restricted by the datatype). A
complex type is one that has at least one child element or attribute. Declaring a child
element on an element automatically assigns the element a type of complex.
 Global and local components. A global component can be any of the five listed above. A
global component can be defined in Schema Overview, and it then immediately
appears in the list of global components in Schema Overview. If the global component
is a complex type, an element declaration, or a model group, you can subsequently
define its content model by editing it in Content Model View. Once a global component
has been defined, it can be referenced by local components. A local component is
created directly within the content model of some component. Note that, in the Content
Model View, a local component can be converted into a global component (via the
right-click context menu).

Comments and processing instructions


In XML Schema documents, comments and processing instructions within simple types and
complex types are collected and moved to the end of the enclosing object. In such cases, it is
therefore recommended that you use annotations instead of comments.

Creating global components


To create a global component in Schema Overview:

1. Click the Insert or Append icon at the top of the Schema Overview. This pops
up a menu listing the various component types (element, simple type, complex type,
model group, etc).

2. Select the type of component you want. An entry of that type is created in the list of
global components.
3. Enter the name of the component in the entry, and press Enter. The name of the new

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Schema View 117

global component is added to the appropriate list/s (Elm, Grp, Com, Sim, etc.) in the
Component Navigator entry helper. You can edit the content model of the new global
component either by double-clicking the component name in the Component Navigator
or by clicking the icon to the left of the new component's name in the list of global
components.

Please note:
 You can also create a global component while editing in Content Model View.
Right-click anywhere in the window and select New Global | Element.
 While editing in Content Model View, you can make a local element a global element—
or even a complex type if the element has an element or attribute child. Select the local
element, right-click anywhere in the window, and select Make Global | Element or
Make Global | Complex type.

Deleting global components


To delete a global component:
1. Select the global component in the list of global components in the Schema Overview.
2. Press the Delete key, or click the Delete icon at the top of the Schema Overview.

Attributes and identity constraints of components


You can define attributes and identity constraints for components in either Schema Overview or
Content Model View. In Schema Overview, the attributes and identity constraints of a
component are displayed in the Attributes/Identity Constraints pane at the bottom of the
Schema Overview window and can be edited there. In Content Model View, attributes and
identity constraints can appear either in the Attributes/Identity Constraints pane at the bottom of
the Content Model Window or within the Content Model diagram itself, where it can be edited.
You can select how to display attributes and identity constraints in Content Model View with a
setting in the Schema Display Configuration dialog, which is accessed with the Schema design
| Configure view menu command.

Defining attributes for a component


To define attributes for a component, you use the Attributes/Identity Constraints pane, which is
at the bottom of the Schema Overview window.

To define attributes for a global component for which attributes are allowed:
1. Select the global component in the global components list.

© 2010 Altova GmbH User Manual


118 Editing Views Schema View

2. In the Attributes/Identity Constraints pane, select the Attributes tab.

3. Click the Append or Insert icon at the top left of the Attribute tab.
4. From the popup that appears, select the attribute type you want to append or insert. An
entry is created in the Attribute list.
5. In the newly created entry, enter the attribute's properties.

Please note: You can also define attributes for global components in Content Model View:
Select the global component, and then define attributes as described above.

Defining identity constraints for a component


To define identity constraints for a component, you use the Attributes/Identity Constraints pane,
which is at the bottom of the Schema Overview window. See Identity Constraints for a
description of how to work with identity constraints.

4.3.2 Content Model View


A content model is a description of the structure and contents of an element. Global
components which can have a content model (for example, elements, complex types, and
model groups; but not, for example, simple types) are indicated in the Schema Overview list
with a icon to the left of the component name. Clicking on this icon opens the Content Model
View for that global component. Alternatively, (i) select a component and then select the menu
option Schema design | Display Diagram, or (ii) double-click on a component's name in the
Component Navigator (which is the entry helper located, by default, at top right). Note that only
one content model in the schema can be open at a time. When a content model is open, you
can jump to the content model of a component within the current content model by holding
down Ctrl and double-clicking the required component.

The content model is displayed in the Content Model View as a tree (see screenshot below).
You can configure the appearance of the tree in the Schema Display Configuration dialog
(menu item Schema design | Configure view).

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Schema View 119

Note the following editing features of Content Model View:


 Each level (of elements or element groups) in the tree is joined to adjacent levels with a
compositor.
 Drag-and-drop functionality enables you to move tree objects (compositors, elements,
element groups) around.
 You can use keyboard shortcuts to copy (Ctrl-c) and paste (Ctrl-v) tree objects
 You can add objects (compositors, elements, and element groups) via the context
menu (right-click an object).
 You can edit the properties of an object in the Details entry helper (compositors,
elements, element groups) and the Attributes/Identity Constraints pane.
 The Attributes and Identity Constraints of a component are displayed in a pane at the
bottom of the Main Window. Attributes and Identity Constraints can also be displayed in
the Content Model diagram instead of in the Attributes/Identity Constraints pane. This
viewing option can be set in the Schema Display Configuration dialog.

These features are explained in detail in the subsections of this section and in the tutorial.
To return to the Schema Overview, click the Show Globals icon or select the menu option
Schema design | Display All Globals.

Editing in Content Model View


Content Model View enables you to quickly define the content model of the following three
component types graphically with a few mouse clicks:
 Complex types
 Element declarations
 Model groups

All other schema components (annotations, attribute declarations, simple types, etc.) do not
have a content model.

© 2010 Altova GmbH User Manual


120 Editing Views Schema View

In Content Model View, the various parts of the content model are represented graphically,
These parts are organized into two broad groups: compositors and components. Typically a
compositor is added and then the desired child components.

Compositors
A compositor defines the order in which child elements occur. There are three compositors:
sequence, choice, and all.

To insert a compositor:
1. Right-click the element to which you wish to add child elements
2. Select Add Child | Sequence (or Choice or All).

The compositor is added, and will look as below:

 Sequence

 Choice

 All

To change the compositor, right-click the compositor and select Change Model | Sequence (or
Choice or All). After you have added the compositor, you will need to add child element/s or a
model group.

Components in the Content Model


Given below is a list of components that are used in content models. The graphical
representation of each provides detailed information about the component's type and structural
properties.

 Mandatory single element

Details: The rectangle indicates an element and the solid border indicates that the
element is required. The absence of a number range indicates a single element (i.e.
minOcc=1 and maxOcc=1). The name of the element is Country. The blue color
indicates that the element is currently selected; (a component is selected by clicking it).

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Schema View 121

When a component is not selected, it is white.

 Single optional element

Details: The rectangle indicates an element and the dashed border means the element
is optional. The absence of a number range indicates a single element (i.e. minOcc=0
and maxOcc=1). Element name is Location.
Note: The context menu option Optional converts a mandatory element into an optional
one.

 Mandatory multiple element

Details: The rectangle indicates an element and the solid border indicates that the
element is required. The number range 1..5 means that minOcc=1 and maxOcc=5.
Element name is Alias.

 Mandatory multiple element containing child elements

Details: The rectangle indicates an element and the solid border indicates that the
element is required. The number range 1..infinity means that minOcc=1 and
maxOcc=unbounded. The plus sign means complex content (i.e. at least one element
or attribute child). Element name is Division.
Note: The context menu option Unbounded changes maxOcc to unbounded.
Clicking on the + sign of the element expands the tree view and shows the child
elements.

 Element referencing global element

Details: The arrow in the bottom-left means the element references a global element.
The rectangle indicates an element and the solid border indicates that the element is
required. The number range 1..infinity means that minOcc=1 and

© 2010 Altova GmbH User Manual


122 Editing Views Schema View

maxOcc=unbounded. The plus sign indicates complex content (i.e. at least one
element or attribute child). Element name is xs:field.
Note: A global element can be referenced from within simple and complex type
definitions, thus enabling you to re-use a global declaration at multiple locations in your
schema. You can create a reference to a global element in two ways: (i) by entering a
name for the local element that is the same as that of the global element; and (ii) by
right-clicking the local element and selecting the option Reference from the context
menu. You can view the definition of a global element by holding down Ctrl and
double-clicking the element. Alternatively, right-click, and select Go to Definition. If you
create a reference to an element that does not exist, the element name appears in red
as a warning that there is no definition to refer to.

 Complex type

Details: The irregular hexagon with a plus sign indicates a complex type. The complex
type shown here has the name keybase. This symbol indicates a global complex type.
A global complex type is declared in the Schema Overview, and its content model is
typically defined in Content Model View. A global complex type can be used either as (i)
the data type of an element, or (ii) the base type of another complex type by assigning it
to the element or complex type, respectively, in the Details entry helper (in either
Content Model View or in Schema Overview).

The keybase complex type shown above was declared in Schema Overview with a
base type of xs:annotated. The base type is displayed as a rectangle with a dashed
gray border and a yellow background color. Then, in Content Model View, the child
elements xs:selector and xs:field were created. (Note the tiny arrows in the
bottom left corner of the xs:selector and xs:field rectangles. These indicate that
both elements reference global elements of those names.)

A local complex type is defined directly in Content Model View by creating a child
element or attribute for an element. There is no separate symbol for local complex
types.

Please note: The base type of a content model is displayed as a rectangle with a
dashed gray border and a yellow background color. You can go to the content model of
the base type by double-clicking its name.

 Model group

Details: The irregular octagon with a plus sign indicates a model group. A model group
allows you to define and reuse element declarations.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Schema View 123

Note: When the model group is declared (in Schema Overview) it is given a name. You
subsequently define its content mode (in Content Model View) by assigning it a child
compositor that contains the element declarations. When the model group is used, it is
inserted as a child, or inserted or appended within the content model of some other
component (in Content Model View).

 Wildcards

Details: The irregular octagon with any at left indicates a wildcard.


Note: Wildcards are used as placeholders to allow elements not specified in the
schema or from other namespaces. ##other = elements can belong to any
namespace other than the target namespace defined in the schema; ##any = elements
can belong to any namespace; ##targetNamespace = elements must belong to the
target namespace defined in the schema; ##local = elements cannot belong to any
namespace; anyURI = elements belong to the namespace you specify.

 Attributes

Details: Indicated with the word 'attributes' in italics in a rectangle that can be expanded.
Each attribute is shown in a rectangle with a (i) dashed border if the attribute is options,
or (ii) a solid border if the attribute is required (mandatory).
Note: Attributes can be edited in the Details Entry Helper. Attributes can be displayed in
the Content Model View diagram or in a pane below the Content Model View. You can
toggle between these two views by clicking the Display Attributes icon. When
attributes are displayed in the Content Model View diagram, all attributes of a single
element are displayed in a rectangle with a dashed border. To change the order of
attributes of an element, drag the attribute outside the containing box and drop when
the arrow appears at the required location.

 Identity constraints

Details: Indicated with the word 'constraints' in italics in a rectangle that can be
expanded.
Note: The identity constraints listed in the content model of a component show
constraints as defined with the key and keyref elements, and with the unique
element. Identity constraints defined using the ID datatype are not shown in the content
model diagram, but in the Details Entry Helper. Identity constraints can be displayed
and edited in the Content Model View or in the Identity Constraints tab of Schema
Overview. In Content Model View, you can toggle the Constraints box on and off with

© 2010 Altova GmbH User Manual


124 Editing Views Schema View

the Display Constraints icon..

Please note:
 Property descriptor lines you have defined in the Schema Display Configuration dialog

can be turned on and off by clicking the Add Predefined Details toolbar icon.
 You can toggle Attributes and Identity Constraints to appear either in the diagram of the
content model itself or in a pane below the Content Model View by clicking the Display
in Diagram icons for attributes and constraints, and respectively.
 In Content Model View, you can jump to the content model view of any global
component within the current content model by holding down the CTRL key and
double-clicking the required component. You can go to the content model of a base
type by double-clicking the name of the base type.

Other editing operations in Content Model View


Editing operations in Content Model View are carried out via the context menu (see screenshot)
that appears when you right-click within Content Model View. A description of the operations are
given below.

Adding child compositors/components and inserting/appending


compositors/components
1. Right-click the compositor or component. This opens the context menu (with only the
allowed operations enabled).
2. Select the required operation from the context menu.

Changing a compositor
1. Right-click the compositor you want to change.
2. Select the context menu option Change Model and, from the sub-menu, select the

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Schema View 125

compositor to which you want to change. (The currently selected compositor is


checked.) If a compositor is not allowed at that point, it is disabled.

Creating global components


 To create a new global component, right-click anywhere in Content Model View, select
New Global, and, from the sub-menu, the required component.
 To make a local element a global element or global complex type, right-click the local
element, select Make Global, and, from the sub-menu, select either Element or
Complex type. If any of these components cannot legally be created, then it is
disabled.

Changing the occurrence definition


You can toggle the minimum and maximum occurrences values of a compositor between 0
and 1 (for minOccurs) and 1 and unbounded (for maxOccurs), respectively.

Do this as follows:
1. Right-click the compositor or component for which the occurrence value has to be
changed.
2. Select the context menu option Optional to set minOccurs to 0, deselect Optional to
set minOccurs to 1. Select the context menu option Unbounded to set maxOccurs
to unbounded, deselect Unbounded to set maxOccurs to 1. A check mark appears to
the left of the respective menu item when that menu item is selected.

Toggling between local definition and global definition


If a global element exists that has the same name as a local element, then you can toggle
between referencing the global definition and using the local definition.

Do this as follows:
1. Right-click the element.
2. Select the context menu option Reference. If the global element is referenced, then the
menu item is checked. If the local definition is used, the Reference item in the menu is
not checked.

Jumping to another definition


When you are within a content model, you can jump to the definition of any global component
that is contained in that content model.

Do this as follows:
1. Right-click the global component. The global component could be the yellow rectangle
of a base type; an element that references a global element; or a model group.
2. Select the context menu option Go to Definition. This opens the Content Model View
of that global component.

Alternatively, double-click the name of the base type, or press Ctrl and double-click the
referencing element or the model group.

Editing element names


1. Right-click the element.
2. Select the context menu option Edit | Name and edit the name.

© 2010 Altova GmbH User Manual


126 Editing Views Schema View

Alternatively, double-click the element name, and type in the change.

Creating and editing documentation for a compositor or component


You can add documentation to individual compositors and components as a guide for schema
editors.

Do this as follows:
1. Right-click the compositor or component.

2. Select the context menu option Edit Annotation. This highlights the documentation
space below the compositor/component, in which you can enter descriptive text about
the compositor or component. In Text View, the annotation and
annotation/documentation elements will have been created and the
documentation element will contain the descriptive text you enter.

Alternatively, you can right-click the compositor or component and select Whole Annotation
Data. In the Annotation dialog that opens, you can append or insert a documentation item and
enter content for it.

In order to edit pre-existing documentation text, you can use either of the two methods
described above, but a quicker method is to double-click the annotation in the diagram and edit
directly.

Creating and editing application info for a compositor or component


1. Right-click the compositor or component.

2. Select the context menu option Whole Annotation Data. The Annotation dialog box
opens (see screenshot below). If annotation (either documentation or appinfo) exists for
that element, then this is indicated by a corresponding row in the dialog.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Schema View 127

3. To create an appinfo element, click the Append or Insert icon at top left to
append or insert a new row, respectively.
4. In the Kind field of the new row, select the app option from the dropdown menu.
5. In the Content pane of the dialog, enter the script or info that you want to have
processed by a processing application.
6. Optionally, in the Source field, you can enter a source URI where further information
can be made available to the processing application.

Using keyboard shortcuts in Content Model View


You can copy and paste elements in Content Model View using the shortcuts Ctrl-c and Ctrl-v.

To copy and paste elements:


1. Select the elements you want to copy. To select one element, click on it. To select more
than one element, click on the first element and use SHIFT and the down arrow key to
select further elements.
2 Press Ctrl-c. The elements are copied to the clipboard.
3. Select the compositor you want to copy the elements to.
4. Press Ctrl-v. The elements are pasted as child elements of the compositor.

To copy and paste elements in reverse order:


1. Click on the lowermost element you want to copy and use SHIFT and the up arrow key
to select further elements.
2. Press Ctrl-c. The elements are copied to the clipboard.
3. Select the compositor you want to copy the elements to.
4. Press Ctrl-v. The elements are pasted such that the element that was the uppermost
element is now the lowermost element.

About XML Schema annotations


XML Schema annotations are held in the annotation element. There are two types of
annotation, both of which are elements of the annotation element:
 compositor or component documentation, which contains information that could be
useful for editors of the schema and is contained in the documentation child element
of annotation.
 application information, which allows you to insert a script or information that a
processing application may use; this information is contained in the appinfo child
element of annotation.

© 2010 Altova GmbH User Manual


128 Editing Views Schema View

Given below is the text of an annotation element. It is based on the example in the description
of creating documentation and application information given above.
<xs:element name="session_date" type="xs:dateTime" nillable="true">
<xs:annotation>
<xs:documentation>Date and time when interview was
held</xs:documentation>
<xs:appinfo
source="http://www.altova.com/datehandlers/interviews">separator =
:</xs:appinfo>
</xs:annotation>
</xs:element>

Comments and processing instructions


In XML Schema documents, comments and processing instructions within simple types and
complex types are collected and moved to the end of the enclosing object. In such cases, it is
therefore recommended that you use annotations instead of comments.

Configuring the content model view


You can configure the content model view for the entire schema in the Schema display
configuration dialog (Schema design | Configure view). For details about configuration
options, see the Configure view section later in the User Reference. Note that the settings you
define here apply to the whole schema, and to the schema documentation output as well the
printer output.

Changing component properties directly in the content model


If the Content Model View is configured so that components are displayed with property
descriptor lines (additional information about components) in the component box, then you can
edit this information and so change the properties of components. The property descriptor lines

you have defined can be turned on and off by clicking the Add Predefined Details toolbar
icon. You can toggle between a view containing the defined properties and a view not containing
them.

To edit component properties:


1. Double-click the (component's) information field that you want to edit, and start entering
or editing data. If a predefined option is available, then a drop-down list can be opened
and the appropriate entry selected. Otherwise simply enter the required value.

2. Press Enter to confirm. The Details entry helpers will be updated to reflect your
changes.

Alternatively, you can edit a component's properties in the Details entry helper, and changes will
be reflected in the placeholder fields—if these are configured to be displayed.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Schema View 129

Documenting the content model


You can generate detailed documentation about your schema in HTML and MS Word formats.
Detailed documentation is generated for each global component, and the list of global
components is displayed in a table-of-contents page that allows you to link to the content
models of individual components. Additionally, related elements (such as child elements or
complex types) are referenced by hyperlinks, thus enabling you to navigate from element to
element. To generate schema documentation, select the menu command Schema design |
Generate documentation.

Attributes and Identity Constraints


Attributes and Identity constraints can appear in a pane below the Content Model View or as
boxes in the Content Model View itself. You can toggle between these views by clicking the
icon. For a description of how to insert and edit attributes and identity constraints, see Defining
attributes for components and Defining identity constraints for components, respectively.

4.3.3 Entry Helpers in Schema View


There are three Entry Helpers in Schema View: Component Navigator, Details Entry Helper,
and Facets Entry Helper. The entry helpers are the same in both Schema Overview and
Content Model View. They are described below.

Component Navigator
The Component Navigator is an Entry Helper in Schema View. It serves three purposes:
 To organize global components in a tree view by component type and namespace (see
screenshots below). This provides organized overviews of all global components.
 To enable you to navigate to and display the Content Model View of a global component
—if the component has a content model. If a component does not have a content
model, the component is highlighted in the Schema Overview. Global components that
are included or imported from other schemas are also displayed in the Component
Navigator.
 To provide an overview of the identity constraints defined in the schema document. For
a description of the Identity Constraints tab, see Identity Constraints Overview.

In the Globals tab (above) global components are grouped in a tree according to their
component type. In the Namespace tab (below), components are organized first
according to namespace and then according to component type. Note that a
component type is listed in a tree only if at least one component of that type exists in
the schema.

© 2010 Altova GmbH User Manual


130 Editing Views Schema View

In the tree display, global components are organized into the following six groups:
 Element Declarations (Elements)
 Model Groups (Groups)
 Complex Types
 Simple Types
 Attribute Declarations (Attributes)
 Attribute Groups

Expanding a component-type group in the tree displays all the components in that group (see
screenshot). This enables you to easily navigate to a required component.

If a component has a content model (i.e., if it is an Element, Group, or Complex Type),


double-clicking it will cause the content model of that component to be displayed in Content
Model View (in the Main Window). If the component does not have a content model (i.e. if it is a
Simple Type, Attribute, or Attribute Group), then the component is highlighted in the Schema
Overview (in the Main Window).

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Schema View 131

Please note: If the component is in an included or imported schema, then the


included/imported schema is opened (if it is not already open), and either the component's
content model is displayed in Content Model View or the component is highlighted in Schema
Overview.

Details Entry Helper


The Details Entry Helper is available in Schema View. It displays editable information about the
compositor or component currently selected in the Main Window. If you are editing a schema
file which contains database extensions, an additional tab with information about the DB
extensions may be visible.

To change the properties of the currently selected compositor or component, double-click the
field to be edited and edit or enter text directly. If a combo box is available in the field to be
edited, select the desired value; this value is entered in the field.

Changes you make via the Details Entry Helper are immediately reflected in the content model
diagram.

Facets Entry Helper


The Facets Entry Helper is available in the Schema View, and enables you to enter the values
of facets, patterns, sample values, and enumerations.

To change facets, patterns, Sample Values, or enumerations in the Facets Entry Helper:

© 2010 Altova GmbH User Manual


132 Editing Views Schema View

1. Select the required tab (Facets, Patterns, Sample Values, or Enumerations)


2. If a combo box is present, select a value from the drop-down menu. Alternatively,
double-click a row, and edit or enter text directly.

Note:
 You can use the cut, copy and paste shortcuts (CTRL+X, CTRL+C, CTRL+V,
respectively) to copy the patterns and enumerations of one component to another
component. In the Facets Entry Helper, select the pattern/s or enumeration/s to copy,
cut or copy the selection, then click in the Facets Entry Helper window of the target
component, and paste.
 Sample values can be used when generating an XML file from the schema (with the
menu command DTD/Schema | Generate Sample XML File).

4.3.4 Identity Constraints


Identity constraints can be defined for a global component via two entry points:
 In Schema Overview, select a global component and define identity constraints in the
Identity Constraints tab (at the bottom of the view and below the main pane).
 In the Content Model View of a global component. Content Model View provides a
graphical representation of the identity constraints and drag-and-drop editing
functionality, neither of which is available when editing identity constraints in Schema
Overview.

In this section, we describe these two mechanisms for creating and editing identity constraints.
An overview of all identity constraints in the schema is available in the Identity Constraints tab of
the Components entry helper; this is described further below.

Identity constraints in Schema Overview


To define identity constraints for a global component in Schema Overview, do the following:
1. Select the global component in the global components list of Schema Overview.
2. In the Attributes/Identity Constraints pane, select the Identity Constraints tab.

3. Click the Append or Insert icon at the top left of the Identity Constraints tab.
4. From the popup that appears (screenshot below), select the type of identity constraint
you want to append or insert: Unique, Key, or Keyref.

An entry is created in the Identity Constraints list.


5. In the newly created entry, enter the Identity Constraint's properties. Give the identity
constraint a name (see screenshot below) and then define XPath expressions for the

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Schema View 133

selector and field elements. For each location step in these XPath expression, a
pop-up containing the available nodes appears (see screenshot below). For the refer
element of the keyref kind of identity constraint, a dropdown list shows the available
key elements (see screenshot below).

If you wish to define multiple field elements on an identity constraint, select the identity
constraint, click the Append or Insert icon (see Step 3 above), and select Field. An
empty Field entry box is added to the selected identity constraint. Enter the required
XPath expression in the Field entry box.

Note: An ID can be assigned to any of these elements (that is, to the identity constraint, its
selector, and/or field/s). To assign an ID, select the element and, in the Details entry
helper, enter the ID in the id row.

Identity constraints in Content Model View


To view identity constraints in Content Model View, do the following:
1. In Schema Overview, select the global component for which you wish to create the
identity constraint and switch to the Content Model View of that component.
2. Ensure that the display of identity constraints is toggled on in the Schema Display
Configuration dialog (Schema Design | Configure View). This toggle switches on and
off the display of the identity constraints box in the design (see screenshot below). You
can also toggle on and off the display of the Constraints box with the Display
Constraints icon in the Schema Design toolbar
3. Ensure that the Visualize ID Constraints icon in the Schema Design toolbar is
toggled on. This ensures that relationship lines and ID constraint information are
displayed in Content Model View (see screenshot below).

Note: The Visualize ID Constraints icon switches on ID Constraint editing and validating
functionality in Schema View. If an XPath expression in an ID Constraint does not
locate a node, an error or warning might be displayed. This error or warning is to alert
you to the incorrect XPath expression; the XML Schema document itself is not invalid
because of the incorrect XPath expression. To re-check the validity of the document
without the XPath expression check, switch to Text View or Grid View and validate. You
can also disable validation in Schema View by toggling the Visualize ID Constraints
icon off.

The screenshot below shows the graphical display of identity constraints. There are two identity
constraints in the identity constraints box: TeamKey and TeamKeyRef. The properties of
TeamKeyRef are highlighted with a solid green line (since TeamKeyRef is selected). The
properties of TeamKey (unselected) are shown with a dotted green line. For each identity
constraint the node selected by the XPath expression for selector and field are show with
the icons and respectively. If a node is collapsed, as is the case with the field element

© 2010 Altova GmbH User Manual


134 Editing Views Schema View

of the TeamKey constraint, the relationship line ends with an ellipsis (see screenshot below).

To create an identity constraint in Content Model View, do the following:


1. In the Constraints box, right-click the Constraints entry or the name of an existing
identity constraint.
2. Select Insert or Append, and then select the kind of identity constraint to insert (at the
top of the list of existing constraints) or append (at the bottom of the list of existing
constraints). The identity constraint will be created with an empty selector element
and an empty field element.
3. The XPath expression can be entered in the selector and field element boxes in
one of two ways: (i) By typing it in, or (ii) By dragging the target node into the selector
or field element box and dropping it when the box becomes highlighted; the XPath
expression will be created automatically.
4. To add an additional field element to an identity constraint, either right-click the
constraint name and select Add child | Field from the context menu, or right-click the
selector or field element and select Insert | Field or Append | Field from the
context menu.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Schema View 135

5. To enter an ID attribute on any element in a constraint, select that element and enter a
value in the id row of the Details entry helper.

Note: Identity constraint information can be toggled on and off with the Enable ID Constraints
Information icon in the Schema Design toolbar. The display of the entire Constraint
box can be toggled on and off in the Schema Display Configuration dialog (Schema
Design | Configure View) or with the Display Constraints icon in the Schema
Design toolbar.

Identity constraints overview


The Identity Constraints tab of the Components entry helper (screenshot below) provides an
overview of a document's identity constraints. In this tab, identity constraints are listed by the
kind of identity constraint (unique, key, keyref) and displayed as an expandable/collapsible
tree.

Entries in bold are present in the current schema, while those in normal face are present in
sub-schemas. Double-clicking an entry in the Identity Constraints tab selects that schema
component in Content Model View.

The following context menu commands are available when an item in the Identity Constraints
tab is selected:
 Show in Diagram: selects the schema component in Content Model View.
 Show Selector/Field Target in Diagram: selects, in Content Model View, the schema
component targeted by the selector or field of the identity constraint. In the case of
multiple fields, a dialog prompts the user for the required field.
 Go to Identity Constraint: selects the identity constraint in Schema Overview.
 Expand/Collapse All: expands or collapses the tree, respectively.

© 2010 Altova GmbH User Manual


136 Editing Views Schema View

4.3.5 Smart Restrictions


When restricting a complex type, parts of the content model of the base type are rewritten in the
derived type. This can be confusing if the content model is complex because while editing the
derived type it might be hard to correctly remember exactly what the content model of the base
type looks like.

Smart Restrictions combine and correlate the two content models in the graphical view of the
derived content model. In the derived complex type, all particles of the base complex type, and
how they relate to the derived type, can be seen. Additionally, Smart Restrictions provide visual
hints to show you all possible ways to restrict the base type. This makes it easy to correctly
restrict the derived type.

To switch on Smart Restrictions:


 Click the Smart Restrictions icon . in the Schema Design toolbar.

The example that follows illustrates the features of Smart Restrictions.

The following complex type is the base type used in this example:

The complex type "derived" is derived from the "base" type as follows:
1. Create a new complex type in the schema and call it "derived".
2. In the Details Entry Helper select "base" from the base drop-down list and "restriction"
from the derivedBy drop-down list.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Schema View 137

With Smart Restrictions switched on, the new derived type looks like this:

Notice the following controls that can be used to restrict the derived type in this example:
 Use this icon to remove elements that are in the base type from the derived type.
Here, elem1 has been deleted. To add it again, click this icon .

 Click the down arrow on the Choice compositor to get the following list, which allows
you to change the Choice model group to a Sequence model group:

© 2010 Altova GmbH User Manual


138 Editing Views Schema View

It is also possible to change wildcards in the same way, as seen in this example:

For a complete list of which particles can be replaced by which other particles, see the
XML schema specification.
 Change the number of occurrences of the model group using the following control

to increase the minimum number of occurrences by clicking the plus sign


over the "1", or to decrease the maximum number of occurrences by clicking the minus
sign under "4". These controls are shown if the occurrence range in the base describes
a real range (e.g., 2-5) and not a certain amount (e.g. 4-4). They are also displayed if
the occurrence range is wrong.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Schema View 139

Here you can see that the minimum occurrence for this element has been changed to
2. Notice that the model group now has a blue background, which means that it is no
longer the same as the model group in the base complex type. Also, the permitted
occurrence range of the model group in the base particle is now displayed in
parentheses.
 It is possible to change the data types of attributes or elements if the new data type is a
valid restriction of the base data type as defined in the XML schema specification. For
example, you can change the data type of elem3 in the "derived" data type from
decimal to integer. After you do this, the element has a blue background to show that is
different from the element in the base type, and the type that the element has in the
base type is displayed in parentheses:

This example shows attributes whose data types have been restricted in the derived
complex type:

© 2010 Altova GmbH User Manual


140 Editing Views Schema View

 Smart Restrictions alert you to pointless occurrences in the content model. A pointless
occurrence happens, for example, when a sequence that is present in the content
model is unnecessary. This example shows a pointless occurrence:

Please note: Pointless occurrences are only shown if the content model contains an
error. It is possible for a content model to contain a pointless occurrence and be valid,
in which case the pointless occurrence is not explicitly shown in order to avoid
confusion.

See the XML schema specification for more information about pointless occurrences.

4.3.6 xml:base, xml:id, xml:lang, xml:space


The namespace http://www.w3.org/XML/1998/namespace is, according to the XML
Namespaces specification, bound by definition to the xml: prefix. What this means is that this is
the namespace that must be used with the xml: prefix and that is reserved for it. There are four
attributes in this namespace that can be children of any XML element in any XML document
(schema or instance):
 xml:base (for setting the base URI of an element)
 xml:id (for specifying the unique ID of an element)
 xml:lang (for identifying the language used within that element)
 xml:space (for specifying how whitespace in the element should be handled)

In Schema View, once the XML Namespaces namespace has been imported into the XML
Schema document, these four xml: attributes can be referenced for use on any element in the

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Schema View 141

schema.

In order to declare one of these attributes on an element, do the following:


1. Declare the XML Namespaces namespace for that schema document and bind the
namespace to the xml: prefix. When any of the four xml: attributes is used in the
document, its name would then be expanded to include the correct namespace part.
2. Import the XML Namespaces namespace. XMLSpy's validator will recognize the
namespace and make the four xml: attributes available as global attributes, which can
be referenced within that schema.
3. Insert the required xml: attribute as the child of an element. The attribute is declared as
a reference to the "imported" global attribute.

Declare the XML Namespaces namespace


You can declare the XML Namespaces namespace (http://www.w3.org/XML/1998/
namespace) by entering it via the Schema Settings dialog, where all namespaces declared for
that schema are stored and can be edited.. The namespace must be bound to the xml: prefix.
(Alternatively, you could declare the namespace (with the xml: prefix) on the xs:schema
element in Text View.)

Import the XML Namespaces namespace


In Schema Overview, create a global import declaration for the XML Namespaces namespace.

Do this by clicking the Insert or Append icon at the top of the Schema Overview
window and selecting Import from the menu that pops up. Enter the XML Namespaces
namespace as the namespace to be imported. In Text View, the import declaration should look
like this:
<xs:import namespace="http://www.w3.org/XML/1998/namespace"
schemaLocation="http://www.w3.org/XML/1998/namespace"/>.

Adding the xml: attribute


In Schema Overview, select the element for which the xml: attribute is to be added, and add an
attribute for it. In the Details entry helper (screenshot below), click the down arrow of the name
combo box and select the required xml: attribute, for example xml:base. When you are
prompted whether you wish to reference the global attribute, click Yes. The attribute is added as
a reference.

XInclude and xml:base


When XInclude's include element is replaced by the XML file specified in the href attribute of

© 2010 Altova GmbH User Manual


142 Editing Views Schema View

the include element, the top-level element of the parsed XML document is included with an
xml:base attribute. If this XML document is going to be validated, then the schema must define
an xml:base attribute on the relevant element/s.

4.3.7 Back and Forward: Moving through Positions


The Back and Forward commands in Schema View enable you to move through previously
viewed positions in Schema View. This is useful because, while clicking through schema
components in Schema View, you might wish to view a previously viewed component. Clicking
the Back button once in the toolbar takes you to the previously viewed position. By repeatedly
clicking the Back button, you can view up to 500 of the last visited positions. After moving back
through previous positions, you can move forward through these positions by using the
Forward button in the toolbar.

The shortcut keys for the two commands are:

 Back: Alt + Left Arrow

 Forward: Alt + Right Arrow

Back/Forward versus Undo/Redo


Note that the Back and Forward commands are not the same as the Undo (Ctrl+Z) and Redo
(Ctrl+Y) commands. These two sets of commands make up two different series of steps.
Clicking the Back command once takes you to the previously viewed component as previously
displayed. Clicking the Undo command once undoes the last editing change regardless of when
that editing change was made.

Additional notes
Note the following points:
 The Back button enables you to re-view the previous 500 positions.
 The Back/Forward feature is enabled across schemas. If a schema has since been
closed or is currently open in another view, it will be opened in Schema View or
switched to Schema View, respectively.
 If a component that was viewed in a previous position is deleted, then that component
will not be able to be viewed. If such a component was part of a previous position, this
position will be displayed without the deleted component. If the component comprised
the entire position, the entire position will be unavailable, and clicking the Back button
at this point in the Back series will take you to the position previous to the unavailable
position.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views WSDL View 143

4.4 WSDL View


WSDL View (screenshot below) provides an interface for graphically editing WSDL 1.1 and
WSDL 2.0 documents. WSDL View is available when a WSDL document is active and the
WSDL View tab is clicked. The structure and components of a WSDL document are created in
the Main Window using graphical design mechanisms, and additional editing is enabled from
the Entry Helpers.

The Main Window (consisting of the PortTypes (WSDL 1.1) or Interfaces (WSDL 2.0), Bindings,
and Services sections) and the Entry Helpers (Overview and Details) are described in the
sub-sections of this section. (For a description of how to work with projects, see Project Menu in
the User Reference section.)

Functionality available in WSDL View


The following functionality is available in WSDL View:
 A graphical display in the Main Window of all WSDL elements, grouped by PortTypes
(WSDL 1.1) or Interfaces (WSDL 2.0), Bindings, and Services.
 Direct manipulation of WSDL elements using drag and drop.
 Ability to add, append, and delete any WSDL element visible in the graphical view
(context sensitive menu).
 Ability to enter and edit values in the Details Entry Helper.
 WSDL validation against W3C Working Draft.
 Automatic switching to Schema View if a referenced or imported schema is found to be
invalid.
 Editing of schema types from within WSDL View.
 Generation of WSDL documentation in MS Word or HTML.
 Generation of a diagram (PNG image) of the WSDL document in the Main Window.
 Printing of the view in the WSDL window.

File viewing
Note the following points concerning file viewing:
 When you open a WSDL file, the file opens automatically in WSDL View.
 You can also view a WSDL document in the Text and Enhanced Grid Views. To do this,
click on the appropriate tab.

© 2010 Altova GmbH User Manual


144 Editing Views WSDL View

 If the WSDL file contains a reference to an XML Schema, then the schema can be
viewed and edited by selecting the menu command WSDL | Types | Edit Schema in
Schema View. This opens the schema file in the Schema View.
 If an associated schema file is open, then you are not allowed to change the view of the
WSDL file (for example, from WSDL View to Text View). Before trying to change views
of the WSDL file, make sure that you have saved changes to the schema file and
closed the file.

There are two entry helpers to help you edit WSDL documents: Overview and Details. Both
entry helpers can be docked/undocked by double-clicking the title bar. When docked, the
auto-hide feature can be activated by clicking the drawing-pin icon in the title bar. When
auto-hidden, the entry helper is minimized as a tab at an edge of the application window. An
auto-hidden entry helper can be re-docked by rolling it out from the edge (by mousing over its
tab) and clicking the drawing-pin icon in the title bar.

4.4.1 Main Window


The Main Window is where you edit your WSDL document. It consists of three vertical sections:
(i) Port Types (WDL 1.1) or Interfaces (WSDL 2.0); (ii) Bindings, and (iii) Services. The
relationship between a port type and a binding and between a binding and a service is each
indicated with a connector line. Each of these three sections is described in detail below.

Symbols in the Main Window


The following symbols are used in the Main Window:

Port type in WSDL 1.1, Interface in WSDL 2.0

Binding

Service

Fault

Operation. The green arrow represents inputs and the blue arrow represents outputs.
Depending on the type of operation, an appropriate symbol is used.

Message

Message part (parameter)

XSD element

XSD simpleType or complexType

Port

Adding new port types, interfaces, bindings, and services


To add a new port type (in WSDL 1.1 documents), interface (in WSDL 2.0 documents), binding,
or service, right-click anywhere in the Main Window but outside a component box, and select
the relevant command from the context menu that appears.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views WSDL View 145

Drag and drop functionality


The following drag-and-drop functionality is available:
 In the Main Window, associations between PortTypes (WSDL 1.1) or Interfaces (WSDL
2.0) and Bindings and between Bindings and Services can be established with
drag-and-drop.
 In WSDL 2.0 documents, elements in the Overview entry helper can be dragged to
interface faults in both the Main Window and the Overview entry helper.

PortTypes (WSDL 1.1), Interfaces (WSDL 2.0)


The PortTypes section (WSDL 1.1 documents) contains all the portTypes defined in the WSDL
document (the screenshot below shows only one portType in the PortTypes section). The
Interfaces section (in WSDL 2.0 documents) contains all the interfaces defined in the WSDL
document

Each portType or interface is represented as a box containing the operations defined


for that portType or interface. Components can be edited directly in the box. The main features
of port type and interface boxes are listed below:

 Operations can be expanded to display their messages by clicking the icon at the
left of an operation name.
 In WSDL 1.1 a message can contain a message part . Such messages can be
expanded to show the message part.
 Right-clicking a component of a portType box (either portType, operation, message, or
message part), pops up a context menu from which relevant actions can be selected.
For example, right-clicking a portType name allows you, among other actions, to
append a new portType, append an operation to the selected portType, or create a
binding for the selected portType.
 The optional WSDL 2.0 interface properties, extends, styleDefault, and documentation
are hidden if empty. They can be edited via the Edit command in the context menu of
the interface.
 In WSDL 2.0 documents, properties of operations can be edited via the Edit command
in the context menu of the operation. The value of the style property is selected via a

© 2010 Altova GmbH User Manual


146 Editing Views WSDL View

combo box listing the options.


 Note that when a component is selected, its details can be edited in the Detail entry
helper.
 Documentation for port types and interfaces appears at the bottom of individual boxes.

The association of a portType or interface with a binding is indicated in the Main Window by a
black connector line linking the portType box or interface box to the binding box; the binding box
will be in the Bindings section of the Main Window.

Bindings
A binding defines message formats and protocol details for:
 Operations defined by a particular portType (WSDL 1.1), or
 Operations and faults defined by a particular interface (WSDL 2.0).

In WSDL 1.1, bindings can be created for SOAP 1.1 or SOAP 1.2 endpoints, or for HTTP 1.1's
GET and POST verbs. In WSDL 2.0, bindings can be created for SOAP 1.1 or SOAP 1.2
endpoints, or for HTTP. Each binding is represented by a binding box (screenshot below) in the
Bindings section of the Main Window. The binding box contains all the operations and/or faults
of the associated portType or interface (see screenshot below).

A binding can be associated with a port type or an interface in any of the following ways:
 Right-click a port type or an interface and select the command Create binding for
portType or Create binding for interface, respectively.
 Right-click a WSDL 1.1 binding and edit the PortType property.
 Right-click a WSDL 2.0 binding and select the command Edit | Interface.

To define the binding, in the first combo box to the right of the binding name (screenshot below
), select the required protocol. In WSDL 1.1, this is either soap 1.1, soap 1.2, http-get, or
http-post to define the kind of binding. If you select a SOAP protocol, you can additionally
define (using the second combo box) whether the style should be doc or rpc. In WSDL 2.0
documents, the wsoap:protocol property can be added or edited via the Edit command of the
context menu of the binding.

In WSDL 1.1, MIME encodings (also referred to as MIME bindings) are defined at the message

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views WSDL View 147

level. To define a MIME encoding, right-click on the message (screenshot below) and append
the appropriate MIME definition. In the screenshot below, MIME definitions have been created
for the Output message.

Right-clicking a specific item in a binding box opens a context-sensitive menu. Using the
context menus, for example, bindings can be appended or deleted; extensibility items can be
edited; and messages defined. Note also that when a binding box or an item in a binding box is
selected, the definitions are displayed in the Details entry helper and can be edited there.

A port can be created for a binding by right-clicking the title bar of a binding box and selecting
the Create Port for Binding command (WSDL 1.1 documents) or Create Endpoint for
Binding command (WSDL 2.0 documents). The associated port or endpoint is created within a
service box (in the Services section of the Main Window). The association between a binding
and a port is indicated by a black connector line.

Documentation for bindings appears at the bottom of individual binding boxes.

Services
A service groups together a set of related ports (WSDL 1.1) or endpoints (WSDL 2.0). It is
represented by a service box in the Services section of the Main Window (screenshot below).
Each service box consists of one or more port or endpoint declarations (see screenshot below).

The service name, port or endpoint name, the binding associated with a port or endpoint, and
the address information of a port or endpoint can be edited directly in the service box or in the
Details entry helper. Right-clicking a service box or a specific item in the service box opens a
context menu in which commands relevant to the service or that item are available.

Documentation for services appears at the bottom of individual service boxes.

© 2010 Altova GmbH User Manual


148 Editing Views WSDL View

4.4.2 Overview Entry Helper


The Overview entry helper (screenshot below) provides an overview of the WSDL document
by grouping the document's various components into structural categories and by listing the
target namespace, imported schemas, and included/imported WSDL documents. In addition to
port types (or interfaces in WSDL 2.0), messages (WSDL 1.1), bindings, and services, the
various types defined in the document are also listed.

Overview entry helper in WSDL 1.1 (left) and WSDL 2.0 (right).

In each category, components are displayed in a tree view. A tree item can be expanded and
collapsed, respectively, to reveal and to hide its contents. Selecting a component in the
Overview entry helper displays it and its properties in the Details entry helper, where the
properties can be edited. The names of WSDL and schema components that are displayed in
the tree can be edited directly in the trees. Externally defined components (those in included or
imported WSDL documents or schemas and displayed in gray), however, cannot be edited. The
individual categories in the Overview entry helper are explained below.

Target namespace (WSDL 1.1 and 2.0): Indicated in the tree by tns. The target namespace
can be edited in the Overview entry helper. All other namespaces must be edited in Text View.

Imports (WSDL 1.1): XML Schema (XSD) files and WSDL files can be imported into the active
WSDL document. To import a file, right-click the Imports item or an already imported file in the
Imports list, and select Add new import. Right-clicking an imported file in the Imports list pops
up a context menu in which you can choose to add a new import, select another file to replace
the selected file as an import (Edit import), or delete the imported file. You can also open the
file from its location. The file opens in WSDL View (.wsdl file) or Schema View (.xsd file), and
can be edited there.

WSDL includes, WSDL imports, Schema imports (WSDL 2.0): XML Schema (XSD) files can
be imported, and WSDL files can be included or imported, into the active WSDL document. To
include or import a file, right-click the respective item and add the include or import. The
namespace of an imported file is generated automatically from the target namespace of the
imported file.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views WSDL View 149

Right-clicking an included or imported file pops up a context menu in which you can choose to
delete the file or open it in XMLSpy. The file opens in WSDL View (.wsdl file) or Schema View (
.xsd file), and can be edited there.

Types (WSDL 1.1 and 2.0): Lists all types defined in the WSDL document (in black) and in any
imported schema or WSDL document (in gray). You can create a new XSD element,
simpleType, or complexType by right-clicking any type in the list and selecting the appropriate
Add New command. A newly created type is added to the WSDL types definitions and is listed
under the Types item in the Overview entry helper.

A type defined in the WSDL document can be edited in XMLSpy's Schema View. To do this,
right-click the type you wish to edit and select Edit (Schema View) from the context menu that
pops up. This causes a temporary XSD file to be generated on the fly from the types definitions
in the WSDL document. This XSD document is displayed in Schema View and can be edited.
After you have finished editing the XSD document, saving the changes will cause the changes
to be saved back to the types definitions in the WSDL document. You can close the XSD
document without saving changes; in this case, the types definitions in the WSDL document
will not be modified.

Messages (WSDL 1.1): When a message or its sub-component is selected, the properties of
that message or sub-component are displayed in the Details entry helper, where they can be
edited. Additionally, you can do the following via the context menu:
 With a message selected in the Overview entry helper, you can add a message part to
that message or delete the message, as well as add a new message.
 With a message part selected in the Overview entry helper, you can add another
message part to that message or delete the selected message part.
 The Synchronize command highlights the selected message or message part in the
relevant portType box.

PortTypes (WSDL 1.1): For portTypes, the following functionality is available via context
menus.

© 2010 Altova GmbH User Manual


150 Editing Views WSDL View

 With the item PortTypes selected, a portType can be added.


 With a portType selected, portTypes can be added, the selected portType can be
deleted, and operations can be added to the selected portType.
 With an operation selected, additional operations can be appended, the selected
operation can be deleted, and elements (input, output, or fault) can be added to the
selected operation.
 With a message element (input, output, or fault) selected, additional messages can be
added and the selected message can be deleted.
 The Synchronize command highlights the selected portType, operation, or message.

Interfaces (WSDL 2.0): Interfaces can be managed using context menus.


 To add an interface, right-click the Interfaces item and select the menu command, Add
new interface.
 Right-clicking an interface pops up a menu (see screenshot below) with commands
enabling the selected interface to be deleted, and faults and operations to be added to
the definition of the selected interface. The type of operation to be added can be
specified in the submenu of the Add new operation command. A corresponding
binding operation is added to all bindings referencing the interface. In the same way,
when an operation is deleted, referencing binding operations are also deleted.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views WSDL View 151

 Right-clicking an operation pops up commands (see screenshot below) enabling the


selected operation to be deleted, and elements (such as infault and outfault) to be
added to the operation.

 Right-clicking a message element pops up a menu via which you can delete the
selected message.
 Clicking the Synchronize command highlights the selected interface, operation, or
message in the design.

Bindings (WSDL 1.1 and 2.0): With a binding selected, additional bindings can be appended to
the already-existing bindings, the selected binding can be deleted, and operations inserted for
the selected binding. With an operation or message selected, the same options are available as
described for operations and messages in the PortTypes (WSDL 1.1) or Interfaces (WSDL 2.0)
category. Clicking the Synchronize command highlights the selected binding, operation, or
message.

Services (WSDL 1.1 and 2.0): With a service selected, additional services can be added, the
selected service can be deleted, and ports can be added for the selected service. Clicking the

© 2010 Altova GmbH User Manual


152 Editing Views WSDL View

Synchronize command highlights the selected service or port.

4.4.3 Details Entry Helper


The Details entry helper displays the properties of the item selected in the Main Window or
Overview entry helper (screenshot below). These properties can be edited in the Details entry
helper.

For example, as shown in the screenshot above, if, in the Main Window, the port
TimeServiceSoap (of the TimeService service) is selected, then the properties of
TimeServiceSoap are displayed in the Details entry helper, where they can be edited. To edit a
text field such as for name or description, double-click in the field and edit the text. For some
properties, such as binding in the screenshot example above, where a selection can be made
from among options, a combo box allows you to select from the available options.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views XBRL View 153

4.5 XBRL View


XBRL View is a graphical interface that enables you to edit XBRL taxonomies. It provides fast
validation and error messages, which helps users to develop taxonomies quickly and
accurately.

XBRL View consists of the following parts:


 A Main Window having four tabs: Elements, Definitions, Presentation, Calculation (
screenshot below). The main features of these tabs are described in the sub-sections
of this section.

 Three powerful entry helpers: Overview, Global Elements, Details. These entry helpers
enable you to manage taxonomy files and edit the taxonomy in the Main Window.
 A Messages window which displays messages about the validity of the taxonomy.

This section provides a description of the Main Window and entry helpers of XBRL View and
information about how to use them. For more related information, see the sections XBRL and
the description of commands in the XBRL menu.

Additional features of XBRL View


Besides the editing features described in this section, the following useful features are available:
 Generate Documentation: which creates detailed documentation files in HTML, Word,
and RTF formats.
 Print of the current view enables a printout of the current view to be taken using
XMLSpy's File | Print command.

4.5.1 Main Window: Elements Tab


The Elements tab of the Main Window (screenshot below) displays the concepts of the
taxonomy, including, by default, the concepts contained in imported taxonomies. Concepts in
the current taxonomy are displayed in black; concepts in imported taxonomies are displayed in
gray.

© 2010 Altova GmbH User Manual


154 Editing Views XBRL View

Selecting the taxonomy to display


In the File combo box located below the tabs of the Main Window (screenshot below), you can
select whether concepts from the current taxonomy only, or whether concepts from the current
taxonomy plus its imported taxonomies, should be displayed. Select All to show the imported
taxonomies. Filtering out large imported taxonomies from the display will speed up editing
considerably.

Sorting elements
In the Sort combo box located below the tabs of the Main Window and to the right (screenshot
below), you can sort the elements in the Main Window.

The sorting criterion can be one of the following:


 Unsorted: Elements are listed in document order.
 Name: A namespace prefix is considered part of an element's name.
 Substitution Group: There are four substitution groups: items; tuples; hypercubeItems;
dimensionItems.
 Sort by Type: Refers to the Type attribute of the XBRL element.

Finding elements in the Main Window


To find an element in the Main Window press the key combination Ctrl+F. This pops up a Find
dialog, in which you can enter the string for which you wish to search. The namespace prefixes
used in the taxonomy can also be searched.

About concepts (the <element> elements)


Each taxonomy concept is defined in an XML Schema <element> element (see listing below).
This plain text definition can be seen on switching to the Text View of the taxonomy document.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views XBRL View 155

(To see the text definitions of an imported taxonomy document, the imported taxonomy
document will have to be opened in XMLSpy.)
<xs:element id="icui_UnrealizedHoldingLoss"
name="UnrealizedHoldingLoss"
substitutionGroup="xbrli:item"
type="xbrli:monetaryItemType"
xbrli:balance="credit"
xbrli:periodType="instant"
abstract="false"
nillable="true"/>

Each element (or concept) is displayed in the Elements tab with an icon indicating its
substitution group (item, tuple, hypercube, or dimension). Additionally, icons indicating the
values of the concept's balance, periodType, abstract, and nillable attributes are
displayed to the left of the concept name (screenshot below).

To edit the name of the concept, double-click the name of the concept and edit the name.

Substitution group
The substitution group value of a concept is indicated by the concept's icon:

xbrli:item
xbrli:tuple
xbrldt:hypercubeItem

xbrldt:dimensionItem

The screenshot below shows an element with a substitutionGroup value of xbrli:item.

The attributes balance, periodType, abstract, nillable


The additional icons to the left of an element's name (see screenshot above) indicate the values
of the concept's main attributes, respectively, from left to right:
 xbrli:balance: a plus icon for a value of credit, a minus icon for debit
 xbrli:periodType: a clock icon with a gray segment between the clock hands for a
value of duration, white segment for instant
 xs:abstract: black A icon when true, gray when false
 xs:nillable: black 0 icon when true, gray when false

Note that the xbrli: attributes listed above are from the XBRL schema and the xs: attributes
are from the XML Schema schema.

In the screenshot above, the plus icon indicates that the value of the xbrli:balance attribute
is credit. The values of the other attributes in the screenshot (xbrli:periodType, xs:
abstract, xs:nillable), respectively, are: duration, false, (i.e. not abstratct), and true (i.e.
nillable).

The values of these four attributes are displayed in a popup when the cursor is placed over any
of the four icons. Clicking any of these icons pops up a list box containing the allowed values for
that attribute. You can select one of the allowed choices, and in this way edit the value of

© 2010 Altova GmbH User Manual


156 Editing Views XBRL View

concept attributes quickly.

These attribute values can also be edited in the Details entry helper (screenshot below).

The attributes substitutionGroup, type


Clicking the arrowhead symbol at the left of the element name expands the display of the
element so that the values of the two attributes, xs:substitutionGroup and xs:type, are
displayed graphically (screenshot below).

In the screenshot above, the value of the xs:substitutionGroup and xs:type attributes are,
respectively: xbrli:item and xbrli:monetaryItemType. These values can be edited by
selecting alternative values from the dropdown list of the corresponding combo boxes. Both
attribute values can also be edited in the Details entry helper (see screenshot further above) by
double-clicking in the respective value field in the Details entry helper and editing the value via
the keyboard.

Label links
To add a label child, right-click an element and select Add Label Linkrole from the context
menu. This adds a label row (screenshot below), in which you can specify the label's properties
(language, label type, and value). You can expand and collapse labels by clicking the + and -
icons on the right edge of the box.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views XBRL View 157

The language and label type properties of each label can be edited by selecting the required
property value from in respective combo boxes (screenshot above).

Reference links
To add a reference chid, right-click an element and select Add Reference Linkrole from the
context menu. This adds a reference box, in which the properties of the reference can be edited
by clicking in the Reference field and editing the reference URN. You can expand and collapse
references by clicking the + and - icons on the right edge of the box.

4.5.2 Main Window: Definitions, Presentation, Calculation Tabs


The Main Window contains tabs for each of the three relationships between concepts:
 Definition relationships, shown in the Definitions tab
 Presentation relationships, shown in the Presentations tab
 Calculation relationships, shown in the Calculations tab

Each tab (Definition, Presentation, and Calculation) displays the taxonomy relationships of that
kind (screenshot below) and allows you to edit the relationships graphically. A relationship
between two concepts (whether a definition, presentation, or calculation relationship) is created
by building an arc from one concept to another concept. This from–to arc is indicated in the
graphical display as a curved arrow. The relationship between the two concepts (in the
direction from–to) is specified and is known as its arcrole. The arcrole of an arc is shown in the
Details entry helper when the element at the to-end of a relationship is selected, and, in the
case of definition relationships, in an Arcrole column in the Definitions tab (see screenshot
below).

The way the relationship arcs are displayed is the same for all kind of relationships (definition,
presentation, and calculation). In this section, each tab is considered separately, with the basic
description of how relationships are displayed being in the section on the Definitions tab.
Additional or specific information about presentation and calculation arcs are in the respective
sections. For more detailed information, see the sections, Creating Relationships: Part 1 and
Creating Relationships: Part 2.

Definitions tab
The Definitions tab shows all the definitions of the taxonomy. These definitions are specified in
definition arcs contained in definition relationships (.xml) file/s. In the Definitions tab of XBRL
View, the structure resulting from the set of definition arcs is displayed in an expandable/
collapsible tree form (screenshot below).

© 2010 Altova GmbH User Manual


158 Editing Views XBRL View

In this graphical display of the definitions, each definition arc is displayed as a curved arrow with
two endpoints (a from endpoint and a to endpoint). The type of relationship between the two
elements at either endpoint is displayed in the Arcrole column of the element at the to endpoint.
For example, in a hypercube–dimension relationship, the relationship (or arcrole) is listed with
the element that is the dimension part of the element pair. Arcrole URIs can also be entered in
the Details entry helper.

For more information on definitions relationships, see the section Creating Relationships: Part 1
.

Presentation tab
Presentation arcs have the same attributes as definition arcs, and they work in the same way
(see Definitions tabs above). Arcrole URIs are entered in the Details entry helper. One
important presentation attribute is the order attribute, which determines the order in which child
elements of a single parent element are presented. In the Presentation tab, such child elements
are displayed in correct ascending order. The value of the order attribute can be changed
quickly by dragging a child element to another position in the ordered list. The value of the
order attribute can also be changed in the Details entry helper (see screenshot below).

For more information on presentation relationships, see the section Creating Relationships: Part
2.

Calculation tab
Calculation arcs have the same attributes as definition arcs, and they work similarly to definition
arcs (see Definitions tabs above). Arcrole URIs are entered in the Details entry helper. There
are two types of arcroles:
 those that sum the values of elements to another element; and
 those that do not represent a summation relationship but an equivalent relationship

In the case of the former the weight attribute determines how much of the value of that element
is summed up to the aggregator element. A value of 1.0 indicates that 100% of the value
should be summed up. A negative value indicates that the value must be subtracted from the
aggregator. The value of the weight attribute can be edited in the Calculation tab as well as in
the Details entry helper.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views XBRL View 159

Editing in the graphical view


The following editing possibilities are available:
 Elements can be dragged from the Global Elements entry helper and dropped in a to
relationship to an element in the tree.
 An arcrole can be created or edited for an element by selecting the required arcrole (in
the Arcrole column). The relationship defined in the arcrole expresses a from–to
relationship, with the selected element occurring at the to-endpoint of the relationship.
 Elements can be dragged to alternative locations in the tree. This is a quick way to
change the value of the order attribute.
 The properties of an element can be edited by clicking one of its property symbols and
editing it, or by expanding its prroperty box and then editing properties inside the
property box.

Editing in Details entry helper


When an element is selected in the Main Window, the properties of its definition arc are
displayed in the Details entry helper in the Arc section (see screenshot below). The values of
these properties can be edited by double-clicking in a value field and entering the required value
or, if available, by selecting a value in the dropdown list of its combo box.

Additionally, properties of the arc of the selected element are displayed in Arc section of the
Details entry helper. The arc will be a definition arc, presentation arc, or calculation arc
according to what tab is currently active. The arcrole can be entered in the Arcrole field.

Label and reference relationships are listed under the Children heading. These relationships
can be edited in the Elements tab.

© 2010 Altova GmbH User Manual


160 Editing Views XBRL View

4.5.3 Entry Helpers in XBRL View


XBRL View features the following entry helpers:
 An Overview entry helper
 A Global Elements entry helper
 A Details entry helper

Validation information is displayed in the Messages window.

Overview entry helper


The Overview entry helper displays the taxonomy files in a tree structure (screenshot below).

The tree is organized as follows:


 The main concepts file (an XML Schema document) is shown at the root of the tree and
is the currently active file.
 The relationship linkbase files (XML files) have a colored file icon with a character
corresponding to the initial character of the relationship kind.
indicates a definitions linkbase;
indicatess a labels linkbase;
indicates a calculations linkbase;
indicates a presentation linkbase; and
indicates a reference linkbase.
 Imported schemas are listed on lower levels of the hierarchy. All XML Schema (.xsd)
files are indicated with an XSD icon.

This information displayed in the Overview entry helper is obtained from the /schema/
annotation/appinfo element of the main concepts file. See Taxonomy Files for more
information about this element.

Right-clicking a file in the Overview entry helper pops out a context menu (screenshot below), in
which the following commands are available:

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views XBRL View 161

 Open File: opens the selected XML Schema or XML file in XMLSpy.
 Set Default Linkbase: If there are multiple files of a single relationship kind (for
example, presentation relationships), then one of these can be set as the default
linkbase. Newly created relationships will be saved in the default linkbase of its
particular relationship kind. The default linkbase of each relationship kind is displayed in
bold.
 Set Linkbase Kind: Specifies the relationship kind of the selected linkbase. Select the
required relationship kind from the submenu that rolls out. The All relationship kind
specifies that the selected linkbase will be used for all relationship kinds.
 Add New Linkbase: Creates a new linkbase file to contain relationships of one of the
five kinds (definition, presentation, calculation, label, resource). The added file can be
renamed by right-clicking it and selecting the Rename command in the context menu. A
new linkbaseRef element is added to the concepts file; this element references the
newly added linkbase.
 Import/Reference: Imports a standard taxonomy or creates a reference to an existing
XML Schema or linkbase. If you select the standard taxonomy option, a window
containing a list of standard taxonomies pops up. Select the taxonomy you wish to
import; see Importing a Taxonomy for details. If you create a reference to an XML
schema or linkbase, a new linkbaseRef element containing the reference is added to
the concepts file. Clicking either the XML Schema or linkbase option pops up a dialog in
which you can browse for the required file.
 Set Target Namespace: Sets the target namespace and declares this namespace to be
in scope on the xs:schema element (that is, for the entire taxonomy). See the
description of the command XBRL | Set Target Namespace.
 Rename: Enables the selected file to be renamed.
 Remove: Removes the selected file from the Overview and its linkbaseRef element
from the concepts file.

Global Elements entry helper


The Global Elements entry helper (screenshot below) displays all the items, tuples, hypercubes,
and dimensions present in a taxonomy document. Elements can be dragged from the Global
Elements entry helper into the main window.

© 2010 Altova GmbH User Manual


162 Editing Views XBRL View

The following functionality is available in the Global Elements entry helper:


 Filtering by type: The display of each element type (item, tuple, hypercube, and
dimension) can be toggled on and off by clicking its icon in the toolbar of the Global
Elements entry helper. Clicking the Show All Elements icon displays all elements.
The selected filter is highlighted (Show All, in the screenshot above).
 Filtering by text: Clicking the Text Filter icon displays the Text Filter bar (see
screenshot below).

After the Text Filter has been selected, in the combo box at the right-hand side of the
Text Filter bar (under the arrow cursor in the screenshot above), choose a condition
with which to filter. The available options are Contains, Does not contain, and Starts
with. In the screenshot above, the Starts with condition has been selected. Next, enter
the text for the filter in the Text Filter box. The displayed elements will be filtered
accordingly. In the screenshot above, the list is filtered by names that begin with n1.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views XBRL View 163

Note that: (i) the filters work on the names of the entries as text strings, and (ii) the
names of entries can be changed with the Format icon (see below) and are sensitive to
the changes in name formats.
 Filtering by sources: The required sources can be selected in a popup, and only the
elements in the selected sources will be displayed.
 Format: There are three format options for the way names of elements are displayed:
Short qualified names , Expanded qualified names, and Labels. The short qualified
name uses the prefixes assigned to the respective namespaces; expanded qualified
name (icon is ) uses the whole namespace; and label uses the labels associated
with elements. Note that the format selection affects the Text Filter option, in that the
filter is applied to elements as listed according to the currently selected Format option.
 Drag-and-drop functionality: Elements in the Global Elements entry helper can be
dragged and dropped into relationships in any of the relationships views of the Main
Window (Definitions, Presentations, Calculations)

Details entry helper


When an element is selected in the Main Window, the Details entry helper (screenshot below)
displays its properties.

The properties of some elements can be edited in the Details entry helper: Abstract, Nillable,
Balance, Period Type, Substitution Group, and Type.

© 2010 Altova GmbH User Manual


164 Editing Views Authentic View

4.6 Authentic View


Authentic View is enabled by clicking the Authentic tab of the active document. If no SPS has
been assigned to the XML document, you are prompted to assign one. You can assign an SPS
at any time via the Authentic | Assign a Stylevision Stylesheet command.

This section provides:


 An overview of the interface
 A description of the toolbar icons specific to Authentic View
 A description of viewing modes available in the main Authentic View window
 A description of the Entry Helpers and how they are to be used
 A description of the context menus available at various points in the Authentic View of
the XML document

Additional sources of Authentic View information are:


 An Authentic View Tutorial, which shows you how to use the Authentic View interface.
This tutorial is available in the documentation of the Altova XMLSpy and Altova
Authentic Desktop products (see the Tutorials section), as well as online.
 For a detailed description of Authentic View menu commands, see the User Reference
section of your product documentation.

4.6.1 Overview of the GUI


Authentic View has a menu bar and toolbar running across the top of the window, and three
areas that cover the rest of the interface: the Project Window, Main Window, and Entry Helpers
Window. These areas are shown below.

Menu bar
The menus available in the menu bar are described in detail in the User Reference section of
your product documentation.

Toolbar
The symbols and icons displayed in the toolbar are described in the section, Authentic View

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Authentic View 165

toolbar icons.

Project window
You can group XML, XSL, HTML schema, and Entity files together in a project. To create and
modify the list of project files, use the commands in the Project menu (described in the User
Reference section of your product documentation). The list of project files is displayed in the
Project window. A file in the Project window can be accessed by double-clicking it.

Main window
This is the window in which the XML document is displayed and edited. It is described in the
section, Authentic View main window.

Entry helpers
There are three entry helper windows in this area: Elements, Attributes, and Entities. What
entries appear in these windows (Elements and Attributes Entry Helpers) are context-sensitive,
i.e. it depends on where in the document the cursor is. You can enter an element or entity into
the document by double-clicking its entry helper. The value of an attribute is entered into the
value field of that attribute in the Attributes Entry Helper. See the section Authentic View Entry
Helpers for details.

Status Bar
The Status Bar displays the XPath to the currently selected node.

Context menus
These are the menus that appear when you right-click in the Main Window. The available
commands are context-sensitive editing commands, i.e. they allow you to manipulate structure
and content relevant to the selected node. Such manipulations include inserting, appending, or
deleting a node, adding entities, or cutting and pasting content.

4.6.2 Authentic View Toolbar Icons


Icons in the Authentic View toolbar are command shortcuts. Some icons will already be familiar
to you from other Windows applications or Altova products, others might be new to you. This
section describes icons unique to Authentic View. In the description below, related icons are
grouped together.

Show/hide XML markup


In Authentic View, the tags for all, some, or none of the XML elements or attributes can be
displayed, either with their names (large markup) or without names (small markup). The four
markup icons appear in the toolbar, and the corresponding commands are available in the
Authentic menu.

Hide markup. All XML tags are hidden except those which have been collapsed.
Double-clicking on a collapsed tag (which is the usual way to expand it) in Hide
markup mode will cause the node's content to be displayed and the tags to be
hidden.

Show small markup. XML element/attribute tags are shown without names.

Show large markup. XML element/attribute tags are shown with names.

© 2010 Altova GmbH User Manual


166 Editing Views Authentic View

Show mixed markup. In the StyleVision Power Stylesheet, each XML element or
attribute can be specified to display (as either large or small markup), or not to
display at all. This is called mixed markup mode since some elements can be
specified to be displayed with markup and some without markup. In mixed markup
mode, therefore, the Authentic View user sees a customized markup. Note,
however, that this customization is created by the person who has designed the
StyleVision Power Stylesheet. It cannot be defined by the Authentic View user.

Editing dynamic table structures


Rows in a dynamic SPS table are repetitions of a data structure. Each row represents an
occurrence of a single element. Each row, therefore, has the same XML substructure as the
next.

The dynamic table editing commands manipulate the rows of a dynamic SPS table. That is, you
can modify the number and order of the element occurrences. You cannot, however, edit the
columns of a dynamic SPS table, since this would entail changing the substructure of individual
element occurrences.

The icons for dynamic table editing commands appear in the toolbar, and are also available in
the Authentic menu.

Append row to table

Insert row in table

Duplicate current table row (i.e. cell contents are duplicated)

Move current row up by one row

Move current row down by one row

Delete the current row

Please note: These commands apply only to dynamic SPS tables. They should not be used
inside static SPS tables. The various types of tables used in Authentic View are described in
the Using tables in Authentic View section of this documentation.

Creating and editing XML tables


You can insert your own tables should you want to present your data as a table. Such tables are
inserted as XML tables. You can modify the structure of an XML table, and format the table.
The icons for creating and editing XML tables are available in the toolbar, and are shown below.
They are described in the section XML table editing icons.

The commands corresponding to these icons are not available as menu items. Note also that

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Authentic View 167

for you to be able to use XML tables, this function must be enabled and suitably configured in
the StyleVision Power Stylesheet.

A detailed description of the types of tables used in Authentic View and of how XML tables are
to be created and edited is given in Using tables in Authentic View.

Text formatting icons


Text in Authentic View is formatted by applying to it an XML element or attribute that has the
required formatting. If such formatting has been defined, the designer of the StyleVision Power
Stylesheet can provide icons in the Authentic View toolbar to apply the formatting. To apply text
formatting using a text formatting icon, highlight the text you want to format, and click the
appropriate icon.

DB Row Navigation icons

The arrow icons are, from left to right, Go to First Record in the DB; Go to
Previous Record; Open Go to Record # dialog; Go to Next Record; and Go to Last Record.

This icon opens the Edit Database Query dialog in which you can enter a query.
Authentic View displays the queried record/s.

XML database editing


The Select New Row with XML Data for Editing command enables you to select a new row
from the relevant table in an XML DB, such as IBM DB2. This row appears in Authentic View,
can be edited there, and then saved back to the DB.

4.6.3 Authentic View Main Window


There are four viewing modes in Authentic View: Large Markup; Small Markup; Mixed Markup;
and Hide All Markup. These modes enable you to view the document with varying levels of
markup information. In Authentic Preview of StyleVision only two markup modes are available:
Hide Markup and Show Large (Full) Markup.

To switch between modes, use the commands in the Authentic menu or the icons in the
toolbar (see the previous section, Authentic View toolbar icons).

Large markup
This shows the start and end tags of elements and attributes with the element/attribute names
in the tags:

The element Name in the figure above is expanded, i.e. the start and end tags, as well as the
content of the element, are shown. An element/attribute can be contracted by double-clicking
either its start or end tag. To expand the contracted element/attribute, double-click the
contracted tag.

© 2010 Altova GmbH User Manual


168 Editing Views Authentic View

In large markup, attributes are recognized by the equals-to symbol in the start and end tags of
the attribute:

Small markup
This shows the start and end tags of elements/attributes without names:

Notice that start tags have a symbol inside it while end tags are empty. Also, element tags have
an angular-brackets symbol while attribute tags have and equals sign as its symbol (see
screenshot below).

To collapse or expand an element/attribute, double-click the appropriate tag. The example


below shows a collapsed element (highlighted in blue). Notice the shape of the start tag of the
collapsed element and that of the start tag of the expanded element to its left.

Mixed markup
Mixed markup shows a customized level of markup. The person who has designed the
StyleVision Power Stylesheet can specify either large markup, small markup, or no markup for
individual elements/attributes in the document. The Authentic View user sees this customized

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Authentic View 169

markup in mixed markup viewing mode.

Hide all markup


All XML markup is hidden. Since the formatting seen in Authentic View is the formatting of the
printed document, this viewing mode is a WYSIWYG view of the document.

Content display
In Authentic View, content is displayed in two ways:
 Plain text. You type in the text, and this text becomes the content of the element or the
value of the attribute.

 Data-entry devices. The display contains either an input field (text box), a multiline input
field, combo box, check box, or radio button. In the case of input fields and multiline
input fields, the text you enter in the field becomes the XML content of the element or
the value of the attribute.

In the case of the other data-entry devices, your selection produces a corresponding
XML value, which is specified in the StyleVision Power Stylesheet. Thus the selection
"approved" in the display example below could map to an XML value of "1", or to
"approved", or anything else; while "not approved" in the display could map to "0", or
"not approved", or anything else.

Optional nodes
When an element or attribute is optional (according to the referenced schema), a prompt of
type add [element/attribute] is displayed:

Clicking the prompt adds the element, and places the cursor for data entry. If there are multiple
optional nodes, the prompt add... is displayed. Clicking the prompt displays a menu of the
optional nodes.

4.6.4 Authentic View Entry Helpers


There are three entry helpers in Authentic View: for Elements, Attributes, and Entities. They are
displayed as windows down the right side of the Authentic View interface (see screenshot below
).

© 2010 Altova GmbH User Manual


170 Editing Views Authentic View

The Elements and Attributes Entry Helpers are context-sensitive, i.e. what appears in the entry
helper depends on where the cursor is in the document. The entities displayed in the Entities
Entry Helper are not context-sensitive; all entities allowed for the document are displayed no
matter where the cursor is.

Each of the entry helpers is described separately below.

Elements Entry Helper


The Elements Entry Helper consists of two parts:
 The upper part, containing an XML tree that can be toggled on and off using the Show
XML tree check box. The XML tree shows the ancestors up to the document's root
element for the current element. When you click on an element in the XML tree,
elements corresponding to that element (as described in the next item in this list)
appear in the lower part of the Elements Entry Helper.
 The lower part, containing a list of the nodes that can be inserted within, before, and
after; removed; applied to or cleared from the selected element or text range in
Authentic View. What you can do with an element listed in the Entry Helper is indicated
by the icon to the left of the element name in the Entry Helper. The icons that occur in

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Authentic View 171

the Elements Entry Helper are listed below, together with an explanation of what they
mean.

To use node from the Entry Helper, click its icon.

Insert After Element


The element in the Entry Helper is inserted after the selected element. Note
that it is appended at the correct hierarchical level. For example, if your cursor
is inside a //sect1/para element, and you append a sect1 element, then
the new sect1 element will be appended not as a following sibling of
//sect1/para but as a following sibling of the sect1 element that is the
parent of that para element.

Insert Before Element


The element in the Entry Helper is inserted before the selected element. Note
that, just as with the Append After Element command, the element is inserted
at the correct hierarchical level.

Remove Element
Removes the element and its content.

Insert Element
An element from the Entry Helper can also be inserted within an element.
When the cursor is placed within an element, then the allowed child elements
of that element can be inserted. Note that allowed child elements can be part of
an elements-only content model as well as a mixed content model (text plus
child elements).

An allowed child element can be inserted either when a text range is selected
or when the cursor is placed as an insertion point within the text.
 When a text range is selected and an element inserted, the text range
becomes the content of the inserted element.
 When an element is inserted at an insertion point, the element is inserted at
that point.

After an element has been inserted, it can be cleared by clicking either of the
two Clear Element icons that appear (in the Elements Entry Helper) for these
inline elements. Which of the two icons appears depends on whether you
select a text range or place the cursor in the text as an insertion point (see
below).

Apply Element
If you select an element in your document (by clicking either its start or end tag
in the Show large markup view) and that element can be replaced by another
element (for example, in a mixed content element such as para, an italic
element can be replaced by the bold element), this icon indicates that the
element in the Entry Helper can be applied to the selected (original) element.
The Apply Element command can also be applied to a text range within an
element of mixed content; the text range will be created as content of the
applied element.
 If the applied element has a child element with the same name as a child
of the original element and an instance of this child element exists in the
original element, then the child element of the original is retained in the new

© 2010 Altova GmbH User Manual


172 Editing Views Authentic View

element's content.
 If the applied element has no child element with the same name as that
of an instantiated child of the original element, then the instantiated child of
the original element is appended as a sibling of any child element or
elements that the new element may have.
 If the applied element has a child element for which no equivalent
exists in the original element's content model, then this child element is not
created directly but Authentic View offers you the option of inserting it.

If a text range is selected rather than an element, applying an element to the


selection will create the applied element at that location with the selected text
range as its content. Applying an element when the cursor is an insertion point
is not allowed.

Clear Element (when range selected)


This icon appears when text within an element of mixed content is selected.
Clicking the icon clears the element from around the selected text range.

Clear Element (when insertion point selected)


This icon appears when the cursor is placed within an element that is a child of
a mixed-content element. Clicking the icon clears the inline element.

Attributes Entry Helper


The Attributes Entry Helper consists of a drop-down combo box and a list of attributes. The
element that you have selected (you can click the start or end tag, or place the cursor anywhere
in the element content to select it) appears in the combo box.

The Attributes Entry Helper shown in the figures below has a para element in the combo box.
Clicking the arrow in the combo box drops down a list of all the para element's ancestors up
to the document's root element, which in this case is OrgChart.

Below the combo box, a list of valid attributes for that element is displayed, in this case for para
. If an attribute is mandatory on a given element, then it appears in bold. (In the example below,
there are no mandatory attributes.)

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Authentic View 173

To enter a value for an attribute, click in the value field of the attribute and enter the value. This
creates the attribute and its value in the XML document.

In the case of the xsi:nil attribute, which appears in the Attributes Entry Helper when a
nillable element has been selected, the value of the xsi:nil attribute can only be entered by
selecting one of the allowed values (true or false) from the dropdown list for the attribute's
value.

Entities Entry Helper


The Entities Entry Helper allows you to insert an entity in your document. Entities can be used to
insert special characters or text fragments that occur often in a document (such as the name of
a company). To insert an entity, place the cursor at the point in the text where you want to have
the entity inserted, then double-click the entity in the Entities Entry Helper.

Note: An internal entity is one that has its value defined within the DTD. An external entity is
one that has its value contained in an external source, e.g. another XML file. Both
internal and external entities are listed in the Entities Entry Helper. When you insert an
entity, whether internal or external, the entity—not its value—is inserted into the XML
text. If the entity is an internal entity, Authentic View displays the value of the entity. If
the entity is an external entity, Authentic View displays the entity—and not its value.
This means, for example, that an XML file that is an external entity will be shown in the
Authentic View display as an entity; its content does not replace the entity in the
Authentic View display.

You can also define your own entities in Authentic View and these will also be displayed in the
entry helper: see Define Entities in the Editing in Authentic View section.

4.6.5 Authentic View Context Menus


Right-clicking on some selected document content or node pops up a context menu with
commands relevant to the selection or cursor location.

Inserting elements
The figure below shows the Insert submenu, which is a list of all elements that can be inserted
at that current cursor location. The Insert Before submenu lists all elements that can be
inserted before the current element. The Insert After submenu lists all elements that can be
inserted after the current element. In the figure below, the current element is the para element.
The bold and italic elements can be inserted within the current para element.

© 2010 Altova GmbH User Manual


174 Editing Views Authentic View

As can be seen below, the para and Office elements can be inserted before the current
para element.

The node insertion, replacement (Apply), and markup removal (Clear) commands that are
available in the context menu are also available in the Authentic View entry helpers and are fully
described in that section.

Insert entity
Positioning the cursor over the Insert Entity command rolls out a submenu containing a list of all
declared entities. Clicking an entity inserts it a the selection. See Define Entities for a
description of how to define entities for the document.

Insert CDATA Section


This command is enabled when the cursor is placed within text. Clicking it inserts a CDATA
section at the cursor insertion point. The CDATA section is delimited by start and end tags; to
see these tags you should switch on large or small markup. Within CDATA sections, XML
markup and parsing is ignored. XML markup characters (the ampersand, apostrophe, greater
than, less than, and quote characters) are not treated as markup, but as literals. So CDATA
sections are useful for text such as program code listings, which have XML markup characters.

Remove node
Positioning the mouse cursor over the Remove command pops up a menu list consisting of the
selected node and all its removable ancestors (those that would not invalidate the document) up
to the document element. Click the element to be removed. This is a quick way to delete an
element or any removable ancestor. Note that clicking an ancestor element will remove all its
descendants, including the selected element.

Clear
The Clear command clears the element markup from around the selection. If the entire node is
selected, then the element markup is cleared for the entire node. If a text segment is selected,
then the element markup is cleared from around that text segment only.

Apply
The Apply command applies a selected element to your selection in the main Window. For
more details, see Authentic View entry helpers.

Copy, Cut, Paste


These are the standard Windows commands. Note, however, that the Paste command pastes
copied text either as XML or as Text, depending on what the designer of the stylesheet has
specified for the SPS as a whole. For information about how the Copy as XML and Copy as
Text commands work, see the description of the Paste As command immediately below.

Paste As
The Paste As command offers the option of pasting as XML or as text an Authentic View XML

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Authentic View 175

fragment (which was copied to the clipboard). If the copied fragment is pasted as XML it is
pasted together with its XML markup. If it is pasted as text, then only the text content of the
copied fragment is pasted (not the XML markup, if any). The following situations are possible:
 An entire node together with its markup tags is highlighted in Authentic View and
copied to the clipboard. (i) The node can be pasted as XML to any location where this
node may validly be placed. It will not be pasted to an invalid location. (ii) If the node is
pasted as text, then only the node's text content will be pasted (not the markup); the
text content can be pasted to any location in the XML document where text may be
pasted.
 A text fragment is highlighted in Authentic View and copied to the clipboard. (i) If this
fragment is pasted as XML, then the XML markup tags of the text—even though these
were not explicitly copied with the text fragment—will be pasted along with the text, but
only if the XML node is valid at the location where the fragment is pasted. (ii) If the
fragment is pasted as text, then it can be pasted to any location in the XML document
where text may be pasted.

Note: Text will be copied to nodes where text is allowed, so it is up to you to ensure that the
copied text does not invalidate the document. The copied text should therefore be:
(i) lexically valid in the new location (for example, non-numeric characters in a numeric
node would be invalid), and
(ii) not otherwise invalidate the node (for example, four digits in a node that accepts only
three-digit numbers would invalidate the node).
If the pasted text does in any way invalidate the document, this will be indicated by the
text being displayed in red.

Delete
The Delete command removes the selected node and its contents. A node is considered to be
selected for this purpose by placing the cursor within the the node or by clicking either the start
or end tag of the node.

© 2010 Altova GmbH User Manual


176 Editing Views Browser View

4.7 Browser View


Browser View is typically used to view:
 XML files that have an associated XSLT file. When you switch to Browser View, the
XML file is transformed on the fly using the associated XSLT stylesheet and the result is
displayed directly in the browser.
 HTML files which are either created directly as HTML or created via an XSLT
transformation of an XML file.

To view XML and HTML files in Browser View, click the Browser tab.

Note about Microsoft Internet Explorer and XSLT


Browser View requires Microsoft's Internet Explorer 5.0 or later. If you wish to use Browser View
for viewing XML files transformed by an XSLT stylesheet, we strongly recommend Internet
Explorer 6.0 or later, which uses MSXML 3.0, an XML parser that fully supports the XSLT 1.0
standard. You might also wish to install MSXML 4.0. Please see our Download Center for more
details.( Note that support for XSLT in IE 5 is not 100% compatible with the official XSLT
Recommendation. So if you encounter problems in Browser View with IE 5, you should upgrade
to IE 6 or later.) You should also check the support for XSLT of your version of Internet
Explorer.

Browser View features


The following features are available in Browser View. They can be accessed via the Browser
menu and Edit menu.

 Open in separate window: When Browser View is a separate window, it can be


positioned side-by-side with an editing view of the same document. This command is in
the Browser menu and is a toggle-command that can be used to return a separate
Browser View window as a tabbed view. In the View tab of the Options dialog, you can
set whether Browser View should, by default, be a separate window.
 Forward and Back: The common browser commands to navigate through pages that
were loaded in Browser View. These commands are in the Browser menu.
 Font size: Can be adjusted via the Browser menu command.
 Stop, Refresh, Print: More standard browser commands, these can be found in the
Browser and File menus.
 Find: Enables searches for text strings, this command is in the Edit menu.

Altova XMLSpy 2011 © 2010 Altova GmbH


Editing Views Archive View 177

4.8 Archive View


An Office Open XML (OOXML) file or ZIP file (for example, WinZip or WinRAR) can be opened
and edited in Archive View. Not only can OOXML and ZIP archives be structurally modified in
Archive View, but individual files in the archive can be opened from Archive View, edited in one
of XMLSpy's editing views, and then saved directly back to the archive.

Archive files and Archive View


When an archive file (OOXML or ZIP file) is created or opened in XMLSpy, it is opened in
Archive View (screenshot below). Multiple archive files can be open at a time, with each archive
file being in a separate Archive View window. The type of the archive file appears in the top
right-hand corner of Archive View. In the screenshot below, the type of the archive file is MS
Office Word Open XML.

Folder View
The Folder View is located on the left-hand side of the Archive View window and displays the
folder structure of the ZIP archive. On each level, folders are listed alphabetically. To view the
sub-folders of a folder, click the plus symbol to the left of the folder. If a folder does not have a
plus symbol to the left of it, then it has no sub-folder. To view the document files (hereafter
called documents) contained in a folder, select the folder; the files will be displayed in the Main
Window. In the screenshot above, the documents displayed in the Main Window are in the word
folder, which also has two sub-folders: _rels and theme.

Main Window
The Main Window lists the documents in the folder that is selected in Folder View. Documents
are displayed in alphabetical order, each with its respective uncompressed size and the date
and time of last modification. To open a Document from Archive View, double-click it. The
document opens in a separate XMLSpy window.

Command buttons
The command buttons are located along the top of the Archive View window.
 Open document: Enabled when a document in the Main Window is selected. Clicking
it opens the selected document. A document can also be opened by double-clicking the
document listing in the Main Window.
 New folder: Adds a new folder to the folder that is currently selected in Folder View.
The folder must be named immediately upon its being created in Folder View. It is not
possible to rename a folder subsequently. The new folder is saved in the archive when
the archive file is saved.

© 2010 Altova GmbH User Manual


178 Editing Views Archive View

 Add new document: Adds a new document to the folder currently selected in Folder
View. Clicking this button opens the Create New Document dialog of XMLSpy. The
newly created document opens in a separate XMLSpy window. The document must be
named immediately upon its being listed in the document listing of the selected folder.
The document is saved in the archive only when it is saved in its own editing window or
when the archive file is saved.
 Add document: Opens a Browse dialog in which you can browse for a document to
add. The document is added to the listing in the Main Window of documents currently in
the selected folder, and the document is opened in a separate XMLSpy window. For the
document to be saved to the archive, it must either be saved in its own window, or the
archive file must be saved.
 Delete from archive: Deletes the selected document (in Main Window) or selected
folder (in Folder View) from the archive. The archive file must be saved in order for the
deletion to take effect.
 Info: Toggles the Info Window on and off. See below.

Info Window
The Info Window is toggled on and off by clicking the Info command button. The Info Window
provides general information about the archive file, such as the number of files it contains, its
uncompressed and compressed sizes, and the compression ratio.

Altova XMLSpy 2011 © 2010 Altova GmbH


XML 179

5 XML
This section describes how to work with XML documents in XMLSpy. It covers the following
aspects:
 How to create, open, and save XML documents. In this section, some important
XMLSpy settings relating to file creation are also explained.
 XML documents can be edited in Text View, Grid View, and Authentic View. You can
select the view that is most useful for you and switch among the views while editing.
Each of the views offers different advantages.
 Entry helpers for XML documents have certain specific features, and these are
described.
 How to process XML documents with XSLT and XQuery. Various XMLSpy features
related to processing are explained.
 Miscellaneous other features for working with XML documents are described.

Altova website: XML Editor

© 2010 Altova GmbH User Manual


180 XML Creating, Opening, and Saving XML Documents

5.1 Creating, Opening, and Saving XML Documents


When creating, opening, or saving XML documents, the following issues are involved:
 In what view will the XML document open: Text View, Grid View, or Authentic View
 When a new XML document is created, whether a schema (XML Schema or DTD) will
be automatically assigned, manually assigned, or not assigned
 If a schema is assigned to the XML document, whether the document will be validated
automatically on opening and/or saving

Default view
There are application-wide settings for specifying in what view XML documents (new and
existing) should open. These settings are in the Options dialog (Tools | Options).

In the File Types tab of the Options dialog, select a file type of .xml and, in the Default View
pane, check the required editing view (Text or Grid). Note that: (i) Schema View and WSDL
View can be used only for XML Schema and WSDL documents, respectively; and (ii) Browser
View is a display view, not an editing view.

In the File Types tab, you can also set XMLSpy as the default editor for the selected file type.

An XML document can be edited in Authentic View if a StyleVision Power Stylesheet (SPS) has
been assigned to it. When an XML file with an associated SPS is opened, you can specify that it
opens directly in Authentic View. Do this by checking the Always open in Authentic View option
in the View tab of the Options dialog. If this option is not checked, the file will open in the default
view specified for .xml files in the File Types tab (see above).

Assigning schemas
When a new XML file is to be created, select the menu command File | New. This pops up the
Create New Document dialog (screenshot below).

Notice that there are several options for the XML document type. The option marked Extensible
Markup Language creates a generic XML document. Each of the other options is associated
with a schema, for example the DocBook DTD. If you select one of these options, an XML

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Creating, Opening, and Saving XML Documents 181

document is created that has (i) the corresponding schema automatically assigned to it, and (ii)
a skeleton document structure that is valid according to the assigned schema. Note that you
can create your own skeleton XML document. If you save it in the Template folder of the
application folder, your skeleton document will be available for selection in the Create New
Document dialog.

If you select the generic Extensible Markup Language document type, you will be prompted for
a schema (DTD or XML Schema) to assign to the document. At this point, you can choose to
browse for a schema or go ahead and create an XML document with no schema assigned to it.

You can, of course, assign a schema via the DTD/Schema menu at any subsequent time
during editing.

Automatic validation
If an existing XML document has a schema assigned to it, then it can be automatically validated
on opening and/or saving. The setting for this is in the File tab of the Options dialog (Tools |
Options).

The automatic validation settings in the File tab can be combined with a setting in the File
Types tab to disable automatic validation for specific file types. Using the settings in the two
tabs together enables you to specify automatic validation for specific file types.

© 2010 Altova GmbH User Manual


182 XML Assigning Schemas and Validating

5.2 Assigning Schemas and Validating


Altova website: XML Validator, XML Validation

A schema (DTD or XML Schema) can be assigned to an XML document when it is first created.
A schema can also be assigned, or changed, at any subsequent time using the Assign DTD or
Assign Schema commands in the DTD/Schema menu.

The path to the schema file that is inserted in the XML document can be made relative by
checking the relative path check box in the dialog.

Global resources for schemas


A global resource is an alias for a file or folder. The target file or folder can be changed within
the GUI by changing the active configuration of the global resource (via the menu command
Tools | Active Configuration). Global resources therefore enable the assigned schema to be
switched among multiple schemas, which can be useful for testing. How to use global resources
is described in the section Altova Global Resources.

XML Schema plus DTD


One very useful DTD feature that XML Schema does not have is the use of entities. However, if
you wish to use entities in your XML-Schema-validated XML document, you can add a DOCTYPE
declaration to the XML document and include your entity declarations in it.

<?xml version="1.0" encoding="UTF-8"?>


<!DOCTYPE OrgChart [
<!ENTITY name-int "value">
<!ENTITY name-ext SYSTEM "extfile.xml">
]>
<OrgChart xmlns="http://www.xs.com/org"
xsi:schemaLocation="http://www.xs.com/org OrgChart.xsd">
...
</OrgChart>

After declaring the entities in the DTD, they can be used in the XML document. The document
will be well-formed and valid. Note, however, that external parsed entities are not supported in
Authentic View..

Going to schema definitions


With the XML document open, you can directly open the DTD or XML Schema on which it is
based by clicking the Go to DTD or Go to Schema commands in the DTD/Schema menu.
Additionally, you can place the cursor within a node in the XML document and go to the schema
definition of that node via the Go to Definition command in the DTD/Schema menu.

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Assigning Schemas and Validating 183

Validating and checking well-formedness


To validate and/or check for well-formedness, use the Validate XML (F8) and Check Well-
Formedness (F7) commands in the XML menu or the corresponding commands in the toolbar.
Any error is reported in the Messages window.

© 2010 Altova GmbH User Manual


184 XML Editing XML in Text View

5.3 Editing XML in Text View


XMLSpy offers some specialized XML text editing features in addition to the generally available
editing features in Text View, which are described in Text View in the Editing Views section.
 Commenting text in and out
 Inserting file paths
 Inserting XML fragments via XInclude
 Copying XPath and XPointer expressions to the clipboard

Commenting text in/out


Text in an XML document can be commented out using the XML start-comment and end-
comment delimiters, respectively <!-- and -->. In XMLSpy, these comment delimiters can be
easily inserted using the Edit | Comment In/Out menu command.

To comment out a block of text, select the text to be commented out and then select the
command Comment In/Out, either from the Edit menu or the context menu that you get on
right-clicking the selected text. The commented text will be grayed out (see screenshot below).

To uncomment a commented block of text, select the commented block excluding the
comment delimiters, and select the command Comment In/Out, either from the Edit menu or
the context menu that you get on right-clicking the selected text. The comment delimiters will be
removed and the text will no longer be grayed out.

Note about empty lines


In XML documents, empty lines are discarded when you change views or save the document. If
you wish to retain empty lines, enclose them in comment delimiters.

Inserting file paths


The Edit | Insert File Path command enables you to browse for the file in question and insert
its file path at the selected location in the XML document being edited. This command enables
you to quickly and accurately enter a file path. See the command description for more details.

Inserting XML fragments via XInclude


The Edit | Insert XInclude enables you, via XInclude, to insert the contents of an entire XML
document, or a fragment of one, in the XML document being edited. This command enables
you to quickly and accurately enter a file path. See the command description for more details.

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Editing XML in Text View 185

Copying XPath and XPointer expressions to the clipboard


The XPath and XPointer expressions of the selected node can be copied to the clipboard using
the Edit | Copy XPath and Edit | Copy XPointer commands, respectively. This enables you to
obtain the correct XPath and XPointer expressions for a given node. The copied expressions
can then be inserted at the required location, for example, an XPath expression in an XSLT
stylesheet and an XPointer expression in the href attribute of an xinclude element. For more
detailed descriptions of the commands, see their descriptions in the User Reference section.

© 2010 Altova GmbH User Manual


186 XML Editing XML in Grid View

5.4 Editing XML in Grid View


Grid View shows the hierarchical structure of XML documents through a set of nested
containers that can be expanded and collapsed. This provides a clear picture of the document's
structure. In Grid View, both structure and contents can be easily manipulated.

In the screenshot above, notice that the document is displayed as a hierarchy in a grid form.
When a node can contains content, it is divided into two fields: for name and for content. Node
names are displayed in bold face and node content in normal face.

Display as table
If there are several instances of a repeating element, then, in standard Grid View, each
complete instance is displayed, one after the other, progressing vertically downward in
document order (screenshot below).

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Editing XML in Grid View 187

Such a structure of multiple instances can also be displayed as a table (screenshot below), in
which the child nodes form the columns and the multiple instances form the rows.

Table View offers a unique editing advantage in that whole rows and columns can be
manipulated relative to other columns and rows in the table. This enables such operations as
sorting data with respect to the value of one common child node. For example, in the
screenshot above, the six Person elements can be sorted on the basis of their Last child
elements via a simple GUI operation. Such an operation is much simpler than running an XSLT
transformation, which would be the usual way to sort an XML nodeset.

Editing the document structure


In Grid View, the XML document structure can be edited graphically. For example, you can
collapse and expand individual segments of the document structure, insert, append and delete
nodes, drag-and-drop nodes to different locations, and convert one type of node to another
type.

The XML menu offers commands to insert, append, and add empty child nodes. For example,
you can add an empty child node by selecting an element and then adding an empty child
element. You can then enter a name and content for the newly added node by double-clicking in
the respective field (name or content field) and entering the required string.

© 2010 Altova GmbH User Manual


188 XML Editing XML in Grid View

The Elements and Attributes entry helpers enable you to insert, append, and add child nodes
that are allowed at the selected location. For example, you select a node in the Main Window.
The element and attribute nodes that may be validly inserted, appended, or added as a child at
this location are listed in the Elements and Attributes entry helpers.

The commands available in the XML menu and entry helpers that are applicable to a selected
node are also available in the context menu of that node.

Editing content
To edit content, double-click in the content field and type in the content text. Entities can be
inserted via the Entities entry helper.

More about Grid View


For a more detailed description of Grid View, see under Editing Views.

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Editing XML in Authentic View 189

5.5 Editing XML in Authentic View


Authentic View enables a user to edit an XML document as if it were a text document (
screenshot below). The XML markup and all other non-content text can be hidden from the
person editing the document. This can be useful for people who are unfamiliar with XML,
enabling them to a valid XML document even while concentrating entirely on the content of the
document..

The Authentic View of a document is enabled when a StyleVision Power Stylesheet (SPS) is
assigned to an XML document. An SPS is based on the same schema source as that on which
the XML document is based, and it defines the structure of the XML document. The SPS also
defines the layout and formatting of the document in Authentic View. For example, in the
document shown in the screenshot above, the following Authentic formatting and editing
features are used:

 Paragraph and other block formatting


 Table structures
 Text formatting, such as color and font face
 Combo boxes (see the State and Zip fields) enable the user to select from a group of
valid choices, which can be taken from schema enumerations, as has been done in the
case above
 Additional information can be calculated from the data in the document and be
presented (in the example above, the office summary details have not been entered by
the user but calculated from other data in the document)

SPSs are created specifically for viewing and editing XML documents in Authentic View and for

© 2010 Altova GmbH User Manual


190 XML Editing XML in Authentic View

generating standard output (such as HTML, PDF, RTF, and Word 2007 documents) from XML.
SPSs are created with Altova StyleVision.

Editing document structure


Valid nodes can be added to the document at any time by selecting a location and then adding
the required node via the entry helpers (Elements and Attributes) or context menu. The nodes
available at any given location are restricted to the nodes that can be validly added as siblings
or children at the selected location. For example, when the cursor is located within a
paragraph, you can append another paragraph if this is allowed by the schema.

When editing the structure of an XML document in Authentic View, it could be useful to see the
markup of the document. Markup can therefore be switched on as tags (screenshot below)
using the Authentic | Show Large Markup command (or the corresponding toolbar icon).

Editing content
Content is created and edited by typing it into the nodes of the document. Entities and CDATA
sections can be added via the context menu (entities also via the Entities entry helper).

More about editing in Authentic View


For more details of how to edit in Authentic View, see the Authentic View section.

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Entry Helpers for XML Documents 191

5.6 Entry Helpers for XML Documents


For XML documents, there are three entry helpers: Elements entry helper; Attributes entry
helper; and Entities entry helper. When an element is added via the Elements entry helper, it
can be added together with mandatory child elements, mandatory attributes, all child elements,
or no child element or attribute, according to the respective settings in the Editing tab of the
Options dialog. When empty attributes are added, they are added with quotes.

Note that in the different views, the entry helpers are designed differently, in accordance with
the functionality of the respective view.

Elements entry helper


The following points should be noted:
 Text View: Elements are inserted at the cursor insertion point. Unused elements are
displayed in red, used elements in gray. Mandatory elements are indicated with an
exclamation mark "!" before the name of the element.
 Grid View: Elements can be appended after, inserted before, or added as a child of the
selected element. There are therefore three tabs, each displaying the elements that
may be added. Unused elements are displayed in black, used elements in gray.
 Authentic View: Elements can be inserted before, after, or within the selected element.
Additionally, there is a document tree that shows the location of the currently selected
element in the document's tree structure. For more details of how to edit in Authentic
View, see the Authentic View section.

Attributes entry helper


The following points should be noted:
 Text View: When the cursor is placed inside the start tag of an element and after a
space, the attributes declared for that element become visible. Unused attributes are
displayed in red, used attributes in gray. Mandatory attributes are indicated with an
exclamation mark "!" before the name of the attribute.

To insert an attribute, double-click the required attribute. The attribute is inserted at the
cursor point together with an equals-to sign and quotes to delimit the attribute value.
The cursor is placed between the quotes, so you can start typing in the attribute value
directly.
 Grid View: When an element is selected, the attributes that can be added as a child are
listed in the Add Child tab of then entry helper. When an attribute is selected, the
available attributes are listed in the Append (after) and Insert (before) tabs. Unused
attributes are displayed in black, used attributes in gray.
 Authentic View: When an element is selected, the attributes declared for that element
become visible. Enter he value of the attribute in the entry helper.

Entities entry helper


Any parsed or unparsed entity that is declared inline (within the XML document) or in an
external DTD, is displayed in the Entities entry helper. In all three views (Text, Grid, and
Authentic), an entity is inserted at the cursor insertion point by double-clicking it. In Grid View,
entities are displayed in the Append, Insert, and Add Child tabs.

© 2010 Altova GmbH User Manual


192 XML Entry Helpers for XML Documents

Note that if you add an internal entity, you will need to save and reopen your document before
the entity appears in the Entities entry helper.

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Processing with XSLT and XQuery 193

5.7 Processing with XSLT and XQuery


XML documents can be processed with XSLT or XQuery documents to produce output
documents. XMLSpy has built-in XSLT 1.0, XSLT 2.0, and XQuery 1.0 processors. The
following processing-related features are available in the GUI:
 Assigning XSLT stylesheets
 Go to XSLT
 XSLT parameters and XQuery variables
 XSLT transformations
 XQuery executions
 Automating XML tasks with AltovaXML

Assigning XSLT stylesheets


You can assign an XSLT stylesheet to an XML document via the XSL/XQuery | Assign XSL
command (browse for the file in the dialog (screenshot below) that pops up). The assignment is
entered in the XML document as a processing instruction (PI) having the standard XSLT target
defined by the W3C: xml-stylesheet. This assignment is used when an XSLT transformation
is invoked (XSL/XQuery | XSL Transformation).

Additionally, an XSLT-for-FO stylesheet can be assigned with the XSL/XQuery | Assign XSL:
FO command (browse for the file in the dialog (screenshot below) that pops up). The
assignment is entered in the XML document as a processing instruction (PI) having the Altova-
defined target: altova_xslfo. This assignment is used when an XSLT-for-FO transformation
is invoked (XSL/XQuery | XS:FO Transformation).

You can also select a global resource to specify the XSLT file. A global resource is an alias for a
file or folder. The target file or folder can be changed within the GUI by changing the active
configuration of the global resource (via the menu command Tools | Active Configuration).
Global resources therefore enable the assigned XSLT file to be switched from one to another,
which can be useful for testing. How to use global resources is described in the section Altova
Global Resources.

If a previous assignment using either of these PI targets exists, then you are asked whether you
wish to overwrite the existing assignment.

Go to XSLT
The XSL/XQuery | Go to XSL command opens the XSLT file that has been assigned to the
XML document.

XSLT parameters and XQuery variables


XSLT parameters and XQuery variables can be defined, edited, and deleted in the dialog that

© 2010 Altova GmbH User Manual


194 XML Processing with XSLT and XQuery

appears on clicking the command XSL/XQuery | XSLT Parameters / XQuery Variables. The
parameter/variable values defined here are used for all XSLT transformations and XQuery
executions in XMLSpy. However, these values will not be passed to external engines such as
MSXML. For the details of how to use this feature, see the User Reference section.

XSLT transformations
Two types of XSLT transformation are available:
 Standard XSLT transformation (XSL/XQuery | XSL Transformation): The output of the
transformation is displayed in a new window or, if specified in the stylesheet, is saved to
a file location. The engine used for the transformation is specified in the XSL tab of the
Options dialog (Tools | Options).
 XSL-for-FO transformation (XSL/XQuery | XSL-FO Transformation): The XML
document is transformed to PDF in a two-step process. In the first step, the XML
document is transformed to an FO document using the XSLT processor specified in the
XSL tab of the Options dialog (Tools | Options); note that you can also select (at the
bottom of the tab) the XSLT engine that comes with some FO processors such as FOP.
In the second step, the FO document is processed by the FO processor specified in
the XSL tab of the Options dialog (Tools | Options) to produce PDF output.

Note: An FO document (which is a particular type of XML document) can be transformed to


PDF by clicking the XSL:FO transformation command. When the source document is
an FO document, the second step of the two-step process for this command is
executed directly.

XQuery executions
An XQuery document can be executed on the active XML document by clicking the command
XSL/XQuery | XQuery Execution. You are prompted for the XQuery file, and the result
document is displayed in a new window in the GUI.

Automating XML tasks with AltovaXML


AltovaXML is a free application which contains Altova's XML Validator, XSLT 1.0, XSLT 2.0,
and XQuery 1.0 engines. It can be used from the command line, via a COM interface, in Java
programs, and in .NET applications to validate XML documents, transform XML documents
using XSLT 1.0 and 2.0 stylesheets, and execute XQuery documents.

XSLT transformation tasks can therefore be automated with the use of AltovaXML. For
example, you can create a batch file that calls AltovaXML to transform a set of documents. See
the Altova XML documentation for details.

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Charts 195

5.8 Charts
When an XML document is open in Text View or Grid View, a chart (pie chart, bar chart, etc)
representing selected data in the XML document can be generated in the Charts Window
(which is one of the Output Windows). The chart can then be exported as an image file or as an
XSLT or XQuery fragment to the clipboard. The Charts feature is useful for quickly representing
selected numeric data in an XML document graphically.

The following chart types are available:


 Pie charts (2D, 3D)
 Bar charts, single bars (2D, 3D)
 Bar charts, grouped bars (2D, 3D)
 Category line graphs
 Value line graphs
 Gauge charts (round and bar)

Overview: from creation to export


The steps to create a chart are described broadly below. For a more detailed account, see the
subsections of this section.
1. In Text View or Grid View, select the node that you wish to use as the context node for
the data selection. You can also select a range of nodes. The implications of the
various selection methods are explained in the section Source XPath.
2. Right-click and, from the context menu that appears, select the command New Chart.
Alternatively, in the Charts output window, click the New Chart button. This pops up the
Select Columns dialog (screenshot below), in which the X-Axis and Y-Axis data will be
selected and in which the Source XPath can be modified.

3. On clicking OK, the chart is created in the Charts Window (see screenshot below).

© 2010 Altova GmbH User Manual


196 XML Charts

4. The chart's data selection and other settings can subsequently be edited. Not only can
its Source XPath and column selection be edited, but also its type and appearance. The
data selection for the chart's axes can be edited by clicking the Select Data button. And
the chart's type and appearance can be modified by clicking the Change Type button
and Change Appearance button, respectively.
5. The chart can be exported as an image file or as an XSLT or XQuery fragment to the
clipboard.

Other features
The following features help to make usage easier:
 Multiple tabs: If you wish to create a new chart without deleting the current chart, then
create the new chart in any one of the other tabs marked one to nine (see screenshot
above). Note that, even when an XML document is closed, charts generated from that
document will stay open in their respective tabs in the Charts Window.
 Auto Reloading: If the Auto button (see screenshot above) is toggled on, then the
chart will be automatically reloaded every time data in the XML document is modified.
Otherwise, the chart will have to be manually updated by clicking the Reload button.

5.8.1 Creating a Chart


The Create Chart button pops up the Select Columns dialog (screenshot below), in which three
fundamental data selection parameters for the chart are specified. These parameters (listed
below) are used to build up the chart data table.
 Source XPath: This XPath expression is automatically entered when the dialog opens.
It selects the node in the XML document that was selected when the Select Columns
dialog was accessed. It can be edited in the dialog using the keyboard. Descendant
nodes of the node/s selected by the Source XPath will be available for selection as X-
Axis and Y-Axis data columns. The Column Search Depth combo box determines how
many descendant levels will be searched to return nodes that may be used for X-Axis
and Y-Axis data selection. After the Source XPath has been edited, Update Columns

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Charts 197

must be clicked for the change to take effect and for the X-Axis and Y-Axis lists in the
dialog to be refreshed.
 X-Axis: The selection in this combo box specifies which node will be used as the X-
Axis. The sequence returned for this selection will give the labels that occur on the X-
Axis. The Auto-Enumerated option of the combo box provides numbered labels for the
X-Axis. Note that XPath expressions created for the Y-Axis are also available for
selection.
 Y-Axis: The entries that are checked in this pane will be the nodes, the numeric values
of which will be represented on the numeric Y-Axis. The Clear All and Mark All buttons
deselect all items and select all items in the Y-Axis pane, respectively. The Insert
XPath button enables a series to be generated that is not available because it is not a
descendant of the node the Source XPath returns. The node or XPath expression
selected for the X-Axis is not available for Y-Axis selection and is grayed out.

How the chart data table is created


Since the XML document (see screenshot further below) contains three Region elements, the
Source XPath /Data/Region selects each of them in turn. With each Region element as the
context node, the columns of data are then generated. For each Region element selected
because of the Source XPath the following is done:
1. The X-Axis expression generates the first column (by default the column used for the
labels of the X-Axis).
2. For each series (Y-Axis selections) a column is generated.

The chart data generated for the Select Columns dialog shown above can be visualized as in
the following table.

© 2010 Altova GmbH User Manual


198 XML Charts

Source XPath X-Axis Y-Axis (Series columns)


Region[1] @id Year[1] Year[2] Year[3] Year[4] Year[5] Year[6]
Region[2] @id Year[1] Year[2] Year[3] Year[4] Year[5] Year[6]
Region[3] @id Year[1] Year[2] Year[3] Year[4] Year[5] Year[6]

The chart generated from this data would look something like this:

The following important points should be noted:


 The number of ticks on the X-Axis is determined by the size of the sequence returned
by the Source XPath expression (in this case three).
 The nodes returned by the Source XPath will be the context nodes, respectively, for
generating data for each tick on the X-Axis. This data will be the X-Axis tick label (the
X-Axis selection) and all the series to be plotted for that tick (Y-Axis selection). The
XPath expressions entered for the X-Axis and Y-Axis will be evaluated as XPath
expressions in the context of these (Source XPath) nodes.
 The X-Axis selections will be, respectively, the label for each tick. If there are fewer
labels than there are ticks, then some ticks will remain unlabelled.
 Each series (for example Year[1]) is evaluated once for each context node. For some
charts, like pie charts or single-bar charts, only one series is used.
 The legends are obtained from the names of series items.

The XML document used for the example above is given here for reference..

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Charts 199

The data selection shown in the Select Columns dialog above can be seen in the table of the
Select Data dialog (screenshot below). The Select Data dialog is accessed by clicking the
Select Data button in the Charts output window.

For more details about the individual parameters of the Select Columns dialog, see the

© 2010 Altova GmbH User Manual


200 XML Charts

individual sections: Source XPath, X-Axis Selection, Y-Axis Selection, and Chart Data.

5.8.2 Source XPath


The Source XPath is specified in the Select Columns dialog. It determines what nodes in the
document are available for selection as X-Axis and Y-Axis data. The Column Search Depth
combo box determines how many descendant levels will be searched to return nodes that may
be used for the X-Axis and Y-Axis data.

After a new Source XPath has been selected, clicking Update Columns refreshes the available
selections (in the dialog) for the X-Axis and Y-Axis. If you modify the Source XPath expression
be sure to click Update Columns.

Source XPath from cursor location


To explain what Source XPath is selected when the Select Columns dialog is opened, we'll use
the XML document shown below.

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Charts 201

The following cases are possible:


 If the cursor is placed anywhere inside the start tag (including in an attribute-value) or
end tag of the Data element, or anywhere inside the Data element but not within a
descendant node, the Source XPath will be: /Data
 If the cursor is placed anywhere inside the start tag (including in an attribute-value) or
end tag of any Region element, or anywhere inside a Region element but not within a
descendant node, the Source XPath will be: /Data/Region
 If the cursor is placed anywhere inside the start tag (including in an attribute-value) or
end tag of a Year element, or anywhere inside a Year element, the Source XPath will
be: /Data/Region[N]/Year. The predicate filter [N] selects the particular Region
element inside which the selected Year element is. So the X-Axis and Y-Axis data
selections will be restricted to Year elements of this particular Region element.
 If you wish to select just one Region element, say: /Data/Region[1], then highlight
this element, that is, the first Region element as shown in the screenshot below.

© 2010 Altova GmbH User Manual


202 XML Charts

 Similarly, highlighting two Region elements will generate an XPath expression that
selects these two Region elements only.

The Source XPath expression can be edited subsequently in the Select Columns dialog.

In Grid View, selection is done by clicking a node or marking a range. The Source XPath that is
generated from the Grid View selection is as described above for Text View.

Implications of Source XPath selections


Note the following implications of the Source XPath selection.
 The number of items in the sequence returned by the Source XPath determines the
number of ticks on the X-Axis. The number of ticks on the X-Axis can be changed in
only one other way besides by modifying the Source XPath: by selecting a number of
labels for any series, which number is more than the number of ticks. See X-Axis
Selection for more information about this scenario.
 The Source XPath node is the ancestor node for all nodes available for X-Axis and Y-
Axis data selection and for all XPath expressions you may enter.
 As a result of the above two points, note that any change to the Source XPath
expression affects not only the number of ticks on the X-Axis but also the context for
any XPath expression related to the chart.

For example, here are the implications of some XPath expressions with respect to the XML
document shown above.
 /Data/Region: Returns the three Region elements, so three ticks on the X-Axis. Each
Region element will in turn be the context node for XPath expressions.
 /Data/Region/Year: Returns 18 Year elements, so 18 ticks on the X-Axis. Each Year
element will in turn be the context node for XPath expressions.
 /Data/Region[1]/Year: Returns the six Year element children of the first Region
element, so six ticks on the X-Axis. Each Year element of the first Region element will
in turn be the context node for XPath expressions.
 distinct-values(//Year/@id): Returns six items (the distinct values of the Year/
@id attribute: 2005, 2006, 2007, 2008, 2009, 2010). However, since this XPath
expression returns no node item, it cannot be a context node for any XPath expression.
If the items in this sequence are to be used to target nodes in the XML document
(using, say, the current() function (shorthand: .)), then the XPath expression using
the current item must start from the document root in order for the context to be
established. For example: /Data/Region[1]/Year[@id eq .].

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Charts 203

5.8.3 X-Axis Selection


The X-Axis selection is specified in the Select Columns dialog (screenshot below). This
selection determines the labels that appear on the X-Axis.

Consider the following XML document example. The cursor is placed in the start tag of the first
Region element and the New Chart button of the Charts output window is clicked. The Select
Columns dialog appears, with the Source XPath: /Data/Region (see screenshot above).

© 2010 Altova GmbH User Manual


204 XML Charts

As explained in the Source XPath section, this Source XPath sets up a chart with three ticks on
the X-Axis (because the Source XPath returns three items: the three Region elements). Since
we want the labels of these three ticks in the chart to be the names of the three regions, we
select the @id attribute in the combo box of the the X-Axis selection (see screenshot of Select
Columns dialog above).

To produce the chart data for each tick, each Region element is evaluated in turn. For each
Region element, the id attribute generates the correct label for the X-Axis tick. The X-Axis
would look something like in the screenshot below.

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Charts 205

If another XPath expression is selected in the X-Axis combo box, then that expression is
evaluated within the respective Region element context and the evaluated result will be the
label of the respective tick. The Auto-Enumerated option generates a number sequence that
corresponds to the tick number: the first tick will be numbered 1, the second 2, and so on.

Modifying the X-Axis labels and the number of X-Axis ticks


The selection of labels for the X-Axis can be modified in the Select Data dialog (accessed by
clicking the Select Data button of the Charts output window).

In the Select Data dialog shown in the screenshot below, for example, click in the X-Axis text
box of the Axis Values pane. This enables the X-Axis selection to be modified. Now click the B1
field and drag the mouse to F1 to make the B1:F1 selection. Click OK to see the new chart.

© 2010 Altova GmbH User Manual


206 XML Charts

This selection will now provide the labels for the ticks, as shown in the screenshot below. Notice
also that since the new selection contains five items, five ticks have been generated. However,
only the first three are populated. This is because the Source XPath returns three nodes and
these are the nodes that will be processed for the charts. These three nodes correspond to the
rows of the table shown in the Select Data dialog. Note that the number of rows in the table can
only be modified by changing the Source XPath.

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Charts 207

For more information about how the Source XPath and X-Axis selections interact, see How
Chart Data Is Created.

5.8.4 Y-Axis Selection


The Y-Axis (see screenshot below) is also known as the Series Axis.

The selection you make for this axis determines how many series are plotted for each X-Axis
tick. If only one series is selected, then at each X-Axis tick, the value returned by the XPath
expression for that series is plotted. If more series are selected, as in the screenshot below, in
which six series are selected, then the chart data selection will be as in the table below. (The
context node for the Y-Axis data selection is the respective Region element.)

Source XPath X-Axis Y-Axis (Series columns)


Region[1] @id Year[1] Year[2] Year[3] Year[4] Year[5] Year[6]
Region[2] @id Year[1] Year[2] Year[3] Year[4] Year[5] Year[6]
Region[3] @id Year[1] Year[2] Year[3] Year[4] Year[5] Year[6]

The resulting chart will look something like this:

© 2010 Altova GmbH User Manual


208 XML Charts

There are three X-Axis ticks, labeled with the value of the respective Region/@id attributes. At
each X-Axis tick, the XPath expression for each series is evaluated. In our example, for each X-
Axis tick, each of the six series is evaluated and plotted. For example, the first series (Year[1])
is plotted for all three regions, so also Year[2] to Year[6].

Note: Some charts, such as pie charts and single-bar charts, take only one axis. In a single-
bar chart for example, each X-Axis tick will have just a single bar: that representing the
single series. In a pie chart, the values of the single series will sum up to 100% of the
pie, with each value being assigned to one X-Axis tick.

Y-Axis legends
The legends that appear below the chart are the names of the series. These names can be
modified in the Select Data dialog.

Switching the X-Axis and Y-Axis selections


In the example above, the regions are on the X-Axis and the yearly sales are plotted on the Y-
Axis for each region; the Year elements are the series. But what if we wished to plot the years
on the X-Axis and compare the regional sales for each year as in the bar chart below?

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Charts 209

Selecting the series


To make a node a series for the chart, check that node's check box. You can modify the Source
XPath and the Column Search Depth to make the required node available in the Series pane.
Alternatively, you can add an XPath expression to select a node, as in the screenshot below.
See Chart Example: Advanced for a description of this scenario.

© 2010 Altova GmbH User Manual


210 XML Charts

Reference
The XML document used for the example in this section is given here for reference..

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Charts 211

5.8.5 Chart Data


Clicking the Select Data button pops up the Select Data dialog (screenshot below), which
consists of three panes: (i) the Series pane, (ii) the Axis Values pane, and (iii) the chart data
table. Each of these is described below.

The Select Columns button pops up the Select Columns dialog, in which you can change the
Source XPath and modify the data selection for the X-Axis and Y-Axis.

Series pane
The series contained originally in the Series pane are those that were selected in the Select
Columns dialog. The series present in this pane when you click OK will be the series that
appear in the chart. In the Series pane you can carry out three operations:
 Add and delete series: This enables you to control the number of series appearing in
the chart.
 Edit series names: The names of series are the legends that appear in the chart.
 Select data for individual series: With a series selected in the Series pane, the X-Axis
and Y-Axis data can be specified in the Axis Values pane. How to do this is described
below.

Axis Values pane


With a series selected, the X-Axis and Y-Axis data for that series can be specified in the
respective text boxes. When you click in either text box, the value in it can be edited; this is
indicated by an asterisk to the right of the text box.

The data selection is specified as a range from the chart data table. It can be entered via the
keyboard (for example, B1:F1) or a range can be marked in the chart data table. A range can

© 2010 Altova GmbH User Manual


212 XML Charts

only be within a column or a row. To mark a range select the first cell in the range and drag the
cursor to the last cell in the range.

Chart data table


The structure of the chart data table (at the bottom of the Select Data dialog) is obtained from
the selections in the Select Columns dialog.
 The number of rows in the table is equal to the number of items in the sequence
returned by the Source XPath.
 The columns are named starting from A. The purpose of this naming is to enable
selection in the Axis Values pane (for example B1:F1).
 The first column is obtained by evaluating the X-Axis selection in the Select Columns
dialog in the context of nodes returned by the Source XPath expression.
 All other columns except the first are obtained by evaluating the Y-Axis selections in
the Select Columns dialog. Each series in the Y-Axis selection of the Select Columns
dialog corresponds to a column in the chart data table.

The chart data table can be viewed as a superset of data that is selected using the parameters
in the Select Columns dialog. From this superset, you can then select ranges of data you
require (in the Axis Values pane) for individual series.

5.8.6 Chart Type


To select the chart type in the Change Type dialog (screenshot below), select the chart type you
want and click OK. The Chart Type dialog is accessed by clicking the Change Type button.

After the chart type has been selected, chart settings (such as title, height, and width) must be
made in the Change Appearance dialog and the chart data must be specified. How data is
selected for each chart type is described in the sections, Creating a Chart and Chart Data.

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Charts 213

5.8.7 Chart Appearance


Chart settings (such as the chart's title, color scheme, and font sizes) are made in the Change
Appearance dialog (screenshot below, which shows the Settings dialog of a bar chart). This
dialog is accessed with the Change Appearance button and the settings in it are different
according to the chart type.

The various settings are organized into the following common tabs:
 General: The chart title (see screenshot below) can be edited in this tab, as well as the
chart's background color and the plot's border and background color. In the screenshot
below, the plot has been given a pale green background color. The legends are at the
bottom of the chart; they explain the color codes in the chart and can be turned on or off
in the dialog.

© 2010 Altova GmbH User Manual


214 XML Charts

 Color scheme: Four predefined color schemes are available plus a user-defined color
scheme. You can modify any of the color schemes by adding and/or deleting colors to a
scheme. The color scheme selected in the Color Scheme tab will be used in the chart.
 Sizes: Sizes of various aspects of the chart can be set, either as pixels or as a
percentage ratio.
 Font: The font properties of the chart title and of legends and labels can be specified in
this tab. Sizes can be set as a percentage of the chart size or as pixels.

Additionally, each type of chart has settings specific to its type. These are listed below:
 Pie charts: Settings for: (i) the angle from which the first slice should be drawn; (ii) the
direction in which slices should be drawn; (iii) the outline color; (iv) whether the colors
receive highlights (in 3D pie charts: whether dropshadows and transparency are used);
(v) whether labels should be drawn; and (vi) whether values and percentages should be
added to labels and how many decimal places should be added to the percentages.
 Bar charts: Settings for: (General) Drawing the X and Y axes exchanged generates a
horizontal bar chart (for 2D bar charts only); (Bar) Bar outlines and dropshadows
(dropshadows in 2D bar charts only); (X-Axis) Label and color of the x-axis, and vertical
gridlines; (Y-Axis) Label and color of the y-axis, horizontal gridlines, the range of values
to be displayed, and the tick marks on the y-axis; (Z-Axis, 3D only) Label and color of
the z-axis; (3D) the vertical tilt, horizontal rotation, and the width of the view.
 Line graphs: Settings for: (General) Drawing the X and Y axes exchanged; (Line)
including the plot points or not; (X-Axis) Label and color of the x-axis, and vertical
gridlines; (Y-Axis) Label and color of the y-axis, horizontal gridlines, the range of values
to be displayed, and the tick marks on the y-axis.
 Gauge: Settings for: (i) the angle at which the gauge starts and the angular sweep of
the scale (Round Gauge only); (ii) the range of the values displayed (Round and Bar
Gauges); (iii) the interval and color of major and minor ticks (Round and Bar Gauges);
(iv) colors of the dial, the needle, and the border.

5.8.8 Export
Clicking the Export button gives you the following options:
 Save the chart as an image to file: The image formats available are PNG, GIF, BMP,
and JPG.

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Charts 215

 Copy the currently sized image or a resized to the clipboard: Enables the chart to be
subsequently copied from the clipboard into a report in another application.
 Print chart: Sends the image to a printer on your network. The height and width of the
image can each be specified as a percentage of the page size.
 Copy XSLT or XQuery code to the clipboard: Creates an XSLT fragment or XQuery
fragment. Each is essentially the Altova extension function CreateChart. This function
can be used with other Altova extension functions and processed with XMLSpy or
AltovaXML Engine to generate charts. To help you use the CreateChart extension
function, a commented-out usage example is also created with each fragment.

5.8.9 Chart Example: Simple


Consider the following XML document.

We wish to produce a chart that plots the three regions on the X-Axis and gives the yearly sales
for each region. Our chart should look something like the bar chart below.

© 2010 Altova GmbH User Manual


216 XML Charts

This is a simple chart to create because we can select the Region element as the Source
XPath. The Source XPath expression returns a sequence of three items: the three Region
elements. Each Region element will, in turn, be the context node for the X-Axis and Y-Axis data
selections.

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Charts 217

For the series we want the Year elements of each region, so a search depth of one level will
suffice. We select the Region element's id attribute for the X-Axis. The id attribute values will
therefore be used as the labels of the three X-Axis ticks. All the Year series are checked
because we wish to include all the Year elements in the chart data table.

Clicking the OK button generates the chart we wanted. For more advanced charts, see the
section, Chart Example: Advanced.

5.8.10 Chart Example: Advanced


Consider the following XML document.

We wish to produce a chart that plots the years on the X-Axis and compare the regional sales
for each year. Our chart should look something like the bar chart below.

© 2010 Altova GmbH User Manual


218 XML Charts

We show two ways in which this can be done. These two ways together demonstrate how the
different data selection parameters can be combined to produce the required results.

Method 1: Modifying Axis Values


In the first method, the axes that were selected in the Select Columns dialog are modified in the
Select Data dialog. All that must be ensured is that all the required data is available for selection
in the chart data table in the Select Data dialog.

1. In the Select Columns dialog, makes sure that all the required nodes will be available
for X-Axis and Y-Axis selection. In the screenshot below, notice that the Column Search
Depth has been set to 2 so that the Year/@id attributes are also selected.

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Charts 219

2. In the Select Data dialog (screenshot below), the chart data table has the following
columns: the first column is the X-Axis selection (which is the Auto-Enumerated
selection), the remaining columns are the series (Y-Axis) columns, which are the
Region/@id attributes, the Year element contents, and the Year/@id attributes. Notice
also that: (i) there are only three rows, so three X-Axis ticks; (but we need six X-Axis
ticks for the six years); (ii) there are 13 series columns.

© 2010 Altova GmbH User Manual


220 XML Charts

3. In the Series pane, we delete any 10 of the 13 series rows and rename the remaining
three series to Americas, Europe, and Asia, as shown in the screenshot above. The
order selected here will be the order of the X-Axis tick labeling.
4. In the Series pane, select the Americas series. In the Axis Values pane, click in the X-
Axis box to enable modification. Then click the cell I1 in the chart data table and drag
to the cell N1. In the Y-Axis text box either enter C1:H1 or make the selection by
dragging from C1 to H1.
5. For the Europe and Asia series, select C2:H2 and C3:H3, respectively for the Y-Axis.
The X-Axis selection can be the same as that for the Americas series.
6. Click OK. The required chart is generated.

Note: The number of X-Axis ticks (defined by default by the number of rows in the chart data
table) is increased from three to six because the number of X-Axis labels is six.

Method 2: Generating series with XPath expressions


In the second method, XPath expressions are inserted to generate series. This is necessary
because the Source XPath (see screenshot below) does not have as its descendants the nodes
wanted for the series. However, the Source XPath does generate six X-Axis ticks (by selecting
the Year elements of the first Region element).

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Charts 221

In the Select Columns dialog, the Region[1]/Year element has only two descendants: @id and
text(). The @id attribute is selected for the X-Axis, thereby generating the correct X-Axis label
for each of the six X-Axis ticks. The chart data table would be evaluated as follows.

Source XPath X-Axis Y-Axis (Series columns)


Region[1]/Year[1] @id text() XPath-1 XPath-2
Region[1]/Year[2] @id text() XPath-1 XPath-2
Region[1]/Year[3] @id text() XPath-1 XPath-2
Region[1]/Year[4] @id text() XPath-1 XPath-2
Region[1]/Year[5] @id text() XPath-1 XPath-2
Region[1]/Year[6] @id text() XPath-1 XPath-2

Note that the context node is each of the six Region[1]/Year elements in turn. The first XPath
expression looks for the current Year/@id attribute value and returns the Region[2]/Year
element that has the same Year/@id value as the @id value of the current Region[1]/Year.
The second XPath expression does the same for the Region[3]/Year elements. In this way,
for each of the six years: the three Y-Axis series are the Year element children, respectively, of
each of the three Region elements. (The text() node returns the contents of the Region[1]/
Year elements.)

The chart data table in the Select Data dialog would look something like this.

© 2010 Altova GmbH User Manual


222 XML Charts

The names of the series in the Select Data dialog can be changed from XPath expressions (as
in the screenshot above) into meaningful legends (screenshot below). For each series the
correct data column can be assigned in the Axis Values pane (by clicking in the Y-Axis text box
and then selecting the required column in the chart data table).

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Charts 223

Both the methods shown above generate identical charts. The different approaches are
intended to show how the data selection parameters are to be used.

© 2010 Altova GmbH User Manual


224 XML Additional Features

5.9 Additional Features


Additional features for working with XML files are listed below.
 Encoding
 Generating DTDs and XML Schemas
 Find and Replace
 Evaluating XPath
 Importing and exporting text

Encoding
The encoding of XML files (and other types of documents) can be set via the menu command
File | Encoding. The default encoding of XML and non-XML files can be specified in the
Options | Encoding tab.

Generating DTDs and XML Schemas


If you wish to create a schema that describes the structure of an XML document, use the DTD/
Schema | Generate DTD/Schema menu command. In the Generate DTD/Schema dialog that
appears, you can select whether to generate a DTD or an XML Schema as well as certain XML
Schema options, such as whether to generate enumerations from the values contained in the
XML document.

Find and Replace


The Find and Replace features (accessed via the Edit menu) has powerful search capabilities.
The search term can be defined additionally in terms of casing and whether whole words should
be matched, and it can also be expressed as a regular expression. The search range can be
restricted to a selection in the document and to particular node types (see screenshot below).

The screenshot above shows the Find & Replace dialog in Text View. The dialog and
functionality varies according to the view that is active.

Altova XMLSpy 2011 © 2010 Altova GmbH


XML Additional Features 225

Evaluate XPath
An XPath expression, which you enter in the XPath Window, can be evaluated against the
active XML document. The results of the evaluation are displayed in the XPath Window, and
clicking a node in the result highlights that node in the document display in the Main Window.
Note that the XPath Window can be made active by clicking XML | Evaluate XPath command.

Importing and exporting text


Text data can be imported from, and exported to, other application formats. Commands for
these features are in the Convert menu.

© 2010 Altova GmbH User Manual


226 DTDs and XML Schemas

6 DTDs and XML Schemas


Altova website: XML Schema Editor

This section provides an overview of how to work with DTDs and XML Schemas. It also
describes SchemaAgent and the powerful Find in Schemas feature. In addition to the editing
features, XMLSpy provides the following powerful DTD/Schema features:

Catalog mechanism
Support for the OASIS catalog mechanism enables the re-direction of URIs to local addresses,
thus facilitating use across multiple workstations.

Schema rules
An XML Schema can be assigned a set of additional constraints defined by the user. XMLSpy
contains a Schema Rule Editor in which a Schema Rule Set for an XML Schema can be
created and edited.

Schema subsets
Components of a large schema can, in Schema View, be created as a separate file. These
smaller schema subsets can then be included in the larger schema. The reverse operation,
known as flattening a schema, puts the components of included files directly in the larger
schema. How to generate schema subsets and flatten schemas is described in the section,
Schema Subsets.

Converting DTDs to XMLSchemas and vice versa


A DTD can be converted to an XML Schema and vice versa via the DTD/Schema | Convert
DTD/Schema menu command. See the description of this file command in the User Reference
section for a description of how to use it.

Generate Sample XML file


You can generate, via the DTD/Schema | Generate Sample XML File menu command, a
skeleton XML document based on the active DTD or XML Schema file. This is very useful for
quickly creating an XML file based on a schema.

Go to definition
When the cursor is located within a node in an XML document, clicking the DTD/Schema | Go
to Deinition menu command opens the schema file and highlights the definition of the selected
XML node.

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas DTDs 227

6.1 DTDs
A DTD document can be edited in Text View and Grid View. The default view can be set in the
File Types tab of the Options dialog.

Text View
In Text View, the document is displayed with syntax coloring and must be typed in. Given below
is a sample of a DTD fragment:

<!-- Element declarations -->


<!ELEMENT document (header, para, img, link)>
<!ELEMENT header (#PCDATA)>
<!ELEMENT img EMPTY>
<!ATTLIST img
src CDATA #REQUIRED
>

<!-- Notation Declarations -->


<!NOTATION GIF PUBLIC "urn:mime:img/gif">

Indentation is indicated by indentation guides and is best obtained by using the tab key. The
amount of tab indentation can be set in the Text View Settings dialog.

Grid View
In Grid View, the DTD document is displayed as a table. The screenshot below shows the Grid
View display of the DTD listed above.

When the cursor is inside a row of the table, or if a row is selected, DTD editing commands in
the XML menu become enabled. You can insert, append, and add child nodes to the graphical
representation of the DTD. The DTD items available at a particular selection point are enabled
in the respective sub-menu of the XML menu (Insert, Append, Add Child). You can also
convert a selected DTD item to another item, and move the item left or right in order to change
its position in the document hierarchy. When a node is selected, available DTD items are also
displayed as items in the entry helpers.

DTD features in XMLSpy


XMLSpy offers the following very useful features:
 Convert DTD to XML Schema: With the DTD/Schema | Convert DTD/Schema
command, DTDs can be converted to XML Schemas.

© 2010 Altova GmbH User Manual


228 DTDs and XML Schemas DTDs

 Generate sample XML file from DTD: With the DTD/Schema | Generate Sample XML
File command, an XML document can be generated that is based on the active DTD.

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas XML Schemas 229

6.2 XML Schemas


XML Schema documents can be edited in Text View, Grid View, and Schema View. The default
view in which XML Schema documents open can be set in the File Types tab of the Options
dialog. You can switch between views while you edit, using the view that is most useful for the
current purpose. XML Schema documents are typically saved with the extension .xsd or .xs.

Editing in Text View


In Text View an XML Schema is edited as an XML document; the editing features available for
XML documents are also available for XML Schemas. As with all XML documents where the
schema is identified and accessible, Text View entry helpers display the items available for
addition at the cursor location point.

Editing in Grid View


In Grid View an XML Schema is edited as an XML document; the editing features available for
XML documents are also available for XML Schemas. When an item in Grid View is selected,
Grid View entry helpers display the items available for addition at the cursor location point.

Editing in Schema View


Schema View is a graphical interface for designing schemas. While you create/edit the schema
in Schema View, XMLSpy generates a corresponding text document behind the interface. How
to create and edit XML Schema documents in Schema View is described in detail in the section
Editing Views | Schema View.

XML Schema features in XMLSpy


Additionally, XMLSpy offers the following very useful features:
 Convert XML Schema to DTD: With the DTD/Schema | Convert DTD/Schema
command, XML Schemas can be converted to DTDs.
 Generate sample XML file from XML Schema: With the DTD/Schema | Generate
Sample XML File command, an XML document can be generated that is based on the
active XML Schema. Sample values can also be specified for elements and attributes in
the sample XML.

© 2010 Altova GmbH User Manual


230 DTDs and XML Schemas Schema Subsets

6.3 Schema Subsets


One or more components of an XML Schema can be created as a separate schema file, known
as a schema subset. The advantage of using smaller schema subsets to compose the larger
schema (by means of Includes) is that the smaller files are more manageable than the single
full schema.

In Schema View, one possible work scenario that describes various aspects of the Schema
Subsets feature is as follows:
1. Create a schema subset that contains one or more components of the active schema.
How to do this is described below,
2. Create additional schema subsets as required.
3. Include the newly created schema subset/s to compose the larger schema. Do this for
each schema subset by appending or inserting an Include component in the Schema
Overview window, and selecting the newly created schema subset file.
4. Delete any components that were present in the original full schema but are now
duplicated because of the included subset/s.

You can also do the reverse in Schema View, that is, flatten the included schema subsets so
that: (i) the components contained in the schema subsets are added directly to the main
schema, and (ii) the included schema subsets are deleted from the main schema. How to
flatten a schema is described further below.

Creating schema subsets


To create a schema subset, do the following:

1. With the required XML Schema active in Schema View, select the command Schema
Design | Create Schema Subset. This pops up the Select Schema Components
dialog (screenshot below).
2. In the dialog, check the component or components you wish to create as a single
schema subset, then click Next. (Note that a check box below the pane enables
components from all referenced files to also be listed for selection.)

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Schema Subsets 231

3. In the Schema Subset Generation dialog that now appears (screenshot below), enter
the name/s you want the file/s of the schema subset package to have. You must also
specify the folder in which the new schema subset files are to be saved. A schema
subset package could have multiple files if one or more of the components being
created is an imported component in the original schema. A separate schema file is
created for each namespace in the schema subset. The filenames displayed in the
dialog are, by default, the names of the original files. But since you are not allowed to
overwrite the original files, use new filenames if you wish to save the files in the same
folder as the original files.

© 2010 Altova GmbH User Manual


232 DTDs and XML Schemas Schema Subsets

4. On clicking OK, the schema subset file with the namespace corresponding to that of
the active file is opened in Schema View. Any other files in the package are created but
not opened in Schema View.

Flattening a schema
Flattening the active schema in Schema View is the process of: (i) adding the components of all
included schemas as global components of the active schema, and (ii) deleting the included
schemas.

To flatten the active schema, select the command Schema Design | Flatten Schema. This
pops up the Flatten Schema dialog (screenshot below), which contains the names of separate
files, one for each namespace that will be in the flattened schema. These default names are the
same as the original filenames. But since you are not allowed to overwrite the original files, the
filenames must be changed if you wish to save in the same folder as the active file. You can
browse for a folder in which the flattened schema and its associated files will be saved.

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Schema Subsets 233

On clicking OK, the flattened schema file will be opened in Schema View.

© 2010 Altova GmbH User Manual


234 DTDs and XML Schemas Schema Rules

6.4 Schema Rules


A Schema Rule Set is a set of rules one can use to validate an XML Schema. For example, a
rule can specify that attribute names, as defined in the XML Schema, begin with a lowercase
alphabet, or that a given complex type can only be extended from a specific type.

A set of schema rules is saved in a Rule Set file, which is an XML (.xml) file. XMLSpy contains
a Schema Rules Editor in which you can edit schema rules graphically. In XMLSpy, one or more
Rule Set files can then be assigned to an XML Schema. The XML Schema is validated in
Schema View against the assigned Rule Sets by selecting the XML | Validate (F8) command.

6.4.1 Managing Rule Sets


One or more Schema Rule Set files (.xml files) can be assigned to the active XML Schema (.
xsd file). This is done via the Schema tab of the Info Window (screenshot below).

Adding Rule Sets for extended validation


To add a Schema Rule Set file, click the context menu button. This pops up a menu (see
screenshot above) in which you can select how you wish to add Schema Rule Set files to the
XML Schema. The following options are available:
 Add Predefined Rule Set: You can select from a list of predefined Schema Rule Sets
that have been supplied with XMLSpy. These Rule Set files are saved in the Extended
Schema Validation folder in the XMLSpy application folder. Any Rule Set file added to
this folder will be displayed in the Predefined Rule Set dialog and will be available for
addition.
 Browse for Existing Rule Set: You can browse for a non-predefined Schema Rule Set
file.
 Create a New Rule Set: Pops up the Schema Rule Editor, in which you can edit the
Schema Rules in a Schema Rule Set file. How to work with the Schema Rules Editor is
described in the section, Defining a Rule Set. After you save a Schema Rule Set file
created via this command, it is added to the listing for the active XML Schema (see
screenshot below).

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Schema Rules 235

Any number of Schema Rule Sets can be added (see screenshot above). When more than one
Schema Rule Set is assigned to an XML Schema, the rules in all the added Schema Rule Sets
are used when the XML Schema is validated in Schema View (XML | Validate).

Enabling and disabling extended schema validation


Extended schema validation can be enabled or disabled by clicking the Enable Extended
Schema Validation check box.

Editing and removing Rule Sets


Individual Rule Sets assigned to an XML Schema can be managed via the context menu that
appears on clicking the context menu button (screenshot below).

The following options are available:


 Apply Rule Set to imported and included schemas: If a Rule Set is applied, rules in it will
be used for all schemas that the main schema imports or includes.
 Edit Rule: Opens the Schema Rule Set in the Schema Rules Editor.
 Remove Rule Set: Removes the Rule Set from the list of added Rule Sets.
 Remove Rule Set and delete from disk: This command is enabled for all non-predefined
Rule Sets. In addition to removing the Rule Set from the list of added Rule Sets, this
command also deletes the Rule Set.

© 2010 Altova GmbH User Manual


236 DTDs and XML Schemas Schema Rules

6.4.2 Defining a Rule Set


A Schema Rule Set can be opened for editing in the Schema Rules Editor (screenshot below).
You can then create, edit, and delete schema rules in that Schema Rule Set file. To open a
Rule Set in the Schema Rules Editor, do the following:
1. Select the Rule Set in the list of Rule Sets in the Info window.
2. Clicking the context menu button of that Rule Set.
3. In the context menu that appears, select Edit Rule.

The Schema Rules Editor dialog has two panes:


 A Rules pane (in the top part of the Editor), in which you can add and delete rules. An
empty line for a rule can be appended or inserted by clicking on the respective button (
Append or Insert) in the top left of the pane. A rule can be deleted by selecting it and
clicking the Delete button in the top right of the pane. Each rule in this pane has a
name, a descriptive message text, and a severity level (if the rule is contradicted,
validation can be set to return an error or a warning).
 A Rule pane (in the bottom part of the Editor). This pane displays the details of the rule
that has been selected in the Rules pane above it, and enables the details of the rule to
be edited. For details about defining rules, see the section, Defining a Rule, below.

After the rules in a Rule Set file have been edited, click Save to save the rules to the Rule Set
File.

Defining a rule
To define or edit a rule, select the rule from the listing in the upper Rules pane. The definition of
the rule will be displayed in the Rule pane and can be edited. The screenshot below displays a

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Schema Rules 237

rule which can be defined as follows: If a complex type is an extension of a simple type, then it
must have a child kind AttributeGroup.

The Validate condition set and Filter condition set:


 Each rule has one set of Validate conditions and one set of Filter conditions (see first
column in screenshot above).
 The set of Filter conditions must eventually evaluate to true in order for the Validate
condition to be evaluated.
 Each set of conditions (Validate or Filter) consists of one or more Condition Groups,
with each Condition Group containing one or more conditions. In the screenshot above,
the Validate set contains one Condition Group of one condition, and the Filter set
contains three Condition Groups, each having one condition. In the screenshot below,
the Filter set contains three Condition Groups: The first contains contains two
conditions, the second contains three conditions, and the third contains one condition.

 Each individual condition can be negated by checking its Not check box (located to the
left of the condition).
 Within a Condition Group, the logical connectors and or or indicate, respectively,
whether all conditions in the group or one condition in the Condition Group must
evaluate to true in order for the entire Condition Group to evaluate to true. In the GUI,
these logical operators are the inner of the two columns of logical operators.
 Each Condition Group can be negated by checking its Not check box (located to the left
of the Condition Group's logical operator).
 The outer logical connector and or or indicates, respectively, whether all the Condition
Groups in the set (Validate or Filter) or one Condition Group must evaluate to true in
order for the entire set (Validate or Filter) to evaluate to true.
 Logical connectors can be changed by selecting the appropriate option in the combo
box for the outer logical connector (the Condition Group connector). The value of the
inner logical connectors (the connectors for conditions within a Condition Group) are all
switched to the opposite value as that of the outer logical connector.
 A Condition Group or Condition can be appended or inserted relative to the selected
condition. Do this by selecting a condition, then clicking the Append or Insert button (at

© 2010 Altova GmbH User Manual


238 DTDs and XML Schemas Schema Rules

the top left of the pane) and then selecting the required item (Condition Group or
Condition) from the menu (see screenshot below).

Kinds of condition
A condition can belong to one of three groups (also see screenshot below):
 Component kind (in the dropdown list the kinds beginning with Component; see
screenshot below)
 Property kind (Property Value)
 A combination of component and property kinds (kinds with Property and Component in
their names)

The kind of a condition is selected from the dropdown list in the Condition column of the
condition (screenshot above). Each of the three groups of conditions is described below.

Conditions of Component kind


For conditions of the Component kind (kinds beginning with Component), the component must
be specified subsequently in the Component column (see screenshot below). The component is
selected from the dropdown list in the Component field of a sub-condition. Since no other field
(Property, Comparator Value) is to be defined for conditions of the Component kind, all other
fields are grayed out.

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Schema Rules 239

In the screenshot above, the Filter condition specifies that the rule concerns components of
kind Element. If the Validate condition then specifies that the component must have a child of
kind Notation, then the complete rule can be stated as: An Element component must have a
child of kind Notation. If the Validate condition had its NOT option checked, then the rule would
be stated as: An Element component must not have a child of kind Notation.

Conditions of Property kind


The condition of the Property kind is Property Value (see screenshot below). This kind of
condition specifies the nature of a property. It therefore requires entries in the Property and
Comparator columns, and, optionally, an entry in the Value column. No entry is required in the
Component column, which is therefore grayed out. Properties listed in the dropdown lists of the
Property column include not only XML attributes (such as default and maxOccurs) but also the
logical properties of components (such as derivedBy).

The screenshot above shows a rule in which the Model property has a value equal to All and is
negated (via the Not check box). Taken in conjunction with the filter on the Model Group
component, this rule simply states that a schema must not contain any xsd:all element.

Note: The following points should be noted:


 When using the IsQNameEqualTo comparator, the corresponding value must be
written in the form: {URI}localName. For example, a value could be: {http://www.
w3.org/2001/XMLSchema}NOTATION.
 The default property can be present and empty (<element name default=""/>) or
it can be absent (<element name/>).

Conditions that combine Component and Property kinds


Conditions that are a combination of Component and Property kinds are:
 ComponentHasChildOfKindWithPropertyValue: Specifies the component kind of a
child element and the property's value.
 PropertyResolvesToComponentOfKind: A property is specified that resolves to a
component kind. The Comparator and Value columns are empty.

© 2010 Altova GmbH User Manual


240 DTDs and XML Schemas Schema Rules

Negating a condition
A condition is negated by checking the Not check box to its immediate left (the inner Not check
boxes). A Condition Group is negated by checking the Not check box to the left of the logical
connector for conditions in that Condition Group..

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Catalogs in XMLSpy 241

6.5 Catalogs in XMLSpy


XMLSpy supports a subset of the OASIS XML catalogs mechanism. The catalog mechanism
enables XMLSpy to retrieve commonly used schemas (as well as stylesheets and other files)
from local user folders. This increases the overall processing speed, enables users to work
offline (that is, not connected to a network), and improves the portability of documents (because
URIs would then need to be changed only in the catalog files.)

The catalog mechanism in XMLSpy works as outlined below.

RootCatalog.xml
When XMLSpy starts, it loads a file called RootCatalog.xml (structure shown in listing below),
which contains a list of catalog files that will be looked up. You can modify this file and enter as
many catalog files to look up as you like, each in a nextCatalog element. Each of these catalog
files is looked up and the URIs in them are resolved according to the mappings specified in
them.

<?xml version="1.0" encoding="UTF-8"?>


<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"
xmlns:spy="http://www.altova.com/catalog_ext"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:entity:xmlns:xml:catalog
Catalog.xsd">
<nextCatalog catalog="%PersonalFolder%/Altova/%AppAndVersionName%/
CustomCatalog.xml"/>
<nextCatalog catalog="CoreCatalog.xml"/>
<!-- Include all catalogs under common schemas folder on the first directory
level -->
<nextCatalog spy:recurseFrom="%AltovaCommonFolder%/Schemas" catalog="
catalog.xml" spy:depth="1"/>
<!-- Include all catalogs under common XBRL folder on the first directory
level -->
<nextCatalog spy:recurseFrom="%AltovaCommonFolder%/XBRL" catalog="
catalog.xml" spy:depth="1"/>
</catalog>

In the listing above, notice that in the Schemas and XBRL folders of the folder identified by the
variable %AltovaCommonFolder% are catalog files named catalog.xml. (The value of the
%AltovaCommonFolder% variable is given in the table below.)

The catalog files in the Altova Common Folder map the pre-defined public and system
identifiers of commonly used schemas (such as SVG and WSDL) and XBRL taxonomies to
URIs that point to locally saved copies of the respective schemas. These schemas are installed
in the Altova Common Folder when XMLSpy is installed.You should take care not to duplicate
mappings in these files, as this could lead to errors.

CoreCatalog.xml, CustomCatalog.xml, and Catalog.xml


In the RootCatalog.xml listing above, notice that CoreCatalog.xml and CustomCatalog.xml
are listed for lookup:
 CoreCatalog.xml contains certain Altova-specific mappings for locating schemas in
the Altova Common Folder.
 CustomCatalog.xml is a skeleton file in which you can create your own mappings. You
can add mappings to CustomCatalog.xml for any schema you require but that is not
addressed by the catalog files in the Altova Common Folder. Do this using the
supported elements of the OASIS catalog mechanism (see below).
 There are a number of Catalog.xml files in the Altova Common Folder. Each is inside

© 2010 Altova GmbH User Manual


242 DTDs and XML Schemas Catalogs in XMLSpy

the folder of a specific schema or XBRL taxonomy in the Altova Common Folder, and
each maps public and/or system identifiers to URIs that point to locally saved copies of
the respective schemas.

Location of catalog files and schemas


The files RootCatalog.xml and CoreCatalog.xml are installed in the XMLSpy application
folder. The file CustomCatalog.xml is located in your MyDocuments\Altova\XMLSpy folder.
The catalog.xml files are each in a specific schema folder, these schema folders being inside
the folders: %AltovaCommonFolder%\Schemas and %AltovaCommonFolder%\XBRL.

Shell environment variables and Altova variables


Shell environment variables can be used in the nextCatalog element to specify the path to
various system locations (see RootCatalog.xml listing above). The following shell environment
variables are supported:

%AltovaCommonF
older% C:\Program Files\Altova\Common2011
%DesktopFolder
% Full path to the Desktop folder for the current user.
%ProgramMenuFo
lder% Full path to the Program Menu folder for the current user.
%StartMenuFold
er% Full path to Start Menu folder for the current user.
%StartUpFolder
% Full path to Start Up folder for the current user.
%TemplateFolde
r% Full path to the Template folder for the current user.
%AdminToolsFol Full path to the file system directory that stores administrative tools for the
der% current user.
%AppDataFolder
% Full path to the Application Data folder for the current user.
%CommonAppData
Folder% Full path to the file directory containing application data for all users.
%FavoritesFold
er% Full path of the Favorites folder for the current user.
%PersonalFolde
r% Full path to the Personal folder for the current user.

%SendToFolder% Full path to the SendTo folder for the current user.

%FontsFolder% Full path to the System Fonts folder.


%ProgramFilesF
older% Full path to the Program Files folder for the current user.
%CommonFilesFo
lder% Full path to the Common Files folder for the current user.
%WindowsFolder
% Full path to the Windows folder for the current user.

%SystemFolder% Full path to the System folder for the current user.
%CommonAppData
Folder% Full path to the file directory containing application data for all users.

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Catalogs in XMLSpy 243

%LocalAppDataF Full path to the file system directory that serves as the data repository for
older% local (nonroaming) applications.
%MyPicturesFol
der% Full path to the MyPictures folder.

How catalogs work


Catalogs are commonly used to redirect a call to a DTD to a local URI. This is achieved by
mapping, in the catalog file, public or system identifiers to the required local URI. So when the
DOCTYPE declaration in an XML file is read, the public or system identifier locates the required
local resource via the catalog file mapping.

For popular schemas, the PUBLIC identifier is usually pre-defined, thus requiring only that the
URI in the catalog file point to the correct local copy. When the XML document is parsed, the
PUBLIC identifier in it is read. If this identifier is found in a catalog file, the corresponding URL in
the catalog file will be looked up and the schema will be read from this location. So, for
example, if the following SVG file is opened in XMLSpy:

<?xml version="1.0" standalone="no"?>


<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">

<svg width="20" height="20" xml:space="preserve">


<g style="fill:red; stroke:#000000">
<rect x="0" y="0" width="15" height="15"/>
<rect x="5" y="5" width="15" height="15"/>
</g>
</svg>

This document is read and the catalog is searched for the PUBLIC identifier. Let's say the
catalog file contains the following entry:

<catalog>
...
<public publicId="-//W3C//DTD SVG 1.1//EN" uri="schemas/svg/svg11.dtd"/>
...
</catalog>

In this case, there is a match for the PUBLIC identifier, so the lookup for the SVG DTD is
redirected to the URI schemas/svg/svg11.dtd (this path is relative to the catalog file), and this
local file will be used as the DTD. If there is no mapping for the Public ID in the catalog, then
the URL in the XML document will be used (in the example above:
http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd).

The catalog subset supported by XMLSpy


When creating entries in CustomCatalog.xml (or any other catalog file that is to be read by
XMLSpy), use only the following elements of the OASIS catalog specification. Each of the
elements below is listed with an explanation of their attribute values. For a more detailed
explanation, see the XML Catalogs specification. Note that each element can take the
xml:base attribute, which is used to specify the base URI of that element.

 <public publicId="PublicID of Resource" uri="URL of local file"/>


 <system systemId="SystemID of Resource" uri="URL of local file"/>
 <uri name="filename" uri="URL of file identified by filename"/>
 <rewriteURI uriStartString="StartString of URI to rewrite"
rewritePrefix="String to replace StartString"/>
 <rewriteSystem systemIdStartString="StartString of SystemID"

© 2010 Altova GmbH User Manual


244 DTDs and XML Schemas Catalogs in XMLSpy

rewritePrefix="Replacement string to locate resource locally"/>

In cases where there is no public identifier, as with most stylesheets, the system identifier can
be directly mapped to a URL via the system element. Also, a URI can be mapped to another
URI using the uri element. The rewriteURI and rewriteSystem elements enable the rewriting
of the starting part of a URI or system identifier, respectively. This allows the start of a filepath to
be replaced and consequently enables the targeting of another directory. For more information
on these elements, see the XML Catalogs specification.

File extensions and intelligent editing according to a schema


Via catalog files you can also specify that documents with a particular file extension should
have XMLSpy's intelligent editing features applied in conformance with the rules in a schema
you specify. For example, if you create a custom file extension .myhtml for (HTML) files that
are to be valid according to the HTML DTD, then you can enable intelligent editing for files with
these extensions by adding the following element of text to CustomCatalog.xml as a child of
the <catalog> element.
<spy:fileExtHelper ext="myhtml" uri="schemas/xhtml/xhtml1-transitional.dtd"/>

This would enable intelligent editing (auto-completion, entry helpers, etc) of .myhtml files in
XMLSpy according to the XHTML 1.0 Transitional DTD. Refer to the catalog.xml file in the
%AltovaCommonFolder%\Schemas\xhtml folder, which contains similar entries.

XML Schema and catalogs


XML Schema information is built into XMLSpy and the validity of XML Schema documents is
checked against this internal information. In an XML Schema document, therefore, no
references should be made to any schema for XML Schema.

The catalog.xml file in the %AltovaCommonFolder%\Schemas\schema folder contains


references to DTDs that implement older XML Schema specifications. You should not validate
your XML Schema documents against either of these schemas. The referenced files are
included solely to provide XMLSpy with entry helper info for editing purposes should you wish to
create documents according to these older recommendations.

More information
For more information on catalogs, see the XML Catalogs specification.

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Working with SchemaAgent 245

6.6 Working with SchemaAgent


XMLSpy can be set up to work with Altova's SchemaAgent technology.

SchemaAgent technology
The SchemaAgent technology enables users to build and edit relationships between multiple
schemas. It consists of:
 A SchemaAgent Server, which holds and serves information about the relationships
among schemas in one or more search path/s (folder/s on the network) that you
specify.
 A SchemaAgent client, Altova's SchemaAgent product, which uses schema
information from the SchemaAgent server to which it is connected (i) to build
relationships between these schemas; and (ii) to manage these schemas (rename,
move, delete schemas, etc).

Two types of SchemaAgent server are available:


 Altova SchemaAgent Server, which can be installed on, and accessed from, a network,
and
 Altova SchemaAgent, which is the SchemaAgent client product. It includes a lighter
server version, called LocalServer, which can only be used on the same machine on
which SchemaAgent is installed.

XMLSpy uses SchemaAgent technology to directly edit schemas in Schema View using
information about other schemas it gets from a SchemaAgent server. In this setup, XMLSpy is
connected to a SchemaAgent server, and, in interaction with SchemaAgent Client, sends
requests to SchemaAgent Server. When XMLSpy has been set up to work with SchemaAgent,
the Entry Helpers in Schema View not only list components from the schema currently active in
Schema View but also list components from other schemas in the search paths of the
SchemaAgent server to which it is connected. This provides you with direct access to these
components. You can view the content model of a component belonging to another schema in
Schema View, and reuse this component with or without modifications. You can also build
relationships between schemas, thereby enabling you to modularize and manage complex
schemas directly from within XMLSpy.

Installing SchemaAgent and SchemaAgent Server

For details about installing SchemaAgent and SchemaAgent Server and configuring search
paths on servers, see the SchemaAgent user manual.

Setting up XMLSpy as a SchemaAgent client


In order for XMLSpy to work as a SchemaAgent client, you must do the following:
 Download SchemaAgent from the Altova website. You can now use SchemaAgent's
LocalServer to serve schemas. For information about configuring search paths on
LocalServer, see the SchemaAgent user manual.
Please note: SchemaAgent requires a valid license, which must be purchased after the
free trial period runs out. Also note that Altova MissionKit product packages each
includes the SchemaAgent product and a license key for it. (The SchemaAgent Server
application, however, is not included in Altova MissionKit packages.)
 Additionally, you might want to download and install the network-based SchemaAgent
Server from the Altova website.
 Define the search path(s) for SchemaAgent server (also known as configuring
SchemaAgent Server). A detailed description of how to do this is given in the
SchemaAgent user manual. (A search path is a path to the folder containing the XML

© 2010 Altova GmbH User Manual


246 DTDs and XML Schemas Working with SchemaAgent

schemas that will be mapped for their relationships with each other.)
 Start a connection from within XMLSpy to a SchemaAgent server.

Important: All SchemaAgent and SchemaAgent-related products from Altova (including


XMLSpy) starting with Version 2005 release 3 are not compatible with previous versions of
SchemaAgent or SchemaAgent-related products.

SchemaAgent commands in XMLSpy


The SchemaAgent functionality in XMLSpy is available only in Schema View and is accessed
via menu commands in the Schema Design menu (see screenshot) and by using the Entry
Helpers in Schema View.

The menu commands provide general administrative functionality. The Entry Helpers (and
standard GUI mechanisms, such as drag-and-drop) are used to actually edit schemas.

This section describes how to use the SchemaAgent functionality available in Schema View.

6.6.1 Connecting to SchemaAgent Server


Please note: SchemaAgent Client must be installed in order for you to be able to make a
connection.

Before you connect to SchemaAgent Server, only the Connect to SchemaAgent Server
command is enabled in the Schema Design menu; other SchemaAgent commands in the
Schema Design menu are disabled (see screenshot). The other menu items become enabled
once a connection to a SchemaAgent Server has been successfully made.

Connection steps
To connect to a SchemaAgent server:

1. Click the Connect to SchemaAgent server toolbar icon (Schema Design |


Connect to SchemaAgent Server). The Connect to SchemaAgent Server dialog (
screenshot below) opens:

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Working with SchemaAgent 247

2. You can use either the local server (the SchemaAgent server that is packaged with
Altova SchemaAgent) or a network server (the Altova SchemaAgent Server product,
which is available free of charge). If you select Work Locally, the local server of
SchemaAgent will be started when you click OK and a connection to it will be
established. If you select Connect to Network Server, the selected SchemaAgent
Server must be running in order for a connection to be made.

Note on servers running with Windows XP SP2


If the SchemaAgent Server name is listed in the Connect to SchemaAgent Server
dialog but you cannot connect to it, it is possible that your server is not taking part in
the name resolution process of your network. Name resolution is blocked by the
default settings of the Windows XP SP2 Firewall.

To connect to such a server, do one of the following:


 Change the server settings to enable the name resolution process, or
 Enter the IP address of the server in the Edit field of the Connect Dialog
box.
This need be done only once as SchemaAgent Client stores the connection string of
the last successful connection.

Schema View after connecting to SchemaAgent server


After a connection to a SchemaAgent server is established, Schema View will look something
like this:

© 2010 Altova GmbH User Manual


248 DTDs and XML Schemas Working with SchemaAgent

Please note:
 At the top of the Globals view the text "Connected to SchemaAgent Server" appears,
specifying the server to which the connection has been made.
 You now have full access to all schemas and schema constructs available in the server
search path. SchemaAgent schema constructs such as global elements,
complexTypes, and simpleTypes are visible in bold blue text, below the constructs of
the active schema (bold black text).

Schema constructs can be viewed by Type (Globals), by Namespace, or by Identity


Constraints in the respective tabs in the Schema View.

6.6.2 Opening Schemas Found in the Search Path


This example demonstrates how to open a schema found in a search path defined in
SchemaAgent Server. It uses the DB2schema.xsd file available in the ..\Tutorial folder as
the active schema. The Global tab of the Components entry helper is active.

1. Scroll down to the blue Company entry in the Components entry helper, and
double-click it. The Goto Definition dialog box is opened.

2. Click the Addresslast.xsd entry, and click OK to confirm. This opens the
addresslast.xsd schema and displays the content model of the Company element.

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Working with SchemaAgent 249

Please note: Double-clicking a SchemaAgent schema construct, such as Element,


complexType, or simpleType, opens the associated schema (as well as all other included
schemas) in XMLSpy.

6.6.3 Using IIRs


XML schema provides Import, Include, and Redefine (IIR) statements to help modularize
schemas. Each method has different namespace requirements. These requirements are
automatically checked by SchemaAgent Client and XMLSpy when you try to create IIRs.

Imports, Includes, and Redefines (IIRs)


Schema constructs can be "inserted" by different methods:
 Global elements can be dragged directly from the Components Entry Helper into the
content model of a schema component (in Schema View).
 Components, such as complexTypes and simpleTypes, can be selected from the list
box that automatically opens when defining new elements/attributes, etc.
 Components, such as complexTypes, can be selected from the Details Entry Helper
when creating/updating these type of constructs.

Incorporating schema components


This example uses the DB2schema.xsd file available in the ..\Tutorial folder as the active
schema; the Global tab of the Components Entry Helper is active.

To use schema constructs from SchemaAgent Server schemas:


1. Make sure you are connected to a SchemaAgent server (see Connecting to
SchemaAgent server).
2. Open and rename the DB2Schema.xsd file for this example, for example to
Altova-office.

3. Click the icon of the Altova element in the Schema Overview to see its content
model.
4. Right-click the Altova sequence compositor and select the menu option Add Child |
Element. Note that a list box containing all global elements within the server path opens
automatically at this point. Selecting one would incorporate that element.

© 2010 Altova GmbH User Manual


250 DTDs and XML Schemas Working with SchemaAgent

5. Enter Altova-office as the name for this new element and press Enter.
6. Using the Details Entry Helper, click the type combo box and select the entry
OfficeType.

This opens the Select Definition For OfficeType dialog box.

7. Select Orgchart.xsd and click OK to confirm.

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Working with SchemaAgent 251

8. Click OK. The Import command was automatically selected for you. An expand icon
appears in the Altova-office element.

Please note: The type entry in the Details entry helper has changed; it is now
displayed as ns1:OfficeType due to the fact that the Orgchart.xsd schema file has
been imported and the target namespaces must be different in both schemas. An
Import command has also been added to the schema.

9. Click the Expand button to see the OfficeType content model.

10. Press F8 to validate the schema. The "Schema is valid" message should appear at this

© 2010 Altova GmbH User Manual


252 DTDs and XML Schemas Working with SchemaAgent

stage.

Cleaning up the schema:


1. Delete the Division element in the content model.
2. Click the Return to globals icon to switch to the Schema Overview.
3. Delete the following global elements: Division, Person and VIP.

4. Select the menu option Schema Design | Schema settings to see how the
namespace settings have changed.

The ns1 prefix has been automatically added to the


www.xmlspy.com/schemas/orgchart namespace. The Components (see screenshot)
and Details Entry Helpers displays all imported constructs with the ns1: namespace
prefix.

Please note:
 Changes made to schemas under SchemaAgent Server control using XMLSpy

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Working with SchemaAgent 253

automatically update other schemas in the SchemaAgent Server path that referenced
the changed schema.
 It is possible to see duplicates of constructs element, simpleTypes etc. in entry helpers
(in black and blue), if the schema you are working on is also in the SchemaAgent
Server path.

6.6.4 Viewing Schemas in SchemaAgent


To work with the active schema and its related schemas in SchemaAgent, select the menu
option Schema Design | Show in SchemaAgent | schema or related schemas (see
screenshot).

You have the option of opening only the active schema in SchemaAgent (File only command),
or the active schema together with either (i) all directly referenced schemas, or (ii) all directly
referencing schemas, or (iii) all directly related schemas.

6.6.5 SchemaAgent Validation


XMLSpy, in conjunction with SchemaAgent, allows you to validate not only the currently active
schema but also schemas related to the currently active schema. We call this extended
validation. There are two types of related schemas that SchemaAgent distinguishes for
extended validation: (i) directly referenced schemas, and (ii) referenced schemas.

How to carry out extended validation is demonstrated below by means of an example. This
example assumes that the schema file address.xsd is the active schema in Schema View of
XMLSpy. You would then do the following:

1. Click the Extended Validation icon in the toolbar or the menu item Schema Design
| Extended Validation. This opens the Extended Validation dialog box, in which you
can choose whether to validate the active schema only or one or more related schemas
as well.

2. To insert schemas into the list, click the Show Directly Referenced or Show All
Referenced button as required. In this example, we have clicked the Show All
Referenced button, and this inserts all referenced files into the list.

© 2010 Altova GmbH User Manual


254 DTDs and XML Schemas Working with SchemaAgent

At this point, you can remove a schema from the list (Remove from List).
3. Click the Validate button to validate all the schemas in the list box.

The Validate column displays whether the validation was successful or whether it failed.

You can now open the schemas that failed validation or a set of selected schemas in XMLSpy.

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Find in Schemas 255

6.7 Find in Schemas


In Schema View, XML Schemas can be searched intelligently using XMLSpy's Find & Replace
in Schema View feature.

The Find and Replace in Schema View feature is enabled when a schema is active in Schema
View. It is accessed in one of two ways:
 Via the Edit | Find and Edit | Replace menu commands.
 Via the Find and Replace buttons in the Find in Schemas window.

Clicking a command or a button pops up the Find or the Replace dialog, according to which
command/button was clicked. The Replace dialog (screenshots below) is different from the Find
dialog in that it has a text entry field for the Replace term.

The standard Replace dialog looks like this:

Clicking the More button expands the dialog to show additional search criteria (screenshot
below).

© 2010 Altova GmbH User Manual


256 DTDs and XML Schemas Find in Schemas

Usage is as follows:
 Enter the search and replace terms in the Search and Replace text fields
 Specify the schema components to be searched in the Components tab
 Specify the properties of the components to be searched; this helps to narrow the
search
 Set the scope of the search to the current document or project, or specify a folder to
search
 Execute the command
 Use the Find in Schemas window to navigate to a component quickly

The Reset button at the bottom of the dialog resets the original settings, which are as follows:
 No search term, no replace term
 Components: all
 Namespaces: none specified
 Property restrictions: anywhere
 Additional property restrictions: none
 Scope: current file

6.7.1 Search Term


The search term can be entered as a string (select the String radio button) or as a number (
Numeric radio button).

String search
In a string search (screenshot below), the entry can be: (i) text; (ii) a QName; or (iii) a regular

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Find in Schemas 257

expression. For QName searches, the namespace is determined on the basis of either the
prefix used in the document or by the namespace URI, either of which must be entered. In the
screenshot below, the ts: prefix is the prefix used in the document to identify a certain
namespace.

To search using a regular expression, check the Regular Expression check box and then enter
the regular expression. Entry helpers for regular expressions are available in a menu that is
activated by clicking the right-pointing arrowhead at the right of the Search entry field (
screenshot below).

You can also select whether a search term must match a whole word in the document and/or
whether the casing in the document must match. Use the check boxes below the text entry field
to specify these options.

If you wish to search in referenced objects (such as a complexType definition or a global


element), then check the Search In Referenced Objects check box. This option is available only
in the Find dialog; it is disabled in the Replace dialog.

Numeric search
When the Numeric Search radio button is selected, the search term can be a single operator-
and-number search parameter, or a set of two such operator-and-number search parameters
joined by the logical connector AND or OR. In the screenshot below, there are two search term
parameters which create a search term for all integers between, and including, 1 and 5.

© 2010 Altova GmbH User Manual


258 DTDs and XML Schemas Find in Schemas

6.7.2 Components
The search can be restricted to one or more component types and to one or more target
namespaces. These options are available in the Components tab. Expand the Find or Replace
dialog by clicking the More button. This will bring up the tabs for refining the search, one of
which is the Components tab (screenshot below).

The Components tab consists of two parts: (i) for selecting the component types to be
searched, and (ii) for selecting the target namespaces to be searched.

Component selection

You can enter the component types to be searched by clicking the Add icon located to the
right of the text field (see screenshot above). This pops up the Component Restriction dialog (
screenshot below), in which you can select the components to be searched by checking them.
Checking the Components item at the top of the list selects all components (text entry: all).
Unchecking it de-selects all components (text entry: none)—including individually selected
components. Individual components, therefore, can be selected only when the Components item
is unchecked. The selected components are entered in the text field as a comma-separated list
(see screenshot above).

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Find in Schemas 259

Note: Each time the Components tab or the Find/Replace dialog is opened, the previous
component selection is retained.

Namespace selection
To select one or more target namespaces to be searched, click the Add or Insert icons and
enter the required namespace/s. If no target namespace is specified, then all target
namespaces are searched. To delete a target namespace that has been entered in this pane,
select the target namespace and click the Delete icon.

6.7.3 Properties
The search can be restricted to one or more component properties (details and facets) by using
options in the Properties tab, as well as to match the contents of properties. Expand the Find or
Replace dialog by clicking the More button, and then select the Properties tab (screenshot

© 2010 Altova GmbH User Manual


260 DTDs and XML Schemas Find in Schemas

below).

The Properties tab consists of two parts: (i) for restricting the main search term (entered in the
Find text box); and (ii) for adding additional content restrictions (which have their own match
term); see the section Additional Restrictions below.

Properties selection

You can enter the property types to be searched by clicking the Add icon , which is to the
right of the text field (see screenshot above). This pops up the Property Restriction dialog (
screenshot below), in which you can select the properties to be searched by checking them.
The properties are organized in three groups: (i) Details; (ii) Facets; (iii) Advanced (such as the
DerivedFrom property). Checking Details, Facets, or Advanced selects all properties in that
group. Unchecking a group de-selects all properties in that group, including individually selected
properties. Individual properties, therefore, can be selected only when the group item is
unchecked. The selected properties are entered in the text field (see screenshot above).

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Find in Schemas 261

Note: Each time the Properties tab or the Find/Replace dialog is opened, the previous
properties selection is retained.

Additional restrictions
An additional restriction enables you to specify the value of the property to search for. For
example, if you are looking for an element called state which has an enumeration MA (for the
US state of Massachusetts), you could specify the value MA of the property enumeration with
the Addition Restrictions option. You would do this as follows:

1. In the Additional Restrictions pane, click the the Add or Insert icon (screenshot below).

2. This adds a row to the pane and pops up the Property Restriction dialog. Deselect all
properties and select only the enumeration property (screenshot below).

3. In the text field at the top of the dialog, enter the enumeration value to be searched for,
in this case, MA (see screenshot above).

© 2010 Altova GmbH User Manual


262 DTDs and XML Schemas Find in Schemas

4. Click OK. The additional restriction is entered in the newly created row in the Additional
Restrictions pane (screenshot below).

In the screenshot above, notice that the search term is ipo:state. In the Properties
tab, the anywhere specifies that all properties will be searched, but the additional
restriction specifies that the search should be restricted to enumerations having a value
of MA.

Multiple additional restrictions can be added to further narrow the search. To delete an
additional restriction, select the additional restriction and click the Delete icon.

Note: Each time the Properties tab or the Find/Replace dialog is opened, the previous
additional restriction/s are retained.

6.7.4 Scope
The scope of the search can be set in the Scope tab (screenshot below). You can select either
file/s or the currently selected schema component in Schema View.

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Find in Schemas 263

If the File/s option is selected, you can further specify one from among the following options:
 Current file: An additional option to search included, imported and redefined files is also
available.
 Open files: All XML Schema (XSD) files that are open in XMLSpy. Only the Find All and
Replace All commands are enabled; single-step searching is not available.
 Project: The currently active project is selected, with the option to skip external folders.
Only the Find All and Replace All commands are enabled; single-step searching is not
available. If the default view for the .xsd file extension (Tools | Options | File Types |
Default View) is not Schema View, then the .xsd files are not searched.
 Folder: You can browse for the required folder; an option to search sub-folders is also
available. Only the Find All and Replace All commands are enabled; single-step
searching is not available.If the default view for the .xsd file extension (Tools |
Options | File Types | Default View) is not Schema View, then the .xsd files are not
searched.
 Included, imported, and redefined files can be included in the scope by checking the
option for adding them to the scope.

In the Replace dialog, you can choose whether to copy the replacement to the file on disk or
whether to open the file in XMLSpy. Do this by selecting the appropriate button in the dialog.

6.7.5 Find and Replace Commands


The Find command behaves differently in the Find and Replace dialogs. The behavior of the
Find command in both dialogs and of the Replace command is described below.

Find dialog
After you have entered the search term and, optionally, other criteria to refine the search, you
can click either the Find (F3) or Find All command (screenshot below).

© 2010 Altova GmbH User Manual


264 DTDs and XML Schemas Find in Schemas

Clicking the Find (Ctrl+F) command in the dialog closes the Find dialog and finds the next
occurrence of the search term within the specified scope and refinement criteria. The next
occurrence is found relative to the currently selected component in Schema View. If the search
reaches the end of the scope, it will not start automatically from the beginning of the scope.
Therefore, you should make sure that the currently selected component in Schema View before
starting the search is located before the document part you wish to search.

The result of the Find is highlighted in Schema View and the result is also reported in the Find
In Schemas window. In the Find In Schemas window, you can click a result to highlight that item
in Schema View.

Clicking the Find All command closes the Find dialog and lists all the search results in the Find
In Schemas window.

Replace dialog
In the Replace dialog (screenshot below), clicking the Find command finds the next occurrence
of the search term relative to the current selection in Schema View. You can then click
Replace to replace this occurrence.

The Find All command closes the Replace dialog and lists all the search results in the Find In
Schemas window.

The Replace All command replaces all occurrences of the found term, closes the Replace
dialog, and lists the found terms in the Find In Schemas dialog.

Altova XMLSpy 2011 © 2010 Altova GmbH


DTDs and XML Schemas Find in Schemas 265

6.7.6 Results and Information


Each time a Find, Find All, Replace, or Replace All command is executed the results of the
command execution are displayed in the Find In Schemas window (screenshot below). The
term that was searched for is displayed in green; (in the screenshot below, it can be seen that
email was the search term, with no case restriction specified). Notice that the location of the
schema file is also given.

The Find All and Replace All commands list all the found occurrences in the document.

Note: The Find and Replace buttons at the top of this window bring up the Find dialog and
the Replace dialog, respectively. The Find button can be used to find the next
occurrence of the search term.

Features of the Find In Schemas window


Results are displayed in nine separate tabs (numbered 1 to 9). So you can keep the results of
one search in one tab, do a new search, and compare results. Clicking on a result in the Find In
Schemas window pops up and highlights the relevant component in the Main Window of
Schema View. In this way you can search and navigate quickly to the desired component.

The following Find In Schema toolbar commands are available:


 The Next and Previous icons select, respectively, the next and previous messages to
the currently selected message.
 The Copy Messages commands copy, respectively, the selected message, the
selected message and its children messages, and all messages, to the clipboard.
 The Find commands find text in the Find In Schemas window.
 The Clear command deletes all messages in the currently active tab.

© 2010 Altova GmbH User Manual


266 XSLT and XQuery

7 XSLT and XQuery


XMLSpy provides editing support for XSLT and XQuery documents, has built-in engines for
transforming with XSLT and executing XQuery documents, as well as powerful debuggers and
profilers. This section provides an overview of the XSLT and XQuery functionality available in
XMLSpy. It is organized into the following sections:
 XSLT
 XQuery
 XSLT and XQuery Debugger
 XSLT/XQuery Profiler

Additional and more detailed information about commands is in the descriptions of the relevant
menu commands (in the User Reference section). For more information on editing support, also
see the Editing Views section and the XML section.

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT 267

7.1 XSLT
Altova website: XSLT Editor

This section on XSLT is organized into the following sections:

 Editing XSLT documents: describes the editing support for XSLT documents in
XMLSpy
 XSLT Processing: shows the various ways in which XSLT transformations can be
carried out in the XMLSpy GUI using engines of your choice. This section also explains
important XSLT settings in XMLSpy.
 XSL Outline: describes the XSL Outline and XSL Info Windows, which together provide
a powerful way to view, navigate, and manage a collection of XSLT files.

XPath Evaluation
When an XML document is active, you can use the XPath Window to evaluate XPath
expressions. This is a very useful feature to quickly check how an XPath expression will be
evaluated. Type in an XPath expression and specify whether it should be evaluated relative to
the document root or to a selected context node in the XML document. The result of the
evaluation will be displayed immediately in the XPath Window. How to use the XPath Window is
described in the section Introduction | XPath Window.

XSLT Profiler and Debugger


XMLSpy also contains an XSLT Profiler and XSLT Debugger to help you create correct and
efficient XSLT stylesheets faster. These two features are described in the section XSLT and
XQuery.

Additional XSLT features


Additional and more detailed information about the various features described in this section is
in the descriptions of the relevant menu commands (in the User Reference section).

Altova XSLT Engines


For details about how the Altova XSLT 1.0 and 2.0 Engines are implemented, see Engine
Information in the Appendices.

AltovaXML for command line and batch processing


The XMLSpy GUI enables batch processing via the projects functionality. However, if you are
looking for more flexibility, you should try Altova's free AltovaXML product, which contains the
Altova XSLT 1.0 and 2.0 Engines that are built into XMLSpy. AltovaXML is ideal if you wish to
perform XSLT transformations from the command line, or batch processing.

7.1.1 XSLT Documents


XSLT 1.0 and 2.0 documents can be edited in Text View and Grid View, and are edited like any
other XML document in Text View and Grid View. The default view in which an XSLT document
is opened can be set in the File Types tab of the Options dialog.

Entry helpers
Entry helpers are available for elements, attributes, and entities. Information about the items

© 2010 Altova GmbH User Manual


268 XSLT and XQuery XSLT

displayed in the entry helpers is built into XMLSpy, and is not dependent on references
contained in the XSLT document.

The following points should be noted:


1. If a new XSLT document is created via the Create a New Document dialog (File | New),
then the appropriate XSLT elements and attributes (XSLT 1.0 or XSLT 2.0, depending
upon which document type was created) are loaded into the entry helpers. Additionally,
HTML elements and attributes are loaded, as well as the HTML 4.0 entity sets, Latin-1,
special characters, and symbols.
2. If an XML document is created via the Create a New Document dialog (File | New) and
given XSLT content, no entry helper items are available except for XML character
entities.
3. If an XSLT document is opened that was created as an XSLT document via the Create
a New Document dialog (File | New), then the entity helpers will be as in Point 1 above.
4. If an XSLT document is opened that was not created as an XSLT document via the
Create a New Document dialog (File | New), then the entity helpers will be as in Point 1
above. Additionally, XSL-FO elements and attributes will be listed in the Text View entry
helpers.
5. The prefixes of elements in the Elements entry helper are as follows and are invariable:
xsl: prefix for XSLT elements; no prefix for HTML elements; fo: prefix for XSL-FO
elements. Consequently, in order to use the entry helpers, the namespace declarations
in the XSLT document must define prefixes that match the built-in prefixes shown in the
entry helpers.

Auto-completion
In Text View, auto-completion is available in a pop-up as you type, with the first item in the pop-
up list being highlighted that matches the typed text. When an element is being typed, a list of
elements pops up with the first nearest match in alphabetical order being highlighted. Similarly,
when an attribute is being typed in, a list of applicable attributes pops up. The items in the list
are determined according to the rules described in the previous section on entry helpers.

XPath intelligent editing


At locations in the XSLT document where XPath expressions can be entered (for example, the
value of a select attribute), intelligent XPath editing is available. XPath functions and XPath
axes become available in popup as you type. Additionally, if an XML file has been assigned in
the Info window, the elements and attributes of the XML file will also be available in the popup.

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT 269

Validating XSLT documents


The XSLT document can be validated against the XSLT schema built into XMLSpy (click XML |
Validate (F8)). The correct built-in schema is automatically selected according to whether the
XSLT document is XSLT 1.0 or XSLT 2.0 (specified in the version attribute of the xsl:
stylesheet element).

7.1.2 XSLT Processing


In the XMLSpy GUI, two types of XSLT transformation are available:
 The XSL/XQuery | XSL Transformation (F10) command is used for straightforward
XML transformations with an XSLT stylesheet to result formats specified and described
in the stylesheets.
 The XSL/XQuery | XSL-FO Transformation command is used: (i) for transformations
of XML to FO to PDF in two steps, and (ii) for one-step transformations of FO to PDF.

Specifying the XSLT processor for the transformation


The XSLT engine that will be used for transformations is specified in the XSL tab of the Options
dialog (screenshot below).

The available options are explained in the User Reference section. The engine specified in the
XSL tab will be used for all XSLT transformations. Note that for the XSL:FO transformation, an
additional XSLT engine option is available: the XSLT engine that is packaged with some FO
processors. To select this option, select the corresponding radio button at the bottom of the XSL
tab (see screenshot above).

Specifying the FO processor


The FO processor that will be used for transformations of FO to PDF is specified in the text box
at the bottom of the XSL tab of the Options dialog (screenshot above).

XSLT 1.0 and 2.0 and Altova's XSLT engines

© 2010 Altova GmbH User Manual


270 XSLT and XQuery XSLT

The XSLT version of a stylesheet is specified in the version attribute of the xsl:stylesheet
(or xsl:transform) element. XMLSpy contains the built-in Altova XSLT 1.0 and Altova XSLT
2.0 engines, and the appropriate engine is selected according to the value of the version
attribute (1.0 or 2.0).

XSLT Transformation
The XSLT Transformation (F8) command can be used in the following scenarios:
 To transform an XML document that is active in the GUI and has an XSLT document
assigned to it. If no XSLT document is assigned, you are prompted to make an
assignment when you click the XSLT Transformation (F8) command.
 To transform an XSLT document that is active in the GUI. On clicking the XSLT
Transformation (F8) command, you are prompted for the XML file you wish to process
with the active XSLT stylesheet.
 To transform project folders and files. Right-click the project folder or file and select the
command.

XSL:FO Transformation
The XSL:FO Transformation command can be used in the following scenarios:
 To transform an XML document that is active in the GUI and has an XSLT document
assigned to it. The XML document will first be transformed to FO using the specified
XSLT engine. The FO document will then be processed with the specified FO
processor to produce the PDF output. If no XSLT document is assigned, you are
prompted to make an assignment when you click the XSL:FO Transformation
command.
 To transform an FO document to PDF using the specified FO processor.
 To transform an XSLT document that is active in the GUI. On clicking the XSL:FO
Transformation command, you are prompted for the XML file you wish to process with
the active XSLT stylesheet.
 To transform project folders and files. Right-click the project folder or file and select the
command.

For a description of the options in the XSL:FO output dialog, see the User Reference section.

Parameters for XSLT


If you are using the Altova XSLT engines, XSLT parameters can be stored in a convenient GUI
dialog. All the stored parameters are passed to the XSLT document each time you transform.
For more information, see the description of the XSLT Parameters / XQuery Variable command.

Batch processing with AltovaXML


AltovaXML is a free standalone application that contains Altova's XML validator, XSLT engines,
and XQuery engine. It can be used from the command line, via a COM interface, in Java
programs, and in .NET applications to validate XML documents, transform XML documents
using XSLT 1.0 and 2.0 stylesheets, and execute XQuery documents.

XSLT transformation tasks can therefore be automated with the use of Altova XML. For
example, you can create a batch file that calls AltovaXML to transform a set of documents. See
the Altova XML documentation for details.

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT 271

7.1.3 XSL Outline


When an XSLT document is the active document in XMLSpy, information about the structure of
the document is displayed in the XSL Outline window and information about the files related to
the active XSLT document is displayed in the XSLT tab of the Info Window (which is displayed
only when an XSLT document is the active document in XMLSpy). Additionally, via these two
windows, a number of commands are available that facilitate editing the XSLT document and
managing files related to it.

In the XSL Outline window (screenshot below), you can do the following:

 View the templates and functions in the active XSLT document and in all imported and
included XSLT documents.
 Sort the templates and functions on the basis of their names or match expressions,
mode, priority, or comments.
 Search for specific templates on the basis of their names/expressions.
 Use the XSL Outline to navigate to the corresponding template in the XSLT document.
 Quickly insert calls to named templates.
 Set a selected named template as the entry point for transformations.

In the XSLT tab of the Info Window (screenshot below), you can do the following:

© 2010 Altova GmbH User Manual


272 XSLT and XQuery XSLT

 View information about all the files related to the active XSLT document, such as the
locations of imported and included files.
 Set an XML file for transformation with the active XSLT document. Also, the schema
(XSD/DTD) file can be set for validating the selected XML file.
 Open a related file from within the Info Window.
 Quickly organize all related files into XMLSpy projects.
 Zip all related files to a user-defined location.

The XSL Outline window and the XSLT tab of the Info Window are described in detail in the
sub-sections of this section.

XSL Outline Window


In the XSL Outline Window (screenshot below), all templates and functions in the active XSLT
document are listed. Templates are indicated with blue icons ( templates without a
parameter; and templates containing parameters). Functions are indicated with a red icon.
In the combo box in the bottom left-hand of the window, you can select whether the templates
and functions listed are from: (i) only the active XSLT document (as in the screenshot below), or
(ii) the active XSLT document and all included and imported stylesheets.

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT 273

There are two types of templates: (i) named templates, and (ii) templates that match an XPath
expression. Each template is listed with:
 Its name (if the template has a name attribute) and/or XPath expression (if the template
has a match attribute). If the template has both, a name and a match attribute, then
both are listed, with the value of the name attribute first: namevalue, matchvalue (see
the template named bold in the screenshot above).
 Its mode, if any;
 Its priority, if any;
 The comment that directly precedes the template or function, if any.

Functions in the stylesheet are listed by their names. Functions have neither mode nor priority.

Operations
The following operations can be performed in the XSL Outline Window:
 Filtering: The list displayed in the window can be filtered to show one of the following: (i)
all templates and functions (the default setting each time XMLSpy is started); (ii) named
templates only; (iii) XPath-expression templates only; (iv) functions only. To select the
required filter, click the dropdown arrow to the right of the Search box at bottom right of
the window (screenshot below), and select the required filter (the second group of
commands in the menu). The selected filter is applied immediately and applies from
this moment onwards till it is modified or till XMLSpy is closed.

© 2010 Altova GmbH User Manual


274 XSLT and XQuery XSLT

 Sorting and locating: Each column can be sorted alphabetically by clicking the column
header. Each subsequent click reverses the previous sorting order. After a column has
been sorted in this way, if you select any item in the list and then quickly type in a term
from the sorted column, the first item in the list that contains that term will be
highlighted. In this way, you can quickly go to templates of a particular name/
expression, mode, or priority.
 Searching: Enter in the Search box (at bottom right) the name or XPath expression for
which you wish to search. The search results are displayed as you type. The following
search options are available in the dropdown list of the Search box (screenshot above):
(i) whether the name or expression either starts with or contains the search term (the
first group of commands in the menu); the starts-with option is the default each time
XMLSpy is started; (ii) whether the search results should be displayed as a reduced list
or be highlighted (the third group of commands in the menu); the reduced-list option is
the default each time XMLSpy is opened. These selections are applied immediately and
remain in effect till changed or till XMLSpy is closed.
 Reloading: After the stylesheet has been modified, click the Reload icon in the
window's toolbar to update the XSL outline.
 Go to item: When a template or function is selected in the XSL Outline window, clicking
the the Go to Item icon in the window's toolbar highlights the template or function
in the document in Design View. Alternatively, double-click an entry to go to it.
 Named template actions: Two groups of actions can be carried out involving named
templates: (i) Calls to the named template (with xsl:call-template) can be inserted
in the stylesheet at the cursor insertion point; and (ii) A named template can be set as
the entry point for a transformation. The commands for these actions are carried out via
icons in the toolbar and are described below.

Named templates
When a named template is selected, one or more commands in the window's toolbar relating to
named templates become enabled (screenshot below).

The commands in the toolbar (screenshot above) are, from left to right:
 Insert xsl:call-template: This command becomes active when a named template is
selected in the XSL Outline window. The command inserts an xsl:call-template
element at the cursor insertion point in the stylesheet. The name attribute of the xsl:
call-template element that is inserted in the stylesheet is given a value that is the
value of the name attribute of the selected named template. This makes the xsl:call-
template a call to the selected named template.
 Insert xsl:call-template with param: This command becomes active when a named

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT 275

template having one or more xsl:param child elements is selected in the XSL Outline
window. As with the Insert xsl:call-template command, the command inserts an xsl:
call-template element, but in this case with a corresponding xsl:with-param child
element for every xsl:param child element of the selected named template. The
names of the inserted xsl:call-template and its xsl:with-param child elements
correspond to the names of the selected named template and its xsl:param children.
 Set the selected named template as entry point for transformation: When a named
template is set as the entry point for a transformation, transformations executed in
XMLSpy start at this named template. In the XSL Outline Window, such a named
template is indicated in boldface (see screenshot at the start of this section).
 Clear named template as entry point for transformation: Becomes active once a named
template has been set as the entry point for transformations.
 Jump to the named template selected as the entry point for transformations: Becomes
active once a named template has been set as the entry point for transformations.
When the focus in the XSL Outline window is at some other point than the named
template set as the entry point for transformations, clicking this icon highlights the
named template in the XSL Outline window, thus making access to it faster.

Info Window
The XSLT tab of the Info Window, which is displayed only when an XSLT document is the
active document in XMLSpy, displays all the imported and included XSLT files related to the
active XSLT document, and enables the selection of an XML file that can be used as the source
XML document on which the XSLT document is used for the transformation.

The following files are displayed in the XSLT tab of the Info Window:

 XSLT files: All imported and included XSLT files are listed (see screenshot above). The
location of each file is displayed in a pop-up when the mouse cursor is placed over the
file. Double-clicking an imported or included file, or selecting it and then clicking the
Open icon in the Info Window toolbar, opens the file in a new window. The Go to
Include/Import Location icon in the toolbar highlights the include/import declaration in
the active XSLT document.

 XML file: An XML file can be assigned to the active XSLT stylesheet for
transformations. The location of the assigned XML file is displayed in a pop-up when
the mouse cursor is placed over the file. If an XML file is specified and the menu

© 2010 Altova GmbH User Manual


276 XSLT and XQuery XSLT

command XSL/XQuery | XSL Transformation (F10) is clicked, a transformation is


executed on the defined XML file using the active XSLT document as the stylesheet.
The XML file can be selected by clicking the XML icon and browsing; the selected file is
displayed in bold face. Alternatively, the XML file can be assigned via the Project
Properties dialog (XSL transformation of XSL files) or via a processing instruction in the
XSLT document of the form: <?altova_samplexml "Products.xml"?>. In each case,
the XML file will be shown in the Info Window with the relevant icon:

assigned via the Project Properties dialog

assigned via a processing instruction in the XSLT document

assigned by clicking the XML icon and browsing for the


required file; entry is in bold font face

In the event that more than one of the above assignments exists, the selection priority
is: (i) project; (ii) processing instruction; (iii) browsed by user. The XML file can be
opened by double-clicking it or by selecting it and clicking the Open toolbar icon.

 XSD/DTD file: If the selected XML file has a reference to a schema (XML Schema or
DTD), then this schema file is displayed in the XSD/DTD entry. Alternatively, just as
with the XML file, the schema file can be selected via the Project Properties dialog (
Validation) or by clicking the XSD/DTD icon and browsing for the required schema file.
If the schema file is selected via the Projects Properties dialog, a Projects icon is
displayed next to the entry, otherwise the clickable XSD/DTD icon is displayed with the
file entry either in a normal font face (when the schema is referenced from the XML file)
or bold font face (schema browsed for by the user via the XSD/DTD icon). Should the
schema file be assigned via more than one method, then the order of priority is as
follows: (i) project; (ii) browsed by user; (iii) reference in XML document. The location of
the assigned XSD file is displayed in a pop-up when the mouse cursor is placed over
the file. The schema file can be opened by double-clicking it or by selecting it and
clicking the Open toolbar icon.

Note: If an XML or XSD/DTD file is selected via the Project Properties dialog, then to clear
this selection, you must go to the Project Properties dialog and clear the setting there. If
the selection has been made by browsing via the XML or XSD/DTD icons, then to clear
this setting, select the file and click the Clear icon in the Info Window toolbar.

Options
XPath intelligent editing: If an XML file has been assigned, the structure of the XML
document is known and intelligent XPath editing will extend to elements and attributes. At
locations in the XSLT document where an XPath expression can be entered, available elements
and attributes will be shown in a popup. This option is switched on by default. To disable XPath
intelligent editing, uncheck the check box. The setting is saved for each XSLT file separately
when the file is closed, and will be used each time the file is opened.

Toolbar icons
The Info Window toolbar icons (screenshot below) are, from left to right:

 Reload info: Updates the Info Window to reflect modifications made in teh XSLT

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT 277

document.
 Clear XML/XSD assignment: Clears an XML or XSD/DTD assignment made by the
user by browsing via the XML or XSD/DTD icons, respectively. Select the file to clear
and then click this icon.
 Open document: Opens the selected document.
 Go to import/include location: When an imported or included file is selected, clicking this
icon highlights the relevant import or include declaration in the XSLT document.
 Zip all local documents: Zips all the documents listed in the Info Window to a user-
defined location. Alternatively, only the selected documents can be zipped; do this by
selecting, in the dropdown menu of this icon, the command Zip selected local
documents.
 Add all files to projects: Adds all files to the current projects. Alternatively, only the
selected documents can be added; do this by selecting, in the dropdown menu of this
icon, the command Add selected files to project.

© 2010 Altova GmbH User Manual


278 XSLT and XQuery XQuery

7.2 XQuery
Altova website: XQuery Editor

XQuery documents can be edited in Text View. The Entry Helpers, syntax coloring, and
intelligent editing are different than for XML documents (see screenshot; line numbering and
folding margins in Enterprise and Professional Editions only). We call this mode of Text View its
XQuery Mode. In addition, you can validate your XQuery document in Text View and execute
the code in an XQuery document (with an optional XML file if required) using the built-in Altova
XQuery Engine.

Please note: XQuery files can be edited only in Text View. No other views of XQuery files are
available.

XQuery Profiler and Debugger


XMLSpy also contains an XQuery Profiler and XQuery Debugger to help you create correct
XQuery documents faster. These two features are described in the section XSLT and XQuery.

Altova XQuery Engine


For details about how the Altova XQuery Engine is implemented and will process XQuery files,

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XQuery 279

see XQuery Engine Implementation.

AltovaXML for command line and batch processing


The XMLSpy GUI enables batch processing via the projects functionality. However, if you are
looking for more flexibility, you should try Altova's free AltovaXML product, which contains the
Altova XQuery Engine that is built into XMLSpy. AltovaXML is ideal if you wish to perform
XQuery executions from the command line, or batch processing.

7.2.1 XQuery Documents


An XQuery document is opened automatically in XQuery Mode of Text View if it is XQuery
conformant. Files that have the file extension .xq, .xql, and .xquery are pre-defined in
XMLSpy as being XQuery conformant.

Setting additional file extensions to be XQuery conformant


To set additional file extensions to be XQuery conformant:

1. Select Tools | Options. The Options dialog appears (see screenshot).


2. Select the File types tab.
3. Click Add new file extension to add the new file extension to the list of file types.
4. Under Conformance, select XQuery conformant.

You should also make the following Windows Explorer settings in this dialog:
 Description: XML Query Language
 Content type: text/xml
 If you wish to use XMLSpy as the default editor for XQuery files, activate the Use
XMLSpy as default editor check box.

© 2010 Altova GmbH User Manual


280 XSLT and XQuery XQuery

7.2.2 XQuery Entry Helpers


There are three Entry Helpers in the XQuery Mode of Text View: XQuery Keywords (blue),
XQuery Variables (purple), and XQuery Functions (olive).

Note the following points:


 The color of items in the three Entry Helpers are different and correspond to the syntax
coloring used in the text. These colors cannot be changed.
 The listed keywords and functions are those supported by the Altova XQuery Engine.
 The variables are defined in the XQuery document itself. When a $ and a character are
entered in Text View, the character is entered in the Variables Entry Helper (unless a
variable consisting of exactly that character exists). As soon as a variable name that is
being entered matches a variable name that already exists, the newly entered variable
name disappears from the Entry Helper.
 To navigate in any Entry Helper, click an item in the Entry Helper, and then use either
the scrollbar, mouse wheel, or page-down and page-up to move up and down the list.

To insert any of the items listed in the Entry Helpers into the document, place the cursor at the
required insertion point and double-click the item. In XQuery, some character strings represent
both a keyword and a function (empty, unordered, and except). These strings are always
entered as keywords (in blue)—even if you select the function of that name in the Functions
Entry Helper. When a function appears in blue, it can be distinguished by the parentheses that
follow the function name.

7.2.3 XQuery Syntax Coloring


An XQuery document can consist of XQuery code as well as XML code. The default syntax
coloring for the XQuery code is described in this section. The syntax coloring for XML code in
an XQuery document is the same as that used for regular XML documents. All syntax coloring
(for both XQuery code and XML code) is set in the Text Fonts tab of the Options dialog (Tools |
Options). Note that XQuery code can be contained in XML elements by enclosing the XQuery
code in curly braces {} (see screenshot for example).

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XQuery 281

In XQuery code in the XQuery Mode of Text View, the following default syntax coloring is used:
 (: Comments, including 'smiley' delimiters, are in green :)
 XQuery Keywords are in blue: keyword
 XQuery Variables, including the dollar sign, are in purple: $start
 XQuery Functions, but not their parentheses, are in olive: function()
 Strings are in orange: "Procedure"
 All other text, such as path expressions, is black (shown underlined below). So:
for $s in doc("report1.xml")//section[section.title =
"Procedure"]
return ($s//incision)[2]/instrument

You can change these default colors and other font properties in the Text Fonts tab of the
Options dialog (Tools | Options).

Please note: In the above screenshot, one pair of colored parentheses for a comment is
displayed black and bold. This is because of the bracket-matching feature (see XQuery
Intelligent Editing).

© 2010 Altova GmbH User Manual


282 XSLT and XQuery XQuery

7.2.4 XQuery Intelligent Editing


The XQuery Mode of Text View provides the following intelligent editing features.

Bracket-matching
The bracket-matching feature highlights the opening and closing brackets of a pair of brackets,
enabling you to clearly see the contents of a pair of brackets. This is particularly useful when
brackets are nested, as in XQuery comments (see screenshot below).

Bracket-matching is activated when the cursor is placed either immediately before or


immediately after a bracket (either opening or closing). That bracket is highlighted (bold black)
together with its corresponding bracket. Notice the cursor position in the screenshot above.

Bracket-matching is enabled for round parentheses (), square brackets [], and curly braces
{}. The exception is angular brackets <>, which are used for XML tags.

Please note: When you place the cursor just inside a start or end bracket, both brackets are
highlighted. Pressing Ctrl+E moves the cursor to the other member of the pair. Pressing Ctrl+E
repeatedly enables you to switch between the start and end brackets. This is another aid to
quickly navigating your document.

Keywords
XQuery keywords are instructions used in query expressions, and they are displayed in blue.
You select a keyword by placing the cursor inside a keyword, or immediately before or after it.
With a keyword selected, pressing Ctrl+Space causes a complete list of keywords to be
displayed in a pop-up menu. You can scroll through the list and double-click a keyword you wish
to have replace the selected keyword.

In the screenshot above, the cursor was placed in the let keyword. Double-clicking a keyword
from the list causes it to replace the let keyword.

Variables
Names of variables are prefixed with the $ sign, and they are displayed in purple. This
mechanism of the intelligent editing feature is similar to that for keywords. There are two ways
to access the pop-up list of all variables in a document:
 After typing a $ character, press Ctrl+Space
 Select a variable and press Ctrl+Space. (A variable is selected when you place the
cursor immediately after the $ character, or within the name of a variable, or

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XQuery 283

immediately after the name of a variable.)

To insert a variable after the $ character (when typing), or to replace a selected variable,
double-click the variable you want in the pop-up menu.

Functions
Just as with keywords and variables, a pop-up menu of built-in functions is displayed when you
select a function (displayed in olive) and press Ctrl+Space. (A function is selected when you
place the cursor within a function name, or immediately before or after a function name. The
cursor must not be placed between the parentheses that follow the function's name.)
Double-clicking a function name in the pop-up menu replaces the selected function name with
the function from the pop-up menu.

To display a tip containing the signature of a function (screenshot below), place the cursor
immediately after the opening parenthesis and press Ctrl+Space.

Please note: The signature can be displayed only for standard XQuery functions.

The downward-pointing arrowhead indicates that there is more than one function with the same
name but with different arguments or return types. Click on the signature to display the
signature of the next function (if available); click repeatedly to cycle through all the functions
with that name. Alternatively, you can use the Ctrl+Shift+Up or Ctrl+Shift+Down
key-combinations to move through a sequence.

Visual Guides
Text folding is enabled on XQuery curly braces, XQuery comments, XML elements, and XML
comments.

7.2.5 XQuery Validation and Execution


Validating XQuery documents
To validate an XQuery document:
1. Make the XQuery document the active document.

2. Select XML | Validate, or press the F8 key, or click the toolbar icon.

The document will be validated for correct XQuery syntax.

Executing XQuery documents


XQuery documents are executed within XMLSpy using the built-in XQuery 1.0 engine. The
output is displayed in a window in XMLSpy.

© 2010 Altova GmbH User Manual


284 XSLT and XQuery XQuery

Typically, an XQuery document is not associated with any single XML document. This is
because XQuery expressions can select any number of XML documents with the doc()
function. In XMLSpy, however, before executing individual XQuery documents you can select a
source XML document for the execution. In such cases, the document node of the selected
XML source is the starting context item available at the root level of the XQuery document.
Paths that begin with a leading slash are resolved with this document node as its context item.

To execute an XQuery document:


1. Make the XQuery document the active document.
2. Select XSL/XQuery | XQuery Execution or click the toolbar icon. This opens the
Define an XML Source for the XQuery dialog.

3. Do one of the following:


 To select an XML file, use either the Browse button or the Window button (which
lists files that are open in XMLSpy and that are in XMLSpy projects). Select an XML
source if you wish to assign its document node as the context item for the root level
of the XQuery document. Click Execute.
 To skip this dialog click Skip XML.

The result document is generated as a temporary file that can be saved to any location with the
desired file format and extension.

XQuery Variables
If you are using the Altova XQuery engine, XQuery variables can be stored in a convenient GUI
dialog. All the stored variables are passed to the XQuery document each time you execute an
XQuery document via XMLSpy. For more information, see the description of the XSLT
Parameters / XQuery Variable command.

Altova XQuery Engine


For details about how the Altova XQuery Engine is implemented and will process XQuery files,
see XQuery Engine Implementation.

7.2.6 XQuery and XML Databases


An XQuery document can be used to query an XML database (XML DB). Currently this XQuery
functionality is supported only for IBM DB2 databases. The mechanism for querying an XML DB
using XQuery essentially involves: (i) indicating to the XQuery engine that XML in a DB is to be
queried—as opposed to XML in an XML document; and (ii) accessing the XML data in the DB.

The steps for implementing this mechanism are as follows and are described in detail below:
1. Set up the XQuery document to query the XML DB by inserting the XQUERY keyword at

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XQuery 285

the start of the document.


2. For the active XQuery document, enable DB support (via the Info window) and connect
to the DB (using the Quick Connect dialog).
3. In the XQuery document, insert DB-specific XQuery extensions so as to access the DB
data and make it available for XQuery operations.
4. Execute the XQuery document in XMLSpy.

Setting up the XQuery document to query the XML DB


To set up the XQuery document to query an XML DB, open the XQuery document (or create a
new XQuery document) and enter the keyword XQUERY (casing is irrelevant) at the start of the
document (before the prolog); see examples below.

XQUERY (: Retrieve details of all customers :)


declare default element namespace "http://www.altova.com/xquery/databases/db2"
;
<a> {db2-fn:xmlcolumn("CUSTOMER.INFO")} </a>

If the document uses the optional xquery version expression, the XQUERY keyword is still
required:

XQUERY xquery version "1.0"; (: Retrieve details of all customers :)


declare default element namespace "http://
http://www.altova.com/xquery/databases/db2";
<a> {db2-fn:xmlcolumn("CUSTOMER.INFO")} </a>

Note: XMLSpy's built-in XQuery Engine reads the XQUERY keyword as indicating that an XML
DB is to be accessed. As a result, attempting to execute an XQuery document
containing the XQUERY keyword on any XML document other than one contained in an
XML DB will result in an error.

Enable DB support for XQuery and connect to the DB


DB support for an XQuery document is enabled by checking the Enable Database Support
check box in the Info window (screenshot below). Note that DB Support must be enabled for
each XQuery document separately and each time an XQuery document is opened afresh.

When you enable DB support in the Info window, a Quick Connect dialog pops up, which
enables you to connect to a database. Currently, only IBM DB2 databases are supported. How
to connect to a DB is described in the section, Connecting to a Data Source. If connections to
data sources already exists, then these are listed in the Data Sources combo box of the Info
window (screenshot below), and one of these data sources can be selected as the data source
for the active XQuery document. In the Info window, you can also select the root object from
among those available in the Root Object combo box.

© 2010 Altova GmbH User Manual


286 XSLT and XQuery XQuery

The Quick Connect dialog (which enables you to connect to a DB) can be accessed at any time
by clicking the icon in the Info window.

Note: When you close an XQuery document the connection to the DB is closed as well. If you
subsequently re-open the XQuery document, you will also have to re-connect to the DB.

IBM DB2-specific XQuery language extensions


Two IBM DB2-specific functions can be used in XQuery documents to retrieve data from an IBM
DB2 database:
 db2-fn:xmlcolumn retrieves an entire XML column without searching or filtering the
column.
 db2-fn:sqlquery retrieves values based on an SQL SELECT statement

The XML data retrieved using these functions can then be operated on using standard XQuery
constructs. See examples below.

db2-fn:xmlcolumn:The argument of the function is a case-sensitive string literal that


identifies an XML column in a table. The string literal argument must be a qualified column
name of type XML. The function returns all the XML data in the column as a sequence, without
applying a search condition to it. In the following example, all the data of the INFO (XML) column
of the CUSTOMER table is returned within a top-level <newdocelement> element:
XQUERY (: Retrieve details of all customers :)
declare default element namespace "http://www.altova.com/xquery/databases/db2"
;
<newdocelement> {db2-fn:xmlcolumn("CUSTOMER.INFO")} </newdocelement>

The retrieved data can then be queried with XQuery constructs. In the example below, the XML
data retrieved from the the INFO (XML) column of the CUSTOMER table is filtered using an
XQuery construct so that only the profiles of customers from Toronto are retrieved.
XQUERY (: Retrieve details of Toronto customers :)
declare default element namespace "http://www.altova.com/xquery/databases/db2"
;
<newdocelement> {db2-fn:xmlcolumn("CUSTOMER.INFO")/customerinfo[addr/city=
'Toronto']} </newdocelement>

Note: In the example above, the document element of the XML files in each cell is
customerinfo and the root node of the XML sequence returned by db2-fn:xmlcolumn
is considered to be an abstract node above the customerinfo nodes.

db2-fn:sqlquery:The function takes an SQL Select statement as its argument and returns

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XQuery 287

a sequence of XML values. The retrieved sequence is then queried with XQuery constructs. In
the following example, the INFO column is filtered for records in the CUSTOMER table that have a
CID field with a value between 1000 and 1004. Note that while SQL is not case-sensitive,
XQuery is.
XQUERY (: Retrieve details of customers by Cid:)
declare default element namespace "http://www.altova.com/xquery/databases/db2"
;
<persons>
{db2-fn:sqlquery("SELECT info FROM customer WHERE CID>1000 AND CID<1004")/
<person>
<id>{data(@Cid)}</id>
<name>{data(name)}</name>
</person>}
</persons>

The XQuery document above returns the following output:


<persons xmlns="http://www.altova.com/xquery/databases/db2">
<person>
<id>1001</id>
<name>Kathy Smith</name>
</person>
<person>
<id>1002</id>
<name>Jim Jones</name>
</person>
<person>
<id>1003</id>
<name>Robert Shoemaker</name>
</person>
</persons>

Note the following points:


 The default element namespace declaration in the prolog applies for the entire XQuery
document and is used for navigation of the XML document as well as for construction of
new elements. This means that the XQuery selector name is expanded to <default-
element-namespace>:name, and that constructed elements, such as persons, are in
the default element namespace.
 The SQL Select statement is not case-sensitive.
 The WHERE clause of the Select statement should reference another database item—not
a node inside the XML file being accessed.
 The "/" after the db2-fn:sqlquery function represents the first item of the returned
sequence, and this item is the context node for further navigation.

Execute the XQuery


To execute the XQuery document, select the XQuery Execution command (XSL/XQuery
menu). Alternatively, press Alt+F10 or click the XQuery Execution icon . The result of the
execution is displayed in a new document.

© 2010 Altova GmbH User Manual


288 XSLT and XQuery XSLT and XQuery Debugger

7.3 XSLT and XQuery Debugger


Altova website: XSLT Debugger, XQuery Debugger

The XSLT and XQuery Debugger enables you to test and debug XSLT stylesheets and XQuery
documents. The XSLT and XQuery Debugger interface presents simultaneous views of the
XSLT/XQuery document, the result document, and the source XML document. You can then go
step-by-step through the XSLT/XQuery document. The corresponding output is generated
step-by-step, and, if a source XML file is displayed, the corresponding position in the XML file is
highlighted for each step. At the same time, windows in the interface provide debugging
information.

The XSLT and XQuery Debugger always opens within a debugging session. Debugging
sessions can be of three types:
 XSLT 1.0, which uses the built-in Altova XSLT 1.0 engine
 XSLT 2.0, which uses the built-in Altova XSLT 2.0 engine
 XQuery, which uses the built-in Altova XQuery 1.0 engine

Which kind of debugging session is opened is determined automatically by the type of


document from which the debugging session is opened (hereafter called the active document
or active file). XSLT debugging sessions are opened from XSLT files (which version depends
on the value of the version attribute of the xsl:stylesheet (or xsl:transform) element
in the XSLT stylesheet ("1.0" for XSLT 1.0 and "2.0" for XSLT 2.0)). XQuery debugging
sessions are opened from XQuery files. If the active file is an XML file, the selection depends on
whether you choose to run an XSLT or XQuery file on the XML file; if the former, the selection
further depends on whether the stylesheet is an XSLT 1.0 or XSLT 2.0 stylesheet.

This information is summarized in the table below.

Active File Associated File Debugging Session


XSLT 1.0 XML; (required) XSLT 1.0 (using built-in Altova XSLT 1.0 engine)
XSLT 2.0 XML; (required) XSLT 2.0 (using built-in Altova XSLT 2.0 engine)
XQuery XML; (optional) XQuery (using built-in Altova XQuery engine)
XML XSLT 1.0, or XSLT 1.0, XSLT 2.0, or XQuery. XSLT 1.0 or 2.0
XSLT 2.0, or depending on value of version attribute of
XQuery; xsl:stylesheet (or xsl:transform) element of
(required) XSLT stylesheet.

For details about the three Altova engines, please see the following sections:
 Altova XSLT 1.0 Engine
 Altova XSLT 2.0 Engine
 Altova XQuery 1.0 Engine

Automating XSLT and XQuery tasks with Altova XML 2011


Altova XML is a free application which contains Altova's XML Validator, XSLT 1.0, XSLT 2.0,
and XQuery 1.0 engines. It can be used from the command line, via a COM interface, in Java
programs, and in .NET applications to validate XML documents, transform XML documents
using XSLT 1.0 and 2.0 stylesheets, and execute XQuery documents.

XSLT and XQuery tasks can therefore be automated with the use of Altova XML. For example,

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Debugger 289

you can create a batch file that calls Altova XML to transform a set of XML documents or to
execute a set of XQuery documents. See the Altova XML documentation for details.

7.3.1 Mechanism and Interface


The broad mechanism used for debugging XSLT and XQuery files using the XSLT and XQuery
Debugger is given below. Note that there is a difference between a debugging session and the
debugger, even though both are started with the XSL/XQuery | Start Debugger / Go
command. You must first start the debugging session, and then step through the XSLT or
XQuery document with the debugger.
 Open a debugging session (with the XSL/XQuery | Start Debugger / Go command).
The appropriate session (XSLT 1.0, XSLT 2.0, or XQuery) is selected on the basis of
the active file (see XSLT and XQuery Debugger). The XSLT and XQuery Debugger
works only in Text View and Grid View. If the view of the active document is not Text
View or Grid View when you start the debugging session, you will be prompted for
permission to change the view to Text View, which is the default view of the XSLT and
XQuery Debugger. You can, in the Debugger Settings dialog, also choose to have this
option set permanently.
 Step through the XSLT or XQuery document using the Step Into, Step Out, and Step
Over commands in the XSL/XQuery menu. (If you click the Start Debugger / Go
command at this point, the debugger will go through the entire transformation or
execution, stopping only at breakpoints. If no breakpoint has been set, it will go through
the transformation in one step, without showing any debug results.) If an XML file is
associated with the session, the corresponding locations in the XML file are highlighted.
Simultaneously, output for corresponding steps is generated in the result file and the
result document is built up step-by-step. In this way, you can analyse what each
statement of the XSLT or XQuery file does.

Alternatively to the view of the three documents (XML, XSLT/XQuery, Output) shown
above, a view of two documents (XSLT/XQuery and Output), or a view of any one of the
documents can be selected.
 While a debugging session is open, information windows in the interface provide
information about various aspects of the transformation/execution (Variables, XPath
Watch, Call Stack, Messages, Info, etc).
 While a debugging session is open, you can stop the debugger (not the same as

© 2010 Altova GmbH User Manual


290 XSLT and XQuery XSLT and XQuery Debugger

stopping the debugging session) to make changes to any of the documents. All the
editing features that are available in your XMLSpy environment are also available while
editing a file during a debugging session. When the debugger is stopped, the XSLT and
XQuery Debugger interface stays open, and you have access to all the information in
the information windows. After stopping the debugger in a debugging session, you can
restart the debugger (from the beginning of the XSLT/XQuery document) within the
same debugging session.
 Breakpoints can be set in the XSLT file to interrupt the processing at selected points.
This speeds up debugging sessions since you do not have to step through each
statement in the XSLT or XQuery document manually.
 Tracepoints can be set in the XSLT file. For instructions where a tracepoint is set, the
value of that instruction is output when the instruction is reached.
 Stop a debugging session. This closes the XSLT and XQuery Debugger interface and
returns you to your previous XMLSpy environment. The information in the information
windows is no longer available. Breakpoint and tracepoint information, however, is
retained in the respective files till the file is closed. (So if you start another debugging
session involving a file containing breakpoints, the breakpoints will apply in the newly
opened debugging session.)

Please note: The Debugger toolbar with Debugger icons appears automatically when a
debugging session is started.

7.3.2 Commands and Toolbar Icons


Debugger commands are available in the XSL/XQuery menu and as toolbar icons. The
debugger icons are automatically made available in the toolbar when a debugging session is
opened. These icons are listed below.

Start Debugger/Go (Alt+F11)


Starts or continues processing the XSLT/XQuery document till the end. If breakpoints have
been set, then processing will pause at that point. If the debugger session has not been started,
then this button will start the session and stop at the first node to be processed. If the session is
running, then the XSLT/XQuery document will be processed to the end, or until the next
breakpoint is encountered. If tracepoints have been set, the value of the instruction for which
the tracepoint was set is displayed in the Trace window when that instruction is reached.

View the active document only


Maximizes the window of the currently active document in the Debugger interface.

View XSLT/XQuery and Output


Displays the XSLT and Output documents in their windows, while hiding the XML document.

View XML, XSLT/XQuery and Output


Displays the XML, XSLT/XQuery, and Output documents. This is the default view when an XML
document is associated for the debugging session.

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Debugger 291

Stop Debugger
Stops the debugger. This is not the same as stopping the debugger session in which the
debugger is running. This is convenient if you wish to edit a document in the middle of a
debugging session or to use alternative files within the same debugging session. After stopping
the debugger, you must restart the debugger to start from the beginning of the XSLT/XQuery
document.

Step into (F11)


Proceeds in single steps through all nodes and XPath expressions in the stylesheet. This
command is also used to re-start the debugger after it has been stopped.

Step Over (Ctrl+F11)


Steps over the current node to the next node at the same level, or to the next node at the next
higher level from that of the current node. This command is also used to re-start the debugger
after it has been stopped.

Step Out (Shift+F11)


Steps out of the current node to the next sibling of the parent node, or to the next node at the
next higher level from that of the parent node.

Show current execution node


Displays/selects the current execution node in the XSLT/XQuery document and the
corresponding context node in the XML document. This is useful when you have clicked in other
tabs which show or mark specific code in the XSLT stylesheet or XML file, and you want to
return to where you were before you did this.

Restart Debugger
Clears the output window and restarts the debugging session with the currently selected files.

Insert/Remove Breakpoint (F9)


Inserts or removes a breakpoint at the current cursor position. Inline breakpoints can be defined
for nodes in both the XSLT/XQuery and XML documents, and determine where the processing
should pause. A dashed red line appears above the node when you set a breakpoint.
Breakpoints cannot be defined on closing nodes, and breakpoints on attributes in XSLT
documents will be ignored. This command is also available by right-clicking at the breakpoint
location.

© 2010 Altova GmbH User Manual


292 XSLT and XQuery XSLT and XQuery Debugger

Insert/Remove Tracepoint (Shift+F9)


Inserts or removes a tracepoint at the current cursor position. Inline tracepoints can be defined
for nodes in XSLT documents. During debugging, when a statement with a tracepoint is
reached, the result of that statement is output in the Trace window. A dashed blue line appears
above the node when you set a tracepoint. Tracepoints cannot be defined on closing nodes.
This command is also available by right-clicking at the tracepoint location.

Enable/Disable Breakpoint (CTRL+F9)


This command (no toolbar icon exists) enables or disables already defined breakpoints. The red
breakpoint highlight turns to gray when a breakpoint is disabled. The debugger does not stop at
disabled breakpoints. To disable/enable a breakpoint, place the cursor in that node name and
click the Enable/Disable Breakpoint command. This command is also available by right-clicking
at the breakpoint location.

Enable/Disable Tracepoint (Shift+CTRL+F9)


This command (no toolbar icon exists) enables or disables already defined tracepoints. The
blue tracepoint highlight turns to gray when a tracepoint is disabled. No output is made in the
Trace window for disabled tracepoints. To disable/enable a tracepoint, place the cursor in that
node name and click the Enable/Disable Tracepoint command. This command is also available
by right-clicking at the tracepoint location.

End Debugger Session


Ends the debugging session and returns you to the normal XMLSpy view that was active before
you started the debugging session. Whether the output documents that were opened for the
debugging session stay open depends on a setting you make in the XSLT/XQuery Debugger
Settings dialog.

XSLT Breakpoints / Tracepoints Dialog


This command opens the XSLT/XQuery Breakpoints / Tracepoints dialog, which displays a list
of all currently defined breakpoints/tracepoints (including disabled ones) in all files in the current
debugging session.

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Debugger 293

The check boxes indicate whether a breakpoint/tracepoint is enabled (checked) or disabled.


You can remove the highlighted breakpoint/tracepoint by clicking the corresponding Remove
button and remove all breakpoints or tracepoints by clicking the corresponding Remove All
button. The corresponding Edit Code button takes you directly to the selected
breakpoint/tracepoint in the file.

7.3.3 XSLT/XQuery Settings


The XSLT and XQuery Debugger Settings dialog enables you to set debugging and output
options that are applicable to all debugging sessions. To access the Settings dialog, click
XSL/XQuery | XSLT/XQuery Settings or click the icon in the toolbar. The different settings
are described below.

© 2010 Altova GmbH User Manual


294 XSLT and XQuery XSLT and XQuery Debugger

Output Window
Sets the view of the output document window (Default, Text, Grid, or Browser). The Default
View is that selected for the output file type in the File tab of the Options dialog (Tools | Options
). For XSLT transformations, the output file type is defined in the XSLT file. For XQuery
executions, the output file type is determined by the serialization format you choose in the
XQuery setting of this dialog (see below).

The Close All Output Windows option gives you the opportunity to keep open the output
document windows that were opened in the debugging session when the debugging session
ends.

Debugging
The Debug Built-in Templates setting causes the debugger to step into built-in templates code
whenever appropriate. It is not related to the display of built-in templates when clicking this type
of template entry in the Templates tab, or if the callstack shows a node from the built-in
template file.

The XSLT Debugger works only in Text View or Grid View. The Auto Change to Text View
option enables you to automatically switch to the Text View of a document for debugging if a
document is not in Text View or Grid View. (The XQuery Debugger works in Text View only.) If
the On demand variable execution check box is checked, the definition of a variable will be
stepped into when the variable is called. Otherwise, the Debugger will not step into the variable
definition when it encounters a call to a variable, but will carry on to the next step.

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Debugger 295

Layout of Debugger Documents


The Debugger Documents are the documents that are open in the Debugger. You can select
whether these documents should be tiled vertically, horizontally, or XML/XSLT horizontally with
the result document tiled vertically relative to the XML and XSLT.

XQuery
The serialization method determines two things: (i) the file format of the generated output file,
and (ii) the rules followed in writing the output to the output file. The available options are HTML,
Text, XHTML, and XML. The selection you make sets up an empty file of the selected file type
when you start the debugger inside a debugging session. The file type is significant because it
enables currently active XMLSpy features for that file type (such as validation for XML files).

You can choose to omit the XML declaration and to indent the output. The Always Skip XML
Source option enables you to always skip the optional XML file association step when you start
a debugging session from an XQuery file. For DB2 databases, you can specify the maximum
number of rows to be retrieved.

Alternative output setting


In the Project Properties dialog, you can make XSLT transformation associations for a folder.
One of these options is the destination folder of the XSLT transformation, for which you can
select a file extension.

The file type selected here determines the file type of the output format for XML or XSLT files
that belong to a project for which XSLT transformation properties have been defined.

7.3.4 Starting a Debugging Session


The simplest way to start a debugging session is to start one from an XSLT, XQuery, or XML
file. If the required associated file (see Table of associated files) has already been assigned to
the active file, then the debugging session is started immediately. Otherwise you are prompted
to select the required associated file. Since XQuery files neither require nor contain an XML file
association, you can choose to be prompted for an optional XML file association each time you
start an XQuery debugging session from an XQuery file, or to not be prompted.

Predefined associations
Predefined associations are relevant only for XSLT debugging sessions, and refer to cases in
which the associated file assignment is already present in the active file. To make an
assignment in an XML or XSLT file, do the following:
 In XML files: Open the file, click XSL/XQuery | Assign XSL, and select the XSLT file.
 In XSLT files: Open the file, click XSL/XQuery | Assign sample XML file..., and select
the XML file.

When you click XSL/XQuery | Start Debugger/Go, the debugging session is started directly,
i.e. without you being prompted for any file to associate with the active file.

© 2010 Altova GmbH User Manual


296 XSLT and XQuery XSLT and XQuery Debugger

Direct assignment
If no predefined association is present in the active file, you are prompted for an association.
When you select XSL/XQuery | Start Debugger/Go, the following happens:
 For XML files: You are prompted to select an XSLT or XQuery file.
 For XSLT files: You are prompted to select an XML file.
 For XQuery files: You are given the option of selecting an XML file, which you can skip.

(The dialog shown in the screenshot appears when you start a debugging session from
an XQuery file.)

After you select the required associated file or skip an optional association, the debugging
session is started.

Alternative method of file association


In the Project Properties dialog, you can make predefined associations. Click Project | Project
properties, and assign the required files by clicking the Use this XSL / Use this XML check
box.

Debugger View
The XSLT and XQuery Debugger works only in Text View and Enhanced Grid View. If either
your XML or XSLT file is open in some other view than Text or Grid View, or if an SPS file is
associated with an XML file, the following dialog pops up when you start a debugging session
involving one of these files.

Clicking OK causes the document to open in Text View. Note that XQuery files are always
displayed in Text View.

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Debugger 297

7.3.5 Information Windows


Information windows that are opened in the XSLT and XQuery Debugger interface during a
debugging session contain information about various aspects of the XSLT transformation or
XQuery execution. This information is important in helping you debug your XSLT and XQuery
files.

There are eight information windows in XSLT debugging sessions and five information windows
in XQuery debugging sessions. These windows are organized into two groups by default, which
are located at the bottom of the XSLT and XQuery Debugger interface (see illustration below).
These windows and the information they display are described in detail in this section.

The default layout of the XSLT and XQuery Debugger interface.

The first group of information windows displays the following windows as tabs in a single
window:
 Context (for XSLT debugging sessions only)
 Variables
 XPath-Watch

The second group of information windows displays the following windows as tabs in a single
window
 Call Stack
 Messages
 Templates (for XSLT debugging sessions only)
 Info
 Trace

In the default layout, therefore, there are two window groups, each having tabs for the different
windows in them. One tab is active at a time. So, for example, to display information about
Variables in the first information window group, click the Variables tab. This causes the
Variables information window to be displayed and the Context and XPath-Watch information
windows to be hidden. Note that in some tabs, you can use the information display as
navigation tools: clicking an item can take you to that item in the XML, XSLT, or XQuery file.
See the documentation of the respective information windows (Context, Call Stack, Templates)

© 2010 Altova GmbH User Manual


298 XSLT and XQuery XSLT and XQuery Debugger

for details.

The two information window groups can be resized by dragging their borders. Individual
windows can be dragged out of the containing group by clicking the tab name and dragging the
window out of the group. A window can be added to a group by dragging its title bar onto the
title bar of the group. Note that there is no reset button to return the layout to the default layout.

Context Window
The Context Window is available in XSLT debugging sessions only; it is not available in XQuery
debugging sessions.

During the processing of the XSLT stylesheet, the processor's context is always within a
template that matches some sequence (of nodes or atomic values). The Context Window
displays the current processing context, which could be a sequence of nodes, a single node, or
an atomic value (such as a string). Depending on the kind of a context item, its value or
attribute/s is/are displayed. For example, if the context item is an element, the element's
attributes are displayed. If the context item is an attribute or text node, the node's value is
displayed.

Clicking an entry in the Context Window, displays that item in the XML document. If the XML
document is not currently displayed in the interface, a window for the XML document will be
opened.

Variables Window
The Variables Window is available in XSLT and XQuery debugging sessions. It displays the
variables and parameters that are used in the XSLT/XQuery document when they are in scope,
and their values.

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Debugger 299

Parameters are indicated with P, global variables (declared at top-level of a stylesheet) are
indicated with G, and local variables (declared within an XSLT template) are indicated with L.
The type of the values of variables and parameters is also indicated by icons in the Value field.
The following types are distinguished: Node Set, Node Fragment, String, Number, and Boolean.

XPath-Watch Window
The XPath-Watch Window is available in XSLT and XQuery debugging sessions.

It enables you to enter XPath expressions that you wish to evaluate in one or more contexts. As
you step through the XSLT document, the XPath expression is evaluated in the current context
and the result is displayed in the Value column.

To enter an XPath expression, double-click in the text field under the Name column and enter
the XPath. Alternatively, drag an XPath expression from a file and drop it into the XPath-Watch
Window. Use expressions that are correct according to the XPath version that corresponds to
the XSLT version of the XSLT stylesheet (XPath 1.0 for XSLT 1.0, and XPath 2.0 for XSLT 2.0).

Please note: If namespaces have been used in the XML file or XSLT file, you must use the
correct namespace prefixes in your XPath expressions.

Call Stack Window


The Call Stack Window is displayed in XSLT and XQuery debugging sessions.

The Call Stack Window displays a list of previously processed XSLT templates and instructions,
with the current template/instruction appearing at the top of the list.

Clicking an entry in this window, causes the selected XSLT template/instruction to be displayed
in the XSLT document window. Clicking a template/instruction that references a built-in
template highlights the built-in template in a separate window that displays all built-in templates.

© 2010 Altova GmbH User Manual


300 XSLT and XQuery XSLT and XQuery Debugger

Messages Window
The Messages Window is displayed in XSLT and XQuery debugging sessions.

XSLT 1.0 and XSLT 2.0


In XSLT debugging sessions, the Messages tab displays error messages, the xsl:message
instruction(s), or any error messages that may occur during debugging.

XQuery
In XQuery debugging sessions, the Messages Window displays error messages.

Templates Window
The Templates Window (see screenshot) is available in XSLT debugging sessions only; it is not
available in XQuery debugging sessions.

The Templates Window displays the various templates used in the XSLT stylesheet, including
built-in templates and named templates. Matched templates are listed by the nodes they match.
Named templates are listed by their name. For both types of template, the mode, priority, and
location of the template are displayed.

In the screenshot above, there are three matched templates in the XSLT stylesheet: a template
which matches the document node /, and templates that match the n1:italic and n1:bold
nodes. All the other templates are built-in templates (indicated with no entry in the Location
field).

Clicking an entry in this window, causes the template to be highlighted in the XSLT document
window. If you click a built-in template, the template is highlighted in a separate window that
displays all the built-in templates.

Info Window
The Info Window is available in XSLT and XQuery debugging sessions. It provides meta
information about the current debugging session. This information includes what debugger is
being used, the names of the source and output documents, and the status of the debugger.

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Debugger 301

Trace Window
The Trace Window is displayed in XSLT and XQuery debugging sessions.

The Trace Window contains the element the tracepoint is set for, its location in the XSLT
stylesheet and the result generated when that element is executed. Click on a row in the left
side of the window to display the full result on the right.

Arranging the Info Windows


The Information Windows can be arranged inside the XSLT and XQuery Debugger interface.
Windows can be docked in the interface, can float in it, and can be arranged as a collection of
panes in a window. You can use the following mechanisms to arrange the windows.

Menu
In the XSL/XQuery menu, placing the cursor over the item Debug Windows pops up the list of
Info Windows. You can hide or show individual windows by clicking the window.

This toggles the display of the window on and off.

Context Menu
The context menu can be accessed by right-clicking a window tab or title bar.

© 2010 Altova GmbH User Manual


302 XSLT and XQuery XSLT and XQuery Debugger

Click the required option to cause that window to float, be docked or be hidden.

Drag-and-drop
You can drag a window by its tab or title bar and place it at a desired location.

Additionally, you can dock the window in another window or in the interface using placement
controls that appear when you drag a window:

 When you drag a window over another window, a circular placement control appears (
see screenshot below). This control is divided into five placement sectors. Releasing
the mouse key on any of these sectors docks the dragged window into the respective
sector of the target window. The four arrow sectors dock the dragged window into the
respective sides of the target window. The center button docks the dragged window as
a tab of the target window. You can also dock a window as a tab in another window by
dragging it to the tab bar and dropping it there.

 When you drag a window, a placement control consisting of four arrows appears. Each
arrow corresponds to one side of the Debugger interface. Releasing a dragged
window over one of these arrows docks the dragged window into one side of the
Debugger interface.

You can also double-click the title bar of a window to toggle it between its docked and floating
positions.

7.3.6 Breakpoints
The XSLT and XQuery Debugger enables you to define breakpoints in XSLT, XQuery, and XML
documents. Breakpoints are displayed as a dashed red line (shown in the screenshot below).

Please note: It is possible to set a tracepoint and a breakpoint for the same instruction. This
appears as a dashed blue and red line (see screenshot).

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Debugger 303

When you start the debugger within a debugging session, the debugging will pause at each
encountered breakpoint. In this way, you can identify specific areas to debug, and restrict
attention to these areas in either the XSLT, XQuery, and/or XML documents. You can set any
number of breakpoints.

Please note: Breakpoints set for a document remain in that document until it is closed.
However, if you switch to Schema View (for example, in the case of XSD documents), then the
breakpoints are deleted; when you switch back to Text View or Grid View (from Schema View),
there will be no breakpoint.

Breakpoints in XML documents


You can set breakpoints on any node in an XML document. The break in processing will occur
at the start of that node.

Breakpoints in XSLT documents


You can set breakpoints at the following points in an XSLT document:
 At the beginning of templates and template instructions (e.g., xsl:for-each).
 On an XPath expression (XPath 1.0 or XPath 2.0).
 On any node in a literally constructed XML fragment. The break in processing will occur
at the start of that node.

Breakpoints in XQuery documents


You can set breakpoints at the following points in an XQuery document:
 At the beginning of XQuery statements.
 In an XQuery expression.
 On any node in a literally constructed XML fragment. The break in processing will occur
at the start of that node.

Inserting/removing breakpoints
To insert a breakpoint:
1. Place the cursor at the point in the document where you wish to insert the breakpoint (
see paragraphs above). In XSLT debugging sessions, you can set breakpoints in both
Text View and Grid View. XQuery debugging sessions are available only in Text View.
2. Do one of the following:
 Select XSL/XQuery | Insert/Remove Breakpoint.
 Press F9.

© 2010 Altova GmbH User Manual


304 XSLT and XQuery XSLT and XQuery Debugger

 Right-click and select Insert/Remove Breakpoint.

To remove a breakpoint:
1. Place the cursor at the point in the document containing the breakpoint.
2. Do one of the following:
 Select XSL/XQuery | Insert/Remove Breakpoint.
 Press F9.
 Right-click and select Insert/Remove Breakpoint.

Alternatively, you can use the Breakpoints dialog to remove a breakpoint:


1. Select the menu option XSL/XQuery | Breakpoints....
2. Click the breakpoint in the dialog box and click Remove.

The Remove All button deletes all the breakpoints from the dialog box (and all XSLT
stylesheets).

Disabling/enabling breakpoints:
After inserting breakpoints, you can disable them if you wish to skip over breakpoints without
having to delete them. You can enable them again when necessary.

To disable a breakpoint:
1. Place the cursor in the node or expression containing the breakpoint.
2. Select XSL/XQuery | Enable/Disable Breakpoint (or press Ctrl+F9). The breakpoint
changes from red to gray, indicating that it has been disabled.

Alternatively, you can use the Breakpoints dialog to disable a breakpoint:


1. Select the menu option XSL/XQuery | Breakpoints/Tracepoint.... This opens the
XSLT Breakpoints / Tracepoints dialog box which displays the currently defined
breakpoints in all open XML source and XSLT stylesheet documents.

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Debugger 305

2. Remove the check mark of the breakpoints you wish to disable, and click OK to
confirm. The breakpoint changes from red to gray, indicating that it has been disabled.

To enable a breakpoint:

1. Place the cursor in the node or expression containing the breakpoint.


2. Select XSL/XQuery | Enable/Disable Breakpoint (or press Ctrl+F9). The breakpoint
changes from gray to red, indicating that it has been enabled.

Finding a specific breakpoint


To find a specific breakpoint:
1. Select the menu option XSL/XQuery | Breakpoints/Tracepoints.... The XSLT
Breakpoints / Tracepoints dialog appears.
2. Click the required breakpoint in the breakpoint list.
3. Click the Edit Code button. The Breakpoints dialog box is closed and the text cursor is
placed directly in front of the breakpoint in Text view. In the Enhanced Grid view, the
table cell containing the breakpoint is highlighted in red.

Continuing debugging after a breakpoint


To continue debugging after a breakpoint:

 Select the XSL/XQuery | Step into or XSL/XQuery | Start Debugger/Go command.

7.3.7 Tracepoints
The XSLT and XQuery Debugger enables you to define tracepoints in XSLT documents.

Tracepoints allow you to trace content generated by an instruction or view the result of an XPath

© 2010 Altova GmbH User Manual


306 XSLT and XQuery XSLT and XQuery Debugger

expression at the point where the tracepoint is set without having to edit the XSLT stylesheet,
for example, using the xsl:message element to output debugging messages.

Tracepoints are displayed as a dashed blue line in XSLT stylesheets (shown in the screenshot
below).

Please note: It is possible to set a tracepoint and a breakpoint for the same instruction. This
appears as a dashed blue and red line (see screenshot).

The debugger outputs the content generated by each instruction that has a tracepoint set for it.
This output is visible in the Trace window. You can set any number of tracepoints in an XSLT
stylesheet.

Please note: Tracepoints set for a document remain in that document until it is closed.

Tracepoints in XSLT documents


You can set tracepoints on XSL instructions and literal results in an XSLT stylesheet.

Tracepoints in XML and XQuery documents


You can set tracepoints in XML and XQuery documents, however, these tracepoints have no
effect.

Inserting/removing tracepoints
To insert a tracepoint:
1. Place the cursor at the point in the XSLT document where you wish to insert the
tracepoint. During debugging sessions, you can set tracepoints in both Text View and
Grid View.
2. Do one of the following:

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Debugger 307

 Select XSL/XQuery | Insert/Remove Tracepoint.


 Press Shift+F9.
 Right-click and select Insert/Remove Tracepoint.

To remove a tracepoint:
1. Place the cursor at the point in the XSLT document containing the tracepoint.
2. Do one of the following:
 Select XSL/XQuery | Insert/Remove Tracepoint.
 Press Shift+F9.
 Right-click and select Insert/Remove Tracepoint.

Alternatively, you can use the XSLT Breakpoints / Tracepoints dialog to remove a tracepoint:
1. Select the menu option XSL/XQuery | Breakpoints/Tracepoints....
2. Click the tracepoint in the dialog box (see screenshot) and click Remove.

The Remove All button in the Tracepoints pane deletes all the tracepoints from the dialog box
(and from all XSLT stylesheets).

Setting an XPath for a tracepoint


You can set an XPath for a tracepoint. When you set an XPath for a tracepoint, the result of the
evaluation of the XPath is displayed in the Trace window instead of the content generated by
the statement for which the tracepoint is set. The XPath is evaluated relatively to the context
node at the point where the tracepoint is set.

To set an XPath for a tracepoint:


1. Select the menu option XSL/XQuery | Breakpoints/Tracepoints.... This opens the
XSLT Breakpoints / Tracepoints dialog box which displays the currently defined
tracepoints in all open XSLT stylesheet documents.
2. Enter the XPath in the XPath column in the row that corresponds to the tracepoint.

© 2010 Altova GmbH User Manual


308 XSLT and XQuery XSLT and XQuery Debugger

Example:
The following example uses the file OrgChart.xsl, which is found in the XMLSpy Examples
folder.
The tracepoint is set such that the context node is Person. The Person element contains a
Shares element. We want to display the number of shares that each person has, multiplied by
125 (the value of each share).

Do the following:
1. Open the file OrgChart.xsl.
2. Set a tracepoint at line 555.
3. Open the XSLT Breakpoints / Tracepoints dialog and enter the XPath
n1:Shares*125.00 for the tracepoint you just set.

4. Start the Debugger. The results of the XPath you entered for the tracepoint appear in
the Trace window.

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Debugger 309

The Trace window


Select XSL/XQuery | Start Debugger/Go to start debugging. The output of instructions for
which tracepoints are set is displayed in the Trace window (see screenshot). Click a row in the
Trace window to display the full result of that statement in the right side of the dialog (see
screenshot).

Please note: Results are displayed in the Trace window only after the traced instruction is
completed.

Disabling/enabling tracepoints
After inserting tracepoints, you can disable them if you wish to skip over them without having to
delete them. You can enable them again when necessary.

To disable a tracepoint:
1. Place the cursor at the point in the XSLT stylesheet containing the tracepoint.
2. Select XSL/XQuery | Enable/Disable Tracepoint (or press Ctrl+Shift+F9). The
tracepoint changes from blue to gray, indicating that it has been disabled.

Alternatively, you can use the XSLT Breakpoints / Tracepoints dialog to disable a tracepoint:
1. Select the menu option XSL/XQuery | Breakpoints/Tracepoints.... This opens the
XSLT Breakpoints / Tracepoints dialog box which displays the currently defined
tracepoints in all open XSLT stylesheet documents.

© 2010 Altova GmbH User Manual


310 XSLT and XQuery XSLT and XQuery Debugger

2. Remove the check mark of each tracepoint you wish to disable, and click OK to
confirm. The tracepoints change from blue to gray, indicating that they have been
disabled.

To enable a tracepoint:
1. Place the cursor at the point in the XSLT document containing the tracepoint.
2. Select XSL/XQuery | Enable/Disable Tracepoint (or press Ctrl+Shift+F9). The
tracepoint changes from gray to blue, indicating that it has been enabled.

Finding a specific tracepoint


To find a specific tracepoint:
1. Select the menu option XSL/XQuery | Breakpoints/Tracepoints.... The XSLT
Breakpoints / Tracepoints dialog appears.
2. Click the required tracepoint in the tracepoint list.
3. Click the Edit Code button. The XSLT Breakpoints / Tracepoints dialog box is closed
and the text cursor is placed directly in front of the tracepoint in Text view of the XSLT
document. In Enhanced Grid view, the table cell containing the tracepoint is highlighted
in blue.

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Profiler 311

7.4 XSLT and XQuery Profiler


Altova website: XSLT Profiler, XQuery Profiler

The XSLT/XQuery Profiler is a tool that is used to analyze the execution times of XSLT (1.0 and
2.0) stylesheets and XQuery documents from within XMLSpy. It tells you how much time each
instruction in the XSLT stylesheet or XQuery document takes to execute, and you can use this
information to optimize the execution time of these files.

The Profiler is used to find the instructions that have the highest total execution time so that this
information can then be used to optimize these instructions. Instructions can have a high total
execution time for one or both of the following reasons:
 the instruction is time-intensive
 the instruction is evaluated often (high hit count)

Hitcount and Callgraph Profiling


The Profiler lets you choose between hitcount and callgraph profiling. Both types of profiling
show execution time statistics for each instruction.
For optimization purposes, you normally use hitcount profiling, which displays one line in the
profiler for each instruction.
Callgraph profiling shows the entire execution history of an XSLT transformation or XQuery
execution, i.e., which templates/functions were called, and in which order, during the
transformation. In the results of callgraph profiling, there is one line for each time an instruction
is called, rather than one line for each instruction.

To use the XSLT/XQuery Profiler, see Analyzing XSLT Transformations or Analyzing XQuery
Execution.

Profiler Views
The results of the analysis can be viewed in either of the following views by clicking the
corresponding tab:
 List View: The profiling statistics are displayed as a list that can be sorted by, e.g.,
duration of instruction execution or duration of execution of the instruction and its
descendants.

 Tree View: The statistics are displayed in a tree-like structure. It is possible to see, e.g.,
how long a function took to execute, and then expand the tree for that function and see

© 2010 Altova GmbH User Manual


312 XSLT and XQuery XSLT and XQuery Profiler

how much time each instruction in the function took to execute, and how many times it
was executed.

Sorting Results
After you have run the Profiler, you can sort by the amount of time an instruction took to
execute, or by the number of times that instruction was called.
To sort information in the Profiler:
1. Click the List tab.
2. Click the column header of the column you want to sort by (e.g., Hit Count to sort by
the number of times an instruction was called or Duration to sort by the time the
instruction takes to execute).
This screenshot shows the contents of the Profiler sorted by instruction duration in descending
order.

Optimizing Your XSLT Stylesheets and XQuery Documents


Keep in mind the following guidelines when optimizing the execution time of instructions in
XSLT stylesheets and XQuery documents:
 Avoid using variables in an instruction if the variable is used only once, because
initializing a variable can be time-consuming.

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Profiler 313

The following XSLT code fragments show an example of how to optimize code by
removing unnecessary variables. Both do the same thing, but the second example does
so without using the variables name and containsResult:
Code fragment 1:
<xsl:for-each select="row">
<xsl:variable name="row" select="."/>
<xsl:for-each select="@name">
<xsl:variable name="name" select="."/>
<xsl:variable name="containsResult" select="fn:contains
($name, '.exe')"/>
<xsl:if test="string($containsResult)='true'">

...

</xsl:if>
</xsl:for-each>
</xsl:for-each>

The screenshot below shows the results of the analysis of the file that contains this
code fragment, sorted by duration of instructions. The instruction in which the variable
containsResult is initialized needs about 19 seconds total execution time.

The screenshot below shows the results in the tree view. Here we can see that the if-statement
that uses the variable containsResult needs about 50 seconds total execution time:

© 2010 Altova GmbH User Manual


314 XSLT and XQuery XSLT and XQuery Profiler

The XSLT tranformation takes a total of about 74 seconds:

Code fragment 2:
<xsl:for-each select="row">
<xsl:variable name="row" select="."/>
<xsl:for-each select="@name">
<xsl:if test="fn:contains(., '.exe')">

...

</xsl:if>
</xsl:for-each>
</xsl:for-each>

After the stylesheet is rewritten without using these variables, its total execution time is
only about 4.3 seconds:

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Profiler 315

 Use variables if a value or expression is used repeatedly.


 Avoid creating local constant variables within a function; create global variables instead.
 Avoid creating constant tree fragments inside a function; create them globally instead.
 Limit your use of predicates, since filtering with predicates is evaluated separately for
every node. You can reduce the number of calls to predicates, for example, by
prefiltering using names. In this example, * is used with two predicates:
//*[node-name()=Book][author="Steve"]
In this equivalent statement, the name Book and only one predicate are used:
//Book[@Author="Steve"]
 Split up instructions such that parts of the instruction that only need to be executed
once are only executed once. Create global variables from parts that are only
dependent on the global context.

7.4.1 XSLT Profiling


Starting the Profiler

Please note: Execution time results displayed in the Profiler may be influenced by other
applications that are running on your computer. When analyzing files using the Profiler, it is best
to run only the XMLSpy application.

To analyze an XSLT stylesheet:


1. In XMLSpy, open the XML file that will be used as input data for the XSLT
transformation.
2. Activate the Profiler by selecting XSL/XQuery | Enable XSLT / XQuery profiling. A
dialog opens.

3. Select Hitcount Profiling or Callgraph Profiling. Click OK to confirm. An empty


Profiler window appears.
4. Run the XSL transformation (XSL/XQuery | XSL Transformation). A dialog opens in
which you select the path to the XSLT stylesheet you want to analyze. When the
transformation is finished, the execution time statistics appear in the Profiler.
5. Click the "+" icons to expand rows in the Profiler to view the execution time statistics for
the XSLT stylesheet (see screenshot). Note that in the case of these screenshots,
Hitcount Profiling was selected.

© 2010 Altova GmbH User Manual


316 XSLT and XQuery XSLT and XQuery Profiler

Click on a row in the Profiler to highlight the corresponding instruction in the file that was
analyzed.

The following screenshot shows the Tree View in the Profiler:

The following screenshot shows List View in the Profiler for the same XSLT stylesheet:

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Profiler 317

Using the Information in the Profiler


The Profiler displays the following information about each instruction in the XSLT stylesheet:
 Index: A number assigned to each instruction in the order in which the instruction was
called.
 Name: The name of the XSLT instruction.
 Hit Count: The total number of times the instruction was called during the
transformation.
 Duration (ms) and %: The number of milliseconds that the instruction took to execute
without taking the execution time of its descendants into account, and the percentage of
the total execution time.
 Descendants (ms): The number of milliseconds that the descendents of the instruction
took to execute.

© 2010 Altova GmbH User Manual


318 XSLT and XQuery XSLT and XQuery Profiler

 Descendants and Self and %: The number of milliseconds that the instruction and its
descendants took to execute, and the percentage of the total execution time.
 XPath: If the instruction contains an XPath statement, this column contains the time it
took that statement to execute.

Please note: When using hitcount profiling, the times in the Profiler window are the sum total of
execution time for all the hits to the instruction. When using callgraph profiling, because each
call of the instruction is listed separately, the times shown in the Profiler window are the duration
of a single execution of the instruction.

7.4.2 XQuery Profiling


Starting the Profiler

Please note: Execution time results displayed in the Profiler may be influenced by other
applications that are running on your computer. When analyzing files using the Profiler, it is best
to run only the XMLSpy application.

To analyze an XQuery document:


1. In XMLSpy, open the XQuery document that you want to analyze.
2. Activate the Profiler by selecting XSL/XQuery | Enable XSLT 2 / XQuery profiling. A
dialog opens.

3. Select Hitcount Profiling or Callgraph Profiling. Click OK to confirm. An empty


Profiler window appears.
4. Execute the XQuery (XSL/XQuery | XQuery Execution). When execution is finished,
the execution time statistics appear in the Profiler.
5. Click the "+" icons to expand rows in the Profiler to view the execution time statistics for
the instructions in the XQuery document (see screenshot). Note that in the case of
these screenshots, Hitcount Profiling was selected.

Click on a row in the Profiler to highlight the corresponding instruction in the file that was
analyzed.

The following screenshot shows the Tree View in the Profiler:

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Profiler 319

© 2010 Altova GmbH User Manual


320 XSLT and XQuery XSLT and XQuery Profiler

The following screenshot shows List View in the Profiler for the same XQuery document:

Using the Information in the Profiler


The Profiler displays the following information about each instruction in the XQuery document:
 Index: A number assigned to each instruction in the order in which the instruction was
called.
 Name: The name of the XQuery instruction.
 Info: Information about the instruction. For example, if the instruction is a variable
declaration, this column contains the name of the variable and its value; if it is a
function, then this contains the name and parameters of the function.
 Hit Count: The total number of times the instruction was called during execution.

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Profiler 321

 Duration (ms) and %: The number of milliseconds that the instruction took to execute
without taking the execution time of its descendants into account, and the percentage of
the total execution time.
 Descendants and Self (ms) and %: The total time spent executing the instruction and
its descendants, and the percentage of the total execution time.

Please note: When using hitcount profiling, the times in the Profiler window are the sum total of
execution time for all the hits to the instruction. When using callgraph profiling, because each
call of the instruction is listed separately, the times shown in the Profiler window are the duration
of a single execution of the instruction.

7.4.3 Profiler Charts


After running the XSLT/XQuery Profiler, a chart of the results or a subset of the results can be
generated. In the Profiler window (see screenshot below), click the Chart button to generate the
chart in the Charts output window (see screenshot below).

© 2010 Altova GmbH User Manual


322 XSLT and XQuery XSLT and XQuery Profiler

Note the following points:


 In the Profiler window (Tree View or List View), a subset of the results can be selected
by marking them. Click with the Ctrl and/or Shift keys to mark multiple items. In List
View the results can be sorted on the basis of a column's values by clicking on that
column's header. This can be useful, for example, for ordering result items according to
the most time-intensive items and then selecting a subset that takes up most of the
transformation time. By selecting subsets unwanted result items can be filtered out. In
the screenshot above, the highlighted result items have been selected.
 After a chart has been created its type (pie chart, bar chart, line chart, etc) can be
changed by clicking the Change Type button of the Charts output window. The various
types of charts are described in detail in the Charts section of the documentation.

Altova XMLSpy 2011 © 2010 Altova GmbH


XSLT and XQuery XSLT and XQuery Profiler 323

 Clicking the Select Data button of the Charts output window pops up the Select Data
dialog (screenshot below). In this dialog, you can select data for the X-Axis and Y-Axis
from the data table that is produced by the Select Columns process. To select data for
the X-Axis click in the Axis Values text box and then either enter the range of table
values (for example, A1:A7) or drag the cursor from the start of the range to the end of
the range. Do the same for the Y-Axis.

Clicking the Select Columns button enables you to change the data selection for the
data table. See the Source XPath, X-Axis Selection, and Y-Axis Selection for
information about how column selection works.

For more detailed information about charts see the Charts section of the documentation.

© 2010 Altova GmbH User Manual


324 Authentic

8 Authentic
Authentic View (screenshot below) is a graphical representation of your XML document. It
enables XML documents to be displayed without markup and with appropriate formatting and
data-entry features such as input fields, combo boxes, and radio buttons. Data that the user
enters in Authentic View is entered into the XML file.

To be able to view and edit an XML document in Authentic View, the XML document must be
associated with a StyleVision Power Stylesheet (SPS), which is created in Altova's
StyleVision product. An SPS (.sps file) is, in essence, an XSLT stylesheet. It specifies an
output presentation for an XML file that can include data-entry mechanisms. Authentic View
users can, therefore, write data back to the XML file or DB. An SPS is based on a schema and
is specific to it. If you wish to use an SPS to edit an XML file in Authentic View, you must use
one that is based on the same schema as that on which the XML file is based.

Using Authentic View


 If an XML file is open, you can switch to Authentic View by clicking the Authentic button
at the bottom of the Main Window. If an SPS is not already assigned to the XML file,
you will be prompted to assign one to it. You must use an SPS that is based on the
same schema as the XML file.
 A new XML file is created and displayed in Authentic View by selecting the File | New
command and then clicking the "Select a StyleVision Stylesheet" button. This new file is
a template file associated with the SPS you open. It can have a variable amount of
starting data already present in it. This starting data is contained in an XML file (a
Template XML File) that may optionally be associated with the SPS. After the Authentic
View of an XML file is displayed, you can enter data in it and save the file.

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic 325

In this section
This section contains an Authentic View tutorial, which shows you how to use Authentic View. It
is followed by the section, Editing in Authentic View, which explains individual editing features in
detail.

More information about Authentic View


For more information about Authentic View information, see (i) the section Editing Views |
Authentic View in this documentation, which describes the Authentic View editing window, and
(ii) the Authentic menu section of the User Reference part of this documentation.

© 2010 Altova GmbH User Manual


326 Authentic Authentic View Tutorial

8.1 Authentic View Tutorial


In Authentic View, you can edit XML documents in a graphical WYSIWYG interface (screenshot
below), just like in word-processor applications such as Microsoft Word. In fact, all you need to
do is enter data. You do not have to concern yourself with the formatting of the document, since
the formatting is already defined in the stylesheet that controls the Authentic View of the XML
document. The stylesheet (StyleVision Power Stylesheet, shortened to SPS in this tutorial) is
created by a stylesheet designer using Altova's StyleVision product.

Editing an XML document in Authentic View involves two user actions: (i) editing the structure of
the document (for example, adding or deleting document parts, such as paragraphs and
headlines); and (ii) entering data (the content of document parts).

This tutorial takes you through the following steps:


 Opening an XML document in Authentic View. The key requirement for Authentic View
editing is that the XML document be associated with an SPS file.
 A look at the Authentic View interface and a broad description of the central editing
mechanisms.
 Editing document structure by inserting and deleting nodes.
 Entering data in the XML document.
 Entering (i) attribute values via the Attributes entry helper, and (ii) entity values.
 Printing the document.

Remember that this tutorial is intended to get you started, and has intentionally been kept
simple. You will find additional reference material and feature descriptions in the Authentic View
interface section.

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Authentic View Tutorial 327

Tutorial requirements
All the files you need for the tutorial are in the C:\Documents and Settings\<username>\My
Documents\Altova\<ProductName>\Examples folder of your Altova application folder. These
files are:
 NanonullOrg.xml (the XML document you will open)
 NanonullOrg.sps (the StyleVision Power Stylesheet to which the XML document is
linked)
 NanonullOrg.xsd (the XML Schema on which the XML document and StyleVision
Power Stylesheet are based, and to which they are linked)
 nanonull.gif and Altova_right_300.gif (two image files used in the tutorial)

Please note: At some points in the tutorial, we ask you to look at the XML text of the XML
document (as opposed to the Authentic View of the document). If the Altova product edition you
are using does not include a Text View (as with Authentic Desktop and Authentic Browser), then
use a plain text editor like Wordpad or Notepad to view the text of the XML document.

Caution: We recommend that you use a copy of NanonullOrg.xml for the tutorial, so that
you can always retrieve the original should the need arise.

8.1.1 Opening an XML Document in Authentic View


In Authentic View, you can edit an existing XML document or create and edit a new XML
document. In this tutorial, you will open an existing XML document in Authentic View (described
in this section) and learn how you can edit it (subsequent sections). Additionally in this section is
a description of how a new XML document can be created for editing in Authentic View.

Opening an existing XML document


The file you will open is NanonullOrg.xml. It is in the Examples folder of your Altova
application. You can open NanonullOrg.xml in one of two ways:
 Click File | Open in your Altova product, then browse for NanonullOrg.xml in the
dialog that appears, and click Open.
 Use Windows Explorer to locate the file, right-click, and select your Altova product as
the application with which to open the file.

The file NanonullOrg.xml opens directly in Authentic View (screenshot below). This is
because
1. The file already has a StyleVision Power Stylesheet (SPS) assigned to it, and
2. In the Options dialog (Tools | Options), in the View tab, the option to open XML files in
Authentic View if an SPS file is assigned has been checked. (Otherwise the file would
open in Text View.)

© 2010 Altova GmbH User Manual


328 Authentic Authentic View Tutorial

Remember: It is the SPS that defines and controls how an XML document is displayed in
Authentic View. Without an SPS, there can be no Authentic View of the document.

Creating a new XML document based on an SPS


You can also create a new XML document that is based on an SPS. You can do this in two
ways: via the File | New menu command and via the Authentic | New Document menu
command. In both cases an SPS is selected.

Via File | New


1. Select File | New, and, in the Create a New Document dialog, select XML as the new
file type to create.
2. Click Select a STYLEVISION Stylesheet, and browse for the desired SPS.

Via Authentic | Create New Document


1. Select Authentic | New Document.
2. In the Create a New Document dialog, browse for the desired SPS.

If a Template XML File has been assigned to the SPS, then the data in the Template XML File
is used as the starting data of the XML document template that is created in Authentic View.

8.1.2 The Authentic View Interface


The Authentic View editing interface consists of a main window in which you enter and edit the
document data, and three entry helpers. Editing a document is simple. If you wish to see the
markup of the document, switch on the markup tags. Then start typing in the content of your
document. To modify the document structure, you can use either the context menu or the
Elements entry helper.

Displaying XML node tags (document markup)


An XML document is essentially a hierarchy of nodes. For example:
<DocumentRoot>
<Person id="ABC001">
<Name>Alpha Beta</Name>
<Address>Some Address</Address>
<Tel>1234567</Tel>
</Person>

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Authentic View Tutorial 329

</DocumentRoot>

By default, the node tags are not displayed in Authentic View. You can switch on the node tags
by selecting the menu item Authentic | Show Large Markup (or the toolbar icon). Large
markup tags contain the names of the respective nodes. Alternatively, you can select small
markup (no node names in tags) and mixed markup (a mixture of large, small, and no markup
tags, which is defined by the designer of the stylesheet; the default mixed markup for the
document is no markup).

You can view the text of the XML document in the Text View of your Altova product or in a text
editor.

Entry helpers
There are three entry helpers in the interface (screenshot below), located by default along the
right edge of the application window. These are the Elements, Attributes, and Entity entry
helpers.

Elements entry helper: The Elements entry helper displays elements that can be inserted and
removed with reference to the current location of the cursor or selection in the Main Window.

© 2010 Altova GmbH User Manual


330 Authentic Authentic View Tutorial

Note that the entry helper is context-sensitive; its content changes according to the location of
the cursor or selection. The content of the entry helper can be changed in one other way: when
another node is selected in the XML tree of the Elements entry helper, the elements relevant to
that node are displayed in the entry helper. The Elements entry helper can be expanded to
show the XML tree by checking the Show XML Tree check box at the top of the entry helper (
see screenshot above). The XML tree shows the hierarchy of nodes from the top-level element
node all the way down to the node selected in the Main Window.

Attributes entry helper: The Attributes entry helper displays the attributes of the element
selected in the Main Window, and the values of these attributes. Attribute values can be entered
or edited in the Attributes entry helper. Element nodes from the top-level element down to the
selected element are available for selection in the combo box of the Atributes entry helper.
Selecting an element from the dropdown list oft he combo box causes that element's attributes
to be displayed in the entry helper, where they can then be edited.

Entities entry helper: The Entities entry helper is not context-sensitive, and displays all the
entities declared for the document. Double-clicking an entity inserts it at the cursor location.
How to add entities for a document is described in the section Authentic View Interface.

Context menu
Right-clicking at a location in the Authentic View document pops up a context menu relevant to
that (node) location. The context menu provides commands that enable you to:
 Insert nodes at that location or before or after the selected node. Submenus display
lists of nodes that are allowed at the respective insert locations.
 Remove the selected node (if this allowed by the schema) or any removable ancestor
element. The nodes that may be removed (according to the schema) are listed in a
submenu.
 Insert entities and CDATA sections. The entities declared for the document are listed in
a submenu. CDATA sections can only be inserted withn text.
 Cut, copy, paste (including pasting as XML or text), and delete document content.

Note: For more details about the interface, see Authentic View Interface

8.1.3 Node Operations


There are two major types of nodes you will encounter in an Authentic View XML document:
element nodes and attribute nodes. These nodes are marked up with tags, which you can
switch on. There are also other nodes in the document, such as text nodes (which are not
marked up) and CDATA section nodes (which are marked up, in order to delimit them from
surrounding text).

The node operations described in this section refer only to element nodes and attribute nodes.
When trying out the operations described in this section, it is best to have large markup
switched on.

Note: It is important to remember that only same- or higher-level elements can be inserted
before or after the selected element. Same-level elements are siblings. Siblings of a
paragraph element would be other paragraph elements, but could also be lists, a table,
an image, etc. Siblings could occur before or after an element. Higher-level elements
are ancestor elements and siblings of ancestors. For a paragraph element, ancestor
elements could be a section, chapter, article, etc. A paragraph in a valid XML file would
already have ancestors. Therefore, adding a higher-level element in Authentic View,
creates the new element as a sibling of the relevant ancestor. For example, if a section

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Authentic View Tutorial 331

element is inserted after a paragraph, it is created as a sibling of the section that


contains the current paragraph element, and it is created as the last sibling section.

Carrying out node operations


Node operations can be carried out by selecting a command in the context menu or by clicking
the node operation entry in the Elements entry helper. In some cases, an element or attribute
can be added by clicking the Add Node link in the Authentic View of the document. In the
special cases of elements defined as paragraphs or list items, pressing the Enter key when
within such an element creates a new sibling element of that kind. This section also describes
how nodes can be created and deleted by using the Apply Element, Remove Node, and Clear
Element mechanisms.

Inserting elements
Elements can be inserted at the following locations:
 The cursor location within an element node. The elements available for insertion at that
location are listed in a submenu of the context menu's Insert command. In the
Elements entry helper, elements that can be inserted at a location are indicated with
the icon. In the NanonullOrg.xml document, place the cursor inside the para
element, and create bold and italic elements using both the context menu and
Elements entry helper.
 Before or after the selected element or any of its ancestors, if allowed by the schema. In
the first submenu that rolls out, you select the element (selected element or an
ancestor) before/after which you wish to insert the element. In the (second) submenu,
which now rolls out, you select the element you wish to insert. In the Elements entry
helper, elements that can be inserted before or after the selected element are indicated
with the and icons, respectively. Note that in the Elements entry helper, you can
insert elements before/after the selected element only; you cannot insert before/after an
ancestor element. Try out this command, by first placing the cursor inside the para
element and then inside the table listing the employees.

Add Node link


If an element or attribute is included in the document design, and is not present in the XML
document, an Add Node link is displayed at the location in the document where that node is
specified. To see this link, in the line with the text, Location of logo, select the @href node within
the CompanyLogo element and delete it (by pressing the Delete key). The add @href link
appears within the CompanyLogo element taht was edited (screenshot below). Clicking the link
adds the @href node to the XML document. The text box within the @href tags appears
because the design specifies that the @href node be added like this. You still have to enter the
value (or content) of the @href node. Enter the text nanonull.gif.

© 2010 Altova GmbH User Manual


332 Authentic Authentic View Tutorial

If the content model of an element is ambiguous, for example, if it specifies that a sequence of
child elements may appear in any order, then the add... link appears. Note that no node name
is specified. Clicking the link will pop up a list of elements that may validly be inserted.

Note: The Add Node link appears directly in the document template; there is no
corresponding entry in the context menu or Elements entry helper.

Creating new elements with the Enter key


In cases where an element has been formatted as a paragraph or list item (by the stylesheet
designer), pressing the Enter key when inside such a node causes a new node of that kind to
be inserted after the current node. You can try this mechanism in the NanonullOrg.xml
document by going to the end of a para node (just before its end tag) and pressing Enter.

Applying elements
In elements of mixed content (those which contain both text and child elements), some text
content can be selected and an allowed child element be applied to it. The selected text
becomes the content of the applied element. To apply elements, in the context menu, select
Apply and then select from among the applicable elements. (If no elements can be applied to
the selected text, then the Apply command does not appear in the context menu.) In the
Elements entry helper, elements that can be applied for a selection are indicated with the
icon. In the NanonullOrg.xml document, select text inside the mixed content para element and
experiment with applying the bold and italic elements.

The stylesheet designer might also have created a toolbar icon to apply an element. In the
NanonullOrg.xml document, the bold and italic elements can be applied by clicking the
bold and italic icons in the application's Authentic toolbar.

Removing nodes
A node can be removed if its removal does not render the document invalid. Removing a node
causes a node and all its contents to be deleted. A node can be removed using the Remove
command in the context menu. When the Remove command is highlighted, a submenu pops
up which contains all nodes that may be removed, starting from the selected node and going up
to the document's top-level node. To select a node for removal, the cursor can be placed within
the node, or the node (or part of it) can be highlighted. In the Elements entry helper, nodes that
can be removed are indicated with the icon. A removable node can also be removed by
selecting it and pressing the Delete key. In the NanonullOrg.xml document, experiment with
removing a few nodes using the mechanisms described. You can undo your changes with Ctrl
+Z.

Clearing elements
Element nodes that are children of elements with mixed content (both text and element
children) can be cleared. The entire element can be cleared when the node is selected or when
the cursor is placed inside the node as an insertion point. A text fragment within the element
can be cleared of the element markup by highlighting the text fragment. With the selection
made, select Clear in the context menu and then the element to clear. In the Elements entry
helper, elements that can be cleared for a particular selection are indicated with the icon
(insertion point selection) and icon (range selection). In the NanonullOrg.xml document, try
the clearing mechanism with the bold and italic child elements of para (which has mixed
content).

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Authentic View Tutorial 333

Tables and table structure


There are two types of Authentic View table:
 SPS tables (static and dynamic). The broad structure of SPS table is determined by the
stylesheet designer. Within this broad structure, teh only structural changes you are
allowed are content-driven. For example, you could add new rows to a dynamic SPS
table.
 XML tables, in which you decide to present the contents of a particular node (say, one
for person-specific details) as a table. If the stylesheet designer has enabled the
creation of this node as an XML table, then you can determine the structure of the table
and edit its contents. XML tables are discussed in detail in the Using tables in Authentic
View section.

8.1.4 Entering Data in Authentic View


Data is entered into the XML document directly in the main window of Authentic View.
Additionally for attributes, data (the value of the attribute) can be entered in the Attributes entry
helper. Data is entered (i) directly as text, or (ii) by selecting an option in a data-entry device,
which is then mapped to a predefined text entry.

Adding text content


You can enter element content and attribute values directly as text in the main window of
Authentic View. To insert content, place the cursor at the location where you want to insert the
text, and type. You can also copy text from the clipboard into the document. Content can also
be edited using standard editing mechanisms, such as the Delete and Caps keys, key . by
highlighting the text, and typing in the replacement text or deleting the highlighted text.

For example, to change the name of the company, in the Name field of Office, place the cursor
after Nanonull, and type in USA to change the name from Nanonull, Inc. to Nanonull USA, Inc.

If text is editable, you will be able to place your cursor in it and highlight it, otherwise you will not
be able to. Try changing any of the field names (not the field values), such as "Street", "City", or
"State/Zip," in the address block. You are not able to place the cursor in this text because such
text is not XML content; it is derived from the StyleVision Power Stylesheet.

Inserting special characters and entities


When entering data, the following type of content is handled in a special way:
 Special characters that are used for XML markup (ampersand, apostrophe, greater
than, less than, and quotes). These characters are available as built-in entities and can
be entered in the document by double-clicking the respective entity in the Entities entry
helper. If these characters occur frequently (for example, in program code listings), then
they can be entered within CDATA sections. To insert a CDATA section, right-click at
the location where you wish to enter the CDATA section, and select Insert CDATA
Section from the context menu. The XML processor ignores all markup characters
within CDATA sections. This also means that if you want a special character inside a
CDATA section, you should enter that character and not its entity reference.
 Special characters that cannot be entered via the keyboard should be entered by

© 2010 Altova GmbH User Manual


334 Authentic Authentic View Tutorial

copying them from the character map of your system to the required location in the
document.
 A frequently used text string can be defined as an entity, which appears in the Entities
entry helper. The entity is inserted at the required locations by placing the cursor at
each required location and double-clicking the entity in the entry helper. This is useful
for maintenance because the value of the text string is held in one location; if the value
needs to be changed, then all that needs to be done is change the entity definition.

Note: When markup is hidden in Authentic View, an empty element can easily be overlooked.
To make sure that you are not overlooking an empty element, switch large or small
markup on.

Try using each type of text content described above.

Adding content via a data-entry device


In the content editing you have learned above, content is added by directly typing in text as
content. There is one other way that element content (or attribute values) can be entered in
Authentic View: via data-entry devices.

Given below is a list of data-entry devices in Authentic View, together with an explanation of
how data is entered in the XML file for each device.

Data-Entry Device Data in XML File


Input Field (Text Box) Text entered by user
Multiline Input Field Text entered by user
Combo box User selection mapped to value
Check box User selection mapped to value
Radio button User selection mapped to value
Button User selection mapped to value

In the static table containing the address fields (shown below), there are two data-entry devices:
an input field for the Zip field and a combo-box for the State field. The values that you enter in
the text fields are entered directly as the XML content of the respective elements. For other
data-entry devices, your selection is mapped to a value.

For the Authentic View shown above, here is the corresponding XML text:
<Address>
<ipo:street>119 Oakstreet, Suite 4876</ipo:street>
<ipo:city>Vereno</ipo:city>
<ipo:state>DC</ipo:state>
<ipo:zip>29213</ipo:zip>

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Authentic View Tutorial 335

</Address>

Notice that the combo-box selection DC is mapped to a value of DC. The value of the Zip field is
entered directly as content of the ipo:zip element.

8.1.5 Entering Attribute Values


An attribute is a property of an element, and an element can have any number of attributes.
Attributes have values. You may sometimes be required to enter XML data as an attribute
value. In Authentic View, you enter attribute values in two ways:
 As content in the main window if the attribute has been created to accept its value in
this way
 In the Attributes entry helper

Attribute values in the main window


Attribute values can be entered as free-flowing text or as text in an input field, or as a user
selection that will be mapped to an XML value. They are entered in the same way that element
content is entered: see Entering Data in Authentic View. In such cases, the distinction between
element content and attribute value is made by the StyleVision Power Stylesheet and the data is
handled appropriately.

Attribute values in the Attributes Entry Helper


If you wish to enter or change an attribute value, you can also do this in the Attributes Entry
Helper. First, the attribute node is selected in Authentic View, then the value of the attribute is
entered or edited in the Attributes entry helper. In the NanonullOrg.xml document, the
location of the logo is stored as the value of the href attribute of the CompanyLogo element.
To change the logo to be used:
1. Select the CompanyLogo element by clicking a CompanyLogo tag. The attributes of
the CompanyLogo element are displayed in the Attributes Entry Helper.
2. In the Attributes Entry Helper, change the value of the href attribute from
nanonull.gif to Altova_right_300.gif (an image in the Examples folder).

This causes the Nanonull logo to be replaced by the Altova logo.

Note: Entities cannot be entered in the Attributes entry helper.

8.1.6 Adding Entities


An entity in Authentic View is typically XML data (but not necessarily), such as a single
character; a text string; and even a fragment of an XML document. An entity can also be a
binary file, such as an image file. All the entities available for a particular document are
displayed in the Entities Entry Helper (screenshot below). To insert an entity, place the cursor at
the location in the document where you want to insert it, and then double-click the entity in the
Entities entry helper. Note that you cannot enter entities in the Attributes entry helper.

© 2010 Altova GmbH User Manual


336 Authentic Authentic View Tutorial

The ampersand character (&) has special significance in XML (as have the apostrophe, less
than and greater than symbols, and the double quote). To insert these characters, entities are
used so that they are not confused with XML-significant characters. These characters are
available as entities in Authentic View.

In NanonullOrg.xml, change the title of Joe Martin (in Marketing) to Marketing Manager
Europe & Asia. Do this as follows:
1. Place the cursor where the ampersand is to be inserted.
2. Double-click the entity listed as "amp". This inserts an ampersand (screenshot below).

Note: The Entities Entry Helper is not context-sensitive. All available entities are displayed no
matter where the cursor is positioned. This does not mean that an entity can be inserted
at all locations in the document. If you are not sure, then validate the document after
inserting the entity: XML | Validate (F8).

Defining your own entities


As a document editor, you can define your own document entities. How to do this is described in
the section Defining Entities in Authentic View.

8.1.7 Printing the Document


A printout from Authentic View of an XML document preserves the formatting seen in Authentic
View.

To print NanonullOrg.xml, do the following:


1. Switch to Hide Markup mode if you are not already in it. You must do this if you do not
want markup to be printed.
2. Select File | Print Preview to see a preview of all pages. Shown below is part of a print
preview page, reduced by 50%.

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Authentic View Tutorial 337

Notice that the formatting of the page is the same as that in Authentic View.
3. To print the file, click File | Print.

Note that you can also print a version of the document that displays (small) markup. To do this,
switch Authentic View to Show small markup mode or Show large markup mode, and then print.
Both modes produce a printout that displays small markup.

© 2010 Altova GmbH User Manual


338 Authentic Editing in Authentic View

8.2 Editing in Authentic View


This section describes important features of Authentic View in detail. Features have been
included in this section either because they are frequently used or because the mechanisms or
concepts involved require explanation.

The section explains the following:


 There are three distinct types of tables used in Authentic View. The section Using
tables in Authentic View explains the three types of tables (static SPS, dynamic SPS,
and XML), and when and how to use them. It starts with the broad, conceptual picture
and moves to the details of usage.
 The Date Picker is a graphical calendar that enters dates in the correct XML format
when you click a date. See Using the Date Picker.
 An entity is shorthand for a special character or text string. You can define your own
entities, which allows you to insert these special characters or text strings by inserting
the corresponding entities. See Defining Entities for details.
 What image formats can be displayed in Authentic View.

8.2.1 Basic Editing


When you edit in Authentic View, you are editing an XML document. Authentic View, however,
can hide the structural XML markup of the document, thus displaying only the content of the
document (first screenshot below). You are therefore not exposed to the technicalities of XML,
and can edit the document as you would a normal text document. If you wish, you could switch
on the markup at any time while editing (second screenshot below).

An editable Authentic View document with no XML markup.

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Editing in Authentic View 339

An editable Authentic View document with XML markup tags.

Text editing
An Authentic View document will essentially consist of text and images. To edit the text in the
document, place the cursor at the location where you wish to insert text, and type. You can
copy, move, and delete text using familiar keystrokes (such as the Delete key) and drag-and-
drop mechanisms. One exception is the Return key. Since the Authentic View document is pre-
formatted, you do not—and cannot—add extra lines or space between items. The Return key
in Authentic View therefore serves to append another instance of the element currently being
edited, and should be used exclusively for this purpose.

Copy as XML or as text


Text can be copied and pasted as XML or as text.
 If text is pasted as XML, then the XML markup is pasted together with the text content
of nodes. The XML markup is pasted even if only part of a node's contents has been
copied. For the markup to be pasted it must be allowed, according to the schema, at
the location where it is pasted.
 If text is pasted as text, XML markup is not pasted.

To paste as XML or text, first copy the text (Ctrl+C), right-click at the location where the text is
to be pasted, and select the context menu command Paste As | XML or Paste As | Text. If the
shortcut Ctrl+V is used, the text will be pasted in the default Paste Mode of the SPS. The
default Paste Mode will have been specified by the designer of the SPS. For more details, see
the section Context Menus.

Alternatively, highlighted text can be dragged to the location where it is to be pasted. When the
text is dropped, a pop-up appears asking whether the text is to be pasted as text or XML. Select
the desired option.

Text formatting
One of the most fundamental principles of XML document systems is that content be kept
separate from presentation. The XML document contains the content, while the stylesheet
contains the presentation (formatting). In Authentic View, the XML document is presented via
the stylesheet. This means that all the formatting you see in Authentic View is produced by the
stylesheet. If you see bold text, that bold formatting has been provided by the stylesheet. If you

© 2010 Altova GmbH User Manual


340 Authentic Editing in Authentic View

see a list or a table, that list format or table format has been provided by the stylesheet. The
XML document, which you edit in Authentic View contains only the content; it contains no
formatting whatsoever. The formatting is contained in the stylesheet. What this means for you,
the Authentic View user, is that you do not have to—nor can you—format any of the text you
edit. You are editing content. The formatting that is automatically applied to the content you edit
is linked to the semantic and/or structural value of the data you are editing. For example, an
email address (which could be considered a semantic unit) will be formatted automatically in a
certain way because of it is an email. In the same way, a headline must occur at a particular
location in the document (both a structural and semantic unit) and will be formatted
automatically in the way the stylesheet designer has specified that headlines be formatted. You
cannot change the formatting of either email address or headline. All that you do is edit the
content of the email address or headline.

In some cases, content might need to be specially presented; for example, a text string that
must be presented in boldface. In all such cases, the presentation must be tied in with a
structural element of the document. For example, a text string that must be presented in
boldface, will be structurally separated from surrounding content by markup that the stylesheet
designer will format in boldface. If you, as the Authentic View user, need to use such a text
string, you would need to enclose the text string within the appropriate element markup. For
information about how to do this, see the Insert Element command in the Elements Entry
Helper section of the documentation.

Inserting entities
In XML documents, some characters are reserved for markup and cannot be used in normal
text. These are the ampersand (&), apostrophe ('), less than (<), greater than (>), and quote (")
characters. If you wish to use these characters in your data, you must insert them as entity
references, via the Entities Entry Helper (screenshot below).

XML also offers the opportunity to create custom entities. These could be: (i) special characters
that are not available on your keyboard, (ii) text strings that you wish to re-use in your document
content, (iii) XML data fragments, or (iv) other resources, such as images. You can define your
own entities within the Authentic View application. Once defined, these entities appear in the
Entities Entry Helper and can then be inserted as in the document.

Inserting CDATA sections


CDATA sections are sections of text in an XML document that the XML parser does not
process as XML data. They can be used to escape large sections of text if replacing special
characters by entity references is undesirable; this could be the case, for example, with program
code or an XML fragment that is to be reproduced with its markup tags. CDATA sections can
occur within element content and are delimited by <![CDATA[ and ]]> at the start and end,
respectively. Consequently the text string ]]> should not occur within a CDATA section as it
would prematurely signify the end of the section. In this case, the greater than character should
be escaped by its entity reference (&gt;). To insert a CDATA section within an element, place
the cursor at the desired location, right-click, and select Insert CDATA Section from the
context menu. To see the CDATA section tags in Authentic View, switch on the markup display.
Alternatively, you could highlight the text that is to be enclosed in a CDATA section, and then

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Editing in Authentic View 341

select the Insert CDATA section command.

Editing and following links


A hyperlink consists of two parts: the link text and the target of the link. You can edit the link text
by clicking in the text and editing. But you cannot edit the target of the link. (The target of the
link is set by the designer of the stylesheet (either by typing in a static target address or by
deriving the target address from data contained in the XML document).) From Authentic View,
you can go to the target of the link by pressing Ctrl and clicking the link text. (Remember:
merely clicking the link will set you up for editing the link text.)

8.2.2 Tables in Authentic View


The three table types fall into two categories: SPS tables (static and dynamic) and XML tables.

SPS tables are of two types: static and dynamic. SPS tables are designed by the designer of
the StyleVision Power Stylesheet to which your XML document is linked. You yourself cannot
insert an SPS table into the XML document, but you can enter data into SPS table fields and
add and delete the rows of dynamic SPS tables. The section on SPS tables below explains the
features of these tables.

XML tables are inserted by you, the user of Authentic View. Their purpose is to enable you to
insert tables at any allowed location in the document hierarchy should you wish to do so. The
editing features of XML tables and the XML table editing icons are described below.

SPS Tables
Two types of SPS tables are used in Authentic View: static tables and dynamic tables.

Static tables are fixed in their structure and in the content-type of cells. You, as the user of
Authentic View, can enter data into the table cells but you cannot change the structure of these
tables (i.e. add rows or columns, etc) or change the content-type of a cell. You enter data either
by typing in text, or by selecting from options presented in the form of check-box or radio button
alternatives or as a list in a combo-box. After you enter data, you can edit it.

Please note: The icons or commands for editing dynamic tables must not be used to edit
static tables.

Dynamic tables have rows that represent a repeating data structure, i.e. each row has an
identical data structure (not the case with static tables). Therefore, you can perform row
operations: append row, insert row, move row up, move row down, and delete row. These
commands are available under the Authentic menu and as icons in the toolbar (shown below).

© 2010 Altova GmbH User Manual


342 Authentic Editing in Authentic View

To use these commands, place the cursor anywhere in the appropriate row, and then select the
required command.

To move among cells in the table, use the Up, Down, Left, and Right arrow keys. To move
forward from one cell to the next, use the Tab key. Pressing the Tab key in the last cell of a row
creates a new row.

XML Tables
XML tables can be inserted by you, the user of Authentic View. They enable you to insert tables
anywhere in the XML document where they are allowed, which is useful if you need to insert
tabular information in your document. These tables will be printed out as tables when you print
out directly from Authentic View. If you are also generating output with XSLT stylesheets,
discuss the required output with the designer of the StyleVision Power Stylesheet.

Note that you can insert XML tables only at allowed locations. These locations are specified in
the schema (DTD or XML Schema). If you wish to insert a table at additional locations, discuss
this with the person designing the StyleVision Power Stylesheet.

Working with XML tables


There are three steps involved when working with XML tables: inserting the table; formatting it;
and entering data. The commands for working with XML tables are available as icons in the
toolbar (see XML table editing icons).

Inserting tables
To insert an XML table:

1. Place your cursor where you wish to insert the table, and click the icon. (Note that
where you can insert tables is determined by the schema.) This opens the Insert Table
dialog (shown below).

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Editing in Authentic View 343

2. Select the number of columns and rows, and specify whether you wish the table to
extend the entire available width. For the specifications given in the dialog box shown
above, the following table is created.

You can add and delete columns, create row and column joins later. Create the broad
structure first.

Please note: All modifications to table structure must be made by using the Table menu
commands. They cannot be made by changing attribute values in the Attribute Entry Helper.

Formatting tables and entering data


To format your table:

1. Place the cursor anywhere in the table and click the (Table Properties) icon. This
opens the Table Properties dialog (see screenshot), where you specify formatting for
the table, or for a row, column, or cell.

2. Set the cellspacing and cellpadding properties to "0". Your table will now look like this:

© 2010 Altova GmbH User Manual


344 Authentic Editing in Authentic View

3. Place the cursor in the first row to format it, and click the (Table Properties) icon.
Click the Row tab.

Since the first row will be the header row, set a background color to differentiate this
row from the other rows. Note the Row properties that have been set in the figure
above. Then enter the column header text. Your table will now look like this:

Notice that the alignment is centered as specified.


4. Now, say you want to divide the "Telephone" column into the sub-columns "Office" and
"Home", in which case you would need to join cells. Place the cursor in the "Telephone"

cell, and click the (Split vertically) icon. Your table will look like this:

5. Now place the cursor in the cell below the cell containing "Telephone", and click the

(Split horizontally) icon. Then type in the column headers "Office" and "Home".
Your table will now look like this:

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Editing in Authentic View 345

Now you will have to vertically split each cell in the "Telephone" column.

You can also add and delete columns and rows, and vertically align cell content, using the
table-editing icons. The XML table editing icons are described in the User Reference, in the
section titled "XML Table Icons".

Moving among cells in the table


To move among cells in the XML table, use the Up, Down, Right, and Left arrow keys.

Entering data in a cell


To enter data in a cell, place the cursor in the cell, and type in the data.

Formatting text
Text in an XML table, as with other text in the XML document, must be formatted using XML
elements or attributes. To add an element, highlight the text and double-click the required
element in the Elements Entry Helper. To specify an attribute value, place the cursor within the
text fragment and enter the required attribute value in the Attributes Entry Helper. After
formatting the header text bold, your table will look like this.

The text above was formatted by highlighting the text, and double-clicking the element strong,
for which a global template exists that specifies bold as the font-weight. The text formatting
becomes immediately visible.

Please note: For text formatting to be displayed in Authentic View, a global template with the
required text formatting must have been created in StyleVision for the element in question.

XML Table Editing Icons


The commands required to edit XML tables are available as icons in the toolbar, and are listed
below. Note that no corresponding menu commands exist for these icons.

For a full description of when and how XML tables are to be used, see XML tables.

Insert table

The "Insert Table" command inserts a CALS / HTML table at the current cursor
position.

Delete table

© 2010 Altova GmbH User Manual


346 Authentic Editing in Authentic View

The "Delete table" command deletes the currently active table.

Append row

The "Append row" command appends a row to the end of the currently active table.

Append column

The "Append column" command appends a column to the end of the currently active
table.

Insert row

The "Insert row" command inserts a row above the current cursor position in the
currently active table.

Insert column

The "Insert column" command inserts a column to the left of the current cursor position
in the currently active table.

Join cell left

The "Join cell left" command joins the current cell (current cursor position) with the cell
to the left. The tags of both cells remain in the new cell, the column headers remain
unchanged.

Join cell right

The "Join cell right" command joins the current cell (current cursor position) with the cell
to the right. The tags of both cells remain in the new cell, the column headers remain
unchanged.

Join cell below

The "Join cell below" command joins the current cell (current cursor position) with the
cell below. The tags of both cells remain in the new cell, the column headers remain
unchanged.

Join cell above

The "Join cell above" command joins the current cell (current cursor position) with the
cell above. The tags of both cells remain in the new cell, the column headers remain
unchanged.

Split cell horizontally

The "Split cell Horizontally" command creates a new cell to the right of the currently
active cell. The size of both cells, is now the same as the original cell.

Split cell vertically

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Editing in Authentic View 347

The "Split cell Vertically" command creates a new cell below the currently active cell.

Align top

This command aligns the cell contents to the top of the cell.

Center vertically

This command centers the cell contents.

Align bottom

This command aligns the cell contents to the bottom of the cell.

Table properties

The "Table properties" command opens the Table Properties dialog box. This icon is
only made active for HTML tables, it cannot be clicked for CALS tables.

8.2.3 Editing a DB
In Authentic View, you can edit database (DB) tables and save data back to a DB. This section
contains a full description of interface features available to you when editing a DB table. The
following general points need to be noted:
 The number of records in a DB table that are displayed in Authentic View may have
been deliberately restricted by the designer of the StyleVision Power Stylesheet in order
to make the design more compact. In such cases, only that limited number of records is
initially loaded into Authentic View. Using the DB table row navigation icons (see
Navigating a DB Table), you can load and display the other records in the DB table.
 You can query the DB to display certain records.
 You can add, modify, and delete DB records, and save your changes back to the DB.

© 2010 Altova GmbH User Manual


348 Authentic Editing in Authentic View

See Modifying a DB Table.

To open a DB-based StyleVision Power Stylesheet in Authentic View:


 Click Authentic | Edit Database Data, and browse for the required StyleVision Power
Stylesheet.

Navigating a DB Table
The commands to navigate DB table rows are available as buttons in the Authentic View
document. Typically, one navigation panel with either four or five buttons accompanies each DB
table.

The arrow icons are, from left to right, Go to First Record in the DB; Go to Previous Record;
Open the Go to Record dialog (see screenshot); Go to Next Record; and Go to Last Record.

To navigate a DB table, click the required button.

XML Databases
In the case of XML DBs, such as IBM DB2, one cell (or row) contains a single XML document,
and therefore a single row is loaded into Authentic View at a time. To load an XML document
that is in another row, use the Authentic | Select New Row with XML Data for Editing menu
command.

DB Queries
A DB query enables you to query the records of a table displayed in Authentic View. A query is
made for an individual table, and only one query can be made for each table. You can make a
query at any time while editing. If you have unsaved changes in your Authentic View document
at the time you submit the query, you will be prompted about whether you wish to save all
changes made in the document or discard all changes. Note that even changes made in other
tables will be saved/discarded. After you submit the query, the table is reloaded using the query
conditions.

Please note: If you get a message saying that too many tables are open, then you can reduce
the number of tables that are open by using a query to filter out some tables.

To create and submit a query:


1. Click the Query button for the required table in order to open the Edit Database
Query dialog (see screenshot). This button typically appears at the top of each DB table
or below it. If a Query button is not present for any table, the designer of the StyleVision
Power Stylesheet has not enabled the DB Query feature for that table.

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Editing in Authentic View 349

2. Click the Append AND or Append OR button. This appends an empty criterion for the
query (shown below).

4. Enter the expression for the criterion. An expression consists of: (i) a field name
(available from the associated combo-box); (ii) an operator (available from the
associated combo-box); and (iii) a value (to be entered directly). For details of how to
construct expressions see the Expressions in criteria section.
5. If you wish to add another criterion, click the Append AND or Append OR button
according to which logical operator (AND or OR) you wish to use to join the two criteria.
Then add the new criterion. For details about the logical operators, see the section
Re-ordering criteria in DB Queries.

Expressions in criteria

© 2010 Altova GmbH User Manual


350 Authentic Editing in Authentic View

Expressions in DB Query criteria consist of a field name, an operator, and a value. The
available field names are the child elements of the selected top-level data table; the names of
these fields are listed in a combo-box (see screenshot above). The operators you can use are
listed below:
= Equal to
<> Not equal to
< Less than
<= Less than or equal to
> Greater than
>= Greater than or equal to
LIKE Phonetically alike
NOT LIKE Phonetically not alike
IS NULL Is empty
NOT NULL Is not empty
If IS NULL or NOT NULL is selected, the Value field is disabled. Values must be entered
without quotes (or any other delimiter). Values must also have the same formatting as that of
the corresponding DB field; otherwise the expression will evaluate to FALSE. For example, if a
criterion for a field of the date datatype in an MS Access DB has an expression
StartDate=25/05/2004, the expression will evaluate to FALSE because the date datatype
in an MS Access DB has a format of YYYY-MM-DD.

Using parameters with DB Queries


You can enter the name of a parameter as the value of an expression when creating queries.
Parameters are variables that can be used instead of literal values in queries. You first declare
the parameter and its value, and then use the parameter in expressions. This causes the value
of the parameter to be used as the value of that expression. The parameters that you add in the
Edit Parameters dialog can be parameters that have already been declared for the stylesheet.
In this case, the new value overrides the value in the stylesheet.

Parameters are useful if you wish to use a single value in multiple expressions.

Declaring parameters from the Edit DB Query dialog


To declare parameters:
1. Click the Parameters... button in the Edit Database Query dialog. This opens the Edit
Parameters dialog (see screenshot).

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Editing in Authentic View 351

2. Click Append or Insert .


3. Type in the name and value of the parameter in the appropriate fields.

Please note: The Edit Parameters dialog contains all the parameters that have been defined
for the stylesheet. While it is an error to use an undeclared parameter in the StyleVision Power
Stylesheet, it is not an error to declare a parameter and not use it.

Using parameters in queries


To enter the name of a parameter as the value of an expression:
 Type $ into the value input field followed (without any intervening space) by the name of
the parameter in the Edit Database Query dialog.

Please note: If the parameter has already been declared, then the entry will be colored green. If
the parameter has not been declared, the entry will be red, and you must declare it.

Re-ordering criteria in DB Queries


The logical structure of the DB Query and the relationship between any two criteria or sets of
criteria is indicated graphically. Each level of the logical structure is indicated by a square
bracket. Two adjacent criteria or sets of criteria indicate the AND operator, whereas if two
criteria are separated by the word OR then the OR operator is indicated. The criteria are also
appropriately indented to provide a clear overview of the logical structure of the DB Query.

The DB Query shown in the screenshot above may be represented in text as:
State=CA AND (City=Los Angeles OR City=San Diego OR (City=San
Francisco AND CustomerNr=25))

You can re-order the DB Query by moving a criterion or set of criteria up or down relative to the
other criteria in the DB Query. To move a criterion or set of criteria, do the following:
1. Select the criterion by clicking on it, or select an entire level by clicking on the bracket
that represents that level.
2. Click the Up or Down arrow button in the dialog.

The following points should be noted:

© 2010 Altova GmbH User Manual


352 Authentic Editing in Authentic View

 If the adjacent criterion in the direction of movement is at the same level, the two
criteria exchange places.
 A set of criteria (i.e. criterion within a bracket) changes position within the same level; it
does not change levels.
 An individual criterion changes position within the same level. If the adjacent criterion is
further outward/inward (i.e. not on the same level), then the selected criterion will move
outward/inward, one level at a time.

To delete a criterion in a DB Query, select the criterion and click Delete.

Modifying a DB Query

To modify a DB Query:
1. Click the Query button . The Edit Database Query dialog box opens. You can now
edit the expressions in any of the listed criteria, add new criteria, re-order criteria, or
delete criteria in the DB Query.
2. Click OK. The data from the DB is automatically re-loaded into StyleVision so as to
reflect the modifications to the DB Query.

Modifying a DB Table
Adding a record
To add a record to a DB table:
1. Place the cursor in the DB table row and click the icon (to append a row) or the
icon (to insert a row). This creates a new record in the temporary XML file.
2. Click the File | Save command to add the new record in the DB. In Authentic View a
row for the new record is appended to the DB table display. The AltovaRowStatus
for this record is set to A (for Added).

When you enter data for the new record it is entered in bold and is underlined. This enables you
to differentiate added records from existing records—if existing records have not been
formatted with these text formatting properties. Datatype errors are flagged by being displayed
in red.

The new record is added to the DB when you click File | Save. After a new record is saved to
the DB, its AltovaRowStatus field is initialized (indicated with ---) and the record is
displayed in Authentic View as a regular record.

Modifying a record
To modify a record, place the cursor at the required point in the DB table and edit the record as
required. If the number of displayed records is limited, you may need to navigate to the required
record (using the navigation icons described above).

When you modify a record, entries in all fields of the record are underlined and the
AltovaRowStatus of all primary instances of this record is set to U (for Updated). All
secondary instances of this record have their AltovaRowStatus set to u (lowercase). Primary
and secondary instances of a record are defined by the structure of the DB—and
correspondingly of the XML Schema generated from it. For example, if an Address table is
included in a Customer table, then the Address table can occur in the Design Document in two
types of instantiations: as the Address table itself and within instantiations of the Customer
table. Whichever of these two types is modified is the type that has been primarily modified.
Other types—there may be more than one other type—are secondary types. Datatype errors
are flagged by being displayed in red.

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Editing in Authentic View 353

The modifications are saved to the DB by clicking File | Save. After a modified record is saved
to the DB, its AltovaRowStatus field is initialized (indicated with ---) and the record is
displayed in Authentic View as a regular record.

Please note:
 If even a single field of a record is modified in Authentic View, the entire record is
updated when the data is saved to the DB.
 The date value 0001-01-01 is defined as a NULL value for some DBs, and could
result in an error message.

Deleting a record

To delete a record:
1. Place the cursor in the row representing the record to be deleted and click the icon.
The record to be deleted is marked with a strikethrough. The AltovaRowStatus is set
as follows: primary instances of the record are set to D; secondary instances to d; and
records indirectly deleted to X. Indirectly deleted records are fields in the deleted record
that are held in a separate table. For example, an Address table might be included in a
Customer table. If a Customer record were to be deleted, then its corresponding
Address record would be indirectly deleted. If an Address record in the Customer table
were deleted, then the Address record in the Customer table would be primarily deleted,
but the same record would be secondarily deleted in an independent Address table if
this were instantiated.
2. Click File | Save to save the modifications to the DB.

Please note: Saving data to the DB resets the Undo command, so you cannot undo actions
that were carried out prior to the save.

8.2.4 Working with Dates


There are two ways in which dates can be edited in Authentic View:
 Dates are entered or modified using the Date Picker.
 Dates are entered or modified by typing in the value.

The method the Authentic View user will use is defined in the SPS. Both methods are described
in the two sub-sections of this section.

Note on date formats


In the XML document, dates can be stored in one of several date datatypes. Each of these
datatypes requires that the date be stored in a particular lexical format in order for the XML
document to be valid. For example, the xs:date datatype requires a lexical format of
YYYY-MM-DD. If the date in an xs:date node is entered in anything other than this format, then
the XML document will be invalid.

In order to ensure that the date is entered in the correct format, the SPS designer can include
the graphical Date Picker in the design. This would ensure that the date selected in the Date
Picker is entered in the correct lexical format. If there is no Date Picker, the Authentic View
should take care to enter the date in the correct lexical format. Validating the XML document
could provide useful tips about the required lexical format.

© 2010 Altova GmbH User Manual


354 Authentic Editing in Authentic View

Date Picker
The Date Picker is a graphical calendar used to enter dates in a standard format into the XML
document. Having a standard format is important for the processing of data in the document.
The Date Picker icon appears near the date field it modifies (see screenshot).

To display the Date Picker (see screenshot), click the Date Picker icon.

To select a date, click on the desired date, month, or year. The date is entered in the XML
document, and the date in the display is modified accordingly. You can also enter a time zone if
this is required.

Text Entry
For date fields that do not have a Date Picker (see screenshot), you can edit the date directly by
typing in the new value.

Please note: When editing a date, you must not change its format.

If you edit a date and change it such that it is out of the valid range for dates, the date turns red
to alert you to the error. If you place the mouse cursor over the invalid date, an error message
appears (see screenshot).

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Editing in Authentic View 355

If you try to change the format of the date, the date turns red to alert you to the error (see
screenshot).

8.2.5 Defining Entities


You can define entities for use in Authentic View, whether your document is based on a DTD or
an XML Schema. Once defined, these entities are displayed in the Entities Entry Helper and in
the Insert Entity submenu of the context menu. When you double-click on an entity in the
Entities Entry Helper, that entity is inserted at the cursor insertion point.

An entity is useful if you will be using a text string, XML fragment, or some other external
resource in multiple locations in your document. You define the entity, which is basically a short
name that stands in for the required data, in the Define Entities dialog. After defining an entity
you can use it at multiple locations in your document. This helps you save time and greatly
enhances maintenance.

There are two broad types of entities you can use in your document: a parsed entity, which is
XML data (either a text string or a fragment of an XML document), or an unparsed entity,
which is non-XML data such as a binary file (usually a graphic, sound, or multimedia object).
Each entity has a name and a value. In the case of parsed entities the entity is a placeholder for
the XML data. The value of the entity is either the XML data itself or a URI that points to a .xml
file that contains the XML data. In the case of unparsed entities, the value of the entity is a URI
that points to the non-XML data file.

To define an entity:
1. Click Authentic | Define XML Entities.... This opens the Define Entities dialog (
screenshot below).

2. Enter the name of your entity in the Name field. This is the name that will appear in the
Entities Entry Helper.
3. Enter the type of entity from the drop-down list in the Type field. The following types are
possible: An Internal entity is one for which the text to be used is stored in the XML
document itself. Selecting PUBLIC or SYSTEM specifies that the resource is located
outside the XML file, and will be located with the use of a public identifier or a system
identifier, respectively. A system identifier is a URI that gives the location of the
resource. A public identifier is a location-independent identifier, which enables some

© 2010 Altova GmbH User Manual


356 Authentic Editing in Authentic View

processors to identify the resource. If you specify both a public and system identifier,
the public identifier resolves to the system identifier, and the system identifier is used.
4. If you have selected PUBLIC as the Type, enter the public identifier of your resource in
the PUBLIC field. If you have selected Internal or SYSTEM as your Type, the PUBLIC
field is disabled.
5. In the Value/Path field, you can enter any one of the following:
 If the entity type is Internal, enter the text string you want as the value of your entity.
Do not enter quotes to delimit the entry. Any quotes that you enter will be treated as
part of the text string.
 If the entity type is SYSTEM, enter the URI of the resource or select a resource on
your local network by using the Browse button. If the resource contains parsed data,
it must be an XML file (i.e., it must have a .xml extension). Alternatively, the
resource can be a binary file, such as a GIF file.
 If the entity type is PUBLIC, you must additionally enter a system identifier in this field.
6. The NDATA entry tells the processor that this entity is not to be parsed but to be sent to
the appropriate processor. The NDATA field should therefore be used with unparsed
entities only.

Dialog features
You can do the following in the Define Entities dialog:
 Append entities
 Insert entities
 Delete entities
 Sort entities by the alphabetical value of any column by clicking the column header;
clicking once sorts in ascending order, twice in descending order.
 Resize the dialog box and the width of columns.
 Locking. Once an entity is used in the XML document, it is locked and cannot be edited
in the Define Entities dialog. Locked entities are indicated by a lock symbol in the first
column. Locking an entity ensures that the XML document valid with respect to entities.
(The document would be invalid if an entity is referenced but not defined.)
 Duplicate entities are flagged.

Limitations of entities
 An entity contained within another entity is not resolved, either in the dialog, Authentic
View, or XSLT output, and the ampersand character of such an entity is displayed in its
escaped form, i.e. &amp;.
 External entities are not resolved in Authentic View, except in the case where an entity
is an image file and it is entered as the value of an attribute of type ENTITY or
ENTITIES. Such entities are resolved when the document is processed with an XSLT
generated from the SPS.

8.2.6 Images in Authentic View


Authentic View allows you to specify images that will be used in the final output document
(HTML, RTF, PDF and Word 2007). You should note that some image formats might not be
supported in some formats or by some applications. For example, the SVG format is supported
in PDF, but not in RTF and would require a browser add-on for it to be viewed in HTML. So,
when selecting an image format, be sure to select a format that is supported in the output
formats of your document. Most image formats are supported across all the output formats (see
list below).

Authentic View is based on Internet Explorer, and is able to display most of the image formats
that your version of Internet Explorer can display. The following commonly used image formats

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Editing in Authentic View 357

are supported:
 GIF
 JPG
 PNG
 BMP
 WMF (Microsoft Windows Metafile)
 EMF (Enhanced Metafile)
 SVG (for PDF output only)

Relative paths
Relative paths are resolved relative to the SPS file.

8.2.7 Keystrokes in Authentic View


Enter (Carriage Return) Key
In Authentic View the Return key is used to append additional elements when it is in certain
cursor locations. For example, if the chapter of a book may (according to the schema) contain
several paragraphs, then pressing Return inside the text of the paragraph causes a new
paragraph to be appended immediately after the current paragraph. If a chapter can contain one
title and several chapters, pressing Enter inside the chapter but outside any paragraph element
(including within the title element) causes a new chapter to be appended after the current
chapter (assuming that multiple chapters are allowed by the schema).

Please note: The Return key does not insert a carriage return/line feed, i.e. it does not jump to
a new line. This is the case even when the cursor is inside a text node, such as paragraph.

Using the keyboard


The keyboard can be used in the standard way, for typing and navigating. Note the following
special points:
 The Tab key moves the cursor forward, stopping before and after nodes, and
highlighting node contents; it steps over static content.
 The add... and add Node hyperlinks are considered node contents and are highlighted
when tabbed. They can be activated by pressing either the spacebar or the Enter key.

© 2010 Altova GmbH User Manual


358 Authentic Authentic Scripting

8.3 Authentic Scripting


The Authentic Scripting feature provides more flexibility and interactivity to SPS designs.
These designs can be created or edited in StyleVision Enterprise and Professional editions, and
can be viewed in the Authentic View of the Enterprise and Professional editions of Altova
products.

A complete listing of support for this feature in Altova products is given in the table below. Note,
however, that in the trusted version of Authentic Browser plug-in, internal scripting is turned off
because of security concerns.

Altova Product Authentic Scripts Authentic Scripts


Creation Enabled
StyleVision Enterprise Yes Yes
StyleVision Professional Yes Yes
StyleVision Standard * No No
XMLSpy Enterprise No Yes
XMLSpy Professional No Yes
XMLSpy Standard No No
AuthenticDesktop Community No No
AuthenticDesktop Enterprise No Yes
Authentic Browser Plug-in No No
Community **
Authentic Browser Plug-in No Yes
Enterprise Trusted ***
Authentic Browser Plug-in No Yes
Enterprise Untrusted

* No AuthenticView
** Both Trusted and Untrusted versions
*** Scripted designs displayed. No internal macro execution or event handling. External
events fired.

Authentic Scripts behave in the same way in all Altova products, so no product-specific code or
settings are required.

How Authentic Scripting works


The designer of the SPS design can use Authentic Scripting in two ways to make Authentic
documents interactive:
 By assigning scripts for user-defined actions (macros) to design elements, toolbar
buttons, and context menu items.
 By adding to the design event handlers that react to Authentic View events.

All the scripting that is required for making Authentic documents interactive is done within the
StyleVision GUI (Enterprise and Professional editions). Forms, macros and event handlers are
created within the Scripting Editor interface of StyleVision and these scripts are saved with the
SPS. Then, in the Design View of StyleVision, the saved scripts are assigned to design
elements, toolbar buttons, and context menus. When an XML document based on the SPS is
opened in an Altova product that supports Authentic Scripting (see table above), the document
will have the additional flexibility and interactivity that has been created for it.

Altova XMLSpy 2011 © 2010 Altova GmbH


Authentic Authentic Scripting 359

Documentation for Authentic Scripting


The documentation for Authentic Scripting is available in the documentation of StyleVision. It
can be viewed online via the Product Documentation page of the Altova website.

© 2010 Altova GmbH User Manual


360 HTML, CSS, JSON

9 HTML, CSS, JSON


XMLSpy provides intelligent editing features for HTML, CSS, and JSON documents. All three
types of documents can be edited in Text View. Additionally, JSON documents can be edited in
Grid View, and the active HTML document can be previewed in Browser View.

The intelligent editing features of each type of document is described separately in the sub-
sections of this section: HTML, CSS, and JSON.

Altova XMLSpy 2011 © 2010 Altova GmbH


HTML, CSS, JSON HTML 361

9.1 HTML
HTML documents can be edited in Text View, and the edited page can then be viewed
immediately in Browser View. Text View provides a number of useful HTML editing features.
These are described in detail in Text View, but the main features, as well as HTML-specific
options, are listed below.

Entry helpers
Elements, Attributes and Entities entry helpers are available when an HTML document is active.
The entry helpers are context-sensitive; the items displayed in the entry helpers are those
available at the current cursor location. Use the HTML entry helpers as described in Text View.

Auto-completion
As you type markup text into your HTML document, XMLSpy provides Auto-completion help. A
pop-up containing a list of all nodes available at the cursor insertion point is displayed. As you
type, the selection jumps to the first closest match in the list (see screenshot below). Click the
selected item to insert it at the cursor insertion point.

Auto-completion for elements appears when the left bracket of node tags is entered. When the
start tag of an element node is entered in the document, the end tag is automatically inserted as
well. This ensures well-formedness.

Auto-completion for attributes appears when a space is entered after the element name in a
start tag. When you click an attribute name in the Auto-completion pop-up, the attribute is
entered with quotes characters and the cursor positioned between the quotes.

The Entities entry helper contains character entities from the HTML 4.0 entity sets, Latin-1,
special characters, and symbols.

HTML Info window


The HTML Info window (screenshot below) lists applications that can be used to quickly access
the active HTML file. For example, if an HTML file is active in XMLSpy, double-clicking the
Mozilla Firefox item in the HTML Info Window starts an instance of Mozilla Firefox and loads the
active HTML document in it.

© 2010 Altova GmbH User Manual


362 HTML, CSS, JSON HTML

Note the following usage points:


 The icon to the right of the Open HTML With item enables applications to be added to
the Open HTML With list. All the browsers installed on the system, or any other
application (such as a text editor), can be added via the menu commands accessed via
the Open HTML With icon. The associated applications would typically be browser or
editor applications.
 After an application has been added to the Open HTML With list (except when added
with the Add Installed Browsers command), its name in the Open HTML With list can
be changed by selecting it, pressing F2, and editing the name.
 The icons to the right of each application listed in the Open HTML With list each opens
a menu containing commands to: (i) open the application; (ii) open the application and
load the linked HTML file; (iii) remove the application from the list. Double-clicking an
application name opens the linked HTML file in that application.
 Applications added to or removed from the Open HTML With list are also added to or
removed from the CSS Info window.

Assigning a DTD
For XHTML documents, a DTD or XML Schema can be assigned via the DTD/Schema menu,
which enables you to browse for the required DTD or XML Schema file. An XHTML document
can be edited exactly like an XML document.

Browser View commands


Browser View commands are available in the Browser menu.

Altova XMLSpy 2011 © 2010 Altova GmbH


HTML, CSS, JSON CSS 363

9.2 CSS
CSS documents can be edited using Text View's intelligent editing features. These features, as
they apply to the editing of CSS documents, are listed below.

Syntax coloring: A CSS rule consists of a selector, one or more properties, and the values of
those properties. These three components may be further sub-divided into more specific
categories; for example, a selector may be a class, pseudo-class, ID, element, or attribute.
Additionally, a CSS document can contain other items than rules: for example, comments. In
Text View, each such category of items can be displayed in a different color (screenshot below)
according to settings you make in the Options dialog (see below).

You can set the colors of the various CSS components in the Text Fonts tab of the Options
dialog (screenshot below). In the combo box at top left, select CSS, and then select the required
color (in the Styles pane) for each CSS item.

Folding margins: Each rule can be collapsed and expanded by clicking, respectively, the
minus and plus icons to the left of the rule (see screenshot above). Note also that the pair of
curly braces that delimit a rule (screenshot above) turns bold when the cursor is placed either
before or after one of the curly braces. This indicates clearly where the definition of a particular
rule starts and ends.

© 2010 Altova GmbH User Manual


364 HTML, CSS, JSON CSS

CSS outline: The CSS Outline entry helper (screenshots below) provides an outline of the
document in terms of its selectors. Clicking a selector in the CSS Outline highlights it in the
document. In the screenshot at left below, the selectors are unsorted and are listed in the order
in which they appear in the document. In the screenshot at right, the Alphabetical Sorting
feature has been toggled on (using the toolbar icon), and the selectors are sorted alphabetically.

You should note the following points: (i) For evaluating the alphabetical order of selectors, all
parts of the selector are considered, including the period, hash, and colon characters; (ii) If the
CSS document contains several selectors grouped together to define a single rule (e.g. h4,
h5, h6 {...}), then each selector in the group is listed separately.

The icons in the toolbar of the CSS Outline entry helper, from left to right, do the following:

Toggles automatic synchronization (with the document) on and off. When


auto-synchronization is switched on, selectors are entered in the entry helper
even as you type them into the document.

Synchronizes the entry helper with the current state of the document.

Toggles alphabetical sorting on and off. When off, the selectors are listed in
the order in which they appear in the document. When sorted alphabetically,
ID selectors appear first because they are prefaced by a hash (e.g. #intro).

Properties entry helper: The Properties entry helper (screenshot below) provides a list of all
CSS properties, arranged alphabetically. A property can be inserted at the cursor insertion point
by double-clicking the property.

Altova XMLSpy 2011 © 2010 Altova GmbH


HTML, CSS, JSON CSS 365

Auto-completion of properties and tooltips for properties: As you start to type the name of
a property, XMLSpy prompts you with a list of properties that begin with the letters you have
typed (screenshot below). Alternatively, you can place the cursor anywhere inside a property
name and then press Ctrl+Space to pop up the list of CSS properties.

You can view a tooltip containing the definition of a property and its possible values by scrolling
down the list or navigating the list with the Up and Down keys of your keyboard. The tooltip for
the highlighted property is displayed. To insert a property, either press Enter when it is selected,
or click it.

CSS Info window


When a CSS file is active, the CSS Info window (screenshot below) is enabled. The CSS Info
window provides the following functionality:
 It enables the CSS file to be linked to an HTML file. This functionality enables you to
modify the CSS document and view the effect of changes immediately. Additionally, the
linked HTML file can be opened in multiple browsers via the CSS Info window, thus
enabling changes in the CSS document to be viewed in multiple browsers.
 The CSS Info window lists the imported CSS stylesheets, thus giving you an overview
of the import structure of the active CSS stylesheet.

© 2010 Altova GmbH User Manual


366 HTML, CSS, JSON CSS

Note the following usage points:


 Only one HTML file can be linked to the active CSS document. Do this by clicking the
icon to the right of the Linked HTML item, then selecting the command Set Link to
HTML and browsing for the required HTML file. The linked HTML file will be listed
under the Linked HTML item in the Info window (see screenshot below). Creating this
link does not modify the CSS document or the HTML document in any way. The link
serves to set up an HTML file to which the active CSS document can be applied for
testing.
 Double-clicking the Linked HTML file listing opens the HTML file in XMLSpy.
 The toolbar icons enable you to horizontally and vertically tile the CSS document and
the HTML file.
 When changes to the CSS document are saved, the HTML file that is open in XMLSpy
can be automatically updated. To enable these automatic updates, check the Update
Linked HTML Browser check box. Note that these updates will only occur if the HTML
file contains a reference to the CSS document being edited.
 To change the linked HTML file, select another HTML file via the Set Link to HTML
command.
 To remove the link to the HTML file, click the icon to the right of the Linked HTML item
and select the command Remove Link.
 The icon to the right of the Open HTML With item enables applications to be added to
the Open HTML With list. All the browsers installed on the system, or any other
application (such as a text editor), can be added via the menu commands accessed via
the Open HTML With icon. The associated applications would typically be browser or
editor applications.
 After an application has been added to the Open HTML With list (except when added
with the Add Installed Browsers command), its name in the Open HTML With list can
be changed by selecting it, pressing F2, and editing the name.
 The icons to the right of each application listed in the Open HTML With list each opens
a menu containing commands to: (i) open the application; (ii) open the application and
load the linked HTML file; (iii) remove the application from the list. Double-clicking an
application name opens the linked HTML file in that application.
 Applications added to or removed from the Open HTML With list are also added to or
removed from the HTML Info window.
 The Imported item displays a list of the CSS files imported by the active CSS document.

Altova XMLSpy 2011 © 2010 Altova GmbH


HTML, CSS, JSON JSON 367

9.3 JSON
Altova website: JSON Editor

JSON documents can be edited using Grid View and the intelligent editing features of Text
View.
 Grid View provides a number of editing features that are very useful for editing large
files; these features are described in the Grid View section.
 The Text View features, as they apply to the editing of JSON documents, are listed
below.

Note: XMLSpy also provides conversion between JSON and XML in both directions. Clicking
the Convert from/to JSON command in XMLSpy converts the active document to the
other format.

Folding margins: Each JSON element can be collapsed and expanded by clicking,
respectively, the minus and plus icons to the left of the rule (see screenshot below). Note also
that line-numbering is enabled.

Structural marking: The pair of curly braces or square brackets that delimit a JSON element (
screenshot below) turns bold when the cursor is placed either before or after one of the braces
or brackets. This indicates where the definition of a particular element starts and ends.

Syntax coloring: A JSON document is made up of object strings, value strings, operators,
numbers and keywords. In Text View, each category of items can be displayed in a different
color (screenshot above) according to settings you make in the Options dialog (screenshot
below). You can set the colors of the various JSON components in the Text Fonts tab of the
Options dialog (screenshot below). In the combo box at top left, select JSON, and then select
the required color (in the Styles pane) for each JSON item.

© 2010 Altova GmbH User Manual


368 HTML, CSS, JSON JSON

Syntax checking: The syntax of a JSON document can be checked by selecting the
command XML | Check Well-Formedness (F7). The results of te well-formed check are
displayed in the Messages window (screenshot below).

The error message in the screenshot above points out an error in the document: Two double
quotes (a closing quote followed by an opening quote) occur consecutively; syntactically a
comma or a closing curly brace is required between the two quotes.

Converting between XML and JSON


The Convert to/from JSON command in the Convert menu converts an XML document, if it is
the active document, to a JSON document. Also, if a JSON document is active, it can be
converted to an XML document. For more information, see the User Reference.

Altova XMLSpy 2011 © 2010 Altova GmbH


HTML, CSS, JSON JSON 369

© 2010 Altova GmbH User Manual


370 WSDL and SOAP

10 WSDL and SOAP


Altova website: WSDL Editor

This section describes XMLSpy's WSDL and SOAP functionality.

WSDL
A WSDL document is an XML document that describes a web service. XMLSpy supports
WSDL 1.1 and WSDL 2.0. You can create and edit both WSDL 1.1 and WSDL 2.0 documents
in XMLSpy's WSDL View, which automatically provides the correct editing environment for
whichever WSDL version is being edited.

In XMLSpy's WSDL View a WSDL document can be constructed using graphical building
blocks, thus greatly simplifying their creation. WSDL View is described in the section, Editing
Views. For a hands-on description of creating a WSDL document, see the WSDL Tutorial in this
documentation. You can also view and edit WSDL documents in Text View and Grid View. In
these two views, WSDL documents are edited as straightforward XML documents.

SOAP
SOAP is an XML messaging specification, and it is used to transmit messages between
applications. In XMLSpy, not only can you create and edit a SOAP document in Text View and
Grid View with XMLSpy's intelligent editing features for XML documents, but you can generate a
SOAP request file from a WSDL file. How to generate a SOAP request from a a WSDL file is
described in the WSDL Tutorial. XMLSpy is able to also send and receive SOAP requests
(using commands in the SOAP menu). Additionally, you can debug SOAP requests with
XMLSpy's SOAP Debugger, which is described in a sub-section of this section.

Altova XMLSpy 2011 © 2010 Altova GmbH


WSDL and SOAP WSDL Tutorial 371

10.1 WSDL Tutorial


This tutorial is divided into two parts:
 In the first part, we show how a WSDL 1.1 document is created in the graphical WSDL
View of XMLSpy. In this part, you will: (i) create a rudimentary WSDL 1.1 document
using the File | New menu option; (ii) create a PortType; (iii) create a binding; (iv)
create a service and a port; (v) validate the document and save it.
 In the second part, we show how to connect to a web service, save the WSDL file
locally, and send a SOAP request to the web service

You can do all this in the graphical WSDL View and do not have to use the Text View. You can
directly manipulate the WSDL components using drag and drop, as well as enter values of
properties in the Entry Helpers of the WSDL View.

10.1.1 Creating a New Document


To create a new WSDL document, select the File | New command. In the Create New
Document dialog that pops up, select WSDL (WSDL Web Service Description v1.1) as the type
of document you wish to create and click OK. This creates a skeleton new document (
screenshot below), which opens in the graphical WSDL View (called WSDL View in this
tutorial).

Assigning a target namespace


Switch to Text View. The start tag of the wsdl:definitions element will look something like
this:

Change the target namespace (targetNamespace) attribute to


http://mywebservice.namespace or anything else you like (since this tutorial focuses on
showing how to create a WSDL document and does not provide an actual service). You should
then also change the namespace value of the tns attribute to
http:://mywebservice.namespace (or the namespace you selected for the target
namespace).

Note: In the skeleton starter document, WSDL elements are in the target namespace while

© 2010 Altova GmbH User Manual


372 WSDL and SOAP WSDL Tutorial

references to WSDL elements are made using the tns prefix. For example:
<wsdl:binding name="NewBinding" type="tns:NewPortType">. In order for the
tns prefix to match the target namespace, its namespace value should be identical with
the target namespace.

10.1.2 Creating a PortType


Creating a PortType involves the following:
 Naming the PortType
 Inserting an operation
 Adding input and output messages
 Adding parameters to messages

Naming the PortType


Rename NewPortType to MyPortType by double-clicking in the title bar of the NewPortType box
in the design, then editing the name and pressing Return. Notice that the name of the PortType
also changes in the Overview and Detail entry helper (screenshot below).

Inserting an operation
In the case of MyPortType, an operation, NewOperation, is already present, so we will work
with this. Start by renaming NewOperation to, say, EchoString (double-click its name, edit, and
press Return). (To insert additional operations for a PortType, right-click the PortType box,
select Append Operation, and then click the required type of operation.)

Adding input and output messages


When an operation is appended to a PortType, you can select whether the operation should be
one of five types:
 Request response
 Solicit response
 One-way
 Notification

Altova XMLSpy 2011 © 2010 Altova GmbH


WSDL and SOAP WSDL Tutorial 373

 Empty operation

For each type, input and output messages are added automatically according to the operation
type. When Empty operation is selected, right-clicking the operation allows you to select a
message type to insert. A message can be deleted by right-clicking and selecting Delete input/
output/fault element. In the case of the EchoString operation, rename the input and output
messages to EchoStringRequest and EchoStringResponse, respectively.

Adding parameters to messages


Each input or output message is created with a single default message part (or parameter) of
type xs:string (see screenshot below). To add another parameter, right-click either the
message or one of its parameters and select Add message part (parameter).

To edit a parameter do one of the following: (i) double-click the text to edit it; or (ii) right-click the
parameter and select Edit, or (iii) use the Detail entry helper (see screenshot above).

10.1.3 Creating a Binding


A binding is a concrete protocol and data format specification for a particular PortType. Creating
a binding therefore involves the following:
 Associating the binding with a PortType.
 Defining the binding's protocol and data format specification.
 Associating the binding with a port.

© 2010 Altova GmbH User Manual


374 WSDL and SOAP WSDL Tutorial

Associating a binding with a PortType


When a new binding is created (to create one, right-click anywhere in an empty area of the
design and select Insert Binding), it has no PortType associated with it (screenshot below). (If
you have created a new WSDL document, the binding created by default will be associated, by
default, with the PortType that was created by default, and the association will be shown by a
line joining the two boxes.).

To associate a PortType with a binding, in the new Binding box click the Down arrow of the
PortType entry (see screenshot above). This pops up a list of PortTypes defined in the
document. Select the PortType with which you wish to associate the binding. When a PortType
has been associated with the binding, the association is indicated by a line joining the box of the
the selected PortType to the Binding box, like this:

Selecting the protocol and data format


The protocol of the binding is selected by clicking the down arrow in the title bar of the Binding
box (that of the soap/http entry), and selecting one of the four available protocols: SOAP, SOAP
1.2, HTTP-GET, and HTTP-POST (screenshot below). When the SOAP 1.1 or 1.2 protocol is
chosen, you can select document or rpc as its data format (using the list options list popped up
by the dropdown arrow to the right of the protocol selection).

The soapAction for each operation in the binding can be defined in the design (see screenshot
above) or in the Detail entry helper when that operation is selected.

Associating the binding with a port


To associate the binding with a port, the port has to be first defined. How to create a port within
a service and associate a port with a binding is described in the section Creating a Service and
Ports.

Altova XMLSpy 2011 © 2010 Altova GmbH


WSDL and SOAP WSDL Tutorial 375

10.1.4 Creating a Service and Ports


To add a new service, right-click in an empty space of the design and select Insert Service from
the context menu. If you have created a new WSDL document, a service will already be present
in the design. You can rename the service by double-clicking in its name, editing the name, and
pressing Return. Notice that the name of the service also changes in the Overview entry helper
(screenshot below).

In the Overview entry helper, double-click the NewPort entry, change it to MyPort., and press
Return. Notice that the name of the port also changes in the MyService box in the design (
screenshot above). To add additional ports, right-click either the service or the port, and, from
the context menu, select Insert Port.

Entering the address of a port


The address of a port can be entered either: (i) directly in the design, as the value of the
Location item (see screenshot above), or (ii) in the Detail entry helper (by double-clicking in
the Location field and entering the address (screenshot below)).

Associating a binding with a port


A port is the endpoint that combines a binding with a network address. Once a port's address
has been defined, all that needs to be done is associate a binding with the port. To associate a
binding with a port, click the down arrow of the Binding item of a port and select from the list of
bindings defined in the document.

© 2010 Altova GmbH User Manual


376 WSDL and SOAP WSDL Tutorial

Note: If a binding is already associated with a port and you wish to associate another binding,
you have to remove the binding reference (using the port's right-click menu), and then
insert the new binding reference.

10.1.5 Validating the WSDL Document


After completing the WSDL document, it can be validated by selecting the XML | Validate XML
(F8) command. The results of the validation are displayed in the Validation output bar below the
Main Window (screenshot below).

Detailed information about any error detected is displayed, enabling you to quickly locate the
error and fix it.

10.1.6 Connecting to a Web Service and Opening Files


In this section, you will learn how:
 A web service can be accessed using XMLSpy
 A WSDL file on the web can be opened in XMLSpy
 An XML Schema associated with the WSDL document can be opened in XMLSpy

Accessing a web service


A web service is typically accessed via an HTML page. One such page is DebuggerClient.htm
, which is in the project Examples/SoapDebugger. To access the web service displayed on this
page, do the following:
1. Activate the Project window if it is not visible (using the menu option Window | Project
window).
2. Click the expand icon next to the SOAP Debugger folder, and double-click the file
DebuggerClient.htm. This opens the SOAP Debugger Example Client in the Main
Window.

Altova XMLSpy 2011 © 2010 Altova GmbH


WSDL and SOAP WSDL Tutorial 377

Opening a WSDL file in XMLSpy


To open a web-based WSDL file in XMLSpy, do the following:
1. Select the menu option File | Open and, in the Open dialog, click the Switch to URL
button. Then enter or copy the address
http://www.nanonull.com/TimeService/TimeService.asmx?WSDL into the File URL
field of the dialog box.

2. Click OK to load the WSDL file. The WSDL file is displayed in Text View.
3. Select the menu option File | Save As, and save the file locally, naming it, say,
timeservice.wsdl.
4. Click the WSDL View tab to display the file in the graphical WSDL editor.

Viewing the schema file associated with the active WSDL file
With the timeservice.wsdl file as the active document in WSDL View, select the menu
option WSDL | Types | Edit Schema(s) in Schema View. This opens the schema file that
defines all the datatypes used in the timeservice.wsdl file. You can modify the schema and
save changes. These changes will take effect as soon as the WSDL file is re-parsed.

10.1.7 Sending a SOAP Request from the WSDL File


To send a SOAP request from the timeservice.wsdl file, do the following:
1. Make timeservice.wsdl the active file in the Main Window.
2. Select the menu option SOAP | Create new SOAP request.
3. Browse for the file timeservice.wsdl and confirm with OK.
4. If, among the various services defined in the document, there is more than one port that
references a SOAP 1.1 or 1.2 binding, then a popup appears (screenshot below)
prompting you to select the required Service and Port. After making the selection, click
OK.

© 2010 Altova GmbH User Manual


378 WSDL and SOAP WSDL Tutorial

5. In the dialog box that then pops up (screenshot below), select a SOAP operation, for
example, getServerTime, and click OK.

This creates a SOAP request document containing the getServerTime operation.


6. Make the request document and select the menu option SOAP | Send request to
server. The SOAP response document appears in the Main Window, containing the
element getServerTimeResult, which displays the current server time of the
Nanonull.com time service.

10.1.8 Creating WSDL Documentation


The WSDL | Generate Documentation option allows you to produce detailed documentation of
the current WSDL document. You can output the documentation as an HTML, MS Word, or
RTF file and specify the components you want to include. Related WSDL elements are
hyperlinked in the generated documentation, allowing easy navigation.

Note: In order to generate documentation in MS Word format, you must have MS Word
(version 2000 or later) installed.

To generate documentation for the WSDL file, do the following:


1. Make timeservice.wsdl the active document.
2. Switch to WSDL view.
3. Select the menu option WSDL | Generate Documentation.
This opens the WSDL Documentation dialog box (screenshot below).
4. Select the type of output you want to generate, HTML, MS Word, or RTF.
5. Select the specific WSDL components you want to include in the documentation, and
set other options (see WSDL Documentation Options below).

Altova XMLSpy 2011 © 2010 Altova GmbH


WSDL and SOAP WSDL Tutorial 379

6. Click OK and enter the name of the WSDL documentation file in the Save as dialog
box.

WSDL documentation options


You can select from among the following documentation options:
 The required format is specified in the Output Format pane: either HTML, Microsoft
Word, or RTF. The documentation can be generated either as a single file or be split
into multiple files. When multiple files are generated, each file corresponds to a
component. What components are included in the output is specified using the check
boxes in the Include pane.
 The Embed Diagrams option is enabled for the MS Word and RTF output options.
When this option is checked, diagrams are embedded in the result file, either in PNG or
EMF format. Otherwise diagrams are created as PNG or EMF files, which are displayed
in the result file via object links. When the output is HTML, all diagrams are created as
document-external PNG files.
 In the Include pane, you select which items you want to include in the documentation.
The Overview option lists all components, organized by component type, at the top of
the file.
 The Details pane lists the details that may be included for each component. Select the
details you wish to include in the documentation.
 The Show Result File option is enabled for all three output options. When this option is
checked, the result files are displayed in Browser View (HTML output), MS Word (MS
Word output), and the default application for .rtf files (RTF output).

10.1.9 Converting to WSDL 2.0


In XMLSpy you can easily convert an existing WSDL 1.1 document to the WSDL 2.0 format. Try
this with the TimeService.wsdl example, as follows:

© 2010 Altova GmbH User Manual


380 WSDL and SOAP WSDL Tutorial

1. Make the file TimeService.wsdl the active file. (This file is in the WSDL Editor folder
in the Examples project of XMLSpy.)
2. Click the command WSDL | Convert to WSDL 2.0.
3. In the Save As dialog that appears, enter the name with which you wish to save the
WSDL 2.0 file, for example, TimeService20.wsdl..
4. The new file is generated, automatically validated, and displayed in WSDL View.

Altova XMLSpy 2011 © 2010 Altova GmbH


WSDL and SOAP SOAP 381

10.2 SOAP
Altova website: SOAP Debugger

In this section you will learn how to:


 Validate SOAP messages against WSDL. SOAP messages can be checked for validity
not only against the SOAP specification but as well as against any XML Schemas
referenced in the corresponding WSDL definition
 Send and receive SOAP requests using the SOAP debugger
 Set breakpoints for sending and receiving SOAP requests
 Edit an incorrect SOAP request before sending it on to the web service

When developing an application that accesses data from a web service and does further data
processing, something might happen that you don't expect. This chapter explains how to see
and edit the data that is actually transmitted. This is done using the SOAP debugger. It works as
a proxy server between your client and the web service. The debugger functionality goes a lot
deeper than a normal trace utility that only stores every call's Request and Response.

SOAP debugger allows you to set breakpoints for every Request and Response message and
even define Conditional breakpoints via XPath expressions.

SOAP debugger supports:


 Stepping through SOAP requests and responses
 Modification of the SOAP requests and responses
 Forwarding of modified requests to the client or server

10.2.1 SOAP Validation


SOAP messages can be checked for validity not only against the SOAP specification but also
against any XML Schemas referenced in the corresponding WSDL definition.

Validating against SOAP rules only


To validate a SOAP message, open the SOAP message file (screenshot below) and press F8
(or the menu command XML | Validate). Since no WSDL file has been linked to the SOAP
message file, the SOAP message is validated according to the rules for SOAP messages. The
file is found to be valid if it is valid according to these rules (see the Messages Window in the
screenshot below).

© 2010 Altova GmbH User Manual


382 WSDL and SOAP SOAP

Validating against SOAP rules and linked WSDL


To validate a SOAP message additionally according to the linked WSDL, the WSDL file must be
linked to the SOAP file. This is done in the SOAP tab of the Info Window (screenshot below).
Click the button to the right of the WSDL for Validation item and select the command Select
WSDL for Validation. In the dialog that pops up, browse for the WSDL file you want and click
OK. The WSDL file will be entered in the Info Window and the SOAP message file will be linked
to it.

On pressing F8 (or the menu command XML | Validate) the SOAP message will be validated
not only against the rules for SOAP messages but also against the rules in the linked WSDL
file.

The file is found to be valid if it is valid according to both sets of rules (see screenshot above).

10.2.2 SOAP Communications Process


Once the proxy server (SOAP debugger) has been started, the SOAP communication process
is as follows:

 Proxy server listens continually to a socket/port for incoming client requests


1. Client application sends a request to proxy server
2. Client requests can be modified if/when breakpoints have been triggered
3. Proxy server request data is forwarded to the web service server

 The webservice server responds to the proxy request, and sends the response data
back to the proxy server
4. Server responses can be modified if/when breakpoints have been triggered
5. Proxy server response data is forwarded to the client application

 Client application receives response data from proxy server

How to... example client and server applications:


 The Client application, which sends and receives SOAP messages is the Browser
window
 The "Nanonull Time Service" service will act as the web service server.
The URL for this web service is:
http://www.nanonull.com/TimeService/TimeService.asmx?WSDL

Altova XMLSpy 2011 © 2010 Altova GmbH


WSDL and SOAP SOAP 383

Port settings
The SOAP debugger uses the 8080 port to monitor the clients' requests. The port can only be
altered when a new SOAP debugging session is started.

Please note: This port may be disabled by personal firewalls, or advertising filters. You would
therefore have to disable these programs, or select a different port address.

10.2.3 Using SOAP Debugger


To use the SOAP debugger:

1. Start XMLSpy.
2. Select the menu option Project | Open Project.
3. Select the Examples.spp file in the C:\Documents and Settings\<username>\My
Documents\Altova\XMLSpy2011\Examples folder.
4. Click the + sign of the SOAP Debugger folder to see the folder contents.

5. Double-click the DebuggerClient.htm file to start the SOAP Client and connect to the
web service.

© 2010 Altova GmbH User Manual


384 WSDL and SOAP SOAP

The Browser View displays the current Eastern Standard Time (7:09 in this example).
6. Click the GMT radio button to see the current Greenwich Mean Time.

An error has obviously occurred at this point. We should have a correct time in the
clock display. We will have to activate the SOAP debugger to analyze the SOAP
messages, and see if we can locate the error and perhaps fix it.

Configuring the SOAP debugger


To configure the SOAP debugger:
1. Select the menu option SOAP | SOAP debugger options.
2. Activate the "Hide project/info windows" check box, and click OK to confirm.

Altova XMLSpy 2011 © 2010 Altova GmbH


WSDL and SOAP SOAP 385

This allows more room for the SOAP request and response windows. Make sure you
define these settings before you start the SOAP debugger session.

Starting the SOAP debugger


To start the SOAP debugger:
1. Select the menu option SOAP | SOAP Debugger Session. This opens the "Enter the
WSDL file location..." dialog box.

2. Enter the WSDL file location (shown below into the text box
http://www.nanonull.com/TimeService/TimeService.asmx?WSDL and click OK.
The following dialog box displays the source and target port settings. The source port
setting (8080) is a default setting and is automatically entered. This setting can be
changed every time the debugger is started. The target settings are supplied by the
WSDL file, and also appear automatically. If the port number of the target ends with
443, the Secure Connection (via https) check box will be checked by default. If any
other port number is entered, then you must check the Secure Connection check box
manually. Click the HTTPS Settings button to select the secure connection options
(see the section Change SOAP Request Parameters for details about using these
options).

3. Click OK to start the SOAP debugger session. This opens the SOAP debugger proxy

server in its inactive state. You can see this by noting that the proxy server icon is

© 2010 Altova GmbH User Manual


386 WSDL and SOAP SOAP

disabled. If you are using the https protocol, you might wish to allow a host name
mismatch or an expired server certificate. To make these settings, click the HTTPS
Settings button. The HTTPS Settings dialog (screenshot below) appears.

4. In the HTTPS Settings dialog, you can allow that the host name given in the SOAP
request need not match the host name in the server certificate; do this by checking the
Allow host name mismatch check box. If you wish to allow the connection despite an
expired server certificate, then check the Allow expired server certificate check box.
Confirm the changes with OK.

About trusted certificates


Altova products use Internet Explorer (IE) to access and manage trusted certificates of secure
webservers. Installing the certificate of a webserver in IE allows IE to access the webserver
without issuing a warning or aborting the process. In order to install the certificate of a secure
webserver, do the following:
 In Internet Explorer 8, open the secure website.
 Select File | Properties, and click the Certificates button.
 Click Install Certificate and start the Import Certificate Wizard. (This Wizard can also
be accessed via Tools | Internet Options| Content | Certificates | Import.)
 The certificate should be placed in the Trusted Root Certification Authorities store, for
which you can browse manually.
 Finish the Wizard steps, close the Certificates and Properties dialogs respectively by
clicking OK. You might need to restart Internet Explorer.

Setting debugger breakpoints


To set debugger breakpoints:
This web service uses the method getTimeZoneTime to find the time zone time.
1. Activate the On Request and On Response check boxes for this method (
getTimeZoneTime). This enables you to analyze both SOAP requests and responses
for errors.

Altova XMLSpy 2011 © 2010 Altova GmbH


WSDL and SOAP SOAP 387

2. Click the GO icon (or use the menu command SOAP | GO).
3. Click the DebuggerClient tab to switch to the Client. You may have to select Window |
DebuggerClient.htm to see the contents.

4. Click the Turn On Debugging Mode button in the client window.

This displays a "Debugging is on" message, and sends the SOAP request to the
debugger.

Viewing and editing the SOAP request


The SOAP request automatically appears in the SOAP request window of the debugger, in Text
view. We can now look at the request and edit any errors it might contain.

© 2010 Altova GmbH User Manual


388 WSDL and SOAP SOAP

Looking at the timezone element, we notice that the value is GMD. This cannot be
correct, so we will change it to GMT and see what happens.

1. Double-click in the timezone field, and change the entry to GMT.

2. Click the GO icon (or use the menu command SOAP | GO) to send the corrected
request to the web service.
After a few seconds, the web service response to the SOAP request appears in the
SOAP response window. Select View | Word wrap to see the contents as displayed in
the diagram below.

We did not receive an error message in the response, so we can assume that this is
the correct time.

3. Click the debugger GO icon to send this response to the client (the Browser
window in this case).
4. Click the DebuggerClient.htm tab to switch back to the client, and see the new result.

The error message has disappeared, and the correct GMT time is displayed.
5. Select the menu option SOAP | SOAP debugger session to close the debugger

Altova XMLSpy 2011 © 2010 Altova GmbH


WSDL and SOAP SOAP 389

session.

Fixing the error


Now that we know that the client is actually sending the invalid value "GMD" instead of "GMT"
in its request and the server would correctly respond to "GMT", we have successfully identified
the SOAP Client as being the component that causes the error, so we can go about fixing it.

In the DebuggerClient.htm window:


1. Click the Text View button, open the Find dialog (Edit | Find), and search for "GMD".
XMLSpy will display this code fragment:

2. Change the value from "GMD" to "GMT" and switch back to the Browser View.
The SOAP Client now works correctly, the "Unknown Time zone" message has gone
and the correct time appears in the window.

Closing SOAP Debugger


To close the SOAP Debugger session, click the command SOAP | SOAP Debugger Session.

10.2.4 Breakpoints in SOAP Debugger


The SOAP Debugger window is where you set and delete breakpoints. It is separated into two
tabs (screenshot below).

Function-Breakpoints tab
The Function-Breakpoints tab allows you to set a breakpoint on Requests and/or Responses to
SOAP methods. The debugger highlights the line of the function which triggered the breakpoint.
Data packets to and from the client are analyzed and matched to the corresponding functions
from the WSDL file. If a breakpoint is set for a specific method, then this is where the SOAP
debugger stops. The toolbar buttons are enabled at this point.

The data is displayed in the Soap Request or Soap Response document window. The SOAP
documents displayed in the SOAP windows can be modified at this point. The data is sent the
moment you click one of the toolbar icons (except for the Stop Server icon).

Conditional-Breakpoints
The Conditional-Breakpoints tab (screenshot below) allows you to use XPath expressions to
define breakpoints. If a SOAP request causes an error, the SOAP response must contain a

© 2010 Altova GmbH User Manual


390 WSDL and SOAP SOAP

faultcode element. We therefore would like to have a breakpoint triggered whenever a


faultcode element appears.

To add a conditional breakpoint, do the following:


1. Click the Conditional Breakpoints tab, and then the Add button. The dialog shown
below appears.

2. Enter the XPath expression (for example, .//faultcode) in the XPath field.
3. Select the required XPath version (1.0 or 2.0) and the Break when XPath nodes found
radio button.
4. Click OK to confirm the settings. The SOAP debugger will stop whenever a
.//faultcode element appears in a SOAP request or response.

The various options in this dialog are described below:


 XPath expression field: Enter the specific XPath expression/node here. An XPath has to
be entered here to be able to use any of the specific radio button options.
 Version: The XPath version you wish to use for the XPath expression.
 Break instruction radio buttons: The debuggers stops when the selected option occurs.
The available options are: (i) Break when the targeted XPath node matches the value
entered in this field; (ii) Break when the specified XPath node exists in the SOAP
request or response; and (iii) Break when the specified XPath node does not exist in the

Altova XMLSpy 2011 © 2010 Altova GmbH


WSDL and SOAP SOAP 391

SOAP request or response.


 Requests and Responses: Specifies whether the options in the dialog are to be applied
in SOAP responses and/or requests.
 Functions: Either all methods/functions are scanned for the condition you define (Any
function radio button) or you enter a a specific method/function to scan.

For the condition defined in the dialog displayed above, the following conditional breakpoint will
be listed in the Conditional-Breakpoints tab.

Given below is a description of the columns in this tab:


 The Operation column contains the method/function being searched. If you selected
the Any function radio button then this field remains empty. If you selected a specific
method/function, then this method/function is displayed here.
 The XPath column contains the XPath expression you defined.
 The Value column contains the XPath value against which the nodes returned by the
XPath expression are checked for a match. If you selected Break on value, the specific
string you entered is displayed here. If you selected Break when XPath nodes found,
then <--Exist--> is displayed. If you selected Break when XPath nodes missing, then
<--Missing--> is displayed.
 The In Requests and In Responses check boxes indicate where the condition is
checked. You can change the settings by directly clicking the check box in the column.

To edit a conditional breakpoint, double-click its line in the tab or click the Change button (see
screenshot above). To delete a conditional breakpoint, select the line you want to delete and
click Delete.

© 2010 Altova GmbH User Manual


392 XBRL

11 XBRL
Altova website: XBRL Taxonomy Editor, XBRL Validator

XMLSpy's XBRL View is an XBRL taxonomy editor that provides a graphical overview of XBRL
taxonomies and intelligent taxonomy editing features. In this section we describe how to create
and edit taxonomies in XBRL View.

This section is organized as follows:


 It starts with a brief look at the distinction between new and existing taxonomies and the
significance of this distinction. This is followed by an explanation of the files that
constitute an XBRL taxonomy and how these are displayed in XBRL View.
 Starting with the section Creating a New Taxonomy, we describe, step-by-step, how to
build a taxonomy in XBRL View. How to use the New Taxonomy Wizard is also
explained in the process. At the end of each section is a set of instructions to guide you
with the creation of your own taxonomy in XBRL View. Each set of instructions helps
you put into practice or test the information given in that section, and it builds upon the
taxonomy created till that point using instructions in previous sections.

For more related information, see the sections: Editing Views | XBRL View and the description
of commands in the XBRL menu. For example, information about generating documentation for
the taxonomy (as seen in XBRL View) will be found in the section User Reference | XBRL Menu
| Generate Documentation.

Altova XMLSpy 2011 © 2010 Altova GmbH


XBRL Taxonomies: New and Existing 393

11.1 Taxonomies: New and Existing


In XMLSpy's XBRL View you can edit existing taxonomies and create new taxonomies.
 Existing taxonomies: There are two types of existing taxonomies: (i) standard
taxonomies that should not be edited; and (ii) non-standard taxonomies which may be
edited; these might have been created by you or another party.
 New taxonomies: New taxonomies can be created in XMLSpy. These are of two types:
(i) taxonomies that are created from scratch; and (ii) taxonomies that extend a standard
taxonomy.

Both kinds of taxonomies can be viewed and edited in XBRL View. In some cases, such as
when a standard taxonomy is imported into a taxonomy you are creating (in order to extend the
imported taxonomy), you will not be allowed to edit the imported taxonomy. Elements from
imported taxonomies that are not allowed to be edited are displayed in gray.

Steps for creating a new taxonomy


A new taxonomy typically will build on an existing one. In the new taxonomy, new elements will
be added, and relationships between these new elements and between new elements and
imported elements will be created. The general requirements of a new taxonomy and how you
would go about creating one are outlined below:
1. The new taxonomy must be created in its own namespace in order to distinguish it from
other taxonomies. If the new taxonomy is to extend an existing one, the existing
taxonomy must be imported into the new taxonomy.
2. New concepts (elements) are defined in the new taxonomy.
3. Relationship files (or linkbases) are created to contain the definition, presentation,
calculation, label, and reference relationships of the new taxonomy.
4. Relationships for the new taxonomy must be built from scratch.

In the description above, we have used the term taxonomy to denote the entire taxonomy, which
comprises several files: the concept definitions files and the relationship files. (See the section
Taxonomy Document Files for a description of the various files that comprise a taxonomy.)

Using XBRL View


In the sections that follow, we describe how to use the features of XBRL View to create and edit
taxonomies. Starting with the section, Creating a New Taxonomy, we provide instructions, at the
end of each section, for creating your own taxonomy. The instructions in each successive
section build upon the work of previous sections. By the time you reach the section Creating
Relationships: Part 1, you will have become familiar with XBRL View and be able to use it
confidently.

The taxonomy you will be creating leads, with additional work, to the taxonomy supplied with
XMLSpy (Nanonull.xsd) and which is located in the folder C:\Documents and Settings
\<username>\My Documents\Altova\XMLSpy2011\Examples\XBRLExamples\Nanonull.
(Note that the main taxonomy file always has the extension .xsd. The file extension .xbrl is
used for XBRL instance files and not for taxonomy files.)

© 2010 Altova GmbH User Manual


394 XBRL Taxonomy Files Overview

11.2 Taxonomy Files Overview


A well-designed XBRL taxonomy stores taxonomy concepts in a separate file from the
taxonomy relationships. We call this file the main taxonomy file or the concept definitions file.
Furthermore, since there are different kinds of relationships, relationships will be stored in
separate files for each kind. The table below lists the different kinds of files that normally
constitute a taxonomy document.

XBRL File Description File Type


Concepts Each concept is defined in an XML Schema XML Schema file (.xsd
element element. ) Concept definitions
file
Definition A definitionLink element contains all locators XML file (.xml)
Relationship and definition arcs for concept relationships.
s
Calculation A calculationLink element contains all the XML file (.xml)
Relationship locators and calculation arcs.
s
Presentation A presentationLink element contains all the XML file (.xml)
Relationship locators and presentation arcs.
s
Labels A labelLink element contains all the locators, XML file (.xml)
label arcs, and labels.
References A referenceLink element contains all the XML file (.xml)
locators, reference arcs, and reference
resources.

The locations of the relationship files are specified in the concept definitions file (the .xsd file)
inside a /schema/annotation/appinfo element:
<xsd:annotation>
<xsd:appinfo>
<link:linkbaseRef xlink:arcrole="
http://www.w3.org/1999/xlink/properties/linkbase"
xlink:href="NanonullLabels.xml" xlink:type="simple"
xlink:role="http://www.xbrl.org/2003/role/labelLinkbaseRef" />
<link:linkbaseRef xlink:arcrole="
http://www.w3.org/1999/xlink/properties/linkbase"
xlink:href="NanonullDefinitions.xml" xlink:type="simple"
xlink:role="http://www.xbrl.org/2003/role/definitionLinkbaseRef" />
<link:linkbaseRef xlink:arcrole="
http://www.w3.org/1999/xlink/properties/linkbase"
xlink:href="NanonullPresentations.xml" xlink:type="simple"
xlink:role="http://www.xbrl.org/2003/role/presentationLinkbaseRef" />
<link:linkbaseRef xlink:arcrole="
http://www.w3.org/1999/xlink/properties/linkbase"
xlink:href="NanonullCalculations.xml" xlink:type="simple"
xlink:role="http://www.xbrl.org/2003/role/calculationLinkbaseRef" />
<link:linkbaseRef xlink:arcrole="
http://www.w3.org/1999/xlink/properties/linkbase"
xlink:href="NanonullReferences.xml" xlink:type="simple"
xlink:role="http://www.xbrl.org/2003/role/referenceLinkbaseRef" />

</xsd:appinfo>

Altova XMLSpy 2011 © 2010 Altova GmbH


XBRL Taxonomy Files Overview 395

</xsd:annotation>

When the concept definitions file (the .xsd file) is open in XBRL View, the various taxonomy
files are displayed in a tree structure in the Overview entry helper (screenshot below).

In the screenshot above, notice the icons to the left of the file names. XML Schema (.xsd) files
are indicated with an XSD icon. The relationship files have a colored file icon with a character
corresponding to the initial character of the relationship kind. For example, a icon indicates a
Definition relationships file, a icon indicates a Presentation relationships file, and so on.
Double-clicking any of these files opens it in XMLSpy, where it can be edited in Grid View (
screenshot below) or Text View.

© 2010 Altova GmbH User Manual


396 XBRL Creating a New Taxonomy

11.3 Creating a New Taxonomy


A new taxonomy would typically be created to extend one or more standard taxonomies. If a
new taxonomy builds upon a standard taxonomy or an already existing taxonomy, it must import
the existing taxonomy. Alternatively, a new taxonomy can be built from scratch. In XMLSpy's
XBRL View, you can easily import US-GAAP and IFRS taxonomies using the New Taxonomy
Wizard. The taxonomy can then be modified using the graphical interface of XBRL View.

The first step in creating a new taxonomy is to create its concept definitions file, which is an
XML Schema (.xsd) file. Besides containing concept definitions, this file defines and declares
the namespace of the new taxonomy, locates taxonomies to be imported, locates the
relationships files of the taxonomy, and declares the namespace of imported taxonomies and
other namespaces used.

Creating the concept definitions file


To create a new XBRL taxonomy, select the menu command File | New. This pops up the
Create a New Document dialog (screenshot below).

Select xsd: XBRL Taxonomy Schema and then click OK. This pops up the first screen of the
New Taxonomy Wizard (screenshot below).

Altova XMLSpy 2011 © 2010 Altova GmbH


XBRL Creating a New Taxonomy 397

The New Taxonomy Wizard helps you create XBRL taxonomies that are conformant with US-
GAAP and IFRS requirements. Essentially it imports the taxonomies you specify. Subsequently,
the file can be edited as required.

In the first dialog of the wizard, enter the following:


 The ticker symbol (or name) of the company for which the taxonomy is being created.
Listed companies typically have a unique ticker symbol, and a number of important
taxonomy properties and components will be named on the basis of the ticker symbol
you enter. For example, the ticker symbol you enter in the Ticker Name field will be
used to automatically generate the taxonomy namespace and the names of the
taxonomy's relationship files (see screenshot above). If the company has no ticker
symbol, you can enter in this field the name of the company for which you are creating
this taxonomy.
 The taxonomy base. Options are: US-GAAP 2009, US-GAAP 1.0, IFRS, and None. The
taxonomy that you select in this combo box will form the base of your taxonomy. The
next dialog that the wizard displays will depend on what taxonomy base you select. The
various taxonomy bases are explained in the description of the second screen of the
wizard.
 The date. This can either be entered directly or be selected via a date-picker available
in the dropdown of the combo box. The date, like the ticker symbol, will be used to
generate the taxonomy namespace and the names of the taxonomy's relationship files.
 The destination folder is the location where the main taxonomy file and associated files
will be saved.

© 2010 Altova GmbH User Manual


398 XBRL Creating a New Taxonomy

 The taxonomy namespace (target namespace of the main taxonomy concepts file,
which is a .xsd file) and the names of the concept definitions file (Schema File) and the
of relationship files are generated automatically from: (i) the ticker symbol (or company
name) and (ii) the date. If you try to edit any of these, you will receive a warning to the
effect that changing the values in these fields would lead to non-conformance with the
rules of the relevant taxonomy.

After you have finished, click Next. The dialog that is displayed next depends on what you
selected as the base for your taxonomy. There are three possibilities:
 If you selected US-GAAP, then the US-GAAP-specific second screen of the New
Taxonomy Wizard appears (screenshot below). You can now select the entry points
you wish to include in the taxonomy, as well as specify whether the US-GAAP Core
Schema should be imported (check box at the bottom of the dialog).

When you click Finish, a new concept definitions (.xsd) file that imports the selected
entry-point schemas is created in the destination folder you specified in the wizard. The
taxonomy opens in XBRL View and is ready to be edited.
 If you selected IFRS as the base for your taxonomy, the IFRS-specific second screen of
the New Taxonomy Wizard appears (screenshot below). Click the link in the dialog to

Altova XMLSpy 2011 © 2010 Altova GmbH


XBRL Creating a New Taxonomy 399

go to the IFRS website, where you can generate a ZIP file containing your customized
entry-point schema. Download the ZIP file and unpack it to a local folder. Browse for the
entry-point schema in the local folder, select it, and then click Finish in the wizard.

When you click Finish, a new concept definitions (.xsd) file that imports the selected
entry-point schemas is created in the destination folder you specified in the wizard. The
taxonomy opens in XBRL View and is ready to be edited.
 If you selected None (that is, no base taxonomy), a new concept definitions (.xsd) file is
created in the destination folder you specified in the wizard and opens in XBRL View.
Notice that two elements (xbrldt:hypercube and xbrldt:dimension) are
automatically created and that the basic schemas required for every taxonomy have
been imported automatically (see Overview entry helper).

After you have created your base taxonomy, the next steps are: (i) to create a namespace for
the taxonomy (the target namespace of the schema); and (ii) to import the taxonomy or
taxonomies on which the new taxonomy is to be built. If you have used the New Taxonomy
Wizard, a default taxonomy namespace will have been created and the relevant taxonomies will
have been imported.

Example file: Step 1


Create a new taxonomy document using the New Taxonomy Wizard as described above (using
US-GAAP 1.0 as the base taxonomy and importing the US-GAAP 1.0 Core Schema), and save
the taxonomy with any name to a suitable location. This file is the main taxonomy file, or
concept definitions file. It is an XML Schema file and must have a .xsd file extension. We will
refer to the file we are creating as Nanonull.xsd. This is the same name as that of the supplied
example in C:\Documents and Settings\<username>\My Documents\Altova\XMLSpy2011\
Examples\XBRLExamples\Nanonull. We have also simplified the names of the relationship
files by leaving out the date-generated part of their names.

In the next step we will modify the target namespace of the taxonomy that was automatically

© 2010 Altova GmbH User Manual


400 XBRL Creating a New Taxonomy

created by the New Taxonomy Wizard.

Altova XMLSpy 2011 © 2010 Altova GmbH


XBRL Namespaces in the Taxonomy 401

11.4 Namespaces in the Taxonomy


Taxonomy namespaces can be managed in the Namespaces dialog (screenshot below), which
is accessed in XBRL View via the menu command XBRL | Namespaces. In the dialog, you can
declare namespaces, and associate prefixes and background colors for each namespace. Edits
made in this dialog modify the declarations of namespaces in the taxonomy.

The Namespace Prefixes dialog lists all the namespaces in the taxonomy.
 To add or delete a namespace, use the Add or Delete buttons, respectively. After
adding a namespace, edit the default prefix and default URI by double-clicking in the
respective field and entering the changes.
 A color can be assigned to a namespace via the color palette for that namespace. If a
color has been assigned to a namespace, all components in that namespace will be
displayed with this color as its background in the Main Window and entry helpers of
XBRL View. Note that a color setting for a given namespace applies for that
namespace across all taxonomy documents opened in XBRL View.

When you have finished editing in the Namespaces dialog, click OK to make your editing
changes take effect.

The target namespace


The target namespace of a taxonomy is defined in the xs:targetNamespace attribute of the
taxonomy's xs:schema element (see listing below). (The xs:schema element is the document
element of the concept definitions file.)
<xs:schema targetNamespace="http://www.altova.com/XBRL/Taxonomies">
...
</xs:schema>

In addition to defining the target namespace (specifying it, that is), the target namespace must
also be declared on the xs:schema element so that it is in scope for the entire length of the
document. The listing below declares the namespace that is the target namespace.

© 2010 Altova GmbH User Manual


402 XBRL Namespaces in the Taxonomy

<xs:schema targetNamespace="http://www.altova.com/XBRL/Taxonomies" xmlns:


ns1="http://www.altova.com/XBRL/Taxonomies" >
...
</xs:schema>

In the listing above, the namespace is declared on the xs:schema element and is given a prefix
of ns1.

Setting the target namespace


When a new taxonomy is created using the New Taxonomy Wizard, a default target
namespace and prefix are automatically created for the taxonomy. The default target
namespace is based on data you entered in the New Taxonomy Wizard. The prefix of the
default target namespace will be of the form nX, where X is an integer. The declaration of the
default target namespace and prefix can then be edited by accessing the Set Target
Namespace dialog (via the XBRL | Set Target Namespace command) and editing it there (
screenshot below). These edits will modify not only the definition of the target namespace (the
value of the targetNamespace attribute) but also the declaration of the target namespace.

To modify only the declaration of the target namespace (but not its definition) or the declaration
of any namespace, edit the prefix and value of the namespace in the Namespace Prefixes
dialog (XBRL | Namespace Prefixes command).

Example file: Step 2


Open the Set Target Namespace dialog via the XBRL | Set Target Namespace command. The
default target namespace is http://xbrl.nanonull.com/2009 and it has a prefix of n1.
Double-click the namespace and edit it as required, then do the same with the prefix. We have
used the namespace http://www.altova.com/nanonull and assigned it a prefix of nanonull
(see screenshot above). On clicking OK in the dialog, the target namespace will be assigned
and the target namespace will be declared with the prefix you have assigned. In our case the
target namespace and prefix are, respectively, http://www.altova.com/nanonull and
nanonull.

In the next step we will take a closer look at the import mechanism of XBRL View.

Altova XMLSpy 2011 © 2010 Altova GmbH


XBRL Importing a Taxonomy 403

11.5 Importing a Taxonomy


If a new taxonomy is to build upon an existing taxonomy, the existing taxonomy must be
imported into the extending taxonomy. If a new taxonomy is created with the New Taxonomy
Wizard, then US-GAAP-based and IFRS-based taxonomies can be imported at the time the
taxonomy is created. Whether this has been done or not, a taxonomy can always be imported at
a subsequent time.

To import a taxonomy, do the following: Right-click in the Overview entry helper in XBRL View
and select the menu command Import/Reference. This pops up the Reference Schema dialog
(screenshot below), in which you can specify a taxonomy to import or a linkbase to reference.

There are three import/reference options: (i) a standard taxonomy (US-GAAP or IFRS); (ii) any
other taxonomy (reference schema); and (iii) a linkbase. If you are importing a non-standard
taxonomy, select the Reference Schema radio button, click the Browse button of the Schema
Location text box, and browse for the taxonomy you want. When you are done, click Finish.
The selected taxonomy will be imported and its elements and relationships will be displayed in
XBRL View.

Note the following:


 The Overview entry helper lists taxonomies that the imported taxonomy itself imports,
as well as linkbases that the imported taxonomy uses.
 In the Global Elements entry helper, concepts defined in the imported taxonomy are
listed.
 In the Design window and Details entry helper, imported concepts are indicated with a
gray font color.

© 2010 Altova GmbH User Manual


404 XBRL Importing a Taxonomy

 You can delete an imported taxonomy by right-clicking it in the Overview entry helper
and selecting Remove.

After you have imported a taxonomy, you can extend the taxonomy as required.

Note: If you find that a large taxonomy such as US-GAAP slows down your editing, use the
filter in the main window to limit the display to elements created in the new, extending
taxonomy. This will speed up editing considerably.

Import mechanism
The effect of adding a standard import as described above is to add an xs:import element to
the new taxonomy file. The xs:import element specifies the namespace and location of the
taxonomy to be imported (listing below).

<xs:import namespace="http://xbrl.us/us-gaap-all/2008-03-31"
schemaLocation="
http://xbrl.us/us-gaap/1.0/elts/us-gaap-all-2008-03-31.xsd"/>

In the listing above, the schemaLocation attribute specifies that the taxonomy is to be loaded
via the Internet. But this URI maps, via XMLSpy's catalog mechanism, to a local copy of the US-
GAAP taxonomy (that is delivered with your XMLSpy package).

To locate a locally saved taxonomy, a local address can be used directly to locate the
taxonomy. Alternatively, a web address can be used which is mapped to a local address via a
catalog file. Accessing taxonomies from local locations will greatly speed up your work.

Example file: Step 3


In the example we are creating, we use the US-GAAP Taxonomy 1.0. This taxonomy has
already been imported during the creation of the initial taxonomy. In the Overview entry helper,
take a close look at all the imported taxonomies and referenced linkbases. Switch to Text View
and look for the xs:import elements. In the Main Window, notice that imported concepts are
indicated with a gray font color. Also notice that the Overview entry helper lists the linkbases
and the imported schemas of the US-GAAP taxonomy.

In the next step, we will take a closer look at linkbase files and the referencing mechanism.

Altova XMLSpy 2011 © 2010 Altova GmbH


XBRL Setting Up the Taxonomy Files 405

11.6 Setting Up the Taxonomy Files


The Overview entry helper displays in a tree structure the files that constitute the taxonomy (
screenshot below). At the root of the tree is the main taxonomy file (the concept definitions file);
this is the currently active file. The files on the next level are of two types: (i) linkbase files that
specify the various relationships in the taxonomy; these are indicated by colored icons; and (ii)
imported schemas (the .xsd files).

In the section, Importing a Taxonomy, you have seen how a taxonomy can be imported via the
Overview entry helper. The imported taxonomy is listed among the imported schemas in the
Overview entry helper.

In this section, we show how the Overview entry helper can be used to manage linkbase files.
The four operations for managing linkbases are all accessed via the Overview entry helper's
context menu. They are:
 Adding new linkbases and saving them with the taxonomy.
 Setting the linkbase kind. In cases where the linkbase type (calculation, definition,
presentation, label, or reference) is not know to XMLSpy, the linkbase type can be
explicitly specified.
 Setting a linkbase as the default linkbase for a particular type of relationship linkbase. If
there is more than one linkbase for a particular type of relationship, say, label
relationships, then new labels that you create in the Taxonomy Editor will be created in
the default label linkbase.
 Deleting linkbases.

Note: There are five types of relationships: (i) definition, (ii) calculation, (iii) presentation, (iv)
label, and (v) reference. Separate linkbase files can be created for each of these
relationship types.

Adding a new linkbase


To add a new linkbase, do the following:
1. Right-click in the Overview entry helper and select Add New Linkbase | <relationship
type>. A new linkbase file of the selected relationship type is created in the Overview

© 2010 Altova GmbH User Manual


406 XBRL Setting Up the Taxonomy Files

entry helper with a default name. Note that the new linkbase is created as the default
linkbase of its relationship type (indicated by the filename being in boldface).
2. Right-click the default name, select Rename, and edit the name.
3. A newly created linkbase file is physically saved at a particular location only when the
main taxonomy file is saved the next time. See below for details.

Saving linkbase files


If a linkbase file has not been saved, this is indicated by an asterisk after the name of the
linkbase file. When you save the main taxonomy file, the following will happen:
1. The Confirm Linkbase Paths dialog appears. This dialog contains the names and
locations (paths) of all the linkbases in the taxonomy, including the newly created
linkbase files. Any unsaved linkbase file will have a default path to the folder in which
the main taxonomy file will be, or has been, saved. You can edit the path of individual
linkbase files if you wish to save a linkbase file to another location. You can also edit the
name of the file.
2. Click OK when done. The linkbase files will be saved to the specified locations.

Setting linkbase kind


The linkbase kind of a file (also referred to as a file's linkbase type) can be set by using this
command. Right-click the file for which the linkbase kind is to be changed, and, from the context
menu, select the command Set Linkbase Kind | <relationship type>. The All option enables
you to specify that the linkbase file can contain more than one kind of relationship.

Setting a default linkbase


A default linkbase file can be set for each relationship type. When a relationship of that type is
defined in the Taxonomy Editor, the relationship is saved to the default linkbase file of that
relationship type. To set a linkbase file as the default linkbase, right-click it and select Set
Default Linkbase. The names of default linkbases are displayed in bold.

Deleting a linkbase
A linkbase can be removed from the taxonomy by right-clicking it and selecting Remove.

Example file: Step 4


The taxonomy we are creating already has linkbase files. These were created when the
taxonomy was created with the New Taxonomy Wizard. The original default names were
changed to the following:
 Definition linkbase: nanonull_def.xml
 Calculation linkbase: nanonull_cal.xml
 Presentation linkbase: nanonull_pre.xml
 Label linkbase: nanonull_lab.xml

In order to test some of the commands introduced in this section, do the following: Create a
linkbase file by using the Add New Linkbase command and creating any linkbase kind you like.
Rename it as described above. Notice that it is now the default linkbase of its relationship type
(indicated by its name being displayed in bold). Select it and set it to be some other relationship
type (using the Set Linkbase Kind command). Notice that the file is not the default linkbase of
its new relationship type. Now delete the linkbase (using the Remove command). Since one of
the original linkbase files is now no longer a default linkbase, set it as the default linkbase of its
relationship type.

Altova XMLSpy 2011 © 2010 Altova GmbH


XBRL Setting Up the Taxonomy Files 407

In the next step, we will add new elements to the main taxonomy file (or concept definitions file).

© 2010 Altova GmbH User Manual


408 XBRL Adding Elements to a Taxonomy

11.7 Adding Elements to a Taxonomy


To add an element (concept) to the taxonomy, click the Add New Element icon in the Main
Window (screenshot below).

The new element with a substitution group of xbrli:item and with a default name is added to
the list of elements in the display (screenshot below).

For a description of the element box, see Main Window: Elements Tab. You can now edit the
properties of the element in the main window in the following ways.
 The name of the element can be changed by double-clicking the default name and
entering the correct name. Note that you must also enter the correct namespace prefix
for the name.
 The substitution group of the element can be changed by expanding the element box—
click the plus icon to do this—and then selecting the required substitution group from
this field's dropdown list (screenshot below).

 To change the Balance, Period, Abstract, or Nillable property, click the corresponding
icon to the left of the element name and select one of the options from the box that
pops up.
 To add a label linkrole for the element, right-click anywhere in the element box and
select the Add Label Linkrole command. A row for the label linkrole is added; in this
row you can enter the label linkrole or select an option from the combo box. Note that if
no label linkbase file is associated with the taxonomy, one will be created now and will
be displayed in the Overview entry helper.
 A label can be added for a label linkrole by right-clicking the label linkrole and selecting
the Add Label command. To enter the details of the label, either double-click in the
field to be edited and enter the new value, or select the new value from the respective
combo boxes. The changes you make to labels will be saved to the label linkbase when
the main taxonomy file is saved.
 References are added to the reference linkbase in the same way that labels are added
to the label linkbase. First, a reference linkrole is added for the element, then a
reference is added for a specific reference linkrole.

Altova XMLSpy 2011 © 2010 Altova GmbH


XBRL Adding Elements to a Taxonomy 409

Element properties can also be edited in the Details entry helper. See Entry Helpers in XBRL
View for a description of how to do this.

Example file: Step 5


In this section, we will extend the US-GAAP taxonomy by creating new elements.

The first element we will create is the item nanonull:OnboardAndOther, which represents
revenues from the sale of items on board Nanonull's cruise ships. This specific revenue head is
not available in the US-GAAP taxonomy, which is why it must now be created as an extension
of US-GAAP. As a new element created specially for the Nanonull taxonomy, it must be created
in the Nanonull namespace (http://www.altova.com/nanonull), which has been declared
with a prefix of nanonull. Creating the element with this prefix will put this element in the
Nanonull namespace.

To create the element, do the following:

1. Click the Add New Element icon in the Main Window (screenshot below).

A new element with a substitution group of xbrli:item and with a default name is
added to the list of elements in the display (screenshot below).

2. Double-click the element name and enter the name nanonull:OnboardAndOther (


screenshot below). This creates the element OnboardAndOther in the Nanonull
namespace.
3. Expand the element box and, since the element will contain a monetary amount,
change the Type attribute to xbrli:monetaryItemType (screenshot below).

© 2010 Altova GmbH User Manual


410 XBRL Adding Elements to a Taxonomy

4. Now click to the left of the clock icon and, from the popup that appears, select credit (
screenshot below).

This sets the value of the xbrli:balance attribute to credit.


5. Click on the clock, A, and 0 icons, and set the values of the xbrli:duration, xs:
abstract, and xs:nillable attributes to duration, NOT Abstract, Nillable, respectively.
(In the .xsd file, the actual attribute values will be: credit, duration, false, and true,
respectively.)
6. Right-click the element box and, from the menu that pops up, select Add Label
Linkrole. This creates a label linkrole row at the bottom of the element box (screenshot
below).

7. Select the XBRL link URI.


8. Right-click the label linkrole row and from the menu that pops up select Add Label.
This creates a label row within the label linkrole.
9. Double-click in the language field of the newly created label row (screenshot below) and
enter en-us; in the next field which is the linkrole field, select the documentation role
from the dropdown list; in the label field, enter the text that should appear in
documentation. Then create another label row for the label linkrole by repeating Step
9. The value of the label role will appear in the Taxonomy Editor in the Main Window
and in entry helpers when the label display is switched on (in preference to short or long
names).

The element nanonull:OnboardAndOther has now been successfully created.

Notice that OnboardAndOther had an xbrli:balance value of credit. This is because it is a


revenue item: money is coming in. Since the items being sold on board will have costs attached
to them, i.e. cost the company to procure, we will also create a debit-side element called
nanonull:CostOfOnboardAndOther. Create this element the same way as nanonull:
OnboardAndOther was created, with one difference, however: set the value of xbrli:balance
to debit instead of credit.

Another cost to be included is for commissions to agents. This should be taken care of with a
debit element called nanonull:CruiseCommissionsTransportationAndOther. Create this
element exactly as you did nanonull:CostOfOnboardAndOther.

Finally, we add three abstract elements, Asia, Europe, and US, so that concepts can be
grouped by region. Since the elements are used only for grouping purposes and will not
themselves have values, they are known as abstract elements. What type such an element has

Altova XMLSpy 2011 © 2010 Altova GmbH


XBRL Adding Elements to a Taxonomy 411

is therefore immaterial. It is best to give an abstract element a type that matches its semantics.
For example, we have given the abstract elements Asia, Europe, and US, a type of
stringItemType. Create the nanonull:Asia, nanonull:Europe, and nanonull:USA elements
just as you created the previous elements. The only difference this time will be that the value of
the Abstract attribute must be set to Abstract (actual attribute value in the XSD file will be true)
and there will be no xbrli:balance attribute.

Note: If an xbrli:balance attribute is present on an abstract element, this abstract element


must be of type monetaryItemType, otherwise the taxonomy will be invalid. It is best to
omit the optional xbrli:balance attribute from all abstract elements.

In the next step we will specify linkroles for the new taxonomy. These linkroles will be needed
when we create new relationships.

© 2010 Altova GmbH User Manual


412 XBRL Relationships and Linkroles

11.8 Relationships and Linkroles


When a set of relationships is created these relationships are created within a containing
element. For example, when definition relationships are created, the elements defining the
definition relationships (the locators and definition arcs) are all created within a
definitionLink element, which looks something like this:

<link:definitionLink xlink:type="extended"
xlink:role="
http://www.nanonull.com/taxonomy/role/SegmentRevenueAndOperatingIncome">

The value of the xlink:role attribute in the definition link (as in the definition link listed above)
must be the value of the roleURI attribute of one of the linkroles set to be used on definition
relationships (see listing below). A linkrole (as in the listing below) is contained in the appinfo
element of the taxonomy.

<xs:appinfo>
<link:roleType id="SegmentRevenueAndOperatingIncome"
roleURI="
http://www.nanonull.com/taxonomy/role/SegmentRevenueAndOperatingIncome">
<link:definition>006091 - Disclosure - Segment Revenue and Operating
Income</link:definition>
<link:usedOn>link:calculationLink</link:usedOn>
<link:usedOn>link:definitionLink</link:usedOn>
<link:usedOn>link:presentationLink</link:usedOn>
</link:roleType>
</xs:appinfo>

A linkrole can be used in the containing elements of other relationship kinds besides in
definitionLink elements (for example, in calculationLink and presentationLink
elements). In the listing above, notice that there are usedOn elements that specify in which kind
of relationships this linkrole may be used.

To create linkroles in a concept definitions file (main taxonomy file), in XBRL View, click the
menu command XBRL | Linkroles. This pops up the Link Roles dialog (screenshot below).

In the Taxonomies tab, select the taxonomy and click Add to add a linkrole. Then specify the
linkrole's URI and ID (refer to listing above). Now specify for which kinds of relationships this
linkrole should be available; do this by checking the check boxes of the required relationship
kinds (see screenshot above).

Altova XMLSpy 2011 © 2010 Altova GmbH


XBRL Relationships and Linkroles 413

Example file: Step 6


Create two linkroles via the Link Roles dialog (XBRL | Linkroles) as described above and
shown in the screenshot above:
1. id="SegmentRevenueAndOperatingIncome"
URI="http://www.nanonull.com/taxonomy/role/SegmentRevenueAndOperatingIn
come" (to be used on definition, calculation, and presentation relationships)
2. id="FinancialStatements"
URI="http://www.nanonull.com/taxonomy/role/FinancialStatements" (to be
used on calculation and presentation relationships)

In the next step we will create relationships for the new taxonomy.

© 2010 Altova GmbH User Manual


414 XBRL Creating Relationships: Part 1

11.9 Creating Relationships: Part 1


Relationships are created in their respective tabs: Definitions, Presentation, Calculation. The
way all three kinds of relationships are created is similar, with the biggest difference being that
definition relationships have arcroles, while presentation relationships and calculation
relationships do not have arcroles. In this section we describe how to create relationships using
definition relationships. In the next section we explain how presentation and calculation
relationships are different, as well as other features relating to relationships.

While reading the description below, we recommend that you open a finished taxonomy in
XBRL View. You can find the Nanonull taxonomy (nanonull.xsd) in the folder C:\Documents
and Settings\<username>\My Documents\Altova\XMLSpy2011\Examples\XBRLExamples
\Nanonull.

Adding the linkrole


Click the required relationships tab in the Main Window (Definitions, Presentation, Calculation).
Then right-click in the Main Window and select the Add Extended Link Role command. This
adds a line containing the URI of a default linkrole (screenshot below). Click the dropdown
arrow at the right-hand side of this line to display a list of available linkroles and select the
required linkrole.

If the required linkrole is not available, this is because it has not been defined either in the
taxonomy or for the current relationship kind. See Relationships and Linkroles for details about
linkroles and how to create them.

Any number of linkroles can be added.

Inserting element references and arcs within a linkrole


The first element to create within a linkrole is one from which a relationship will be created to
another element (see screenshot below). This will usually be an abstract element that groups
other elements under it (for example, an element for a balance sheet). This element will have
no entry in the arcrole column because it is at the from end of an arc. Arcroles are listed on the
elements at the to end of an arc.

Altova XMLSpy 2011 © 2010 Altova GmbH


XBRL Creating Relationships: Part 1 415

In the screenshot above the highlighted element is the inserted element reference. It has three
arcs, one to a hypercube element and two to item elements. These three elements are at the to
end of their respective arcs and the from-to relationship is defined by the corresponding
arcoles, which are displayed in the Arcrole column.

To insert an arc on an element reference or element, right-click the from element and select
Insert Arc from the context menu that pops up. This causes the Insert Arc dialog (screenshot
below) to appear. Select the element to be created at the to end of the arc. To filter the view in
this dialog, switch on the filter and specify a condition for the filter (see Entry Helpers in XBRL
View for a description of how to do this).

The element will be inserted with a default arcrole. You can change the arcrole by selecting an
alternative from the dropdown list of the arcrole (screenshot below).

Note: Elements, with arcs, can also be added by dragging them from the Global Elements

© 2010 Altova GmbH User Manual


416 XBRL Creating Relationships: Part 1

entry helper.

Example file: Step 7


Create definition relationships as shown in the screenshots below using the method described
above.

The screenshot above shows the elements to add with arcs. The screenshot below shows the
arcroles of the newly added elements.

You can compare the taxonomy you have created with that supplied with your XMLSpy
package. The supplied taxonomy (nanonull.xsd) is in the folder C:\Documents and
Settings\<username>\My Documents\Altova\XMLSpy2011\Examples\XBRLExamples
\Nanonull.

Altova XMLSpy 2011 © 2010 Altova GmbH


XBRL Creating Relationships: Part 2 417

11.10 Creating Relationships: Part 2


The previous section, Creating Relationships: Part 1, explained how to create relationships
using definition relationships to demonstrate the mechanism. Presentation relationships (
screenshot below) and calculation relationships are created in a similar way. The only difference
is that there is no Arcrole column in presentation and calculation relationships.

The following points should be noted:


 Presentation and calculation relationships can be considered to be a simple arc
between two elements in the manner of parent-child relationships. The arc icons signify
this relationship. So inserting an arc on an element is equivalent to creating a child
element in the graphical representation. Using arcs, therefore, a hierarchy can be built
up.
 Elements can also be dragged from the Global Elements entry helper into the tree.
These elements are always dropped at the to position of an arc. An arrow appears
when the element is in position to be dropped.
 Calculation arcs have weight attributes that indicate how the value of the to element in
the arc should be summed (see screenshot below). For example, a weight value of
+1.0 indicates that 100% of the element's value should be added towards the value of
the from (or summation) element. A value of -1.0 indicates that 100% of the value of
should be subtracted from the value of the summation element. Double-clicking the
weight attribute value enables you to enter an optional value.

© 2010 Altova GmbH User Manual


418 XBRL Creating Relationships: Part 2

The weight attribute can also be modified in the Details entry helper (see below).

Prohibiting the use of an arc


All arcs, whether definition, presentation, or calculation, have a use attribute that can take a
value of optional or prohibited. When the value prohibited is used, the arc is negated.

Color and context menu


When elements have been created in the current taxonomy and can be edited, they are
displayed in black. Otherwise (when they are from imported taxonomies, which must not be
edited) elements are displayed in gray.

The following entries appear in context menus in the main window of the relationships tabs.
 Insert element reference: Available on extended linkroles. Adds an element under the
linkrole that will always be at the from end of arcs.
 Delete element reference: Available on element references immediately under a
linkrole.
 Insert arc: Available on elements. Inserts an arc and pops up a dialog in which the
element to be at the to end of the arc can be selected.
 Set target role: Sets a target role on the selected element.
 Add label linkrole: Adds a label linkrole to the selected element.
 Add reference linkrole: Adds a reference linkrole to the selected element.
 Override arc: Replaces the (impicit) optional value of the use attribute of the arc with
the prohibited value, thus negating the arc.
 Remove arc: Removes the selected arc.
 Show in global elements: Highlights the selected element in the Global Elements entry
helper.

Altova XMLSpy 2011 © 2010 Altova GmbH


XBRL Creating Relationships: Part 2 419

Details entry helper


When an element in a relationship is selected, arc attributes can be edited in the Details entry
helper (screenshot below).

Attributes which cannot be edited in the graphical display in the main window—such as order
and priority—can be edited in the Details entry helper.

© 2010 Altova GmbH User Manual


420 XBRL Find in XBRL

11.11 Find in XBRL


In XBRL View, XBRL taxonomies can be searched using XMLSpy's Find in XBRL feature, which
is enabled when an XBRL taxonomy is active in XBRL View. The Find in XBRL feature is
accessed in one of the following ways:
 Via the Edit | Find menu command when an XBRL taxonomy is active in XBRL View.
 Via the Find button in the Find in XBRL window.
 By pressing Ctrl+F.

Selecting any of these access methods pops up the Find dialog (screenshot below).

Usage is as follows:
 Enter the search term in the Find what text field of the Find dialog (screenshot above)
and check the required options
 Specify the XBRL component types to be searched in the Types pane
 Execute the command using the Find Next or Find All button
 Use the Find in Schemas window to view the search results and navigate to a
component quickly

11.11.1 Search Term


A search term can be specified to be case-sensitive or to match a whole word by checking the
respective options in the Options pane (see screenshot below). If you wish to search using a
regular expression, check the Regular Expression option in the Options pane before clicking
the Find Next or Find All button. See below for more details about using regular expressions.

Altova XMLSpy 2011 © 2010 Altova GmbH


XBRL Find in XBRL 421

Note: A whole word is considered to be delimited by any character that is not alphanumeric or
the underscore character. So the search term asset will return the text xbrl:asset,
since the colon character (:) is considered to be a word delimiter.

Regular expressions
You can use regular expressions to further refine your search criteria. A pop-up list is available
to help you build regular expressions. To access this list, click the > button to the right of the
input field for the search term.

Clicking on the required expression description inserts the corresponding expression syntax
character in the input field. Given below is a list of regular expression syntax characters.

. Matches any character. This is a placeholder for a single character.


\( Marks the start of a region for tagging a match.
\) Marks the end of a tagged region.

© 2010 Altova GmbH User Manual


422 XBRL Find in XBRL

\< Matches the start of a word.


\> Matches the end of a word.
\x Allows you to use a character x, that would otherwise have a special
meaning. For example, \[ would be interpreted as [ and not as the start of a
character set.
[...] Indicates a set of characters, for example, [abc] means any of the
characters a, b or c. You can also use ranges, for example [a-z] for any
lower case character.
[^...] The complement of the characters in the set. For example, [^A-Za-z]
means any character except an alphabetic character.
^ Matches the start of a line (unless used inside a set, see above).
$ Matches the end of a line. Example: A+$ to find one or more A's at end of
line.
* Matches 0 or more times. For example, Sa*m matches Sm, Sam, Saam, Saaam
and so on.
+ Matches 1 or more times.
For example, Sa+m matches Sam, Saam, Saaam and so on.

11.11.2 Command Execution


After the search term has been entered, and the options and filter for component types have
been set, there are two command execution options: Find Next and Find All. These are
available as buttons in the Find dialog (see screenshot below).

Find Next
The Find Next command displays, in the Find in XBRL window (screenshot below), the next
instance of the search term. The search for the next instance will start at the next cell from the
current cursor position in the active document. The Find Next process can be continued till all
instances in the document are displayed.

Altova XMLSpy 2011 © 2010 Altova GmbH


XBRL Find in XBRL 423

Find All
The Find All command displays all instances of the search term, together with a summary of
the search, in the Find in XBRL window (screenshot below).

The result provides: (i) a summary of the XBRL component types that were searched; (ii) a list
of the found instances of the search term, ordered according to linkbase; and (iii) statistics
about the search, including the matches found and the time taken for the search. Each linkbase
group can be expanded or collapsed to view the matches in that group. Clicking a match
highlights the corresponding element in the XBRL document in the Main Window.

For information about the features of the Find in XBRL window, see the section Results and
Information.

© 2010 Altova GmbH User Manual


424 XBRL Find in XBRL

11.11.3 Results and Information


Each time a Find or Find Next command is executed the results of the command execution are
displayed in the Find In XBRL window (screenshot below). The term that was searched for is
displayed in green; (in the screenshot below, it can be seen that Inventory was the search
term).

Features of the Find In XBRL window


Results are displayed in nine separate tabs (numbered 1 to 9). So you can keep the results of
one search in one tab, do a new search, and compare results. Clicking on a result in the Find In
XBRL window pops up and highlights the relevant component in the Main Window of XBRL
View. In this way, using the Find in XBRL window you can search and navigate quickly to the
desired component.

The following Find In XBRL toolbar commands are available:


 The Next and Previous icons select, respectively, the next and previous find results to
the currently selected result.
 The Copy Messages commands copy, respectively, the selected message, the
selected message and its children messages, and all messages, to the clipboard.
 The Find commands find text strings in the Find In XBRL window.
 The Clear command deletes all messages in the currently active tab.

Altova XMLSpy 2011 © 2010 Altova GmbH


Office Open XML and ZIP 425

12 Office Open XML and ZIP


Office Open XML (OOXML) and ZIP files are similar in that both are packages containing other
files. XMLSpy's Archive View provides an interface that enables you to view the internal
structure of these packages, modify these structures, and access the files in the package for
editing in XMLSpy.

Office Open XML (OOXML)


OOXML is a file format for describing documents, spreadsheets, and presentations. It was
originally developed by Microsoft for the company's Office suite of products but is now an open
ECMA specification.

Structure of an OOXML file


Each OOXML document is a package of multiple files that follows the Open Packaging
Convention. A package consists of XML and other data files (such as image files) plus a
relationships file that specifies the relationships among the various files in the package.

The internal structure and internal folder and file names of an OOXML file vary according to the
document type. However, there is a common basic structure: an XML file called
[Content_Types].xml at the root of the directory structure, and three directories: _rels,
docProps, and a directory specific to the document type (in the case of .docx documents, for
example, this folder would be called word; xl in .xlsx documents, and ppt in .pptx
documents).

OOXML File
|-- File: [Content_Types].xml
|-- Folder: _rels
|-- Folder: docProps
|-- Folder: word/xl/ppt

 The _rels folder contains a rels.xml file, which specifies the relationships between
the various files in the package.
 The docProps folder contains app.xml and core.xml, which describe key document
properties.
 The word, xl, and ppt folders contain XML fies that hold the content of the document.
For example, in the word folder, the file document.xml contains the core content of the
document.

OOXML in XMLSpy's Archive View


In XMLSpy's Archive View (screenshot below), you can view and edit the contents of an
OOXML file.

© 2010 Altova GmbH User Manual


426 Office Open XML and ZIP

Folder View on the left-hand side shows the folders in the package, whereas the Main Window
shows the files in the folder selected in Folder View. In Archive View, files and folders can be
added to and deleted from the archive. Also, files can be opened quickly for editing in XMLSpy
by double-clicking the file in Archive View.

Intelligent editing of OOXML's internal files


The XML documents within OOXML packages are based on standard schemas. XMLSpy
provides intelligent editing support for OOXML documents, in the form of entry helpers, auto-
completion, and validation.

ZIP files
ZIP files archive multiple files in a lossless data compression package. These files can be of
various types. In XMLSpy's Archive View, ZIP files can be created, the internal structure
modified, and files in the archive edited. These operations are described in the ZIP Files sub-
section of this section.

Altova XMLSpy 2011 © 2010 Altova GmbH


Office Open XML and ZIP Working with OOXML Files 427

12.1 Working with OOXML Files


This section describes how to work with OOXML documents in Archive View. The following
procedures are discussed:
 Creating, opening, and saving OOXML files
 Editing the structure of an OOXML file
 Opening, editing, and saving internal OOXML documents
 Intelligent editing of internal OOXML documents
 Addressing documents in OOXML files
 Comparing OOXML archives

Creating, opening, and saving OOXML files


OOXML files are created via the Create New Document dialog (File | New command), in which
you select the required file type (.docx, .pptx, or .xlsx). You are prompted for a file name and
a location at which to save the file. The new file is created at the specified location and then
opened in Archive View (screenshot below). Notice that the basic internal structure of the
OOXML document has been created.

An existing OOXML file is opened in Archive View via the Open dialog (File | Open) of XMLSpy.
OOXML files are saved with the File | Save (Ctrl+S) command. This command saves the
structure and relationships of the OOXML file.

Editing the structure of an OOXML file


The contents of an OOXML file can be modified by adding and deleting folders and documents
to it using Archive View functionality. After these structural changes have been made, the
OOXML file must be saved (File | Save) for the modifications to take effect. You should note
the following points:
 When a new folder or document is added using the command buttons in Archive View,
it should be named immediately on its being created. It is not possible to rename a
folder or document in Archive View.
 After a new document has been added to an archive folder, it is saved to the archive by
saving it in its own window or by saving the OOXML file.

Opening, editing, saving internal OOXML documents

© 2010 Altova GmbH User Manual


428 Office Open XML and ZIP Working with OOXML Files

An internal OOXML document—that is, a document within an OOXML file package—is opened
from Archive View by double-clicking it, or by selecting it in the Main Window and clicking the
Open document command button. The document opens in a separate XMLSpy window. After
editing it, simply save the document to save it back to the OOXML archive; there is no need to
save the OOXML file itself.

Intelligent editing of internal OOXML documents


XMLSpy provides intelligent editing features for internal Office Open XML documents—that is,
for documents within an OOXML file package. These features include entry helpers, auto-
completion, and validation.

Addressing documents in OOXML files


Documents in OOXML files can be addressed using normal file paths plus the pipe character.
For example, the file path:
C:\Documents and Settings\<username>\My Documents\Altova\XMLSpy2011\
\Examples\Office20XX\ExcelDemo.xlsx|zip\xl\tables\table1.xml
locates the file table1.xml, which is in the xl\tables folder of the OOXML file ExcelDemo.
xlsx located in the Examples\Office20XX folder of the XMLSpy examples folder.

Comparing OOXML archives


When an OOXML file is open in Archive View, you can compare it with another archive by using
the command Tools | Compare Directories.

Altova XMLSpy 2011 © 2010 Altova GmbH


Office Open XML and ZIP OOXML Example Files 429

12.2 OOXML Example Files


In the Examples\Office2007 folder of your XMLSpy application folder are the following
example files:
 OOXML files: (i) a Word Open XML file (.docx), (ii) an Excel Open XML file (.xlsx),
and (iii) a PowerPoint Open XML file (.pptx)
 XSLT files: (i) docx2html.xslt (to convert the sample .docx file to HTML), (ii)
xslx2html.xslt (to convert the sample .xslx file to HTML), and (iii) pptx2html.xslt
(to convert the sample .pptx file to HTML)
 An XQuery file: ExcelDemo.xq (to retrieve data from the .xslx file)

The XSLT and XQuery files are intended to demonstrate how XSLT and XQ can be used to
access and transform data in OOXML files. To run the XSLT and XQuery documents, you can
use any of the following options:
 Open the OOXML file in Archive View. In Folder View, select Archive and then click
the menu command XSL/XQuery | XSL Transformation (for an XSLT transformation)
or XSL/XQuery | XQuery Execution (for an XQuery execution). Browse for the XSLT
or XQuery file and click OK.
 In the Project Window of XMLSpy, right-click the .xlsx or .docx file in the Office2007
folder of the Examples project (screenshot below), and select the transformation
command. Browse for the transformation file and click OK.

 Open the XSLT or XQuery file in XMLSpy and click the menu command XSL/XQuery |
XSL Transformation and XSL/XQuery | XQuery Execution, respectively. When
prompted for the XML file to transform, browse for the .docx, .xlsx , or .pptx file
(according to whether the XSLT/XQ document is intended for Word or Excel).
 You can also run these operations using AltovaXML, which is a standalone package
containing the Altova XSLT and XQuery Engines.

© 2010 Altova GmbH User Manual


430 Office Open XML and ZIP ZIP Files

12.3 ZIP Files


In Archive View, you can create WinZip files, modify the internal structure of ZIP files (WinZip,
WinRAR, etc), and edit files in the ZIP package directly in XMLSpy and save the files back to
the ZIP archive.

Creating and saving a WinZip file


A WinZip file is created via the Create New Document dialog (File | New command), in which
you select the file type .zip. An empty WinZip archive is created in a new window in XMLSpy (
screenshot below). You must now save the ZIP file to the desired location with the File | Save
(Ctrl+S) command. Add folders and files as described below, and then save the ZIP file to save
your additions and changes.

An existing ZIP file is opened in Archive View via the Open dialog (File | Open) of XMLSpy.

Note: Creating a new ZIP file is different than creating a new OOXML file in that you are not
prompted for a location to save the file before the archive is opened in Archive View.
For the ZIP file to be saved from the empty archive that is opened in Archive View, you
must explicitly use the File | Save (Ctrl+S) command..

Adding folders and files and modifying the archive structure


You can add folders (click the New Folder button), existing files (Add Document), and new
files (Add New Document) to the selected Archive folder. Note that when you add a new folder
or new document, you must immediately enter a name for the folder or file; it is not possible to
rename folders in Archive View.

Addressing documents in ZIP files


Documents in ZIP files can be addressed using normal file paths plus the pipe character. For
example, the file path:
C:\Documents and Settings\<username>\My Documents\Altova\XMLSpy2011\
\Examples\Test.zip|zip\TestFolder\MyFile.xml
locates the file MyFile.xml, which is in the TestFolder folder of the ZIP file Test.zip located
in the Examples folder of the XMLSpy examples folder.

Comparing ZIP archives


When a ZIP file is open in Archive View, you can compare it with another archive by using the

Altova XMLSpy 2011 © 2010 Altova GmbH


Office Open XML and ZIP ZIP Files 431

command Tools | Compare Directories.

© 2010 Altova GmbH User Manual


432 Databases

13 Databases
XMLSpy enables you to connect to a variety of databases (DBs) and then perform operations
such as querying the DB, importing the DB structure as an XML Schema, generating an XML
data file from the DB, and exporting data to a DB. Each DB-related feature is available in
XMLSpy as a menu command, and is described in the User Reference section of this
documentation under the respective command. A complete list of these command is given
below, with links to the respective descriptions.

In this section, we do the following:


 Describe how to connect to a database, which is an operation that is required for
executing any of XMLSpy's DB-related commands; and
 List DBs that have been successfully tested for use with XMLSpy.

Note: If you are using the 64-bit version of XMLSpy, ensure that you have access to the 64-bit
database drivers needed for the specific database you are connecting to.

XMLSpy's DB-related features


XMLSpy's DB-related features are executed with commands in the DB and Convert menus.
 Query Database: In the DB menu. Loads the structure of the DB in a separate
Database Query window and enables queries to the DB. Results are displayed in the
Database Query window.
 IBM DB2: In the DB menu. IBM DB2 is an XML DB, and XMLSpy enables management
of the XML Schemas of the XML DB as well as editing and validation of the XML DB.
 Oracle XML DB: In the DB menu. Provides a range of functionality for Oracle XML DBs,
including XML Schema management, database querying, and generation of XML files
based on DB schemas.
 Import Database Data: In the Convert menu. Imports DB data into an XML file.
 Create XML Schema from DB Structure: In the Convert menu. Generates an XML
Schema that is based on the structure of the DB.
 DB Import Based on XML Schema: In the Convert menu. With an XML Schema
document active in XMLSpy, a DB connection is made and the data of a selected DB
table can be imported. The resulting XML document will have a structure based on the
XML Schema that was active when the DB connection was made.
 Create DB Structure from XML Schema: In the Convert menu. DB tables with no data
are created based on the structure of an existing XML Schema.
 Export to Database: In the Convert menu. Data from an XML document can be
exported to a DB. Existing DB tables can be updated with the XML data, or new tables
can be created that contain the XML data.

Datatype conversions
When converting data between XML documents and DBs, datatypes must necessarily be
converted to types appropriate for the respective formats. The way XMLSpy converts datatypes
is given in the appendices Datatypes in DB-Generated XML Schemas and Datatypes in DBs
Generated from XML Schemas.

Altova DatabaseSpy
Altova's DatabaseSpy is a multi-database query and DB design tool that offers additional DB
functionality to that available in XMLSpy. For more details about Altova DatabaseSpy, visit the
Altova website.

Altova XMLSpy 2011 © 2010 Altova GmbH


Databases Connecting to a Data Source 433

13.1 Connecting to a Data Source


A number of commands and icons in the DB and Convert menus require a connection to a
database. XMLSpy enables you to connect to a variety of databases (see list below). It uses the
Connect to Data Source dialog (for commands in the Convert menu, screenshot below) or
Quick Connect dialog (for the DB | Query Database command) to set up and make the
connection. Both dialogs are essentially the same; they guide you through the same connection
steps. In this section, we describe how the mechanism behind these two dialogs works. In
descriptions of the DB or Convert commands that require a database connection, refer to this
section for information on making the connection.

The options for connecting to the database are:


 Using a Connection Wizard that guides you through the connection process.
 Using an existing connection.
 Using an ADO Connection.
 Using an ODBC Connection.
 Using a global resource.

Each option is described in the subsections of this section. The descriptions in this section
explain only the connection mechanism. The dialogs that appear subsequent to the connection
process are dependent on the specific command being executed, and these dialogs are
therefore described in the sections relating to that specific command. For example, if you are
looking for a description of the command Convert | Import Database Data, the description for
the connection process is in this section, but the selection of DB tables is described in the
section Convert | Import Database Data.

Note: If you are using the 64-bit version of XMLSpy, ensure that you have access to the 64-bit
database drivers needed for the specific database you are connecting to.

© 2010 Altova GmbH User Manual


434 Databases Connecting to a Data Source

13.1.1 Connection Wizard


In the Connect to Data Source dialog, when the Connection Wizard button is selected, the
Connection Wizard (screenshot below) pops up. The Connection Wizard helps you to connect
to the most commonly used types of databases. In this section, we go through the connection to
a Microsoft Access database and an IBM DB2 database.

MS Access
Carry out the following steps to connect to an MS Access database. Select Microsoft Access
(ADO) (screenshot below), and click Next.

In the Connect to MS Access dialog that pops up, browse for the MS Access database, and
click Next. The connection to the data source is established. For information about subsequent
dialogs, refer to the description of the command being executed.

IBM DB2
In the first screen of the Connection Wizard (see first screenshot in this section), select IBM
DB2 and click Next. The Configuration dialog (screenshot below) pops up. The wizard will then
guide you in configuring the connection to the IBM DB2 database and making the connection.
These steps consist essentially of selecting the appropriate driver to connect to the DB, then
locating the DB, and entering user information that enables you to connect.

Altova XMLSpy 2011 © 2010 Altova GmbH


Databases Connecting to a Data Source 435

In the Configuration dialog above, select an existing data source, or create a new data source
with an appropriate driver (additional drivers can be added to the list of available drivers by
clicking the Edit Drivers button and selecting the required drivers). In the following screen you
will be prompted for user information (ID and password). Clicking OK will establish the
connection with the database. Also see ODBC Connections for more details. For information
about subsequent dialogs, refer to the description of the command being executed.

13.1.2 Existing Connections


In the Connect to Data Source dialog, when the Existing Connections button is selected, the
Existing Connections pane opens (screenshot below), showing all the connections that are
currently established.

© 2010 Altova GmbH User Manual


436 Databases Connecting to a Data Source

Select the required database and click Connect. The connection to the database is established.
For information about subsequent dialogs, refer to the description of the command being
executed.

13.1.3 ADO Connections


The ADO Connections option enables you to connect to a DB via ADO. In this section, the
connection via ADO is described using an IBM DB2 database as the target DB. Where options
are different if another type of database is the target DB, these differences are noted.

1. In the Connect to Data Source dialog, select ADO Connections. The ADO Connections
box appears (screenshot below).

Altova XMLSpy 2011 © 2010 Altova GmbH


Databases Connecting to a Data Source 437

2. Click the Build button. The Data Link Properties dialog (screenshot below) opens.

© 2010 Altova GmbH User Manual


438 Databases Connecting to a Data Source

3. Select Microsoft OLE DB Provider for ODBC Drivers from the list and click Next. The
Connection tab is activated. (For Microsoft SQL DBs, we recommend Microsoft OLE
DB Provider for SQL Server; for Oracle, MySQL, Sybase, and IBM DB2 DBs, Microsoft
OLE DB Provider for ODBC Drivers.)

Altova XMLSpy 2011 © 2010 Altova GmbH


Databases Connecting to a Data Source 439

4. Build a connection string via the Build button (the dialog which pops up prompts you for
a data source and user information). In the case of some databases (such as Microsoft
SQL Server), you do not build a connection string but instead select the server and
database from combo box listings.
5. If login information is required, enter a user name and password, and check the Allow
Saving Password check box.
6. Click OK. The Data Link Properties dialog closes. The connection string appears in the
ADO Connections box (screenshot below).

© 2010 Altova GmbH User Manual


440 Databases Connecting to a Data Source

7. Click the Connect button. The connection to the data source is established. For
information about subsequent dialogs, refer to the description of the command being
executed.

Note: For an ADO connection to MS SQL Server via the driver SQL Server Native Client 10.0
the following property values must be set in the All tab of the Data Link Properties
dialog: (i) Set the property value of Integrated Security to a space character; (ii) Set the
property value of Persist Security Info to true.

13.1.4 ODBC Connections


This section describes how to connect to a DB via ODBC. The steps listed below describe a
connection to an IBM DB2 database, but apply also to other types of databases that can be
connected via ODBC. To connect using an ODBC connection, do the following:

1. In the Connect to Data Source dialog, select ODBC Connections.

Altova XMLSpy 2011 © 2010 Altova GmbH


Databases Connecting to a Data Source 441

2. Select one of the options for specifying a Data Source Name (DSN). If you select
System DSN or User DSN, the available DSNs are displayed in the Data Source pane.
If you select File DSN, you are prompted to browse for the DSN file. Alternatively, you
can build a connection string to the DB by selecting the Build a Connection String
option.
3. If you wish to add a DSN to those in the Data Source pane, click the Create a New DSN
icon .
4. In the Create an ODBC DSN dialog that appears, select the required driver, then click
the User DSN or System DSN button.
5. In the dialog that appears (screenshot below), select the DB alias and give it a DSN.

6. Click OK to finish. The DB is added as a Data Source to the list in the Data Source
pane.
7. After you have selected the DataSource (via the System DSN or User DSN option), or
selected a DSN File (File DSN option), or built a connection string (Connection String
option), click Connect.

© 2010 Altova GmbH User Manual


442 Databases Connecting to a Data Source

8. When you are prompted for your user ID and password, enter these and then click OK.
9. You will be asked to choose between connecting to the the database either natively or
via the ODBC API (see screenshot below).

Select the Natively option, unless there are difficulties with the connection or if you
prefer to use the ODBC API. Then click OK. The connection is established. For
information about subsequent dialogs, refer to the description of the command being
executed.

Note: The listing in the data source pane (when the System DSN or User DSN option is
selected) can be edited using the Edit Selected DSN, Remove Selected DSN, and
Refresh Listed DSNs icons at the bottom of the ODBC Connections screen.

Edit selected DSN.

Remove selected DSN.

Refresh listed DSNs.

Building a connection string


In the ODBC Connections screen, when you select the Build a Connection String radio button
and click the Build button that appears, the Select Data Source dialog (screenshot below) pops
up. You can either select a File DSN (in the File Data Source tab), or select a data source that
is available on your machine (listed in the Machine Data Source tab).

Altova XMLSpy 2011 © 2010 Altova GmbH


Databases Connecting to a Data Source 443

Clicking OK pops up a dialog that prompts for user information, including the User ID and
password. When you click OK in this dialog, the connection string is entered in the ODBC
Connections screen.

13.1.5 Global Resources


In the Connect to Data Source dialog, when the Global Resources button is selected, the
Global Resources pane opens (screenshot below), showing all the database-type global
resources that are defined in the currently active Global Resources XML File.

© 2010 Altova GmbH User Manual


444 Databases Connecting to a Data Source

Select the required global resource and click Connect. The connection to the database is
established. For information about subsequent dialogs, refer to the description of the command
being executed.

Altova XMLSpy 2011 © 2010 Altova GmbH


Databases Supported Databases 445

13.2 Supported Databases


Altova XMLSpy fully supports the databases listed below. While Altova endeavors to support
other ODBC/ADO databases, successful connection and data processing have only been tested
with the listed databases.

The available root object for each of the supported databases is also listed.

Database (natively supported) Root Object


MS SQL Server 2000, 2005, and 2008 database
Oracle 9i, 10g, and 11g schema
MS Access 2003 and 2007 database
MySQL 4.x and 5.x database
IBM DB2 8.x and 9 schema
Sybase 12 database
IBM DB2 for i 5.4 and i 6.1 schema
PostgreSQL 8.0, 8.1, 8.2, 8.3 database

Note: If you are using the 64-bit version of XMLSpy, ensure that you have access to the 64-bit
database drivers needed for the specific database you are connecting to.

© 2010 Altova GmbH User Manual


446 Altova Global Resources

14 Altova Global Resources


Altova Global Resources is a collection of aliases for file, folder, and database resources. Each
alias can have multiple configurations, and each configuration maps to a single resource

Therefore, when a global resource is used as an input, the global resource can be switched
among its configurations. This is done easily via controls in the GUI. For example, if an XSLT
stylesheet for transforming an XML document is assigned via a global resource, then we can
set up multiple configurations for the global resource, each of which points to a different XSLT
file. After setting up the global resource in this way, switching the configuration would switch the
XSLT file used for the transformation.

A global resource can not only be used to switch resources within an Altova application, but also
to generate and use resources from other Altova applications. So, files can be generated on-
the-fly in one Altova application for use in another Altova application. All of this tremendously
eases and speeds up development and testing. For example, an XSLT stylesheet in XMLSpy
can be used to transform an XML file generated on-the-fly by an Altova MapForce mapping.

Using Altova Global Resources involves two processes:


 Defining Global Resources: Resources are defined and the definitions are stored in an
XML file. These resources can be shared across multiple Altova applications.
 Using Global Resources: Within an Altova application, files can be located via a global
resource instead of via a file path. The advantage is that the resource being used can
be instantly changed by changing the active configuration in XMLSpy.

Global resources in other Altova products


Currently, global resources can be defined and used in the following individual Altova products:
XMLSpy, StyleVision, MapForce, and DatabaseSpy.

Altova XMLSpy 2011 © 2010 Altova GmbH


Altova Global Resources Defining Global Resources 447

14.1 Defining Global Resources


Altova Global Resources are defined in the Manage Global Resources dialog, which can be
accessed in two ways:
 Click Tools in the menu bar to pop up the Tools menu (screenshot below), and select
the command Global Resources. This pops up the Global Resources dialog.

 Click the menu command Tools | Customize to display the Customize dialog. Then
select the Toolbars tab and check the Global Resources option. This switches on the
display of the Global Resources toolbar (screenshot below).

Once the toolbar is displayed, click the Manage Global Resources icon. This pops up
the Global Resources dialog.

The Global Resources XML File


Information about global resources that you define is stored in an XML file. By default, this XML
file is called GlobalResources.xml, and it is stored in the folder C:\Documents and Settings
\<username>\My Documents\Altova\. This file is set as the default Global Resources XML
File for all Altova applications. As a result, a global resource defined in any application will be
available to all Altova applications—assuming that all applications use this file.

You can also re-name the file and save it to any location, if you wish. Consequently, you may
have multiple Global Resources XML files. However, only one of these Global Resources XML
File can be active at any time, and only the definitions contained in this file will be available to
the application.

To select a Global Resources XML file to be the active file, in the Manage Global Resources
dialog (screenshot below), browse for it in the Definitions File entry and select it.

© 2010 Altova GmbH User Manual


448 Altova Global Resources Defining Global Resources

Managing global resources: adding, editing, deleting


In the Manage Global Resources dialog (screenshot above), you can add a global resource to
the selected Global Resources XML File, or edit or delete a selected global resource. The
Global Resources XML File organizes the aliases you add into a list of several sections: files,
folders, and databases (see screenshot above).

To add a global resource, click the Add button and define the global resource in the Global
Resource dialog that pops up (see description below). After you define a global resource and
save it, the global resource (or alias) is added to the library of global definitions in the selected
Global Resources XML File. To edit a global resource, select it and click Edit. This pops up the
Global Resource dialog, in which you can make the necessary changes (see the descriptions
of files, folders, and databases in the sub-sections of this section). To delete a global resource,
select it and click Delete.

After you finish adding, editing, or deleting, make sure to click OK in the Manage Global
Resources dialog to save your modifications to the Global Resources XML File.

Adding a global resource


Creating a global resource involves mapping one alias name to one or more resources (file,
folder, or database). Each mapping is called a configuration. A single alias name can therefore
be associated with several resources via different configurations (screenshot below).

Altova XMLSpy 2011 © 2010 Altova GmbH


Altova Global Resources Defining Global Resources 449

In the Manage Global Resources dialog (screenshot above), when you click the Add button,
you can select whether you wish to add a file-type, folder-type, or database-type resource. How
to add and edit each type of resource is described in the sub-sections of this section.

14.1.1 Files
In the Global Resource dialog for Files (screenshot below), you can add a file resource as
follows:

1. Enter an alias name.

© 2010 Altova GmbH User Manual


450 Altova Global Resources Defining Global Resources

2. The Configurations pane will have a configuration named Default (screenshot above).
This Default configuration cannot be deleted nor have its name changed. You can enter
as many additional configurations for the selected alias as you like. Add a configuration
by clicking the Add Configuration icon and, in the Add Configuration dialog
which pops up, enter the configuration name. Click OK. The new configuration will be
listed in the Configurations pane. Repeat for as many configurations as required for this
particular alias (global resource). You can also copy a configuration (using the Add
Configuration as Copy icon) and then modify it.
3. Select one of the configurations in the Configurations pane and then define the
resource to which this configuration will map. In the Settings for Configuration X pane,
you can select whether the resource is a file, or the result of either an Altova MapForce
or Altova StyleVision transformation. After selecting the resource type by clicking its
radio button, browse for the file, MapForce file, or StyleVision file. Where multiple inputs
or outputs for the transformation are possible, a selection of the options will be
presented. For example, if the Result of StyleVision Transformation was selected as the
resource type, the output options are displayed according to the what edition of
StyleVision is installed (the screenshot below shows the outputs for Enterprise Edition).

Select the radio button of the desired option (in the screenshot above, 'HTML output' is
selected). The result of a transformation can itself be saved as a global resource or as
a file path (click the icon and select, respectively, Global Resource or Browse). If
neither of these two saving options is selected, the transformation result will be loaded
as a temporary file when the global resource is invoked.
4. Specify a resource for each configuration (that is, repeat Step 3 above for the various
configurations you have created).
5. Click OK in the Global Resource dialog to save the alias and all its configurations as a
global resource. The global resource will be listed under Files in the Manage Global
Resources dialog.

Selecting Result of MapForce transformations as a global resource


Altova MapForce maps one or more (already existing) schemas to one or more (new) schemas
designed by the MapForce user. XML files corresponding to the input schemas are used as
data sources, and an output XML file based on the user-designed schema can be generated by
MapForce. This generated output file (Result of MapForce Transformation) is the file that will be
used as a global resource.

In a MapForce transformation that has multiple output schemas, you can select which one of
the output schemas should be used for the global resource by clicking its radio button (
screenshot below). The XML file that is generated for this schema can be saved as a global
resource or as a file path (click the icon and select, respectively, Global Resource or
Browse). If neither of these options is selected, a temporary XML file is created when the global
resource is used.

Altova XMLSpy 2011 © 2010 Altova GmbH


Altova Global Resources Defining Global Resources 451

Note that each Input can also be saved as a global resource or as a file path (click the icon
and select, respectively, Global Resource or Browse).

14.1.2 Folders
In the Global Resource dialog for Folders (screenshot below), you can add a folder resource as
follows:

Enter an alias name.


1. The Configurations pane will have a configuration named Default (screenshot above).
This Default configuration cannot be deleted nor have its name changed. You can enter
as many additional configurations for the selected alias as you like. Add a configuration
by clicking the Add Configuration icon and, in the Add Configuration dialog

© 2010 Altova GmbH User Manual


452 Altova Global Resources Defining Global Resources

which pops up, enter the configuration name. Click OK. The new configuration will be
listed in the Configurations pane. Repeat for as many configurations as required for this
particular alias (global resource).
2. Select one of the configurations in the Configurations pane and browse for the folder
you wish to create as a global resource.
3. Specify a folder resource for each configuration (that is, repeat Step 3 above for the
various configurations you have created).
4. Click OK in the Global Resource dialog to save the alias and all its configurations as a
global resource. The global resource will be listed under Folders in the Manage Global
Resources dialog.

14.1.3 Databases
In the Global Resource dialog for Databases (screenshot below), you can add a database
resource as follows:

Enter an alias name.


1. The Configurations pane will have a configuration named Default (screenshot above).
This Default configuration cannot be deleted nor have its name changed. You can enter
as many additional configurations for the selected alias as you like. Add a configuration
by clicking the Add Configuration icon and, in the Add Configuration dialog
which pops up, enter the configuration name. Click OK. The new configuration will be

Altova XMLSpy 2011 © 2010 Altova GmbH


Altova Global Resources Defining Global Resources 453

listed in the Configurations pane. Repeat for as many configurations as required for this
particular alias (global resource).
2. Select one of the configurations in the Configurations pane and click the Choose
Database icon. This pops up the Create Global Resources Connection dialog (
screenshot below).

Select whether you wish to create a connection to the database using the Connection
Wizard, an existing connection, an ADO Connection, or an ODBC Connection.
Complete the definition of the connection method as described in the section
Connecting to a Database. You can use either the Connection Wizard, ADO
Connections, or ODBC Connections. If a connection has already been made to a
database from XMLSpy, you can click the Existing Connections icon and select the DB
from the list of connections that is displayed.
3. If you connect to a database server, you will be prompted to select a DB Root Object on
the server. The Root Object you select will be the Root Object that is loaded when this
configuration is used. If you choose not to select a Root Object, then you can select the
Root Object at the time the global resource is loaded.
4. Specify a database resource for each configuration (that is, repeat Steps 3 and 4 above
for the various configurations you have created).
5. Click OK in the Global Resource dialog to save the alias and all its configurations as a
global resource. The global resource will be listed under databases in the Manage
Global resources dialog.

14.1.4 Copying Configurations


The Manage Global resources dialog allows you to duplicate existing configurations for all types
of resources. To do so, select a configuration and click the Copy Configuration icon . Then
select or enter a configuration name and click OK. This creates a copy of the selected
configuration which you can now change as required.

© 2010 Altova GmbH User Manual


454 Altova Global Resources Using Global Resources

14.2 Using Global Resources


There are several types of global resources (file-type, folder-type , and database-type).
Particular scenarios in XMLSpy allow the use of particular types of global resources. For
example, you can use file-type or folder-type global resources for a Working XML File or a CSS
file. Or you can use a database-type resource to create a new DB-based SPS. The various
scenarios in which you can use global resources in XMLSpy are listed in this section: Files and
Folders and Databases.

Selections that determine which resource is used


There are two application-wide selections that determine what global resources can be used
and which global resources are actually used at any given time:
 The active Global Resources XML File is selected in the Global Resource dialog. The
global-resource definitions that are present in the active Global Resources XML File are
available to all files that are open in the application. Only the definitions in the active
Global Resources XML File are available. The active Global Resources XML File can
be changed at any time, and the global-resource definitions in the new active file will
immediately replace those of the previously active file. The active Global Resources
XML File therefore determines: (i) what global resources can be assigned, and (ii) what
global resources are available for look-up (for example, if a global resource in one
Global Resource XML File is assigned but there is no global resource of that name in
the currently active Global Resources XML File, then the assigned global resource
(alias) cannot be looked up).
 The active configuration is selected via the menu item Tools | Active Configuration or
via the Global Resources toolbar. Clicking this command (or drop-down list in the
toolbar) pops up a list of configurations across all aliases. Selecting a configuration
makes that configuration active application-wide. This means that wherever a global
resource (or alias) is used, the resource corresponding to the active configuration of
each used alias will be loaded. The active configuration is applied to all used aliases. If
an alias does not have a configuration with the name of the active configuration, then
the default configuration of that alias will be used. The active configuration is not
relevant when assigning resources; it is significant only when the resources are actually
used.

14.2.1 Assigning Files and Folders


In this section, we describe how file-type and folder-type global resources are assigned. File-
type and folder-type global resources are assigned differently. In any one of the usage
scenarios below, clicking the Switch to Global Resources button pops up the Open Global
Resource dialog (screenshot below).

Altova XMLSpy 2011 © 2010 Altova GmbH


Altova Global Resources Using Global Resources 455

Selecting a file-type global resource assigns the file. Selecting a folder-type global resource
causes an Open dialog to open, in which you can brows for the required file. The path to the
selected file is entered relative to the folder resource. So if a folder-type global resource were to
have two configurations, each pointing to different folders, files having the same name but in
different folders could be targeted via the two configurations. This could be useful for testing
purposes.

In the Open Global Resource dialog, you can switch to the file dialog or the URL dialog by
clicking the respective button at the bottom of the dialog. The Manage Global Resources
icon in the top right-hand corner pops up the Manage Global Resources dialog.

Usage scenarios
File-type and folder-type global resources can be used in the following scenarios:
 Opening global resources
 Saving as global resource
 Assigning files for XSLT transformations
 XSLT transformation and XQuery executions
 Assigning an SPS

Opening global resources


A global resource can be opened in XMLSpy with the File | Open (Switch to Global
Resource) command and can be edited. In the case of a file-type global resource, the file is
opened directly. In the case of a folder-type global resource, an Open dialog pops up with the
associated folder selected. You can then browse for the required file in descendant folders. One
advantage of addressing files for editing via global resources is that related files can be saved
under different configurations of a single global resource and accessed merely by changing
configurations. Any editing changes would have to be saved before changing the configuration.

© 2010 Altova GmbH User Manual


456 Altova Global Resources Using Global Resources

Saving as global resource


A newly created file can be saved as a global resource. Also, an already existing file can be
opened and then saved as a global resource. When you click the File | Save or File | Save As
commands, the Save dialog appears. Click the Switch to Global Resource button to access
the available global resources (screenshot below), which are the aliases defined in the current
Global Resources XML File.

Select an alias and the click Save. If the alias is a file alias, the file will be saved directly. If the
alias is a folder alias, a dialog will appear that prompts for the name of the file under which the
file is to be saved. In either case the file will be saved to the location that was defined for the
currently active configuration.

Note: Each configuration points to a specific file location, which is specified in the definition of
that configuration. If the file you are saving as a global resource does not have the
same filetype extension as the file at the current file location of the configuration, then
there might be editing and validation errors when this global resource is opened in
XMLSpy. This is because XMLSpy will open the file assuming the filetype specified in
the definition of the configuration.

Assigning files for XSLT transformations


XSLT files can be assigned to XML documents and XML files to XSLT documents via global
resources.. When the commands for assigning XSLT files (XSL/XQuery | Assign XSL and
XSL/XQuery | Assign XSL:FO) and XML files (XSL/XQuery | Assign Sample XML) are
clicked the assignment dialog pops up. Clicking the Browse button pops up the Open dialog, in
which you can switch to the Open Global Resource dialog and select the required global
resource. A major advantage of using a global resource to specify files for XSLT
transformations is that the XSLT file (or XML file) can be changed for a transformation merely
by changing the active configuration in XMLSpy; no new file assignments have to be made each
time a transformation is required with a different file. When an XSLT transformation is started, it
will use the file/s associated with the active configuration.

Altova XMLSpy 2011 © 2010 Altova GmbH


Altova Global Resources Using Global Resources 457

XSLT transformations and XQuery executions


Clicking the command XSL/XQuery | XSL Transformation, XSL/XQuery | XSL:FO
Transformation, or XSL/XQuery | XQuery Execution pops up a dialog in which you can
browse for the required XSLT, XQuery, or XML file. Click the Browse button and then the
Switch to Global Resource button to pop up the Open Global Resource dialog (screenshot at
top of section). The file that is associated with the currently active configuration of the selected
global resource is used for the transformation.

Assigning an SPS
When assigning a StyleVision stylesheet to an XML file (Authentic | Assign StyleVision
Stylesheet), you can select a global resource to locate the stylesheet. Click the Browse button
and then the Switch to Global Resource button to pop up the Open Global Resource dialog (
screenshot at top of section). With a global resource selected as the assignment, the Authentic
View of the XML document can be changed merely by changing the active configuration in
XMLSpy.

14.2.2 Assigning Databases


When a command is executed that imports data or a data structure (as an XML Schema) from
a DB into XMLSpy (for example, with the Convert | Import Database Data command), you can
select the option to use a global resource (screenshot below). Other commands where a
database-type global resource can be used are database-related commands in the menu.

When you click the Global Resources icon in the Open Database dialog, all the database-type
global resources that have been defined in the currently active Global Resources XML File are
displayed. Select the required global resource and click Connect. If the selected global

© 2010 Altova GmbH User Manual


458 Altova Global Resources Using Global Resources

resource has more than one configuration, then the database resource for the currently active
configuration (check Tools | Active Configuration or the Global Resources toolbar) is used,
and the connection is made. You must now select the data structures and data to be used as
described in Creating an XML Schema from a DB and Importing DB data.

14.2.3 Changing Configurations


One global resource configuration can be active at any time, and it is active application-wide.
This means that the active configuration is active for all aliases in all currently open files. If an
alias does not have a configuration with the name of the active configuration, then the default
configuration of that alias will be used.

As an example of how to change configurations, consider the case in which an XSLT file has
been assigned to an XML document via a global resource with multiple configurations. The
XSLT file can be switched merely by changing the configuration of the global resource. This can
be done in two ways:

 When you hover over the menu command Tools | Active Configuration, a submenu
with a list of all configurations in the Global Resources XML File pops out. Select the
required configuration.
 In the combo box of the Global Resources toolbar (screenshot below), select the
required configuration. (The Global Resources toolbar can be toggled on and off with
the menu command Tools | Customize | Toolbars | Global Resources.)

The XSLT file will be changed immediately.

In this way, by changing the active configuration, you can change source files that are assigned
via a global resource.

Altova XMLSpy 2011 © 2010 Altova GmbH


Projects 459

15 Projects
A project is a collection of files that are related to each other in some way you determine. For
example, in the screenshot below, a project named Examples collects the files for various
examples in separate example folders, each of which can be organized further into sub-folders.
Within the Examples project, for instance, the OrgChart example folder is organized further into
sub-folders for XML, XSL, and Schema files.

Projects thus enable you to gather together files that are used together and to access them
quicker. Additionally, you can define schemas and XSLT files for individual folders, thus
enabling the batch processing of files in a folder.

This section describes how to create and edit projects and how to use projects.

© 2010 Altova GmbH User Manual


460 Projects Creating and Editing Projects

15.1 Creating and Editing Projects


Projects are managed via the Project Window (screenshot below) and the Project menu. One
project can be open at a time in the application. The open project is displayed in the Project
Window.

Creating new projects, opening existing projects


A new project is created with the menu command Project | New Project. An existing project is
opened with the menu command Project | Open Project. The newly opened project (whether
new or existing) replaces the previously opened project in the Project Window. If the previously
opened project contains unsaved changes (indicated by an asterisk next to the folder name;
see screenshot below), you are asked whether you wish to save these changes.

Naming and saving projects


A new project is named when you save it. A project is saved with the Project | Save Project
command and has the .spp file extension. After a project has been modified, the project must
be saved for the modifications to be stored. Note that a project (indicated by the top-level folder
in the Project Window) can only be re-named by changing its name in Windows File Explorer;
the name cannot be changed in the GUI. (The names of sub-folders, however, can be changed
in the GUI.)

Project structure
A project has a tree structure of folders and files. Folders and files can be created at any level
and to an unlimited depth. Do this by selecting a folder in the Project Window and then using
the commands in the Project menu or context menu to add folders, files, or resources. Folders,
files, and resources that have been added to a project can be deleted or dragged to other
locations in the project tree.

When a new project is created, the default project structure organizes the project by file type

Altova XMLSpy 2011 © 2010 Altova GmbH


Projects Creating and Editing Projects 461

(XML, XSL, etc) (see screenshot below).

File-type extensions are associated with a folder via the property definitions for that folder.
When a file is added to a folder, it is automatically added to the appropriate child folder
according to the file-type extension. For each folder, you can define what file-type extensions
are to be associated with it.

What can be added to a project


Folder, files, and other resources can be added either to the top-level project folder or to a
folder at any level in the project. There are three types of folders: (i) project folders; (ii) external
folders; (iii) external web folders.

To add an object, select the relevant folder and then the required command from the Project
menu or context menu of the selected folder. The following objects are available for addition to
a project folder
 Project folders (green) are folders that you add to the project in order to structure the
project's contents. You can define what file extensions are to be associated with a
project folder (in the properties of that folder). When files are added to a folder, they are
automatically added to the first child folder that has that file's extension associated with
it. Consequently, when multiple files are added to a folder, they will be distributed by file
extension among the child folders that have the corresponding file-extension
associations.
 External folders (yellow) are folders in a file system. When an external folder is added
to a folder, the external folder and all its files, sub-folders, and sub-folder files are
included in the project. Defining file extensions on an external folder serves to filter the
files available in the project.
 External web folders are like external folders, except that they are located on a web
server and require user authentication to access. Defining file extensions on an external
web folder serves to filter the files available in the project.
 Files can be added to a folder by selecting the folder and then using one of the three
Add-File commands: (i) Add Files, to select the file/s via an Open dialog; (ii) Add
Active File, to add the file that is active in the Main Window; (iii) Add Active and
Related Files, additionally adds files related to an active XML file, for example, an XML
Schema or DTD. Note that files associated by means of a processing instruction (for
example, XSLT files), are not considered to be related files.
 Global Resources are aliases for file, folder, and database resources. How they are
defined and used is described in the section on Global Resources.
 URLs identify a resource object via a URL.
 An Altova Scripting Project, which is a .asprj file, can be assigned to an XMLSpy
project. This will make macros and other scripts available to the project. How to create
a Scripting Project and assign one to an XMLSpy project is described in the section,
Scripting.

© 2010 Altova GmbH User Manual


462 Projects Creating and Editing Projects

Project properties
The properties of a folder are stored in the Properties dialog of that folder. It is accessed by first
selecting the folder and then the Properties command in the Project menu or context menu
(obtained by right-clicking the folder). Note that properties can be defined not only for the top-
level project folder, but also for folders at various levels of the project hierarchy. The following
properties of a folder can be defined and edited in the Properties dialog:
 Folder name: cannot be edited for the top-level project folder (for which, instead of a
name, a filepath is displayed).
 File extensions: cannot be edited for the top-level project.
 Validation: specifies the DTD or XML Schema file that should be used to validate XML
files in a folder.
 Transformations: specifies (i) the XSLT files to be used for transforming XML files in the
folder, and (ii) the XML files to be transformed with XSLT files in the folder.
 Destination files: for the output of transformations, specifies the file extension and the
folder where the files are to be saved.
 SPS files for Authentic View: specifies the SPS files to be used so that XML files in a
folder can be viewed and edited in Authentic View.

Source control in projects


Source control systems that are compatible with Microsoft Visual Source-Safe are supported in
projects. How to use this feature is described in the User Reference section of the manual.

Saving projects
Any changes you make to a project, such as adding or deleting a file, or modifying a project
property, must be saved with the Save Project command.

Refreshing projects
If a change is made to an external folder, this change will not be reflected in the Project Window
till the project is refreshed.

Altova XMLSpy 2011 © 2010 Altova GmbH


Projects Using Projects 463

15.2 Using Projects


Projects are very useful for organizing your workspace, applying settings to multiple files, and
for setting up and executing batch commands. Using projects can therefore greatly help speed
up and ease your work.

Benefits of using projects


The following list lists the benefits of using projects.
 Files and folders can be grouped into folders by file extension or any other desired
criterion.
 Schemas and XSLT files can be assigned to a folder. This can be useful if you wish to
quickly validate or transform a single XML file using different schema or XSLT files. Add
the XML file to different folders and define different schemas and XSLT files for the
different folders.
 Batch processing can be applied to individual folders. The commands available for
batch processing are listed below.
 Output folders can be specified for transformations.

Organizing resources for quick access


Folder and file resources can be organized into a tree structure, giving you a clear overview of
the various folders and files in your project, and enabling you to quickly access any and all files
in a project. Simply double-click a file in the Project window to open it. You can quickly add files
and folders to a project as required and delete unwanted files and folders. When you wish to
work with another project, close the project currently open in the Project Window and open the
required project.

Batch processing
The commands for batch processing of files in a folder, whether the top-level project folder or a
folder at any other level, are available in the context menu of that folder (obtained by right-
clicking the folder). The steps for batch processing are as follows:
1. Define the files to be used for validation or transformation in the Properties dialog of
that folder.
2. Specify the folder in which the output of transformations should be saved. If no output
folder is specified for a folder, the output folder of the next ancestor folder in the project
tree is used.
3. Use the commands in the context menu for batch execution. If you use the
corresponding commands in the XML, DTD/Schema, or XSL/XQuery menus, the
command will be executed only on the document active in the Main Window, not on any
project folder in the Project Window.

The following commands in the context menu of a project folder (top-level or other) are
available for batch processing:
 Well-formed check: If any error is detected during the batch execution, it is reported in
the Messages Window.
 Validation: If any error is detected during the batch execution, it is reported in the
Messages Window.
 Transformations: Transformation outputs are saved to the folder specified as the output
folder in the Properties dialog of that folder. If no folder is specified, the output folder of
the next ancestor project folder is used. If no ancestor project folder has an output
folder defined, a document window is opened and the results of each transformation is
displayed successively in this document window. An XSL-FO transformation transforms
an XML document or FO document to PDF.

© 2010 Altova GmbH User Manual


464 Projects Using Projects

 Generate DTD / XML Schema: Before the schemas are generated, you are prompted to
specify an output folder. The generated schema files are saved to this folder and
displayed in separate windows in the GUI.

Note: To execute batch commands use the context menu of the relevant folder in the Project
Window. Do not use the commands in the XML, DTD/Schema, or XSL/XQuery menus.
These commands will be executed on the document active in the Main Window.

Altova XMLSpy 2011 © 2010 Altova GmbH


File/Directory Comparisons 465

16 File/Directory Comparisons
XMLSpy provides a File Comparison feature and a Directory Comparison feature that are linked
to each other. File Comparisons and Directory Comparisons are started with the Compare
Open File With and Compare Directories commands in the Tools menu, respectively.
Comparison options for file comparisons can be defined in the Settings dialog, which is
accessed by clicking the Compare Options command in the Tools menu.

Each of these commands is described in detail in the User Reference section. In the sub-
sections of this section we provide an overview of the File Comparisons and Directory
Comparisons mechanisms.

© 2010 Altova GmbH User Manual


466 File/Directory Comparisons File Comparisons

16.1 File Comparisons


The File Comparisons feature enables you to compare the active file with another file, which is
selected via an Open File dialog or via a global resource. The following points provide an
overview of the mechanism. For details, see the User Reference section.

 The settings current in the Compare Options dialog when a File Compare session is
started are the settings that will be active for that session.
 You can choose to compare the files as XML files (where document structure is also
evaluated) or as Text files. This choice is made by selecting, in the Settings dialog,
either (i) Grid View or Text View (Textual Comparison Only unchecked) for XML
comparisons, or (ii) Text View (Textual Comparison Only checked) for text
comparisons.
 The two files appear in adjacent panes in the selected view (Grid View or Text View)
and the differences are highlighted in both files (screenshot below).

A Compare Files control window also pops up which enables you to navigate through
the differences and to merge them.

The Settings dialog offers several options for specifying what aspects of the XML documents
should be considered for the comparison, and what aspects ignored. For more details, see the
Compare Options section in the User Reference.

Altova XMLSpy 2011 © 2010 Altova GmbH


File/Directory Comparisons Directory Comparisons 467

16.2 Directory Comparisons


The Directory Comparisons feature enables you to compare directories, each of which you
select via separate Browse for Folder dialogs. You can also select whether sub-directories are
to be compared or not, and what file types should be considered for the directory comparison.

Zip archives can also be included in the comparison by including the Zip file extension in the list
of file types to evaluate.

Directories are compared to indicate missing files and whether files of the same name are
different or not. The comparisons between files are based on the settings in the Settings dialog.
The results of the directory comparison are displayed in a separate window (screenshot below).

For details about how to read the symbols and manage the view in the Compare Directories
window, see the description of the Compare Directories command in the User Reference. You
can then double-click a file row to directly start a file comparison.

© 2010 Altova GmbH User Manual


468 Source Control

17 Source Control
Altova has implemented the Microsoft Source Code Control Interface (MSSCCI) v1.1 – v1.3 in
XMLSpy, so that XMLSpy now supports Microsoft SourceSafe and other compatible
repositories. Altova has tested support with a large number of drivers and revision control
systems; these are listed in the section, Supported Version Control Systems.

Please note:
The 64-bit version of XMLSpy automatically supports any of the supported 32-bit
source control programs mentioned in this documentation.

When using a 64-bit version of XMLSpy with a 32-bit source control program, the
"Perform background status updates every... ms" option (Tools | Options) is
automatically greyed-out and cannot be selected!

Registry entry and plug-ins


Microsoft has defined a Registry entry, where all Source Control-compatible programs can
register themselves. This is the entry for XMLSpy:

HKEY_LOCAL_MACHINE\SOFTWARE\SourceCodeControlProvider\InstalledSCCProviders

Note that Source Control (SC) plug-ins are not automatically installed by all SC products.
Please read the documentation supplied with your specific SC software for more information
about plug-ins.

Accessing SC controls in XMLSpy


Source Control commands can be accessed in the following ways:
 Using the menu command Project | Source Control
 Using the context menu in the Project window

Note that a Source Control project is not the same as an XMLSpy project. Source Control
projects are directory dependent, whereas XMLSpy projects are logical constructions without
direct directory dependence.

In this section
This section as organized as follows:
 Supported Source Control Systems lists the Source Control Systems (SCSs) that are
supported by XMLSpy. Systems are listed alphabetically by server, and for each server
the supported clients are also listed.
 Installing Source Control Systems contains notes about how to install the various SCSs.
 SCSs and Altova DiffDog Differencing describes how various Source Control Systems
can be set up to carry out differencing with Altova DiffDog.

Menu commands
The menu commands for using Source Control Systems are in the submenu Project | Source
Control and are described in the User Reference section.

Altova XMLSpy 2011 © 2010 Altova GmbH


Source Control 469

Resource / Speed issues


Very large source control databases might be introducing a speed/resource penalty when
automatically performing background status updates.
You might be able to speed up your system by disabling (or increasing the interval of) the
"Perform background status updates every xxx seconds" field in the Source control tab
accessed through Tools | Options.

© 2010 Altova GmbH User Manual


470 Source Control Supported Source Control Systems

17.1 Supported Source Control Systems


The list below shows the Source Control Servers (SCSs) supported by XMLSpy, together with
their respective Source Control Client/s (SCCs). The list is organized alphabetically by SCS.
Please read the notes following the list for information about support levels.

AccuRev
Version: AccuRev 4.7.0 Windows
Clients:  AccuBridge for Microsoft SCC 2008.2

Bazaar
Version: Bazaar 1.9 Windows
Clients:  Aigenta Unified SCC 1.0.6

Borland StarTeam 2008


Version: StarTeam 2008 Release 2
Clients:  Borland StarTeam Cross-Platform Client 2008 R2

Codice Software Plastic SCM


Version: Codice Software Plastic SCM Professional 2.7.127.10 (Server)
Clients:  Codice Software Plastic SCM Professional 2.7.127.10 (SCC Plugin)

Collabnet Subversion 1.5


Version: 1.5.4
Clients:  Aigenta Unified SCC 1.0.6
 PushOK SVN SCC 1.5.1.1
 PushOK SVN SCC x64 version 1.6.3.1
 TamTam SVN SCC 1.2.24

ComponentSoftware CS-RCS (PRO)


Version: ComponentSoftware CS-RCS (PRO) 5.1
Clients:  ComponentSoftware CS-RCS (PRO) 5.1

Dynamsoft SourceAnywhere for VSS

Altova XMLSpy 2011 © 2010 Altova GmbH


Source Control Supported Source Control Systems 471

Version: Dynamsoft SourceAnywhere for VSS 5.3.2 Standard/Professional Server


Clients:  Dynamsoft SourceAnywhere for VSS 5.3.2 Client

Dynamsoft SourceAnywhere Hosted


Version: Server hosted in a Bell Data Center
Clients:  Dynamsoft SourceAnywhere Hosted Client (22252)

Dynamsoft SourceAnywhere Standalone


Version: SourceAnywhere Standalone 2.2 Server
Clients:  Dynamsoft SourceAnywhere Standalone 2.2 Client

IBM Rational ClearCase 7


Version: 7.0.1 (LT)
Clients:  IBM Rational ClearCase 7.0.1 (LT)

March-Hare CVSNT 2.5


Version: 2.5.03.2382
Clients:  Aigenta Unified SCC 1.0.6

March-Hare CVS Suite 2008


Version: Server 2008 [3321]
Clients:  Jalindi Igloo 1.0.3
 March-Hare CVS Suite Client 2008 (3321)
 PushOK CVS SCC NT 2.1.2.5
 PushOK CVS SCC x64 version 2.2.0.4
 TamTam CVS SCC 1.2.40

Mercurial
Version: Mercurial 1.0.2 for Windows
Clients:  Sergey Antonovs HgSCC 1.0.1

Microsoft SourceSafe 2005

© 2010 Altova GmbH User Manual


472 Source Control Supported Source Control Systems

Version: 2005 with CTP


Clients:  Microsoft SourceSafe 2005 with CTP

Microsoft Visual Studio Team System 2008 Team Foundation Server


Version: 2008
Clients:  Microsoft Team Foundation Server 2008 MSSCCI Provider

Perforce 2008
Version: P4S 2008.1
Clients:  Perforce P4V 2008.1

PureCM
Version: PureCM Server 2008/3a
Clients:  PureCM Client 2008/3a

QSC Team Coherence Version Manager


Version: QSC Team Coherence Server 7.2.1.35
Clients:  QSC Team Coherence Client 7.2.1.35

Qumasoft QVCS Enterprise


Version: QVCS Enterprise 2.1.18
Clients:  Qumasoft QVCS Enterprise 2.1.18

Qumasoft QVCS Pro


Version: 3.10.18
Clients:  Qumasoft QVCS Pro 3.10.18

Reliable Software Code Co-Op


Version: Code Co-Op 5.1a
Clients:  Reliable Software Code Co-Op 5.1a

Altova XMLSpy 2011 © 2010 Altova GmbH


Source Control Supported Source Control Systems 473

Seapine Surround SCM


Version: Surround SCM Client/Server for Windows 2009.0.0
Clients:  Seapine Surround SCM Client 2009.0.0

Serena Dimensions
Version: Dimensions Express/CM 10.1.3 for Win32 Server
Clients:  Serena Dimensions 10.1.3 for Win32 Client

Softimage Alienbrain
Version: Alienbrain Server 8.1.0.7300
Clients:  Softimage Alienbrain Essentials/Advanced Client 8.1.0.7300

SourceGear Fortress
Version: 1.1.4 Server
Clients:  SourceGear Fortress 1.1.4 Client

SourceGear SourceOffsite
Version: SourceOffsite Server 4.2.0
Clients:  SourceGear SourceOffsite Client 4.2.0 (Windows)

SourceGear Vault
Version: 4.1.4 Server
Clients:  SourceGear Vault 4.1.4 Client

VisualSVN Server 1.6


Version: 1.6.2
Clients:  Aigenta Unified SCC 1.0.6
 PushOK SVN SCC 1.5.1.1
 PushOK SVN SCC x64 version 1.6.3.1
 TamTam SVN SCC 1.2.24

© 2010 Altova GmbH User Manual


474 Source Control Supported Source Control Systems

Note the following:


 Altova has implemented the Microsoft Source Code Control Interface (MSSCCI) v1.1 –
v1.3 in XMLSpy, and has tested support for the drivers and revision control systems
listed above. It is expected that XMLSpy will continue to support these products if, and
when, they are updated.
 Source Control plugins not listed in the table above, but that adhere to the MSCCI
1.1-1.3 specification, should also work together with XMLSpy.

Altova XMLSpy 2011 © 2010 Altova GmbH


Source Control Installing Source Control Systems 475

17.2 Installing Source Control Systems


This section gives information on how to install and set up the various supported Source Control
Systems.

AccuBridge for Microsoft SCC 2008.2


http://www.accurev.com/
1. Install AccuRev client software, run the installer and specify the server you want to
connect to (hostname and port) then create a workspace.
2. Install the AccuBridge SCC provider. Extract the ZIP archive into the <AccuRev
installation dir>\bin directory.
Register the AccuRev.dll and SccAcc.dll as follows:
3. Open a command prompt window (if you work with Vista, start Windows Explorer, go to
C:\Windows\System32, right click and run cmd.exe “As administrator”).
4. Go to the <installation AccuRev dir>\bin directory.
5. Enter the following command at the command prompt:
 Regsvr32 AccuRev.dll
 Regsvr32 SccAcc.dll
6. Run the SwitchScc.exe program and set AccuRev as the provider.
7. Perform a Windows log off and log in again.

Aigenta Unified SCC 1.0.6


http://aigenta.com/products/UnifiedScc.aspx
Requirements: source control client. Aigenta Unified SCC works with:
 subversion command line client 1.5.4 at http://subversion.tigris.org
 CVSNT 2.5 (client) at http://www.cvsnt.org
 Bazaar 1.9 Windows (and related pre-requisites)at http://bazaar-vcs.org/ (
http://bazaar-vcs.org/WindowsInstall)
A standard installation will work correctly with Altova products.

Borland StarTeam Cross-Platform Client 2008 R2


http://www.borland.com/us/products/starteam
To install the Borland StarTeam Microsoft SCC integration run the setup program and choose to
install the SCC API Integration. Altova products can now connect to the repository by specifying
the server address, the end point, user and password to log on, your project and working path.

Codice Software Plastic SCM Professional 2.7.127.10 (SCC Plugin)


http://www.codicesoftware.com/xpproducts.aspx
A standard installation will work correctly with Altova products. It is sufficient to install the “client”
and the “Visual Studio SCC plug-in” components.

ComponentSoftware CS-RCS (PRO) 5.1


http://www.componentsoftware.com/Products/RCS

© 2010 Altova GmbH User Manual


476 Source Control Installing Source Control Systems

1. To install ComponentSoftware CS-RCS (PRO) start the setup and choose the option
“Workstation Setup”.
2. Specify your repository tree root and when the installation is finished, restart your
machine as requested.
3. Use the “ComponentSoftware RCS Properties” to choose, or create, a project and to
specify a work folder.

Dynamsoft SourceAnywhere for VSS 5.3.2 Client


http://www.dynamsoft.com/Products/SAW_Overview.aspx
A standard installation will work correctly with Altova products. To integrate with Altova products
you do not need to install the plug-in for Adobe DreamWeaver CS3. After the installation,
establish a server connection and set a working folder.

Dynamsoft SourceAnywhere Hosted Client (22252)


http://www.dynamsoft.com/Products/SourceAnywhere-Hosting-Version-Control-Sourc
e-Control.aspx
A standard installation will work correctly with Altova products. To integrate with the Altova
products you do not need to install the plug-in for Adobe DreamWeaver CS3.

Dynamsoft SourceAnywhere Standalone 2.2 Client


http://www.dynamsoft.com/Products/SourceAnywhere-SourceSafe-VSS.aspx
A standard installation will work correctly with Altova products. To integrate with the Altova
products you do not need to install the plug-in for Adobe DreamWeaver CS3. After the
installation, establish a server connection and set a working folder.

IBM Rational ClearCase 7.0.1 (LT)


http://www-01.ibm.com/software/awdtools/clearcase/
To install IBM Rational ClearCase LT run the setup.
 You will be asked to update the version of the InstallShield scripting engine if it is older
than version 10.5, choose “Update it if necessary”. The update runs prior to the
installation starting.
 Choose the default option “Enterprise deployment, create a network release area and
customize it using Siteprep”.

To integrate with Altova products, it is sufficient to install only the client. Check only the client
check box.
 Provide a server name and the license server element(s) following the examples
provided by the installer (port@server_name).
 Provide a configuration description name by editing a name you like and insert the path
to a Release area. This path must specify a shared folder.
 You can create a new folder on your machine, share it, and use it a Release Area. (In
Vista, you must set the Network discovery to "on" in Network and Sharing Center to set
this path.) The Release Area is now created, some files are copied into it and a shortcut
is created sitedefs.lnk.
 When all files are copied, continue by clicking the shortcut from Windows Explorer. A

Altova XMLSpy 2011 © 2010 Altova GmbH


Source Control Installing Source Control Systems 477

new setup will start to install the client.


 When setup starts, choose the option “Install IBM Rational ClearCase LT”.
 Keep clicking “Next”, accept the “Software License Agreement” and start the
installation.

In Vista, the second setup could generate the internal error: 2739. In this case, start Windows
Explorer and go to C:\Windows\System32.
 Right click and run “cmd.exe” “As Administrator”. A command window pops up.
 Type “regsvr32 jscript.dll”.
 Launch the setup again.

To work with files stored in ClearCase, you should create a view that points to your ClearCase
project.

Jalindi Igloo 1.0.3


http://www.jalindi.com/igloo/
To use Jalindi Igloo with Altova products it is sufficient to run the setup to install Jalindi Igloo.
Note that if you uninstall Jalindi Igloo, all other installed SCC Provider Windows registry keys (if
any) are deleted as well and are not longer available.

When working with Altova products, setting the “Auto Commit” Mode is recommended.
 Auto Commit Mode is found in the advanced Source Control options.
 After defining a workspace, you can start to work.

March-Hare CVS Suite Client 2008 (3321)


http://www.march-hare.com/cvsnt/en.asp
A “typical” installation will work correctly with Altova products.

Mercurial
see under Sergey Antonovs HgScc 1.0.1

Microsoft SourceSafe 2005 with CTP


http://msdn.microsoft.com/en-us/vstudio/aa718670.aspx
A standard installation of Microsoft Source Safe 2005 will work correctly with Altova products.

Microsoft Team Foundation Server 2008 MSSCCI Provider


http://www.microsoft.com/downloads
Requirements: Visual Studio 2008 Team Explorer, or Visual Studio 2008 with Team Explorer
2008. A standard installation will work correctly with Altova products.

Perforce P4V 2008.1

© 2010 Altova GmbH User Manual


478 Source Control Installing Source Control Systems

http://www.perforce.com/
The Perforce Visual Client (P4V) offers a choice:
 To install all client features (default behavior)
 To install only the “SCC Plug-in (P4SCC)” feature.
The default installation will work correctly with all Altova products.

If the “SCC Plug-in (P4SCC)” feature is chosen:


 Two SCC functions “Show differences” and “Source control manager” will not work.
 The “Show differences” functionality and the possibility to launch the source control
manager will not work, because they rely on the non-installed features” Visual Merge
Tool” and “Visual Client (P4V)” respectively.
 The differencing functionality will need 3rd party software, while the launch of the
source control manager will only be possible after the explicit installation of the “Visual
Client (P4V)".
 After starting your Perforce Visual Client installation, specify your own client
configuration settings (server name, Text Editing Application, User Name).
 When the installation is finished, do not forget to create a new workspace or to select
an existing one.

PureCM Client 2008/3a


http://www.purecm.com/
A standard installation will work correctly with Altova products. After the installation, start the
PureCM client to register a server.

PushOK CVS SCC NT 2.1.2.5


http://www.pushok.com/soft_cvs.php
A standard installation is sufficient for using PushOK CVS SCC NT.
 After installation is complete, make sure your copy of the CVS proxy plug-in is correctly
registered.
 After defining a workspace, you can start to work.

PushOK CVS SCC x64 version 2.2.0.4


http://www.pushok.com/soft_cvs.php
A standard installation is sufficient for using PushOK CVS SCC.
 After installation is complete, make sure your copy of the CVS proxy plug-in is correctly
registered.
 After defining a workspace, you can start to work.

PushOK SVN SCC 1.5.1.1


http://www.pushok.com/soft_svn.php
A standard installation of PushOK SVN SCC is sufficient for use with Altova products. When
installing under Vista, it is possible that the COM library svncom.dll cannot be registered. In
this case, finish the installation, and then register the library manually by following these steps:
1. Start a command window using the option "Run as administrator".
2. Enter: cd “C:\Program Files\PushOK Software\SVNSCC\svn”

Altova XMLSpy 2011 © 2010 Altova GmbH


Source Control Installing Source Control Systems 479

3. Type the command > regsvr32 svncom.dll.

PushOK SVN SCC x64 version 1.6.3.1


http://www.pushok.com/soft_svn.php
A standard installation of PushOK SVN SCC is sufficient for use with Altova products. When
installing under Vista, it is possible that the COM library svncom.dll cannot be registered. In
this case, finish the installation, and then register the library manually by following these steps:
1. Start a command window using the option "Run as administrator".
2. Enter: cd “C:\Program Files\PushOK Software\SVNSCC\svn”
3. Type the command > regsvr32 svncom.dll.

QSC Team Coherence Client 7.2.1.35


http://www.teamcoherence.com
A standard installation will work correctly with Altova products.
 If the server is installed on the client machine, a default connection is created after the
client installation.
 If the server resides on a different machine, you need to change the “HOSTNAME”
property in the Connection Properties dialog of Team Coherence client, to point to the
relevant machine.

Qumasoft QVCS Enterprise 2.1.18


http://www.qumasoft.com/
Requirements: J2SE 1.5 or later http://java.sun.com/j2se/downloads.html

To install Qumasoft QVCS-Enterprise client, run the installer. If your operating system is Vista,
you must modify the installation directory from the default value “C:\Program
Files\QVCS-Enterprise Client” to “C:\QVCS-Enterprise Client”. This must be done as Vista does
not let applications write to the C:\Program Files area. 1. Edit the “setEnv.cmd” file that resides
in the installation directory so that the JAVA_HOME environment variable points to the location
of your JVM.

If you work with Vista you might have problem when saving the file.
1. If this is the case, start Windows Explorer and go to C:\Windows\System32.
2. Right click and run “cmd.exe” “As Administrator”.
3. A command window pops up.
4. Type “cd <installation folder of the QVCS –Enterprise client>”
5. Type “Notepad setEnv.cmd” and then edit the file and save it.
6. From the installation directory of the Qumasoft QVCS-Enterprise client run the batch file
“gui.bat”.
7. Add a server from the “Server menu” specifying the requested name, IP address and
ports, log in and define a local workspace.

Qumasoft QVCS Pro 3.10.18


http://www.qumasoft.com/
To install Qumasoft QVCS-Pro run the installer.

© 2010 Altova GmbH User Manual


480 Source Control Installing Source Control Systems

 If your operating system is Vista, you must modify the installation directory from the
default value “C:\Program Files\QVCSBin“ to “C:\QVCSBin”. This must be done as
Vista does not let applications write to the C:\Program Files area.
 After installation is finished, launch the QVCS 3.10 client, create a new user and
enable Ide integration by selecting the submenu “Ide Integration” in the Admin menu
and adding QVCS as a Version Control Tool.
 Create a project and set a workspace.

Reliable Software Code Co-Op 5.1a


http://www.relisoft.com/co_op/index.htm
A standard installation will work correctly with Altova products.

Seapine Surround SCM Client 2009.0.0


http://www.seapine.com/surroundscm.html
A standard installation will work correctly with Altova products. After installation, a server
connection must be established.

Serena Dimensions 10.1.3 for Win32 Client


http://www.serena.com/Products/dimensions/
Supported Versions: Dimensions Express/CM 10.1.3 for Win32 Client
 Perform a “Typical” installation of the Serena Dimension client.
 Specify the WEB client hostname and port number as requested.

Sergey Antonovs HgSCC 1.0.1 for Mercurial SCS


http://www.newsupaplex.pp.ru/hgscc_news_eng.html
A standard installation will work correctly with Altova products.

Softimage Alienbrain Essentials/Advanced Client 8.1.0.7300


http://www.alienbrain.com/
 Perform a “typical” installation of the Alienbrain Client Software, then install the
Alienbrain Microsoft Visual Studio Integration. To work with Altova products you do not
need to install Microsoft Visual Studio.
 The first time you try to open a project from VCS, or to add a project to VCS you will be
asked to enter some user settings, e.g. to specify your server and choose the project
database you want to connect to.

SourceGear Fortress 1.1.4 Client


http://www.sourcegear.com/fortress
A standard installation of SourceGear Fortress client will work with Altova products.

Altova XMLSpy 2011 © 2010 Altova GmbH


Source Control Installing Source Control Systems 481

SourceGear SourceOffsite Client 4.2.0 (Windows)


http://www.sourcegear.com/sos/
A standard installation of SourceOffsite client will work with Altova products.

SourceGear Vault 4.1.4 Client


http://www.sourcegear.com/vault
A standard installation of SourceGear Vault client will work correctly with Altova products.

TamTam CVS SCC 1.2.40


http://www.daveswebsite.com/software/tamtam
Requirements: CVSNT 2.5 (client) at http://www.cvsnt.org. A standard installation will work
correctly with Altova products.
 To connect to the CVS repository you need to install CVSNT.
 In the Altova product open the “Source control” Advanced options and enter the path to
the cvs.exe executable.

TamTam SVN SCC 1.2.24


http://www.daveswebsite.com/software/tamtamsvn
Requirements: subversion command line client 1.5.4 at http://subversion.tigris.org . A
standard installation will work correctly with Altova products.
 To connect to the SVN repository you need to install the subversion command line
client and specify the path to the executable svn.exe in the Altova product Source
control options.
 After starting XMLSpy, you must register the SCC provider.

On a Vista machine the SCC registration could fail.


 If this is the case, use Windows explorer and browse to the directory that contains the
Altova application executable.
 Right click and run the Altova executable “As Administrator”.
The SCC registration will now be successful.

© 2010 Altova GmbH User Manual


482 Source Control SCSs and Altova DiffDog Differencing

17.3 SCSs and Altova DiffDog Differencing


You can configure certain Source Control Systems so that they use Altova DiffDog as their
differencing tools. The systems that support this feature are listed below, together with the setup
steps for each. In XMLSpy, you access the setup process via the Source Control tab of the
Options dialog (Tools | Options, screenshot below).

When using a 64-bit version of XMLSpy with a 32-bit source control program, the "Perform
background status updates every... ms" option (Tools | Options) is automatically greyed-out
and cannot be selected!

The "Perform background status updates every xx ms" check box is unchecked per default,
which means that status updates are not performed at all. Activate the check box and enter a
value in the field, if you want to perform status updates every xx ms. For 64-bit versions using
32-bit source control plugins, this option has no effect.

In the Source Control tab, select the required Source Control System and then click the
Advanced button. The dialog box that opens will be different for each Source Control System.
For the setup process, note the following:
 If you have performed a standard installation of Altova DiffDog, the file path to the
Altova DiffDog executable is:
c:\program files\altova\diffdog2011\DiffDog.exe
If Altova DiffDog is installed elsewhere on your system, insert the appropriate value
when the filepath is required.

Aigenta Unified SCC 1.0.6


http://aigenta.com/products/UnifiedScc.aspx
The following steps will integrate Altova DiffDog into Aigenta Unified SCC:
1. Click the Advanced button of the Source Control tab.
2. Select the Comparison and merging tab and specify the full DiffDog filepath as
comparison tool.

Altova XMLSpy 2011 © 2010 Altova GmbH


Source Control SCSs and Altova DiffDog Differencing 483

Borland StarTeam Cross-Platform Client 2008 R2


http://www.borland.com/us/products/starteam
The following steps integrate Altova DiffDog into Borland Start Team:
1. Use the StarTeam client personal options (Tools | Personal options | File | Alternate
applications)
2. Compare utility: Enter the DiffDog full path.
3. Compare utility options: $file1 $file2.

ComponentSoftware CS-RCS (PRO) 5.1


http://www.componentsoftware.com/Products/RCS
The following steps will integrate Altova DiffDog into ComponentSoftware CS-RCS (Pro):
1. Go to the ComponentSoftware CS-RCS Properties.
2. In the File Types tab, choose a file extension and edit it.
3. Enter/select the value Custom Tool for the “Difference Analysis Tool“, and browse to
insert the DiffDog full path.

Dynamsoft SourceAnywhere for VSS 5.3.2 Client


http://www.dynamsoft.com/Products/SAW_Overview.aspx
The following steps will integrate Altova DiffDog into Dynamsoft SourceAnywhere for VSS:
1. Go to the Dynamic SourceAnywhere For VSS client Options.
2. Specify the DiffDog full path as External application for diff/merge, with the arguments:
%FIRST_FILE%” “%SECOND_FILE%.

Warning: Do not perform these settings from the Altova product options, as there is no
possibility of inserting the external application parameters.

Dynamsoft SourceAnywhere Hosted Client (22252)


http://www.dynamsoft.com/Products/SourceAnywhere-Hosting-Version-Control-Sourc
e-Control.aspx
Dynamsoft SourceAnywhere Standalone 2.2 Client
http://www.dynamsoft.com/Products/SourceAnywhere-SourceSafe-VSS.aspx
The following steps will integrate Altova DiffDog into Dynamsoft SourceAnywhere Hosted and
Dynamsoft SourceAnywhere Standalone:
1. Click the Advanced button of the Source Control tab.
2. Specify the DiffDog full path as External program application for diff/merge with
arguments %FIRST_FILE%” “%SECOND_FILE%.

Jalindi Igloo 1.0.3


http://www.jalindi.com/igloo/
The following steps will integrate Altova DiffDog into Jalindi Igloo:
1. Start the Show differences command in XMLSpy.

© 2010 Altova GmbH User Manual


484 Source Control SCSs and Altova DiffDog Differencing

2. Open the Show Differences or Merge Files panel.


3. Set the External Diff Command by entering the DiffDog full file path as the External Diff
EXE path.

Warning: When using the default diff editor CvsConflictEditor, you might have problems
comparing files with excessively long lines. We recommended that you "pretty print" all files
(particularly .ump files) before storing them in the repository. This limits the line length, thus
avoiding problems with the CVSConflictEditor.

March-Hare CVS Suite Client 2008 (3321)


http://www.march-hare.com/cvsnt/en.asp
The following steps will integrate Altova DiffDog into Marc-Hare CVS Suite 2008:
1. Go to the TortoiseCVS Preferences and choose the Tools tab.
2. Specify the DiffDog full path as Diff application, and the parameters %1 %2 as two-way
differencing parameters.

Mercurial
see under Sergey Antonovs HgScc 1.0.1

Microsoft SourceSafe 2005 with CTP


http://msdn.microsoft.com/en-us/vstudio/aa718670.aspx
The following steps will integrate Altova DiffDog into Microsoft SourceSafe 2005:
1. Click the Advanced button of the Source Control tab.
2. Click the Custom Editors tab and enter C:\Program Files\Altova\DiffDog2011
\DiffDogexe %1 %2 in the Command Line field.
3. In the Operation combo box, select File Difference.

Microsoft Team Foundation Server 2008 MSSCCI Provider


http://www.microsoft.com/downloads
Requirements: Visual Studio 2008 Team Explorer or Visual Studio 2008 with Team Explorer
2008. The following steps will integrate Altova DiffDog into Microsoft Visual Studio Team
System 2008 Team Foundation Server MSSCC1 Provider:
1. In the manager (Visual Studio 2008Team Explorer or Visual Studio 2008) options,
configure Altova DiffDog as new user tool
2. Choose Visual Studio Team Foundation Server source as the plug-in.
3. Configure a new user tool specifying: (i) the extensions of the files you wish to compare
with DiffDog; and (ii) the DiffDog full file path.

Perforce P4V 2008.1


http://www.perforce.com/
The following steps will integrate Altova DiffDog into Perforce 2008:
1. Click the Advanced button of the Source Control tab.
2. Choose the tab Diff in the Preferences panel.
3. Check as default differencing application the field “Other application” and enter the
DiffDog full file path.

Altova XMLSpy 2011 © 2010 Altova GmbH


Source Control SCSs and Altova DiffDog Differencing 485

PushOK CVS SCC NT 2.1.2.5,


PushOK SVN SCC 1.5.1.1
PushOK CVS SCC x64 version 2.2.0.4
PushOK SVN SCC x64 version 1.6.3.1
http://www.pushok.com/soft_cvs.php
The following steps will integrate Altova DiffDog into PushOK CVS NT and PushOK SVN SCC:
1. Click the Advanced button of the Source Control tab.
2. Choose the CVS Executables tab.
3. Select the value External merge/compare tool into the Diff/Merge field.
4. Insert the DiffDog full file path.
5. Edit the value %first %second into the "2 way diff cmd" field.

Warning: When using the default differencing editor CvsConflictEditor, you might have
problems comparing files with excessively long lines. We recommended that you "pretty print"
all files (particularly .ump files) before storing them in the repository. This limits the line length,
thus avoiding problems with the CVSConflictEditor.

QSC Team Coherence Client 7.2.1.35


http://www.teamcoherence.com
The following steps will integrate Altova DiffDog into Team Coherence Version Manager:
1. Go to Team Coherence client Options “Difference Viewer”.
2. Specify as the Default Difference Viewer application, the DiffDog full file path.
3. Specify as parameters: "$LF $RF".

Warning: It is possible that the new settings will only be applied after a Windows log off.

Qumasoft QVCS Enterprise 2.1.18


http://www.qumasoft.com/
The following steps will integrate Altova DiffDog into Qumasoft QVCS-Enterprise:
1. Add the Qumasoft QVCS-Enterprise installation directory to the Path environment
variable.
2. Use the QVCS Enterprise User Preferences.
3. In Utilities, enable the checkbox, Use External Visual Compare Tool.
4. Specify as Visual Compare Command Line:
<DiffDog full path> “file1Name file2Name”

Qumasoft QVCS Pro 3.10.18


http://www.qumasoft.com/
The following steps will integrate Altova DiffDog into Qumasoft QVCS-Pro:
1. Use the QVCS 3.10 client preferences.
2. In Utilities, specify the DiffDog full path as the visual compare utility with parameters
“%s %s “.

© 2010 Altova GmbH User Manual


486 Source Control SCSs and Altova DiffDog Differencing

Seapine Surround SCM Client 2009.0.0


http://www.seapine.com/surroundscm.html
The following steps will integrate Altova DiffDog into Seapine Surround SCM:
1. Go to the Surround SCM client user options (Diff/Merge) section.
2. Edit the Diff/Merge settings to compare with a selected application.
3. Enter the DiffDog full path with the parameters “%1” “%2”.
4. Restart the Surround SCM client and the Altova products.

Sergey Antonovs HgSCC 1.0.1


http://www.newsupaplex.pp.ru/hgscc_news_eng.html
The following steps will integrate Altova DiffDog into Mercurial:
1. Click the Advanced button of the Source Control tab.
2. Select differencing tool “custom”, and specify the DiffDog full path.

SourceGear Fortress 1.1.4 Client


http://www.sourcegear.com/fortress
SourceGear Vault 4.1.4 Client
http://www.sourcegear.com/vault
The following steps will integrate Altova DiffDog into SourceGear Fortress and SourceGear
Vault:
1. Click the Advanced button of the Source Control tab.
2. Set the Diff/Merge Vault options by specifying as the differencing program the DiffDog
full path and using the Arguments:
/ro1 /ro2 /title1:"%LEFT_LABEL%" /title2:"%RIGHT_LABEL%" "%LEFT_PATH%"
"%RIGHT_PATH%"

SourceGear SourceOffsite Client 4.2.0 (Windows)


http://www.sourcegear.com/sos/
The following steps will integrate DiffDog into SourceGear SourceOffsite:
1. Click the Advanced button of the Source Control tab.
2. Specify as “External Programs”, “Application for comparing files” the DiffDog full path.

TamTam CVS SCC 1.2.40,


TamTam SVN SCC 1.2.24
http://www.daveswebsite.com/software/tamtamGo
The following steps will integrate Altova DiffDog into TamTam CVS SCC and TamTam SVN
SCC:
1. Click the Advanced button of the Source Control tab.
2. Specify the DiffDog full file path as the external tool for Diff/Merge and Conflict.

Warning: The default differencing editor CvsConflictEditor, has problems comparing files with
excessively long lines. We recommended that you "pretty print" all files (particularly .ump files)
before storing them in the repository. This limits the line length, avoiding problems with the
CVSConflictEditor.

Altova XMLSpy 2011 © 2010 Altova GmbH


Source Control SCSs and Altova DiffDog Differencing 487

© 2010 Altova GmbH User Manual


488 XMLSpy in Visual Studio

18 XMLSpy in Visual Studio


XMLSpy can be integrated into the Microsoft Visual Studio IDE versions 2005, 2008, and 2010.
This unifies the best of both worlds, integrating advanced XML editing capabilities with the
advanced development environment of Visual Studio.

In this section, we describe:


 The broad installation process and the integration of the XMLSpy plugin in Visual
Studio.
 Differences between the Visual Studio version and the standalone version.
 XMLSpy's Debuggers in Visual Studio.
 Known issues.

Note: The screenshots in this section are of Visual Studio version 2005. If you are using
another version, there could be differences between the screenshots and your version.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy in Visual Studio Installing the XMLSpy Plugin 489

18.1 Installing the XMLSpy Plugin


To install the XMLSpy Plugin for Visual Studio, you need to do the following:
 Install Microsoft Visual Studio
 Install XMLSpy (Enterprise or Professional Edition)
 Download and run the XMLSpy integration package for Microsoft Visual Studio. This
package is available on the XMLSpy (Enterprise and Professional Editions) download
page at www.altova.com. (Please note: You must use the integration package
corresponding to your XMLSpy version (current version is 2011).)

Once the integration package has been installed, you will be able to use XMLSpy in the Visual
Studio environment.

© 2010 Altova GmbH User Manual


490 XMLSpy in Visual Studio Installing the XMLSpy Plugin

How to enable the plug-in


If the plug-in was not automatically enabled during the installation process, do the following:
1. Navigate to the directory where the Visual Studio IDE executable was installed, for
example in C:\Program Files\MS Visual Studio\Common7\IDE
2. Enter the following command on the command-line devenv.exe /setup.
3. Wait for the process to terminate normally before starting to use the application within
Visual Studio.

Note: The screenshots in this section are of Visual Studio version 2005. If you are using
another version, there could be differences between the screenshots and your version.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy in Visual Studio Differences with XMLSpy Standalone 491

18.2 Differences with XMLSpy Standalone


This section lists the ways in which the Visual Studio versions differ from the standalone
versions of XMLSpy. The listing starts with features that are unsupported in the Visual Studio
version, and continues with a listing of other ways in which the Visual Studio version differs from
the standalone version.

Unsupported features in Visual Studio


The following XMLSpy features are not available in Visual Studio:
 The Scripting environment (Tools | XMLSpy Options | Scripting) is currently not
supported.
 Separate browser window (an option in the Tools | Options | View tab) is not
supported. This means the the Text View and Browser View are always in the same
window.
 The text state icons of Authentic View are not supported.
 All Source Control functionality.
 All comparison functionality (available in the Tools menu of the standalone version).

Additional XMLSpy menus in Visual Studio


The following commands are specific to XMLSpy in Visual Studio:
 View | XMLSpy Tool Windows
 View | XMLSpy View
 XMLSpy (includes Global Resources menu items)
 Tools | XMLSPY Options

Entry helpers (Tool windows in Visual Studio)


The entry helpers of XMLSpy are available as Tool windows in Visual Studio. The following
points about them should be noted. (For a description of entry helpers and the XMLSpy GUI,
see the section, Introduction.)
 You can drag entry helper windows to any position in the development environment.
 Right-clicking an entry helper tab allows you to further customize your interface. Entry
helper configuration options are: dockable, hide, floating, and auto-hide.

Same functionality, different command


Some functionality of XMLSpy is available in Visual Studio under differently named commands.
These are:

XMLSpy Visual Studio Functionality


File | Open | Switch File | Open | Website Opens file from URL
to URL
Switch to URL | Save File | Save XMLSpy File to URL Saves file to URL

XMLSpy commands as Visual Studio commands


Some XMLSpy commands are present as Visual Studio commands in the Visual Studio GUI.
These are:
 Undo, Redo: These Visual Studio commands affect all actions in the Visual Studio

© 2010 Altova GmbH User Manual


492 XMLSpy in Visual Studio Differences with XMLSpy Standalone

development environment.
 Projects: XMLSpy projects are handled as Visual Studio projects.
 Customize Toolbars, Customize Commands: The Toolbars and Commands tabs (
screenshot below) in the Customize dialog (Tools | Customize) contain both visual
Studio commands as well as XMLSpy commands.

 Views: In the View menu, the two commands, XMLSpy Tool Windows and XMLSpy
View, contain options to toggle on entry helper windows and other sidebars, switch
between the editing views, and toggle certain editing guides on and off.
 XMLSpy Help: This XMLSpy menu appears as a submenu in Visual Studio's Help
menu.

Note: The screenshots in this section are of Visual Studio version 2005. If you are using
another version, there could be differences between the screenshots and your version.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy in Visual Studio XMLSpy's Debuggers in Visual Studio 493

18.3 XMLSpy's Debuggers in Visual Studio


XMLSpy contains an XSLT/XQuery Debugger (Enterprise and Professional editions) and a
SOAP Debugger (Enterprise edition). A debugger process involves the display of more than one
file (for example, XML, XSLT, and XSLT output files), all of which are displayed in Visual Stuio
as a single tabbed group. To make the debugging easier to follow, you can create one or more
additional tab groups in Visual Studio. Do this as follows:
1. Click the tab you wish to separate from the single tabbed group, then drag and drop it
somewhere in the currently active tab. This opens a pop-up menu which allows you to
define the type of tab you want to create.

2. Select New Vertical Tab Group. This creates a new tab containing just the selected
tab (screenshot below).

Note: The screenshots in this section are of Visual Studio version 2005. If you are using
another version, there could be differences between the screenshots and your version.

© 2010 Altova GmbH User Manual


494 XMLSpy in Visual Studio Known Issues

18.4 Known Issues


This section describes known issues relating to the different editions of MS Visual Studio and
XMLSpy.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy in Eclipse 495

19 XMLSpy in Eclipse
Eclipse 3.x is an open source framework that integrates different types of applications delivered
in the form of plugins.

The XMLSpy Plugin for Eclipse enables you to access the functionality of XMLSpy from within
the Eclipse 3.4 / 3.5 / 3.6 Platform. It is available on Windows platforms. In this section, we
describe how to install the XMLSpy Plugin for Eclipse and how to set up the XMLSpy
perspective and XMLSpy Debugger perspectives. After you have done this, components of the
XMLSpy GUI and XMLSpy menu commands will be available within the Eclipse GUI.

Note:
 Source Control functionality, which is available in the standalone version, is not
supported in the Eclipse version.

© 2010 Altova GmbH User Manual


496 XMLSpy in Eclipse Installing the XMLSpy Plugin for Eclipse

19.1 Installing the XMLSpy Plugin for Eclipse


Before installing the XMLSpy Plugin for Eclipse, ensure that the following are already installed:
 XMLSpy Enterprise or Professional Edition.
 Java Runtime Environment (JRE) version 1.5 or higher, which is required for Eclipse.
JRE5 is recommended. See the Eclipse website for more information.
 Eclipse Platform 3.4, 3.5, or 3.6.

After these have been installed, you can install the XMLSpy Plugin for Eclipse, which is
contained in the XMLSpy Integration Package (see below). (Please note: You must use the
integration package corresponding to your XMLSpy version (current version is 2011).)

Note on JRE
If, on opening a document in Eclipse, you receive the following error message:
java.lang.UnsupportedClassVersionError: com/altova/....
(Unsupported major.minor version 49.0)

it indicates that Eclipse is using an older JRE. Since Eclipse uses the PATH environment
variable to find a javaw.exe, the problem can be solved by fixing the PATH environment variable
so that a newer version is found first. Alternatively, start Eclipse with the command line
parameter -vm, supplying the path to a javaw.exe of version 1.5 or higher.

XMLSpy Integration Package


The XMLSpy Plugin for Eclipse is contained in the XMLSpy Integration Package and is installed
during the installation of the XMLSpy Integration Package. Install as follows:
1. Ensure that XMLSpy, JRE, and Eclipse are already installed (see above).
2. From the Components Download page of the Altova website, download and install the
XMLSpy Integration Package. There are two important steps during the installation;
these are described in Steps 3 and 4 below.
3. During installation of the XMLSpy Integration Package, a dialog will appear asking
whether you wish to install the XMLSpy Plugin for Eclipse (see screenshot below).
Check the option and then click Next.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy in Eclipse Installing the XMLSpy Plugin for Eclipse 497

4. In the next dialog ((Eclipse) Installation Location, screenshot below), you can choose
whether the Install Wizard should integrate the XMLSpy Plugin into Eclipse during the
installation (the "Automatic" option) or whether you will integrate the XMLSpy Plugin into
Eclipse (via the Eclipse GUI) at a later time.

© 2010 Altova GmbH User Manual


498 XMLSpy in Eclipse Installing the XMLSpy Plugin for Eclipse

We recommend that you let the Installation Wizard do the integration. Do this by
checking the Automatic option and then browsing for the folder in which the Eclipse
executable (eclipse.exe) is located. Click Next when done. If you choose to manually
integrate XMLSpy Plugin for Eclipse in Eclipse, select the Manually option (screenshot
below). See the section below for instructions about how to manually integrate from
within Eclipse.

5. Complete the installation. If you set up automatic integration, the XMLSpy Plugin for
Eclipse will be integrated in Eclipse and will be available when you start Eclipse the next
time. Otherwise, you will have to manually integrate the plug-in (see below).

Manually integrating the XMLSpy plug-in in Eclipse


To manually integrate the XMLSpy Plugin for Eclipse, do the following:
1. In Eclipse, click the menu command Help | Install New Software.
2. In the Software Updates and Add-Ons dialog that pops up, click the Available Updates
tab (screenshot below).
3. Click the Add Site button.
4. In the Add Site dialog that pops up, click the Local button.
5. Browse for the folder c:\Program Files\Altova\Common2011\eclipse, select it, and
click OK.
6. Repeat Steps 3 to 5, this time selecting the folder c:\Program Files\Altova\XMLSpy
2011\eclipse.
7. The two added folders are displayed in the Available Software tab (screenshot below).
Check the top-level check box of each folder to select the plug-ins, and click the Install
button.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy in Eclipse Installing the XMLSpy Plugin for Eclipse 499

8. An Installation review dialog box allowing you to confirm that the checked items will be
installed opens.
9. Click Next to continue.The Review License dialog opens.
10. Read the license terms and, if you accept them, click I accept the terms.... Then click
Finish to complete the installation.

If there are problems with the plug-in (missing icons, for example), start Eclipse with the -clean
flag.

Currently installed version


To check the currently installed version of the XMLSpy Plugin for Eclipse, select the Eclipse
menu option Help | About Eclipse Platform. Then select the XMLSpy icon.

© 2010 Altova GmbH User Manual


500 XMLSpy in Eclipse XMLSpy Entry Points in Eclipse

19.2 XMLSpy Entry Points in Eclipse


The following entry points in Eclipse can be used to access XMLSpy functionality:
 XMLSpy Perspective, which provides XMLSpy's GUI features within the Eclipse GUI.
 XMLSpy toolbar buttons, which provides access to XMLSpy Help and the Create New
Document functionality.

XMLSpy Perspective
In Eclipse, a perspective is a configured GUI view with attendant functionality. When the
XMLSpy Plugin for Eclipse is integrated in Eclipse, a default XMLSpy perspective is
automatically created. This perspective is a GUI that includes XMLSpy's GUI elements: its
editing views, menus, entry helpers, and other sidebars.

When a file having a filetype associated with XMLSpy is opened (.xml, for example), this file
can be edited in the XMLSpy perspective. Similarly, a file of another filetype can be opened in
another perspective in Eclipse. Additionally, for any active file, you can switch the perspective,
thus allowing you to edit or process that file in another environment. There are therefore two
main advantage of perspectives:
1. Being able to quickly change the working environment of the active file, and
2. Being able to switch between files without having to open a new development
environment (the associated environment is available in a perspective)

Working with the XMLSpy perspective involves the following:


 Switching to the XMLSpy perspective.
 Setting preferences for the XMLSpy perspective.
 Customizing the XMLSpy perspective.

Switching to the XMLSpy perspective


In Eclipse, select the command Window | Open Perspective | Other. In the dialog that pops
up (screenshot below), select XMLSpy, and click OK.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy in Eclipse XMLSpy Entry Points in Eclipse 501

The empty window or the active document will now have the XMLSpy perspective. This is how
the user switches the perspective via the menu. To access a perspective faster from another
perspective, the required perspective can be listed in the Open Perspective submenu, above
the Other item; this setting is in the customization dialog.

Perspectives can also be switched when a file is opened or made active. The perspective of the
application associated with a file's filetype will be automatically opened when that file is opened
for the first time. Before the perspective is switched, a dialog appears asking whether you wish
to have the default perspective automatically associated with this filetype. Check the Do Not Ask
Again option if you wish to associate the perspective with the filetype without having to be
prompted each time a file of this filetype is opened, and then click OK.

Setting preferences for the XMLSpy perspective


The preferences of a perspective include: (i) a setting to automatically change the perspective
when a file of an associated filetype is opened (see above), and (ii) options for including or
excluding individual XMLSpy toolbars. To access the Preferences dialog, select the command
Window | Preferences. In the list of perspectives in the left pane, select XMLSpy, then select
the required preferences. Finish by clicking OK.

Customizing the XMLSpy perspective


The customization options enable you to determine what shortcuts and commands are included
in the perspective. To access the Customize Perspective dialog of a perspective (screenshot
below shows dialog for the XMLSpy perspective), make the perspective active (in this case the
XMLSpy perspective), and select the command Window | Customize Perspective.

© 2010 Altova GmbH User Manual


502 XMLSpy in Eclipse XMLSpy Entry Points in Eclipse

In the Shortcuts tab of the Customize Perspective dialog, you can set shortcuts for submenus.
Select the required submenu in the Submenus combo box. Then select a shortcut category,
and check the shortcuts you wish to include for the perspective.

In the Commands tab, you can add command groups. To display the commands in a command
group, select the required command group from among the available command groups
(displayed in the Command Groups pane). The commands in this group are displayed in a tree
in the right-hand side pane, ordered hierarchically in the menu in which it will appear. If you wish
to include the command group, check its check box.

Click OK to complete the customization and for the changes to take effect.

XMLSpy toolbar buttons


Two XMLSpy-related buttons are created automatically in the toolbar (screenshot below).

These are for: (i) opening the XMLSpy Help, and (ii) creating new XMLSpy documents .

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy in Eclipse XMLSpy's Debugger Perspectives 503

19.3 XMLSpy's Debugger Perspectives


There are two debuggers in the Enterprise edition of XMLSpy (XSLT/XQuery and SOAP), and
one debugger in the Professional edition of XMLSpy (XSLT/XQuery). Perspectives for these
debuggers are available in Eclipse according to the XMLSpy edition that is currently installed.

To switch to a debugger perspective, select the command Window | Open Perspective |


Other. In the dialog that pops up (screenshot below), select the debugger (for example, Debug
XSLT/XQ), and click OK.

The empty window or the active document will now have the perspective of the selected
debugger. This is how the user switches the perspective via the menu. To access a perspective
faster from another perspective, the required perspective can be listed in the Open
Perspective submenu, above the Other item; this setting is in the customization dialog.

For a description of how to use the debuggers, see the respective sections in this
documentation: XSLT and XQuery, and WSDL and SOAP.

© 2010 Altova GmbH User Manual


504 Code Generator

20 Code Generator
XMLSpy includes a built-in code generator which can automatically generate Java, C++ or C#
class files from XML Schema definitions

XML is not a full programming language in that it cannot be compiled or executed as a


stand-alone binary executable file; rather XML documents must be bound to an external
software application or runtime environment such as a business-to-business application or Web
service.

The implementation of any custom XML software application ultimately requires writing
programmatic access methods within your code to create, validate, process, transform, modify
or perform any in-memory operation on an XML document.

Program coding is most commonly done through the use of high-level XML processing
Application Program Interfaces (API) such as Microsoft MSXML and Apache Xerces Version
2.6.0 and higher, which are freely available for various programming languages.

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Introduction to code generator 505

20.1 Introduction to code generator


In the case of XML Schemas the XMLSpy code generator's default templates automatically
generate class definitions corresponding to all declared elements or complex types which
redefine any complex type in your XML Schema, preserving the class derivation as defined by
extensions of complex types in your XML Schema.

In the case of complex schemas which import schema components from multiple namespaces,
XMLSpy preserves this information by generating the appropriate C#, or C++ namespaces or
Java packages.

Additional code is implemented, such as functions which read XML files into a Document Object
Model (DOM) in-memory representation, write XML files from a DOM representation back to a
system file, or to convert strings to XML DOM trees and vice versa.

The output program code is expressed in C++, Java or C# programming languages.

Target Language C++ C# Java


Development Microsoft Visual C++ 2010 Microsoft Visual Studio Apache Ant
environments Microsoft Visual C++ 2008 2010 (build.xml file)
Microsoft Visual C++ 2005 Microsoft Visual Studio Eclipse 3.4+
Microsoft Visual C++ 6.0 2008 Borland JBuilder
Microsoft Visual Studio
2005

XML DOM MSXML 6.0 or System.Xml JAXP


implementations Apache Xerces 2.6 or later
Database API ADO ADO.NET JDBC
(MapForce only)

C++
The C++ generated output uses either MSXML 6.0, or Apache Xerces 2.6 or later. Both
MapForce and XMLSpy generate complete project and solution/workspace files for Visual C++
6.0 or Visual Studio 2005 to 2010 directly. .sln and .vcproj files are generated in addition to the
.dsw /.dsp files for Visual Studio 6.0. The generated code optionally supports MFC, e.g. by
generated CString conversion methods.

Please note:
When building C++ code for Visual Studio 2005/2008/2010 and using a Xerces library
precompiled for Visual C++ 6.0, a compiler setting has to be changed in all projects of
the solution:

1. Select all projects in the Solution Explorer.


2. [Project] | [Properties] | [Configuration Properties] | [C/C++] | [Language]
3. Select All Configurations
4. Change Treat wchar_t as Built-in Type to No (/Zc:wchar_t-)

C#
The generated C# code uses the .NET XML classes (System.Xml) and can be used from any
.NET capable programming language, e.g. VB.NET, Managed C++, J# or any of the several
languages that target the .NET platform. Project files can be generated for Visual Studio 2005,
2008 and 2010.

Java
The generated Java output is written against the industry-standard Java API for XML Parsing

© 2010 Altova GmbH User Manual


506 Code Generator Introduction to code generator

(JAXP) and includes a JBuilder project file, an Ant build file and project files for Eclipse. Java 5
(JDK 1.5) or higher is supported.

Generated output in XMLSpy:


Generated output Location XMLSpy
Standard libraries Altova folder 
Schema wrapper libraries Schema name folder 
Application
Test Application skeleton - The test application must be 
source code with samples edited for it to function. Not
functional at this point.
Code generator templates
Output code is completely customizable via a simple yet powerful template language which
gives full control in mapping XML Schema built-in data-types to the primitive datatypes of a
particular programming language.
It allows you to easily replace the underlying parsing and validating engine, customize code
according to your company's writing conventions, or use different base libraries such as the
Microsoft Foundation Classes (MFC) and the Standard Template Library (STL).

Additionally you can build your own templates to automate the generation of anything
imaginable, for example: EJB's, WSDL files, SQL scripts, ASP or WML code.

XMLSpy's schema editor is well suited as a software modeling and prototyping tool, allowing
XML applications to be rapidly prototyped at a high level in XML Schema and then automatically
generated. Changes to an application's XML Schema content model can be immediately
reconciled with a software implementation simply by re-running the code generator.

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator What's new ... 507

20.2 What's new ...


Version 2011
Contains bug fixes and enhancements.

Version 2010 R3
 Support for Microsoft Visual Studio 2010
 Support for MSXML 6.0 in generated C++ code
 Support for 64-bit targets for C++ and C# projects

Version 2010 R2
 Code generation for C++ for the Linux platform

Version 2010

 Enumeration facets from XML schemas are now available as symbolic constants in the
generated classes (using 2007r3 templates).

Version 2009 sp1

 Apache Xerces version 3.x support added. (older versions starting from Xerces 2.6.x
are still supported.)

Version 2009


 No new updates.

Version 2008 R2

 Support for generation of Visual Studio 2008 project files for C# and C++ has been
added.

Version 2008
The new 2007 R3-style SPL templates have been further enhanced:

 It is now possible to remove single elements


 Access to schema metadata (e.g. element names, facets, enumerations, occurrence,
etc.) is provided
 Complex types derived by extension are now generated as derived classes

Version 2007 R3
Code Generator has been redesigned for version 2007 release 3 to simplify usage of the
generated code, reduce code volume and increase performance.

 Handling of XML documents and nodes with explicit ownership, to avoid memory leaks
and to enable multi-threading
 New syntax to avoid name collisions
 New data types for simpler usage and higher performance (native types where
possible, new null handling, ...)
 Attributes are no longer generated as collections

© 2010 Altova GmbH User Manual


508 Code Generator What's new ...

 Simple element content is now also treated like a special attribute, for consistency
 New internal object model (important for customized SPL templates)
 Compatibility mode to generate code in the style of older releases

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Generating source code from a schema 509

20.3 Generating source code from a schema


The following sequence shows how to generate the source code produced by the AddressLast
schema file as the input.

1. Open the schema you want to generate source code for (e.g., AddressLast).

2. Select the menu item DTD/Schema | Generate Program Code....


3. Select the type of code you want to generate, Java, C++ or C#, (e.g., java.spl, cpp.spl
or cs.spl). The C++ Settings tab allows you to further specify the code generation
settings for C++, including for the Linux platform.

4. Click OK. The Browse for folder dialog appears.


5. Select the target folder and click OK.
6. You are prompted to open the newly created project in Microsoft Visual Studio. Click
Yes.
If Java code is produced, you are prompted to open the corresponding output directory.
7. The generated workspace contains 4 projects: Altova, AltovaXML, AddressLast, and
AddressLastTest. The latter is a skeleton application to test your new generated library.

© 2010 Altova GmbH User Manual


510 Code Generator Generating source code from a schema

Open the AddressLastTest.cpp file and write your test code into the Example() function.

Linux/GCC support
The "Makefile for Linux/GCC" option adds Makefiles to the generated code with the C++ source
files being generated so that they are portable using #ifdef constructs to support different
compilers and operating systems.

Note that only Xerces 3.x on Linux, with the current template version (2007r3 compatible) is
supported. Enabling the "MFC support" check box will have no effect on compilation with
Linux/GCC.

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Using the generated code library 511

20.4 Using the generated code library


Overview
The library generated by XMLSpy is a DOM (W3C Document Object Model) wrapper that allows
you to read, modify and create XML documents easily and safely. All data is held inside the
DOM, and there are methods for extracting data from the DOM, and to update and create data
into the DOM.

Compatibility Mode
Depending on the value of the setting "Generate code compatible to", the generated classes
have different names, members and methods. The following description applies to version
2007r3 and later only. For the other settings please refer to the chapter about using generated
code compatible to old versions. There were no compatibility-breaking changes since version
2007r3.

Generated Libraries
When XMLSpy generates code from an XML Schema or DTD, the following libraries are
generated:

Name Purpose
Altova Base library containing common runtime support, identical for every schema
AltovaXML Base library containing runtime support for XML, identical for every schema
YourSchema Library containing declarations generated from the input schema, named as the
schema file or DTD
YourSchema Test application skeleton (XMLSpy only)
Test

The test application skeleton is a compilable application that calls an empty Example() method.
You can add your test code into this method for easy and quick testing of your new generated
library.

Name generation and namespaces


Generally, the code generator tries to preserve the names for generated namespaces, classes
and members from the original XML Schema. Characters that are not valid in identifiers in the
target language are replaced by a "_". Names that would collide with other names or reserved
words are made unique by appending a number. Name generation can be influenced by
changing default settings in the SPL template.

The namespaces from the XML Schema are converted to packages in Java or namespaces in
C# or C++ code, using the namespace prefix from the schema as code namespace. The
complete library is enclosed in a package or namespace derived from the schema file name, so
you can use multiple generated libraries in one program without name conflicts.

Data Types
XML Schema has a much more elaborate data type model than Java, C# or C++. Code
Generator converts the 44 XML Schema types to a couple of language-specific primitive types,
or to classes delivered with the Altova library. The mapping of simple types can be configured in
the SPL template.

Complex types and derived types defined in the schema are converted to classes in the
generated library.

© 2010 Altova GmbH User Manual


512 Code Generator Using the generated code library

Enumeration facets from simple types are converted to symbolic constants.

Generated Classes
XMLSpy generally generates one class per type found in the XML Schema, or per element in
the DTD. One additional class per library is generated to represent the document itself, which
can be used for loading and saving the document.

Memory Management
A DOM tree is comprised of nodes, which are always owned by a specific DOM document -
even if the node is not currently part of the document's content. All generated classes are
references to the DOM nodes they represent, not values. This means that assigning an
instance of a generated class does not copy the value, it only creates an additional reference to
the same data.

20.4.1 Example schema


Using the generated classes
The previous sections explained how to open a schema, choose a template and generate the
files you need. You then open the generated project or the corresponding directory and get
down to work.

To keep things simple, we will work with a very small xsd file, the source code is shown below.
Save this as Library.xsd if you want to get the same results as our example:

<?xml version="1.0" encoding="UTF-8"?>


<xs:schema xmlns="http://www.nanonull.com/LibrarySample" xmlns:xs="
http://www.w3.org/2001/XMLSchema" targetNamespace="
http://www.nanonull.com/LibrarySample" elementFormDefault="qualified" attributeFormDefault
="unqualified">
<xs:element name="Library">
<xs:complexType>
<xs:sequence>
<xs:element name="Book" type="BookType" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:complexType name="BookType">
<xs:sequence>
<xs:element name="Title" type="xs:string"/>
<xs:element name="Author" type="xs:string" maxOccurs="unbounded
"/>
</xs:sequence>
<xs:attribute name="ISBN" type="xs:string" use="required"/>
<xs:attribute name="Variant" type="BookVariant"/>
</xs:complexType>
<xs:simpleType name="BookVariant">
<xs:restriction base="xs:string">
<xs:enumeration value="Hardcover"/>
<xs:enumeration value="Paperback"/>
<xs:enumeration value="Audiobook"/>
<xs:enumeration value="E-book"/>
</xs:restriction>

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Using the generated code library 513

</xs:simpleType>
</xs:schema>

We will only use this schema file in this example, it will therefore be easy to figure out the
differences between the different programming languages in the following code examples.

Please note that the generated classes will be named differently from xsd to xsd file. When
working with your own schemas or other samples, make sure you adapt the names of the
functions and variables.

20.4.2 Using the generated Java library


Please note: This topic describes code generation when using the option Generate code
compatible to V2007r3 in the code generation dialog.

Generated Packages
Name Purpose
com.altova Base package containing common runtime support, identical for every schema
com.altova.xm Base package containing runtime support for XML, identical for every schema
l
com.YourSche Package containing declarations generated from the input schema, named as
ma the schema file or DTD
com.YourSche Test application skeleton (XMLSpy only)
maTest

DOM Implementation
The generated Java code uses JAXP (Java API for XML Processing) as the underlying DOM
interface. Please note that the default DOM implementation delivered with Java 1.4 does not
automatically create namespace attributes when serializing XML documents. If you encounter
problems, please update to Java 5 or later.

Data Types
The default mapping of XML Schema types to Java data types is:

XML Schema Java Remarks


xs:string String
xs:boolean boolean
xs:decimal java.math.BigDeci
mal
xs:float, xs:double double
xs:integer java.math.BigInte
ger
xs:long long
xs:unsignedLong java.math.BigInte Java does not have unsigned types.
ger
xs:int int
xs:unsignedInt long Java does not have unsigned types.
xs:dateTime, date, time, com.altova.types.
gYearMonth, gYear, DateTime
gMonthDay, gDay, gMonth
xs:duration com.altova.types.
Duration

© 2010 Altova GmbH User Manual


514 Code Generator Using the generated code library

xs:hexBinary and byte[] Encoding and decoding of binary data is done


xs:base64Binary automatically.
xs:anySimpleType string

All XML Schema types not contained in this list are derived types, and mapped to the same
Java type as their respective base type.

Generated Document Class


In addition to the classes for the types declared in the XML Schema, the document class is
generated. It contains all possible root elements as members, and in addition the following
methods ("Doc" stands for the name of the generated document class itself):

Method Purpose
static Doc loadFromFile(String fileName) Loads an XML document from a file
static Doc loadFromString(String xml) Loads an XML document from a string
static Doc loadFromBinary(byte[] xml) Loads an XML document from a byte array
void saveToFile(String fileName, boolean Saves an XML document to a file with the
prettyPrint, String encoding = "UTF-8") specified encoding. If no encoding is specified,
UTF-8 is assumed.
void SaveToFile(String fileName, boolean Saves an XML document to a file with the
prettyPrint, String encoding, boolean specified encoding. Byte order and Unicode
bigEndian, boolean writeBOM) byte-order mark can be specified for Unicode
encodings.
String saveToString(boolean prettyPrint) Saves an XML document to a string
byte[] saveToBinary(boolean prettyPrint, Saves an XML document to a byte array with
String encoding = "UTF-8") the specified encoding. If no encoding is
specified, UTF-8 is assumed.
byte[] saveToBinary(boolean prettyPrint, Saves an XML document to a byte array with
String encoding, boolean bigEndian, boolean the specified encoding. Byte order and Unicode
writeBOM) byte-order mark can be specified for Unicode
encodings.
static Doc createDocument() Creates a new, empty XML document.
void setSchemaLocation(String Adds an xsi:schemaLocation or
schemaLocation) xsi:noNamespaceSchemaLocation attribute to
the root element. A root element must already
exist.

Generated Type Class


For each type in the schema, a class is generated that contains a member for each attribute
and element of the type. The members are named the same as the attributes or elements in the
original schema (in case of possible collisions, a number is appended). For simple and mixed
types, getValue() and setValue(string) methods are generated. For simple types with
enumeration facets, getEnumerationValue() and setEnumerationValue(int) can be used
together with generated constants for each enumeration value. In addition, the method
getStaticInfo() allows accessing schema information as com.altova.xml.meta.SimpleType or
com.altova.xml.meta.ComplexType (see below).

XML Schema derivation of complexTypes by extension results in derived classes in the


generated library.

Generated Member Attribute Class


For each member attribute of a type, a class with the following methods is created.

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Using the generated code library 515

Method Purpose
boolean exists() Returns true if the attribute exists
void remove() Removes the attribute from its parent element
AttributeType getValue() Gets the attribute value
void setValue(AttributeType value) Sets the attribute value
int getEnumerationValue() Generated for enumeration types only. Returns
one of the constants generated for the possible
values, or Invalid if the value does not match
any of the enumerated values in the schema.
void setEnumerationValue(int) Generated for enumeration types only. Pass
one of the constants generated for the possible
values to this method to set the value.
com.altova.xml.meta.Attribute getInfo() Returns an object for querying schema
information (see below)

Generated Member Element Class


For each member element of a type, a class with the following methods created.

Method Purpose
MemberType first() Returns the first instance of the member
element
MemberType at(int index) Returns the member element specified by the
index
MemberType last() Returns the last instance of the member
element
MemberType append() Creates a new element and appends it to its
parent
boolean exists() Returns true if at least one element exists
int count() Returns the count of elements
void remove() Deletes all occurrences of the element from its
parent
void removeAt(int index) Deletes the occurrence of the element
specified by the index
java.util.Iterator iterator() Returns an object for iterating instances of the
member element.
MemberType getValue() Gets the element content (only generated if
element can have simple or mixed content)
void setValue(MemberType value) Sets the element content (only generated if
element can have simple or mixed content)
int getEnumerationValue() Generated for enumeration types only. Returns
one of the constants generated for the possible
values, or Invalid if the value does not match
any of the enumerated values in the schema.
void setEnumerationValue(int) Generated for enumeration types only. Pass
one of the constants generated for the possible
values to this method to set the value.
com.altova.xml.meta.Element getInfo() Returns an object for querying schema
information (see below)

Creating XML Documents


The generated code library makes it very easy to create XML files. Let's start with an example
XML file for the example schema:

© 2010 Altova GmbH User Manual


516 Code Generator Using the generated code library

<?xml version="1.0" encoding="UTF-8"?>


<Library xsi:schemaLocation="http://www.nanonull.com/LibrarySample Library.xsd" xmlns="
http://www.nanonull.com/LibrarySample" xmlns:xsi="
http://www.w3.org/2001/XMLSchema-instance">
<Book ISBN="0764549642" Variant="Paperback">
<Title>The XML Spy Handbook</Title>
<Author>Altova</Author>
</Book>
</Library>

The following Java code was used to create this file. The classes Library2, LibraryType and
BookType are generated out of the schema and represent the complete document, the type of
the <Library> element, and the complex type BookType, which is the type of the <Book>
element. Note that the automatic name de-collision renamed the Library class to Library2 to
avoid a possible conflict with the library namespace name.
protected static void example() throws Exception {
// create a new, empty XML document
Library2 libDoc = Library2.createDocument();

// create the root element <Library> and add it to the document


LibraryType lib = libDoc.Library3.append();

// create a new <Book> and add it to the library


BookType book = lib.Book.append();

// set the ISBN attribute of the book


book.ISBN.setValue("0764549642");

// set the Variant attribute of the book using an enumeration


constant
book.Variant.setEnumerationValue( BookVariant.EPAPERBACK );

// add the <Title> and <Author> elements, and set values


book.Title.append().setValue("The XML Spy Handbook");
book.Author.append().setValue("Altova");

// set the schema location (this is optional)


libDoc.setSchemaLocation("Library.xsd");

// save the XML document to a file with default encoding (UTF-8)


. "true" causes the file to be pretty-printed.
libDoc.saveToFile("Library1.xml", true);
}

Note that all elements are created by calling append(), and that attributes (like ISBN in the
example) can simply be accessed like structure members.

Reading XML Documents


The following example reads the file we just created and demonstrates the various methods for
reading XML files:

protected static void example() throws Exception {


// load XML document
Library2 libDoc = Library2.loadFromFile("Library1.xml");

// get the first (and only) root element <Library>


LibraryType lib = libDoc.Library3.first();

// it is possible to check whether an element exists:


if (!lib.Book.exists())
{

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Using the generated code library 517

System.out.println("This library is empty.");


return;
}

// iteration: for each <Book>...


for (java.util.Iterator itBook = lib.Book.iterator();
itBook.hasNext(); )
{
BookType book = (BookType) itBook.next();

// output values of ISBN attribute and (first and only)


title element
System.out.println("ISBN: " + book.ISBN.getValue());
System.out.println("Title: " + book.Title.first().get
Value());

// read and compare an enumeration value


if (book.Variant.getEnumerationValue() ==
BookVariant.EPAPERBACK)
System.out.println("This is a paperback book.");

// for each <Author>...


for (java.util.Iterator itAuthor = book.Author.iterator();
itAuthor.hasNext(); )
System.out.println("Author: " +
((com.Library.xs.stringType)itAuthor.next()).getValue());

// alternative: use count and index


for (int j = 0; j < book.Author.count(); ++j)
System.out.println("Author: " + book.Author.at(j)
.getValue());
}
}

Note the type of the book.Author member: xs.stringType is a generated class for any element
with simple string content. Similar classes are generated for all other XML Schema types.

Of course you can also load a document, modify it by adding or deleting elements and
attributes, and then save the changed file back to disk.

Error Handling
Errors are reported by exceptions. The following exception classes are defined in the
namespace com.altova:

Class Base Class Description


SourceInstanceUnvaila Exception A problem occurred while loading an XML instance.
bleException
TargetInstanceUnavail Exception A problem occurred while saving an XML instance.
ableException

In addition, the following Java exceptions are commonly used:

Class Description
java.lang.Error Internal program logic error (independent of input
data)
java.lang.Exception Base class for runtime errors
java.lang.IllegalArgumentsException A method was called with invalid argument values, or
a type conversion failed.
java.lang.ArithmeticException Exception thrown when a numeric type conversion
fails.

© 2010 Altova GmbH User Manual


518 Code Generator Using the generated code library

Accessing Metadata
The generated library allows accessing static schema information via the following classes. The
methods that return one of the metadata classes return null if the respective property does not
exist.

com.altova.xml.meta.SimpleType
Method Purpose
SimpleType getBaseType() Returns the base type of this type
String getLocalName() Returns the local name of the type
String getNamespaceURI() Returns the namespace URI of the type
int getMinLength() Returns the value of this facet
int getMaxLength() Returns the value of this facet
int getLength() Returns the value of this facet
int getTotalDigits() Returns the value of this facet
int getFractionDigits() Returns the value of this facet
String getMinInclusive() Returns the value of this facet
String getMinExclusive() Returns the value of this facet
String getMaxInclusive() Returns the value of this facet
String getMaxExclusive() Returns the value of this facet
String[] getEnumerations() Returns a list of all enumeration facets
String[] getPatterns() Returns a list of all pattern facets
int getWhitespace() Returns the value of the whitespace facet,
which is one of:
com.altova.typeinfo.WhitespaceType.Whitespa
ce_Unknown
com.altova.typeinfo.WhitespaceType.Whitespa
ce_Preserve
com.altova.typeinfo.WhitespaceType.Whitespa
ce_Replace
com.altova.typeinfo.WhitespaceType.Whitespa
ce_Collapse

com.altova.xml.meta.ComplexType
Method Purpose
Attribute[] GetAttributes() Returns a list of all attributes
Element[] GetElements() Returns a list of all elements
ComplexType getBaseType() Returns the base type of this type
String getLocalName() Returns the local name of the type
String getNamespaceURI() Returns the namespace URI of the type
SimpleType getContentType() Returns the simple type of the content
Element findElement(String localName, String Finds the element with the specified local name
namespaceURI) and namespace URI
Attribute findAttribute(String localName, Finds the attribute with the specified local name
String namespaceURI) and namespace URI

com.altova.xml.meta.Element
Method Purpose
ComplexType getDataType() Returns the type of the element. Note that this
is always a complex type even if declared as
simple in the original schema. Use
getContentType() of the returned object to get
the simple content type.

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Using the generated code library 519

int getMinOccurs() Returns the minOccurs value defined in the


schema
int getMaxOccurs() Returns the maxOccurs value defined in the
schema
String getLocalName() Returns the local name of the element
String getNamespaceURI() Returns the namespace URI of the element

com.altova.xml.meta.Attribute
Method Purpose
SimpleType getDataType() Returns the type of the attribute content
boolean isRequired() Returns true if the attribute is required
String getLocalName() Returns the local name of the attribute
String getNamespaceURI() Returns the namespace URI of the attribute

20.4.3 Using the generated C++ library


Please note: This topic describes code generation when using the option Generate code
compatible to V2007r3 in the code generation dialog.

Generated Libraries
Name Purpose
Altova Base library containing common runtime support, identical for every schema
AltovaXML Base library containing runtime support for XML (MSXML or Xerces), identical
for every schema
YourSchema Library containing declarations generated from the input schema, named as the
schema file or DTD
YourSchema Test application skeleton (XMLSpy only)
Test

DOM Implementations
The generated C++ code supports either Microsoft MSXML or Apache Xerces 2.6 or higher,
depending on code generation settings. The syntax for using the generated code is identical for
both DOM implementations.

Character Types
The generated C++ code can be compiled with or without Unicode support. Depending on this
setting, the types string_type and tstring will both be defined to std::string or std::wstring,
consisting of narrow or wide characters. To use Unicode characters in your XML file that are not
representable with the current 8-bit character set, Unicode support must be enabled. Please
take care with the _T() macros. This macro ensures that string constants are stored correctly,
whether you're compiling for Unicode or non-Unicode programs.

Data Types
The default mapping of XML Schema types to C++ data types is:

XML Schema C++ Remarks


xs:string string_type string_type is defined as std::string or std:wstring
xs:boolean bool
xs:decimal double C++ does not have a decimal type, so double is
used.
xs:float, xs:double double

© 2010 Altova GmbH User Manual


520 Code Generator Using the generated code library

xs:integer __int64 xs:integer has unlimited range, mapped to


__int64 for efficiency reasons.
xs:nonNegativeInteger unsigned __int64 see above
xs:int int
xs:unsignedInt unsigned int
xs:dateTime, date, time, altova::DateTime
gYearMonth, gYear,
gMonthDay, gDay, gMonth
xs:duration altova::Duration
xs:hexBinary and std::vector<unsign Encoding and decoding of binary data is done
xs:base64Binary ed char> automatically.
xs:anySimpleType string_type

All XML Schema types not contained in this list are derived types, and mapped to the same C++
type as their respective base type.

Generated Document Class


In addition to the classes for the types declared in the XML Schema, the document class is
generated. It contains all possible root elements as members, and in addition the following
methods ("CDoc" stands for the name of the generated document class itself):

Method Purpose
static CDoc LoadFromFile(const string_type& Loads an XML document from a file
fileName)
static CDoc LoadFromString(const Loads an XML document from a string
string_type& xml)
static CDoc LoadFromBinary(const Loads an XML document from a byte array
std:vector<unsigned char>& xml)
void SaveToFile(const string_type& fileName, Saves an XML document to a file with the
bool prettyPrint, const string_type& encoding = specified encoding. If no encoding is specified,
"UTF-8") UTF-8 is assumed.
void SaveToFile(const string_type& fileName, Saves an XML document to a file with the
bool prettyPrint, const string_type& encoding, specified encoding. Byte order and Unicode
bool bigEndian, bool writeBOM) byte-order mark can be specified for Unicode
encodings.
string_type SaveToString(bool prettyPrint) Saves an XML document to a string
std::vector<unsigned char> SaveToBinary Saves an XML document to a byte array with
(bool prettyPrint, const string_type& encoding = the specified encoding. If no encoding is
"UTF-8") specified, UTF-8 is assumed.
std::vector<unsigned char> SaveToBinary Saves an XML document to a byte array with
(bool prettyPrint, const string_type& encoding, the specified encoding. Byte order and Unicode
bool bigEndian, bool writeBOM) byte-order mark can be specified for Unicode
encodings.
static CDoc CreateDocument() Creates a new, empty XML document. Must be
released using DestroyDocument().
void DestroyDocument() Destroys a document. All references to the
document and its nodes are invalidated. This
must be called when finished working with a
document.
void SetSchemaLocation(const string_type& Adds an xsi:schemaLocation or
schemaLocation) xsi:noNamespaceSchemaLocation attribute to
the root element. A root element must already
exist.

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Using the generated code library 521

void SetDTDLocation(const string_type& Adds a DOCTYPE declaration with the


dtdLocation) specified system ID. A root element must
already exist. This method is not supported for
MSXML, since it is not possible to add a
DOCTYPE declaration to a document in
memory.

Generated Type Class


For each type in the schema, a class is generated that contains a member for each attribute
and element of the type. The members are named the same as the attributes or elements in the
original schema (in case of possible collisions, a number is appended). For simple types,
assignment and conversion operators are generated. For simple types with enumeration
facets, the methods GetEnumerationValue() and SetEnumerationValue(int) can be used
together with generated constants for each enumeration value. In addition, the method
StaticInfo() allows accessing of schema information as altova::meta::SimpleType or
altova::meta::ComplexType (see below).

XML Schema derivation of complexTypes by extension results in derived classes in the


generated library.

Generated Member Attribute Class


For each member attribute of a type, a class with the following methods is created.

Method Purpose
bool exists() Returns true if the attribute exists
void remove() Removes the attribute from its parent element
int GetEnumerationValue() Generated for enumeration types only. Returns
one of the constants generated for the possible
values, or Invalid if the value does not match
any of the enumerated values in the schema.
void SetEnumerationValue(int) Generated for enumeration types only. Pass
one of the constants generated for the possible
values to this method to set the value.
altova::meta::Attribute info() Returns an object for querying schema
information (see below)

In addition, assignment and conversion operators from/to the attribute's native type are created,
so it can be used directly in assignments.

Generated Member Element Class


For each member element of a type, a class with the following methods is created.

Method Purpose
MemberType first() Returns the first instance of the member
element
MemberType operator[](unsigned int index) Returns the member element specified by the
index
MemberType last() Returns the last instance of the member
element
MemberType append() Creates a new element and appends it to its
parent
bool exists() Returns true if at least one element exists

© 2010 Altova GmbH User Manual


522 Code Generator Using the generated code library

unsigned int count() Returns the count of elements


void remove() Deletes all occurrences of the element from its
parent
void remove(unsigned int index) Deletes the occurrence of the element
specified by the index
Iterator<MemberType> all() Returns an object for iterating instances of the
member element
int GetEnumerationValue() Generated for enumeration types only. Returns
one of the constants generated for the possible
values, or Invalid if the value does not match
any of the enumerated values in the schema.
void SetEnumerationValue(int) Generated for enumeration types only. Pass
one of the constants generated for the possible
values to this method to set the value.
altova::meta::Element info() Returns an object for querying schema
information (see below)

For simple and mixed content elements, assignment and conversion operators from/to the
element's native type are created, so it can be used directly in assignments.

Creating XML Documents


The generated code library makes it very easy to create XML files. Let's start with an example
XML file for the example schema:

<?xml version="1.0" encoding="UTF-8"?>


<Library xsi:schemaLocation="http://www.nanonull.com/LibrarySample Library.xsd" xmlns="
http://www.nanonull.com/LibrarySample" xmlns:xsi="
http://www.w3.org/2001/XMLSchema-instance">
<Book ISBN="0764549642" Variant="Paperback">
<Title>The XML Spy Handbook</Title>
<Author>Altova</Author>
</Book>
</Library>

The following C++ code was used to create this file. The classes CLibrary, CLibraryType and
CBookType are generated out of the schema and represent the complete document, the type of
the <Library> element, and the complex type BookType, which is the type of the <Book>
element.
using namespace Library;
void Example()
{
// create a new, empty XML document
CLibrary libDoc = CLibrary::CreateDocument();

// create the root element <Library> and add it to the document


CLibraryType lib = libDoc.Library2.append();

// create a new <Book> and add it to the library


CBookType book = lib.Book.append();

// set the ISBN attribute of the book


book.ISBN = _T("0764549642");

// set the Variant attribute of the book using an enumeration constant


book.Variant.SetEnumerationValue( CBookVariant::k_Paperback );

// add the <Title> and <Author> elements, and set values

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Using the generated code library 523

book.Title.append() = _T("The XML Spy Handbook");


book.Author.append() = _T("Altova");

// set the schema location (this is optional)


libDoc.SetSchemaLocation(_T("Library.xsd"));

// save the XML document to a file with default encoding (UTF-8).


"true" causes the file to be pretty-printed.
libDoc.SaveToFile(_T("Library1.xml"), true);

// destroy the document - all references to the document and any of its
nodes become invalid
libDoc.DestroyDocument();
}

Note that all elements are created by calling append(), and that attributes (like ISBN in the
example) can simply be accessed like structure members. Remember to destroy the document
when you are finished using it.

Reading XML Documents


The following example reads the file we just created and demonstrates the various methods for
reading XML files:

using namespace Library;


void Example()
{
// load XML document
CLibrary libDoc = CLibrary::LoadFromFile(_T("Library1.xml"));

// get the first (and only) root element <Library>


CLibraryType lib = libDoc.Library2.first();

// it is possible to check whether an element exists:


if (!lib.Book.exists())
{
tcout << "This library is empty." << std::endl;
return;
}

// iteration: for each <Book>...


for (Iterator<CBookType> itBook = lib.Book.all(); itBook; ++itBook)
{
// output values of ISBN attribute and (first and only) title
element
tcout << "ISBN: " << tstring(itBook->ISBN) << std::endl;
tcout << "Title: " << tstring(itBook->Title.first()) << std::
endl;

// read and compare an enumeration value


if (itBook->Variant.GetEnumerationValue() ==
CBookVariant::k_Paperback)
tcout << "This is a paperback book." << std::endl;

// for each <Author>...


for (CBookType::Author::iterator itAuthor = itBook->Author.all
(); itAuthor; ++itAuthor)
tcout << "Author: " << tstring(itAuthor) << std::endl;

// alternative: use count and index


for (unsigned int j = 0; j < itBook->Author.count(); ++j)
tcout << "Author: " << tstring(itBook->Author[j]) << std::
endl;
}

© 2010 Altova GmbH User Manual


524 Code Generator Using the generated code library

// destroy the document - all references to the document and any of its
nodes become invalid
libDoc.DestroyDocument();
}

To access the contents of attributes and elements as strings for the cout << operator, an explicit
cast to tstring is required.
Of course you can also load a document, modify it by adding or deleting elements and
attributes, and then save the changed file back to disk.

Error Handling
Errors are reported by exceptions. The following exception classes are defined in the
namespace altova:

Class Base Class Description


Error std::logic_errorInternal program logic error (independent of input
data)
Exception std::runtime_erro Base class for runtime errors
r
InvalidArgumentsExce Exception A method was called with invalid argument values.
ption
ConversionException Exception Exception thrown when a type conversion fails
StringParseException ConversionExce A value in the lexical space cannot be converted to
ption value space.
ValueNotRepresentabl ConversionExce A value in the value space cannot be converted to
eException ption lexical space.
OutOfRangeException ConversionExce A source value cannot be represented in target
ption domain.
InvalidOperationExcept Exception An operation was attempted that is not valid in the
ion given context.
DataSourceUnavailabl Exception A problem occurred while loading an XML instance.
eException
DataTargetUnavailable Exception A problem occurred while saving an XML instance.
Exception

All exception classes contain a message text and a pointer to a possible inner exception.

Method Purpose
string_type message() Returns a textual description of the exception
std::exception inner() Returns the exception that caused this exception, if
available, or NULL

Accessing Metadata
The generated library allows accessing static schema information via the following classes. All
methods are declared as const. The methods that return one of the metadata classes return a
NULL object if the respective property does not exist.

altova::meta::SimpleType
Method Purpose
operator bool() Returns true if this is not the NULL SimpleType
operator !() Returns true if this is the NULL SimpleType
SimpleType GetBaseType() Returns the base type of this type
string_type GetLocalName() Returns the local name of the type

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Using the generated code library 525

string_type GetNamespaceURI() Returns the namespace URI of the type


unsigned int GetMinLength() Returns the value of this facet
unsigned int GetMaxLength() Returns the value of this facet
unsigned int GetLength() Returns the value of this facet
unsigned int GetTotalDigits() Returns the value of this facet
unsigned int GetFractionDigits() Returns the value of this facet
string_type GetMinInclusive() Returns the value of this facet
string_type GetMinExclusive() Returns the value of this facet
string_type GetMaxInclusive() Returns the value of this facet
string_type GetMaxExclusive() Returns the value of this facet
std::vector<string_type> GetEnumerations() Returns a list of all enumeration facets
std::vector<string_type> GetPatterns() Returns a list of all pattern facets
WhitespaceType GetWhitespace() Returns the value of the whitespace facet,
which is one of:
Whitespace_Unknown
Whitespace_Preserve
Whitespace_Replace
Whitespace_Collapse

altova::meta::ComplexType
Method Purpose
operator bool() Returns true if this is not the NULL
ComplexType
operator !() Returns true if this is the NULL ComplexType
std::vector<Attribute> GetAttributes() Returns a list of all attributes
std::vector<Element> GetElements() Returns a list of all elements
ComplexType GetBaseType() Returns the base type of this type
string_type GetLocalName() Returns the local name of the type
string_type GetNamespaceURI() Returns the namespace URI of the type
SimpleType GetContentType() Returns the simple type of the content
Element FindElement(const char_type* Finds the element with the specified local name
localName, const char_type* namespaceURI) and namespace URI
Attribute FindAttribute(const char_type* Finds the attribute with the specified local name
localName, const char_type* namespaceURI) and namespace URI

altova::meta::Element
Method Purpose
operator bool() Returns true if this is not the NULL Element
operator !() Returns true if this is the NULL Element
ComplexType GetDataType() Returns the type of the element. Note that this
is always a complex type even if declared as
simple in the original schema. Use
GetContentType() of the returned object to get
the simple content type.
unsigned int GetMinOccurs() Returns the minOccurs value defined in the
schema
unsigned int GetMaxOccurs() Returns the maxOccurs value defined in the
schema
string_type GetLocalName() Returns the local name of the element
string_type GetNamespaceURI() Returns the namespace URI of the element

altova::meta::Attribute
Method Purpose

© 2010 Altova GmbH User Manual


526 Code Generator Using the generated code library

operator bool() Returns true if this is not the NULL Attribute


operator !() Returns true if this is the NULL Attribute
SimpleType GetDataType() Returns the type of the attribute content
bool IsRequired() Returns true if the attribute is required
string_type GetLocalName() Returns the local name of the attribute
string_type GetNamespaceURI() Returns the namespace URI of the attribute

20.4.4 Using the generated C# library


Please note: This topic describes code generation when using the option Generate code
compatible to V2007r3 in the code generation dialog.

Generated Libraries
Name Purpose
Altova Base library containing common runtime support, identical for every schema
AltovaXML Base library containing runtime support for XML, identical for every schema
YourSchema Library containing declarations generated from the input schema, named as the
schema file or DTD
YourSchema Test application skeleton (XMLSpy only)
Test

DOM Implementation
The generated C# code uses the .NET standard System.XML library as the underlying DOM
implementation.

Data Types
The default mapping of XML Schema types to C# data types is:

XML Schema C# Remarks


xs:string string
xs:boolean bool
xs:decimal decimal xs:decimal has unlimited range and precision,
mapped to decimal for efficiency reasons.
xs:float, xs:double double
xs:long long
xs:unsignedLong ulong
xs:int int
xs:unsignedInt uint
xs:dateTime, date, time, Altova.Types.Date
gYearMonth, gYear, Time
gMonthDay, gDay, gMonth
xs:duration Altova.Types.Dura
tion
xs:hexBinary and byte[] Encoding and decoding of binary data is done
xs:base64Binary automatically.
xs:anySimpleType string

All XML Schema types not contained in this list are derived types, and mapped to the same C#
type as their respective base type.

Generated Document Class

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Using the generated code library 527

In addition to the classes for the types declared in the XML Schema, the document class is
generated. It contains all possible root elements as members, and in addition the following
methods ("Doc" stands for the name of the generated document class itself):

Method Purpose
static Doc LoadFromFile(string fileName) Loads an XML document from a file
static Doc LoadFromString(string xml) Loads an XML document from a string
static Doc LoadFromBinary(byte[] xml) Loads an XML document from a byte array
void SaveToFile(string fileName, bool Saves an XML document to a file with the
prettyPrint, string encoding = "UTF-8") specified encoding. If no encoding is specified,
UTF-8 is assumed.
string SaveToString(bool prettyPrint) Saves an XML document to a string
byte[] SaveToBinary(bool prettyPrint, string Saves an XML document to a byte array with
encoding = "UTF-8") the specified encoding. If no encoding is
specified, UTF-8 is assumed.
static Doc CreateDocument() Creates a new, empty XML document
static Doc CreateDocument(string encoding) Creates a new, empty XML document, with
encoding of type "encoding".
void SetSchemaLocation(string Adds an xsi:schemaLocation or
schemaLocation) xsi:noNamespaceSchemaLocation attribute to
the root element. A root element must already
exist.
void SetDTDLocation(string dtdLocation) Adds a DOCTYPE declaration with the
specified system ID. A root element must
already exist.

Generated Type Class


For each type in the schema, a class is generated that contains a member for each attribute
and element of the type. The members are named the same as the attributes or elements in the
original schema (in case of possible collisions, a number is appended). For simple and mixed
types, a Value property is generated to access the text content. For simple types with
enumeration facets, the EnumerationValue property can be used together with generated
constants for each enumeration value. In addition, the property StaticInfo() allows accessing of
schema information as Altova.Xml.Meta.SimpleType or Altova.Xml.Meta.ComplexType (see
below).

XML Schema derivation of complexTypes by extension results in derived classes in the


generated library.

Generated Member Attribute Class


For each member attribute of a type, a class with the following methods or properties is created.

Method/Property Purpose
bool Exists() Returns true if the attribute exists
void Remove() Removes the attribute from its parent element
AttributeType Value Sets or gets the attribute value
int EnumerationValue Generated for enumeration types only. Sets or
gets the attribute value using one of the
constants generated for the possible values,
reading returns Invalid if the value does not
match any of the enumerated values in the
schema.

© 2010 Altova GmbH User Manual


528 Code Generator Using the generated code library

Altova.Xml.Meta.Attribute Info Returns an object for querying schema


information (see below)

Generated Member Element Class


For each member element of a type, a class with the following methods or properties is created.
The class implements the standard System.Collections.IEnumerable interface, so it can be
used with the foreach statement.

Method/Property Purpose
MemberType First Returns the first instance of the member
element
MemberType this[int index] Returns the member element specified by the
index
MemberType At(int index) Returns the member element specified by the
index
MemberType Last Returns the last instance of the member
element
MemberType Append() Creates a new element and appends it to its
parent
bool Exists Returns true if at least one element exists
int Count Returns the count of elements
void Remove() Deletes all occurrences of the element from its
parent
void RemoveAt(int index) Deletes the occurrence of the element
specified by the index
System.Collections.IEnumerator Returns an object for iterating instances of the
GetEnumerator() member element.
MemberType Value Sets or gets the element content (only
generated if element can have mixed or simple
content)
int EnumerationValue Generated for enumeration types only. Sets or
gets the element value using one of the
constants generated for the possible values,
reading returns Invalid if the value does not
match any of the enumerated values in the
schema.
Altova.Xml.Meta.Element Info Returns an object for querying schema
information (see below)

Creating XML Documents


The generated code library makes it very easy to create XML files. Let's start with an example
XML file for the example schema:

<?xml version="1.0" encoding="UTF-8"?>


<Library xsi:schemaLocation="http://www.nanonull.com/LibrarySample Library.xsd" xmlns="
http://www.nanonull.com/LibrarySample" xmlns:xsi="
http://www.w3.org/2001/XMLSchema-instance">
<Book ISBN="0764549642" Variant="Paperback">
<Title>The XML Spy Handbook</Title>
<Author>Altova</Author>
</Book>
</Library>

The following C# code was used to create this file. The classes Library2, LibraryType and
BookType are generated out of the schema and represent the complete document, the type of

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Using the generated code library 529

the <Library> element, and the complex type BookType, which is the type of the <Book>
element. Note that the automatic name de-collision renamed the Library class to Library2 to
avoid a possible conflict with the library namespace name.
using Library;
...
protected static void Example()
{
// create a new, empty XML document
Library2 libDoc = Library2.CreateDocument();

// create the root element <Library> and add it to the document


LibraryType lib = libDoc.Library3.Append();

// create a new <Book> and add it to the library


BookType book = lib.Book.Append();

// set the ISBN attribute of the book


book.ISBN.Value = "0764549642";

// set the Variant attribute of the book using an enumeration


constant
book.Variant.EnumerationValue =
BookVariant.EnumValues.ePaperback;

// add the <Title> and <Author> elements, and set values


book.Title.Append().Value = "The XML Spy Handbook";
book.Author.Append().Value = "Altova";

// set the schema location (this is optional)


libDoc.SetSchemaLocation("Library.xsd");

// save the XML document to a file with default encoding


(UTF-8). "true" causes the file to be pretty-printed.
libDoc.SaveToFile("Library1.xml", true);
}

Note that all elements are created by calling Append(), and that attributes (like ISBN in the
example) can simply be accessed like structure members.

Reading XML Documents


The following example reads the file we just created and demonstrates the various methods for
reading XML files:

using Library;
...
protected static void Example()
{
// load XML document
Library2 libDoc = Library2.LoadFromFile("Library1.xml");

// get the first (and only) root element <Library>


LibraryType lib = libDoc.Library3.First;

// it is possible to check whether an element exists:


if (!lib.Book.Exists)
{
Console.WriteLine("This library is empty.");
return;
}

// iteration: for each <Book>...


foreach (BookType book in lib.Book)

© 2010 Altova GmbH User Manual


530 Code Generator Using the generated code library

{
// output values of ISBN attribute and (first and only)
title element
Console.WriteLine("ISBN: " + book.ISBN.Value);
Console.WriteLine("Title: " + book.Title.First.Value);

// read and compare an enumeration value


if (book.Variant.EnumerationValue ==
BookVariant.EnumValues.ePaperback)
Console.WriteLine("This is a paperback book.");

// for each <Author>...


foreach (xs.stringType author in book.Author)
Console.WriteLine("Author: " + author.Value);

// alternative: use count and index


for (int j = 0; j < book.Author.Count; ++j)
Console.WriteLine("Author: " + book.Author[j
].Value);
}
}

Note the type of the book.Author member: xs.stringType is a generated class for any element
with simple string content. Similar classes are generated for all other XML Schema types.

Of course you can also load a document, modify it by adding or deleting elements and
attributes, and then save the changed file back to disk.

Error Handling
Errors are reported by exceptions. The following exception classes are defined in the
namespace Altova:

Class Base Class Description


ConversionException Exception Exception thrown when a type conversion fails
StringParseException ConversionExce A value in the lexical space cannot be converted to
ption value space.
DataSourceUnavailabl System.Exceptio A problem occurred while loading an XML instance.
eException n
DataTargetUnavailable System.Exceptio A problem occurred while saving an XML instance.
Exception n

In addition, the following .NET exceptions are commonly used:

Class Description
System.Exception Base class for runtime errors
System.ArgumentException A method was called with invalid argument values, or
a type conversion failed.
System.FormatException A value in the lexical space cannot be converted to
value space.
System.InvalidCastException A value cannot be converted to another type.
System.OverflowException A source value cannot be represented in target
domain.

Accessing Metadata
The generated library allows accessing static schema information via the following classes. The
properties that return one of the metadata classes return null if the respective property does not
exist.

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Using the generated code library 531

Altova.Xml.Meta.SimpleType
Method/Property Purpose
SimpleType BaseType Returns the base type of this type
string LocalName Returns the local name of the type
string NamespaceURI Returns the namespace URI of the type
XmlQualifiedName QualifiedName Returns the qualified name of this type
int MinLength Returns the value of this facet
int MaxLength Returns the value of this facet
int Length Returns the value of this facet
int TotalDigits Returns the value of this facet
int FractionDigits Returns the value of this facet
string MinInclusive Returns the value of this facet
string MinExclusive Returns the value of this facet
string MaxInclusive Returns the value of this facet
string MaxExclusive Returns the value of this facet
string[] Enumerations Returns a list of all enumeration facets
string[] Patterns Returns a list of all pattern facets
WhitespaceType Whitespace Returns the value of the whitespace facet,
which is one of:
Unknown
Preserve
Replace
Collapse

Altova.Xml.Meta.ComplexType
Method/Property Purpose
Attribute[] Attributes Returns a list of all attributes
Element[] Elements Returns a list of all elements
ComplexType BaseType Returns the base type of this type
string LocalName Returns the local name of the type
string NamespaceURI Returns the namespace URI of the type
XmlQualifiedName QualifiedName Returns the qualified name of this type
SimpleType ContentType Returns the simple type of the content
Element FindElement(string localName, string Finds the element with the specified local name
namespaceURI) and namespace URI
Attribute FindAttribute(string localName, Finds the attribute with the specified local name
string namespaceURI) and namespace URI

Altova.Xml.Meta.Element
Method/Property Purpose
ComplexType DataType Returns the type of the element. Note that this
is always a complex type even if declared as
simple in the original schema. Use the
ContentType property of the returned object to
get the simple content type.
int MinOccurs Returns the minOccurs value defined in the
schema
int MaxOccurs Returns the maxOccurs value defined in the
schema
string LocalName Returns the local name of the element
string NamespaceURI Returns the namespace URI of the element
XmlQualifiedName QualifiedName Returns the qualified name of the element

© 2010 Altova GmbH User Manual


532 Code Generator Using the generated code library

Altova.Xml.Meta.Attribute
Method/Property Purpose
SimpleType DataType Returns the type of the attribute content
bool Required() Returns true if the attribute is required
string LocalName Returns the local name of the attribute
string NamespaceURI Returns the namespace URI of the attribute
XmlQualifiedName QualifiedName Returns the qualified name of the attribute

20.4.5 Using generated code compatible to old versions


Compatibility Mode
The code generator has been improved multiple times in the recent releases of Altova products,
sometimes in ways that require changes to the code that uses the generated libraries. To
preserve compatibility with existing code using libraries generated with earlier releases of
XMLSpy, you can set the compatibility mode to the desired release. Default is version 2007r3,
which creates the latest version of the code libraries described in the previous chapters.

The following chapters describe usage of the generated classes when using one of the following
compatibility options:

 Code compatible to version 2005r3


 Code compatible to version 2006 to 2007

Please note that these compatibility options will be removed in a future version.

Version 2005r3:
Code generated code for XML schemas up till V2005R3 uses a static DOM document instance
as parent for all nodes. This allows creating free-standing nodes that can be added to a
document later, but may rise issues with multi-threading or memory management.

{
LibraryTypel
i
b=new LibraryType();
BookType book = new BookType();
book.addISBN(new Schem aString("0764549642"));
book.addTitle(new Schem aString("The XM L SpyHandbook"));
book.addAuthor(new Schem aStri ng("Al
tova"));
li
b.addBook(book);

Li
braryDocdoc=new Li braryDoc();
doc.setRootEl em entNam e("http://www.nanonul l
.com /Li
brarySam pl
e","Li
brary");
doc.setSchem aLocati on("Li
brary.xsd");//opti
onal
doc.save("Li
brary1.xml
",l
i
b);
}

Version 2006 to 2007:


In C# and Java code generated with version 2006 to 2007, the standard (non-parameter)
constructor is not used, because it does not establish a reference to a DOM document. A new
document is created first which can then be referenced by the root node. All new child nodes
must then also be created in the correct document. This is accomplished by using the
generated factory functions called newXXX, please see the example code below.
{
LibraryDocdoc=new Li braryDoc();
doc.setSchem aLocati
on("Li
brary.xsd");//opti
onal

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Using the generated code library 533

// create root element (with no namespace prefix)


LibraryType lib = new LibraryType(doc, "
http://www.nanonull.com/LibrarySample", "", "Library" );

BookType book = lib.newBookType(); // factory functions are


generated for all members of a complex type
book.addISBN( new SchemaString( "0764549642" ) );
book.addTitle( new SchemaString( "The XML Spy Handbook" ) );
book.addAuthor( new SchemaString( "Altova" ) );
lib.addBook( book );

doc.save( "Library1.xml", lib );


}

Version 2007r3:
The code generated by version 2007r3 has been completely redesigned to allow for
multi-threading, avoid name collisions, and simplify the usage of the libraries. For details, see
Using the generated code library.

Creating XML files (XMLSpy 2006)


Please note: This topic describes code generation when using the option Generate code
compatible to V2006-2007 in the code generation dialog.

Java:
To give a general overview, here is the code to create a test file:

protected static void example() throws Exception {


LibraryDoc doc = new LibraryDoc();
doc.setSchemaLocation("Library.xsd"); // optional
LibraryType lib = new LibraryType(doc,
"http://www.nanonull.com/LibrarySample", "", "Library" );
BookType book = lib.newBook();
book.addISBN( new SchemaString( "0764549642" ) );
book.addTitle( new SchemaString( "The XML Spy Handbook" ) );
book.addAuthor( new SchemaString( "Altova" ) );
lib.addBook( book );
doc.save("Library1.xml", lib);
}

The idea of the generated classes is the following:


Create a document and associate it with the root element of the generated schema so that the
tree is stored in the document.

First we create a new document:

LibraryDoc doc = new LibraryDoc();

Optionally we can also set the schema location.

doc.setSchemaLocation( "Library.xsd" );

We create the root element, passing to the method the document object that we have already
generated, the namespace of library.xsd, and the name of the root element in the schema:

LibraryType lib = new LibraryType(doc,

© 2010 Altova GmbH User Manual


534 Code Generator Using the generated code library

"http://www.nanonull.com/LibrarySample", "", "Library" );

LibraryType is a class that was generated. It is similar to the <xs:element name="Library"> in


the schema file. This is the root element for the xml files being generated (as in generate
sample xml file).

We now have a new Library object. All we have to do is fill it with Book objects. Look at the
schema again and notice that books are stored as a sequence within the Library.

The next step is to make an object of BookType and fill the new object.

BookType book = lib.newBook();

Definition of BookType in the schema file:

<xs:complexType name="BookType">
<xs:sequence>
<xs:element name="Title" type="xs:string"/>
<xs:element name="Author" type="xs:string" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="ISBN" type="xs:string" use="required"/>
</xs:complexType>

We will insert an ISBN number, a title and an author.

book.addISBN( new SchemaString( "0764549642" ) );


book.addTitle( new SchemaString( "The XML Spy Handbook" ) );
book.addAuthor( new SchemaString( "Altova" ) );

We filled the BookType object, and we now have to add it to the library sequence:

lib.addBook(book);

Finally, save the file. The first parameter is the file name, the second is the root element itself.

doc.save( "Library1.xml", lib );

C++:
The C++ implementation is very similar to the Java one, we will therefore only discuss the
differences between the two.

The function to be inserted above the main function is as follows:

void Example()
{
CLibraryDoc doc;
CLibraryType lib;
doc.SetRootElementName(_T("http://www.nanonull.com/LibrarySample"), _T(
"Library"));
doc.SetSchemaLocation(_T("Library.xsd")); // optional
CBookType book;
book.AddISBN( _T("0764549642") );
book.AddTitle( _T("The XML Spy Handbook") );
book.AddAuthor( _T("Altova") );
lib.AddBook( book );
doc.Save(_T("Library1.xml"), lib);

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Using the generated code library 535

First off, you'll notice that all classes begin with a capital C - the rest of the class naming stays
the same. All member function names start with a capital letter.

Please take care with the _T macros. The macro ensures that the string constant is stored
correctly, whether you're compiling for Unicode or non-Unicode programs.

C#:
protected static void Example()
{
LibraryDoc doc = new LibraryDoc();
doc.SetSchemaLocation( "Library.xsd" ); // optional
// create root element with no namespace prefix
LibraryType lib = new LibraryType(doc, "
http://www.nanonull.com/LibrarySample", "", "Library" );
BookType book = lib.NewBook(); // factory functions are generated for all
members of a complex type
book.AddISBN( new SchemaString( "0764549642" ) );
book.AddTitle( new SchemaString( "The XML Spy Handbook" ) );
book.AddAuthor( new SchemaString( "Altova" ) );
lib.AddBook( book );
doc.Save( "Library1.xml", lib );
}

Creating XML files (XMLSpy 2005)


Please note: This topic describes code generation when using the option Generate code
compatible to V2005R3 in the code generation dialog.

Java:
To give a general overview, here is the code to create a test file:

protected static void example() {


LibraryType lib = new LibraryType();
BookType book = new BookType();
book.addISBN( new SchemaString( "0764549642" ) );
book.addTitle( new SchemaString( "The XML Spy Handbook" ) );
book.addAuthor( new SchemaString( "Altova" ) );
lib.addBook( book );

LibraryDoc doc = new LibraryDoc();


doc.setRootElementName( "http://www.nanonull.com/LibrarySample", "Library"
);
doc.setSchemaLocation( "Library.xsd" ); // optional
doc.save( "Library1.xml", lib );
}

The idea of the generated classes is the following:


Generate the tree you want to save in the new file, create a document and store the tree in it.

The first line:


LibraryType lib = new LibraryType();

© 2010 Altova GmbH User Manual


536 Code Generator Using the generated code library

LibraryType is a class that was generated. It is similar to the <xs:element name="Library">


in the schema file. This is the root element for the xml files being generated (as in generate
sample xml file).

We now have a new Library object. All we have to do is fill it with Book objects. Look at the
schema again and notice that books are stored as a sequence within the Library.

The next step is to make an object of BookType and fill the new object.

BookType book = new BookType();

Definition of BookType in the schema file:

<xs:complexType name="BookType">
<xs:sequence>
<xs:element name="Title" type="xs:string"/>
<xs:element name="Author" type="xs:string" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="ISBN" type="xs:string" use="required"/>
</xs:complexType>

We will insert an ISBN number, a title and an author.

book.addISBN( new SchemaString( "0764549642" ) );


book.addTitle( new SchemaString( "The XML Spy Handbook" ) );
book.addAuthor( new SchemaString( "Altova" ) );

We filled the BookType object, and we now have to add it to the sequence of
internationalPriceTypes within Test_Empty:

lib.addBook(book);

Done, the tree is complete! All we have to do now, is create a new document and define the
namespace and name of the root element:

LibraryDoc doc = new LibraryDoc();


doc.setRootElementName( "http://www.nanonull.com/LibrarySample", "Library"
);

Optionally we can also set the schema location.

doc.setSchemaLocation( "Library.xsd" );

Finally, save the file, - the first parameter is the file name, the second is the root element itself.

doc.save( "Library1.xml", lib );

C++:
The C++ implementation is very similar to the Java one, we will therefore only discuss the
differences between the two.

The function to be inserted above the main function is as follows:

void Example()
{
CLibraryType lib;

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Using the generated code library 537

CBookType book;
book.AddISBN( _T("0764549642") );
book.AddTitle( _T("The XML Spy Handbook") );
book.AddAuthor( _T("Altova") );
lib.AddBook( book );

CLibraryDoc doc;
doc.SetRootElementName( _T("http://www.nanonull.com/LibrarySample"), _T(
"Library") );
doc.SetSchemaLocation( _T("Library.xsd") ); // optional
doc.Save( _T("Library1.xml"), lib );
}

First off, you'll notice that all classes begin with a capital C - the rest of the class naming stays
the same. All member function names start with a capital letter.

Please take care with the _T macros. The macro ensures that the string constant, is stored
correctly, whether you're compiling for Unicode or non Unicode programs.

C#:
protected static void Example()
{
LibraryType lib = new LibraryType();
BookType book = new BookType();
book.AddISBN( new SchemaString( "0764549642" ) );
book.AddTitle( new SchemaString( "The XML Spy Handbook" ) );
book.AddAuthor( new SchemaString( "Altova" ) );
lib.AddBook( book );

LibraryDoc doc = new LibraryDoc();


doc.SetRootElementName( "http://www.nanonull.com/LibrarySample", "Library"
);
doc.SetSchemaLocation( "Library.xsd" ); // optional
doc.Save( "Library1.xml", lib );
}

Opening and parsing existing XML files (XMLSpy 2006)


Please note: This topic describes code generation when using the option Generate code
compatible to V2006-2007 in the code generation dialog.

We will now use the Library1.xml file generated with our sample program. Please make sure
that this file exists, or change the path to it in the load command.

Java:
Sample source code:

protected static void example2() {

LibraryDoc doc = new LibraryDoc();


LibraryType lib = new LibraryType(doc.load("Library1.xml"));

if (!lib.hasBook()) {
System.out.println("This library is empty");

© 2010 Altova GmbH User Manual


538 Code Generator Using the generated code library

return;
}

for (int i = 0; i < lib.getBookCount(); i++) {


BookType book;
try {
book = lib.getBookAt(i);

System.out.println("ISBN: " + book.getISBN().toString());


System.out.println("Title: " + book.getTitle().toString());

for (int j = 0; j < book.getAuthorCount(); j++) {


System.out.println("Author: "+
book.getAuthorAt(j).toString());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}

in the main() function add a call to:


example2();
after
example1();

The rest is reasonably straightforward.


First create a new variable of type Document, and one for the root element, which is
immediately filled by the doc.load function. The only parameter it needs, is the path to the xml
file being used.

LibraryDoc doc = new LibraryDoc();


LibraryType lib = new LibraryType( doc.load( "Library1.xml" ) );

We now have a document and know that lib contains a sequence of BookType objects.

The next step is to dump the values of all of the Book elements:
if( !lib.hasBook() ) {

Why check for objects? The call just shows that a function exists that checks this for you.

Step through the books and output their values:

for( int i = 0; i < lib.getBookCount(); i++ ) {


BookType book = lib.getBookAt( i );

System.out.println( "ISBN: " + book.getISBN().asString() );


System.out.println( "Title: " + book.getTitle().asString() );

for( int j = 0; j < book.getAuthorCount(); j++ ) {


System.out.println( "Author: " + book.getAuthorAt( j ).asString()
);
}
}

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Using the generated code library 539

We're finished, all the values are listed in your output window.

C++:
This section only explains the differences to the java code.

void Example2()
{
CLibraryDoc doc;
CLibraryType lib = doc.Load( _T("Library1.xml") );

if ( !lib.HasBook() )
{
cout << "This library is empty" << endl;
return;
}

for ( int i = 0; i < lib.GetBookCount(); i++ )


{
CBookType book = lib.GetBookAt( i );
cout << "ISBN: " << book.GetISBN() << endl;
cout << "Title: " << book.GetTitle() << endl;

for ( int j = 0; j < book.GetAuthorCount(); j++ )


{
cout << "Author: " << book.GetAuthorAt( j ) << endl;
}
}
}

All member functions start with a capital letter, and all class names start with a C.

C#:
This section only explains the differences to the java code.

protected static void Example2()


{
LibraryDoc doc = new LibraryDoc();
LibraryType lib = new LibraryType( doc.Load( "Library1.xml" ) );

if ( !lib.HasBook() )
{
Console.WriteLine( "This library is empty" );
return;
}

for ( int i = 0; i < lib.GetBookCount(); i++ )


{
BookType book = lib.GetBookAt( i );
Console.WriteLine( "ISBN: {0}", book.GetISBN() );
Console.WriteLine( "Title: {0}", book.GetTitle() );

for( int j = 0; j < book.GetAuthorCount(); j++ )


{
Console.WriteLine( "Author: {0}", book.GetAuthorAt( j ) );

© 2010 Altova GmbH User Manual


540 Code Generator Using the generated code library

}
}
}

All member functions start with a capital letter.

Opening and parsing existing XML files (XMLSpy 2005)


Please note: This topic describes code generation when using the option Generate code
compatible to V2005R3 in the code generation dialog.

We will now use the Library1.xml file generated with our sample program. Please make sure
that this file exists, or change the path to it in the load command.

Java:
Sample source code:

protected static void example2() {


LibraryDoc doc = new LibraryDoc();
LibraryType lib = new LibraryType( doc.load( "Library1.xml" ) );

if( !lib.hasBook() ) {
System.out.println( "This library is empty" );
return;
}

for( int i = 0; i < lib.getBookCount(); i++ ) {


BookType book = lib.getBookAt( i );
System.out.println( "ISBN: " + book.getISBN().asString() );
System.out.println( "Title: " + book.getTitle().asString() );

for( int j = 0; j < book.getAuthorCount(); j++ ) {


System.out.println( "Author: " + book.getAuthorAt( j
).asString());
}
}
}

in the main() function add a call to:


example2();
after
example1();

The rest is reasonably straightforward.


First create a new variable of type Document, and one for the root element, which is
immediately filled by the doc.load function. The only parameter it needs, is the path to the xml
file being used.

LibraryDoc doc = new LibraryDoc();


LibraryType lib = new LibraryType( doc.load( "Library1.xml" ) );

We now have a document and know that lib contains a sequence of BookType objects.

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Using the generated code library 541

The next step is to dump the values of all of the Book elements:
if( !lib.hasBook() ) {

Why check for objects? The call just shows that a function exists, that checks this for you.

Step through the books and dump their values:

for( int i = 0; i < lib.getBookCount(); i++ ) {


BookType book = lib.getBookAt( i );

System.out.println( "ISBN: " + book.getISBN().asString() );


System.out.println( "Title: " + book.getTitle().asString() );

for( int j = 0; j < book.getAuthorCount(); j++ ) {


System.out.println( "Author: " + book.getAuthorAt( j ).asString()
);
}
}

We're finished, all the values are listed in your output window.

C++:
This section only explains the differences to the java code.

void Example2()
{
CLibraryDoc doc;
CLibraryType lib = doc.Load( _T("Library1.xml") );

if( !lib.HasBook() )
{
cout << "This library is empty" << endl;
return;
}

for( int i = 0; i < lib.GetBookCount(); i++ )


{
CBookType book = lib.GetBookAt( i );

cout << "ISBN: " << book.GetISBN() << endl;


cout << "Title: " << book.GetTitle() << endl;

for( int j = 0; j < book.GetAuthorCount(); j++ )


{
cout << "Author: " << book.GetAuthorAt( j ) << endl;
}
}
}

All member functions start with a capital letter, and all Classnames start with a C.

C#:
This section only explains the differences to the java code.

protected static void Example2()

© 2010 Altova GmbH User Manual


542 Code Generator Using the generated code library

{
LibraryDoc doc = new LibraryDoc();
LibraryType lib = new LibraryType( doc.Load( "Library1.xml" ) );

if( !lib.HasBook() )
{
Console.WriteLine( "This library is empty" );
return;
}

for( int i = 0; i < lib.GetBookCount(); i++ )


{
BookType book = lib.GetBookAt( i );

Console.WriteLine( "ISBN: {0}", book.GetISBN() );


Console.WriteLine( "Title: {0}", book.GetTitle() );

for( int j = 0; j < book.GetAuthorCount(); j++ )


{
Console.WriteLine( "Author: {0}", book.GetAuthorAt( j ) );
}
}
}

All member functions start with a capital letter.

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Code generation tips 543

20.5 Code generation tips


Out-of-memory exceptions during Java compilation and how to resolve them
Complex schemas can produce a large amount of code, which might cause a
java.lang.OutofMemory exception during compilation using Ant. To rectify this:

 Add the environment variable ANT_OPTS, which sets specific Ant options such as the
memory to be allocated to the compiler, and add values as shown below.

You may need to customize the values depending on the amount of memory in your machine
and the size of the project you are working with. For more details please see your Java VM
documentation.

Reserving method names


When customizing code generation using the supplied spl files, it might be necessary to reserve
names to avoid collisions with other symbols. To do this:

1. Navigate to subdirectory corresponding to the programming language of the spl


subdirectory of the program installation directory e.g. C:\Program Files\Altova\
XMLSpy2011\spl\java\.
2. Open the settings.spl file and insert a new line into the reserve section e.g. reserve
"myReservedWord".
3. Regenerate the program code.

XML Schema support


The following XML Schema constructs are translated into code:
 XML Namespaces: Mapped to namespaces in the target programming language

Simple types
 Built-in XML Schema types: Mapped to native primitive types or classes in the Altova
types library
 Derived by extension
 Derived by restriction
 Facets
 Enumerations
 Patterns

Complex types
 Built-in anyType node
 User-defined complex types
 Derived by extension: Mapped to derived classes
 Derived by restriction

© 2010 Altova GmbH User Manual


544 Code Generator Code generation tips

 Complex content
 Simple content
 Mixed content

The following advanced XML Schema features are not, or not fully supported in MapForce,
when generating optional wrapper classes:
 * Wildcards: xs:any and xs:anyAttribute
 Content models (sequence, choice, all): Top-level compositor available in SPL, but not
enforced by generated classes
 default and fixed values for attributes: Available in SPL, but not set or enforced by
generated classes
 attributes xsi:type, abstract types: SetXsiType methods are generated and need to be
called by the user
 Union types: Not all combinations are supported
 Substitution groups: Partial support (resolved like "choice")
 attribute nillable="true" and xsi:nil
 uniqueness constraints
 key and keyref

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Code generator options 545

20.6 Code generator options


The menu option DTD/Schema | Generate Program Code lets you specify the target
programming language as well as specific code generation settings.

C++ Settings tab:


This tab lets you define the settings for C++ and C# programming languages.
C++
 Microsoft Visual Studio 2010, 2008, 2005, Visual C++ 6.0 project file, or makefile for
Linux with GCC compiler.
 generate code using either MSXML 6.0 or Apache Xerces XML library
 generate static libraries, or Dynamic-link libraries
 generate code with or without MFC support

C# Settings tab:
C#
Select the type of project file you want to generate:
 Microsoft Visual Studio 2010, 2008, 2005, project file
 Mono Makefile support was removed in MapForce version 2011. Mono users can use
Visual Studio solution files with Mono's xbuild.

Compatibility Mode:
The code generator has been improved multiple times in the recent releases of Altova products,
sometimes in ways that require changes to the code that uses the generated libraries. To
preserve compatibility with existing code using libraries generated with earlier releases of
XMLSpy, you can set the compatibility mode to the desired release. Default is version 2007r3,
which creates the latest version of the code libraries.

 Please make it a point to use the new code generation features i.e., set the version to
the latest available.
 The availability of the Compatibility Mode is only temporary, it will be removed in a
future version.

© 2010 Altova GmbH User Manual


546 Code Generator The way to SPL (Spy Programming Language)

20.7 The way to SPL (Spy Programming Language)


This section gives an overview of Spy Programming Language, the code generator's template
language.

It is assumed that you have prior programming experience, and are familiar with operators,
functions, variables and classes, as well as the basics of object-oriented programming - which
is used heavily in SPL. You should also have detailed knowledge of XML Schema.

The templates used by XMLSpy are supplied in the ...\XMLSpy2011\spl folder. You can use
these files as an aid to help you in developing your own templates.

How code generator works


Inputs to the code generator are the template files (.spl) and the object model provided by
XMLSpy. The template files contain SPL instructions for creating files, reading information from
the object model and performing calculations, interspersed with literal code fragments in the
target programming language.

The template file is interpreted by the code generator and outputs .cpp, .java, .cs source code
files, project files, or any other type of file depending on the template. The source code can then
be compiled into an executable file that accesses XML data described by the schema file.

SPL files have access to a wide variety of information that is collated from the source schemas.
Please note that an SPL file is not tied to a specific schema, but allows access to all schemas!
Make sure you write your SPL files generically, avoid structures etc. which apply to specific
schemas!

Example: Creating a new file in SPL:


[create "test.cpp"]
#include "stdafx.h"
[close]

This is a very basic SPL file. It creates a file named test.cpp, and places the include statement
within it. The close command completes the template.

20.7.1 Basic SPL structure


An SPL file contains literal text to output, interspersed with code generator instructions.

Code generator instructions are enclosed in square brackets '[' and ']'.
Multiple statements can be included in a bracket pair. Additional statements have to be
separated by a new line or a colon ':'.

Valid examples are:


[$x = 42
$x = $x + 1]

or

[$x = 42: $x = $x + 1]

Adding text to files


Text not enclosed by [ and ], is written directly to the current output file. If there is no current
output file, the text is ignored (see Using files how to create an output file).
To output literal square brackets, escape them with a backslash: \[ and \]; to output a backslash
use \\.

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator The way to SPL (Spy Programming Language) 547

Comments
Comments inside an instruction block always begin with a ' character, and terminate on the next
line, or at a block close character ].

20.7.2 Declarations
The following statements are evaluated while parsing the SPL template file. They are not
affected by flow control statements like conditions, loops or subroutines, and are always
evaluated exactly once.
These keywords, like all keywords in SPL, are not case sensitive.
Remember that all of these declarations must be inside a block delimited by square brackets.

map mapname key to value [, key to value ]...


This statement adds information to a map. See below for specific uses.

map schemanativetype schematype to typespec

The specified built-in XML Schema type will be mapped to the specified native type or class,
using the specified formatter. This setting applies only to code generation for version 2007r3
and higher. Typespec is a native type or class name, followed by a comma, followed by the
formatter class instance.

Example:
map schemanativetype "double" to "double,Altova::DoubleFormatter"

map type schematype to classname


The specified built-in XML Schema type will be mapped to the specified class. This setting
applies only to code generation for version 2007 or lower.

Example:
map type "float" to "CSchemaFloat"

default setting is value


This statement allows you to affect how class and member names are derived from the XML
Schema.
Note that the setting names are case sensitive.

Example:
default "InvalidCharReplacement" is "_"

Setting name Explanation


ValidFirstCharSet Allowed characters for starting an identifier
ValidCharSet Allowed characters for other characters in an identifier
InvalidCharReplac The character that will replace all characters in names that are not in the
ement ValidCharSet
AnonTypePrefix Prefix for names of anonymous types*
AnonTypeSuffix Suffix for names of anonymous types*
ClassNamePrefix Prefix for generated class names
ClassNameSuffix Suffix for generated class names
EnumerationPrefix Prefix for symbolic constants declared for enumeration values

© 2010 Altova GmbH User Manual


548 Code Generator The way to SPL (Spy Programming Language)

EnumerationUpper "on" to convert the enumeration constant names to upper case


Case
FallbackName If a name consists only of characters that are not in ValidCharSet, use this
one

* Names of anonymous types are built from AnonTypePrefix + element name + AnonTypeSuffix

reserve word
Adds the specified word to the list of reserved words. This ensures that it will never be
generated as a class or member name.

Example:
reserve "while"

include filename
Example:
include "Module.cpp"

includes the specified file as SPL source. This allows you to split your template into multiple files
for easier editing and handling.

20.7.3 Variables
Any non-trivial SPL file will require variables. Some variables are predefined by the code
generator, and new variables may be created simply by assigning values to them.

The $ character is used when declaring or using a variable, a variable name is always prefixed
by $.
Variable names are case sensitive.

Variables types:
 integer - also used as boolean, where 0 is false and everything else is true
 string
 object - provided by XMLSpy
 iterator - see foreach statement

Variable types are declared by first assignment:


[$x = 0]
x is now an integer.

[$x = "teststring"]
x is now treated as a string.

Strings
String constants are always enclosed in double quotes, like in the example above. \n and \t
inside double quotes are interpreted as newline and tab, \" is a literal double quote, and \\ is a
backslash. String constants can also span multiple lines.

String concatenation uses the & character:


[$BasePath = $outputpath & "/" & $JavaPackageDir]

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator The way to SPL (Spy Programming Language) 549

Objects
Objects represent the information contained in the XML schema. Objects have properties,
which can be accessed using the . operator. It is not possible to create new objects in SPL (they
are predefined by the code generator, derived from the input schema), but it is possible to
assign objects to variables.

Example:
class [=$class.Name]

This example outputs the word "class", followed by a space and the value of the Name property
of the $class object.

20.7.4 Predefined variables


After a Schema file is analyzed by the code generator, the objects in the table below exist in the
Template Engine.

Current object model (for code compatibility to version 2007r3 and later)

Name Type Description


$schematype integer 1 for DTD, 2 for XML Schema
$TheLibrary Library The library derived from the XML Schema or DTD
$module string name of the source Schema without extension
$outputpath string The output path specified by the user, or the default
output path

Old object model (for code compatibility up to version 2007)

Name Type Description


$schematype integer 1 for DTD, 2 for XML Schema
$namespaces Namespace collection Collection of Namespace objects
$classes Class collection All the complex types, elements,… in a flat view
$module string name of the source Schema without extension
$outputpath string The output path specified by the user, or the default
output path

For C++ generation only:


Name Type Description
$domtype integer 1 for MSXML, 2 for Xerces
$XercesVersion integer 2 for Xerces 2.x, 3 for Xerces 3.x
$libtype integer 1 for static LIB, 2 for DLL
$mfc boolean True if MFC support is enabled
$vc6project boolean True if Visual C++ 6.0 project files are to be generated
$VS2005Project boolean True if Visual C++ 2005 project files are to be generated
$VS2008Project boolean True if Visual C++ 2008 project files are to be generated
$VS2010Project boolean True if Visual C++ 2010 project files are to be generated

For C# generation only:


Name Type Description

© 2010 Altova GmbH User Manual


550 Code Generator The way to SPL (Spy Programming Language)

$CreateVS2005Project boolean True if Visual Studio 2005 project files are to be


generated
$CreateVS2008Project boolean True if Visual Studio 2008 project files are to be
generated
$CreateVS2010Project boolean True if Visual Studio 2010 project files are to be
generated

20.7.5 Creating output files


These statements are used to create output files from the code generation.
Remember that all of these statements must be inside a block delimited by square brackets.

create filename
creates a new file. The file has to be closed with the close statement. All following output is
written to the specified file.

Example:
[create $outputpath & "/" & $JavaPackageDir & "/" & $application.Name &
".java"]
package [=$JavaPackageName];

public class [=$application.Name]Application {


...
}
[close]

close
closes the current output file.

=$variable
writes the value of the specified variable to the current output file.

Example:
[$x = 20+3]
The result of your calculation is [=$x] - so have a nice day!
- The file output will be:
The result of your calculation is 23 - so have a nice day!

write string
writes the string to the current output file.

Example:
[write "C" & $name]

This can also be written as:


C[=$name]

filecopy source to target


copies the source file to the target file, without any interpretation.

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator The way to SPL (Spy Programming Language) 551

Example:
filecopy "java/mapforce/mapforce.png" to $outputpath & "/" & $JavaPackageDir &
"/mapforce.png"

20.7.6 Operators
Operators in SPL work like in most other programming languages.

List of SPL operators in descending precedence order:

. Access object property


( ) Expression grouping
true boolean constant "true"
false boolean constant "false"

& String concatenation

- Sign for negative number


not Logical negation

* Multiply
/ Divide
% Modulo

+ Add
- Subtract

<= Less than or equal


< Less than
>= Greater than or equal
> Greater than

= Equal
<> Not equal

and Logical conjunction (with short circuit evaluation)


or Logical disjunction (with short circuit evaluation)

= Assignment

20.7.7 Conditions
SPL allows you to use standard "if" statements. The syntax is as follows:

if condition
statements
else
statements
endif

or, without else:


if condition
statements
endif

Please note that there are no round brackets enclosing the condition!

© 2010 Altova GmbH User Manual


552 Code Generator The way to SPL (Spy Programming Language)

As in any other programming language, conditions are constructed with logical and comparison
operators.

Example:
[if $namespace.ContainsPublicClasses and $namespace.Prefix <> ""]
whatever you want ['inserts whatever you want, in the resulting file]
[endif]

Switch
SPL also contains a multiple choice statement.

Syntax:
switch $variable
case X:
statements
case Y:
case Z:
statements
default:
statements
endswitch

The case labels must be constants or variables.


The switch statement in SPL does not fall through the cases (as in C), so there is no need for a
"break" statement.

20.7.8 foreach
Collections and iterators
A collection contains multiple objects - like a ordinary array. Iterators solve the problem of
storing and incrementing array indexes when accessing objects.

Syntax:
foreach iterator in collection
statements
next

Example:
[foreach $class in $classes
if not $class.IsInternal
] class [=$class.Name];
[ endif
next]

The first line:


$classes is the global object of all generated types. It is a collection of single class objects.

Foreach steps through all the items in $classes, and executes the code following the
instruction, up to the next statement, for each of them.

In each iteration, $class is assigned to the next class object. You simply work with the class
object instead of using, classes[i]->Name(), as you would in C++.

All collection iterators have the following additional properties:


Index The current index, starting with 0
IsFirst true if the current object is the first of the collection (index is 0)
IsLast true if the current object is the last of the collection

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator The way to SPL (Spy Programming Language) 553

Current The current object (this is implicit if not specified and can be left out)

Example:
[foreach $enum in $facet.Enumeration
if not $enum.IsFirst
], [
endif
]"[=$enum.Value]"[
next]

20.7.9 Subroutines
Code generator supports subroutines in the form of procedures or functions.

Features:
 By-value and by-reference passing of values
 Local/global parameters (local within subroutines)
 Local variables
 Recursive invocation (subroutines may call themselves)

Subroutine declaration
Subroutines

Syntax example:
Sub SimpleSub()
... lines of code
EndSub

 Sub is the keyword that denotes the procedure.


 SimpleSub is the name assigned to the subroutine.
 Round parenthesis can contain a parameter list.
 The code block of a subroutine starts immediately after the closing parameter
parenthesis.
 EndSub denotes the end of the code block.

Please note:
Recursive or cascaded subroutine declaration is not permitted, i.e. a subroutine may
not contain another subroutine.

Parameters
Parameters can also be passed by procedures using the following syntax:
 All parameters must be variables
 Variables must be prefixed by the $ character
 Local variables are defined in a subroutine
 Global variables are declared explicitly, outside of subroutines
 Multiple parameters are separated by the comma character "," within round
parentheses
 Parameters can pass values

Parameters - passing values


Parameters can be passed in two ways, by value and by reference, using the keywords ByVal

© 2010 Altova GmbH User Manual


554 Code Generator The way to SPL (Spy Programming Language)

and ByRef respectively.

Syntax:
' define sub CompleteSub()
[Sub CompleteSub( $param, ByVal $paramByValue, ByRef $paramByRef )
] ...

 ByVal specifies that the parameter is passed by value. Note that most objects can only
be passed by reference.
 ByRef specifies that the parameter is passed by reference. This is the default if neither
ByVal nor ByRef is specified.

Function return values


To return a value from a subroutine, use the return statement. Such a function can be called
from within an expression.

Example:
' define a function
[Sub MakeQualifiedName( ByVal $namespacePrefix, ByVal $localName )
if $namespacePrefix = ""
return $localName
else
return $namespacePrefix & ":" & $localName
endif
EndSub
]

Subroutine invocation
Use call to invoke a subroutine, followed by the procedure name and parameters, if any.
Call SimpleSub()
or,
Call CompleteSub( "FirstParameter", $ParamByValue, $ParamByRef )

Function invocation
To invoke a function (any subroutine that contains a return statement), simply use its name
inside an expression. Do not use the call statement to call functions.
Example:
$QName = MakeQualifiedName($namespace, "entry")

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator The way to SPL (Spy Programming Language) 555

Subroutine example
Highlighted example showing subroutine declaration and invocation.

The same sample code:


[create $outputpath & $module & "output.txt"

' define sub SimpleSub()


Sub SimpleSub()
]SimpleSub() called
[endsub

' execute sub SimpleSub()


Call SimpleSub()

$ParamByValue = "Original Value"


]ParamByValue = [=$ParamByValue]
[$ParamByRef = "Original Value"
]ParamByRef = [=$ParamByRef]

' define sub CompleteSub()

© 2010 Altova GmbH User Manual


556 Code Generator The way to SPL (Spy Programming Language)

[Sub CompleteSub( $param, ByVal $paramByValue, ByRef $paramByRef )


]CompleteSub called.
param = [=$param]
paramByValue = [=$paramByValue]
paramByRef = [=$paramByRef]
[$ParamByRef = "Local Variable"
$paramByValue = "new value"
$paramByRef = "new value"
] Set values inside Sub
[$ParamByRef = "Local Variable"
$paramByValue = "new value"
$paramByRef = "new value"
]CompleteSub finished.
[endsub

' run sub CompleteSub()


Call CompleteSub( "FirstParameter", $ParamByValue, $ParamByRef )
]
ParamByValue=[=$ParamByValue]
ParamByRef=[=$ParamByRef]
[
Close
]

20.7.10 Built in Types


The section describes the properties of the built-in types used in the predefined variables which
describe the parsed schema.

Library
This object represents the whole library generated from the XML Schema or DTD.

Property Type Description


SchemaNamespaces Namespace Namespaces in this library
collection
SchemaFilename string Name of the XSD or DTD file this library is derived
from
SchemaType integer 1 for DTD, 2 for XML Schema
Guid string A globally unique ID
CodeName string Generated library name (derived from schema file
name)

Namespace
One namespace object per XML Schema namespace is generated. Schema components that
are not in any namespace are contained in a special namespace object with an empty
NamespaceURI.
Note that for DTD, namespaces are also derived from attributes whose names begin with
"xmlns".

Property Type Description


CodeName string Name for generated code (derived from prefix)
LocalName string Namespace prefix
NamespaceURI string Namespace URI
Types Type collection All types contained in this namespace
Library Library Library containing this namespace

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator The way to SPL (Spy Programming Language) 557

Type
This object represents a complex or simple type. It is used to generate a class in the target
language.
There is one additional type per library that represents the document, which has all possible root
elements as members.
Anonymous types have an empty LocalName.

Property Type Description


CodeName string Name for generated code (derived from local
name or parent declaration)
LocalName string Original name in the schema
Namespace Namespace Namespace containing this type
Attributes Member collection Attributes contained in this type*
Elements Member colleciton Child elements contained in this type
IsSimpleType boolean True for simple types, false for complex types
IsDerived boolean True if this type is derived from another type,
which is also represented by a Type object
IsDerivedByExtension boolean True if this type is derived by extension
IsDerivedByRestriction boolean True if this type is derived by restriction
IsDerivedByUnion boolean True if this type is derived by union
IsDerivedByList boolean True if this type is derived by list
BaseType Type The base type of this type (if IsDerived is true)
IsDocumentRootType boolean True if this type represents the document itself
Library Library Library containing this type
IsFinal boolean True if declared as final in the schema
IsMixed boolean True if this type can have mixed content
IsAbstract boolean True if this type is declared as abstract
IsGlobal boolean True if this type is declared globally in the
schema
IsAnonymous boolean True if this type is declared locally in an
element

For simple types only:

Property Type Description


IsNativeBound boolean True if native type binding exists
NativeBinding NativeBinding Native binding for this type
Facets Facets Facets of this type
Whitespace string Shortcut to the Whitespace facet

* Complex types with text content (these are types with mixed content and complexType with
simpleContent) have an additional unnamed attribute member that represents the text content.

Member
This object represents an attribute or element in the XML Schema. It is used to create class
members of types.

Property Type Description

© 2010 Altova GmbH User Manual


558 Code Generator The way to SPL (Spy Programming Language)

CodeName string Name for generated code (derived from local


name or parent declaration)
LocalName string Original name in the schema. Empty for the
special member representing text content of
complex types.
NamespaceURI string The namespace URI of this Element/Attribute
within XML instance documents/streams.
DeclaringType Type Type originally declaring the member (equal to
ContainingType for non-inherited members)
ContainingType Type Type where this is a member of
DataType Type Data type of this member's content
Library Library Library containing this member's DataType
IsAttribute boolean True for attributes, false for elements
IsOptional boolean True if minOccurs = 0 or optional attribute
IsRequired boolean True if minOccurs > 0 or required attribute
IsFixed boolean True for fixed attributes, value is in Default
property
IsDefault boolean True for attributes with default value, value is in
Default property
IsNillable boolean True for nillable elements
IsUseQualified boolean True if NamespaceURI is not empty
MinOccurs integer minOccurs, as in schema. 1 for required
attributes
MaxOccurs integer maxOccurs, as in schema. 0 for prohibited
attributes, -1 for unbounded
Default string Default value

NativeBinding
This object represents the binding of a simple type to a native type in the target programming
language, as specified by the "schemanativetype" map.

Property Type Description


ValueType string Native type
ValueHandler string Formatter class instance

Facets
This object represents all facets of a simple type.
Inherited facets are merged with the explicitly declared facets. If a Length facet is in effect,
MinLength and MaxLength are set to the same value.

Property Type Description


DeclaringType Type Type facets are declared on
Whitespace string "preserve", "collapse" or "replace"
MinLength integer Facet value
MaxLength integer Facet value
MinInclusive integer Facet value
MinExclusive integer Facet value
MaxInclusive integer Facet value

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator The way to SPL (Spy Programming Language) 559

MaxExclusive integer Facet value


TotalDigits integer Facet value
FractionDigits integer Facet value
List Facet collection All facets as list

Facet

This object represents a single facet with its computed value effective for a specific type.

Property Type Description


LocalName string Facet name
NamespaceURI string Facet namespace
FacetType string one of "normalization", "lexicalspace",
"valuespace-length", "valuespace-enum" or
"valuespace-range"
DeclaringType Type Type this facet is declared on
FacetCheckerName string Name of facet checker (from schemafacet
map)
FacetValue string or integer Actual value of this facet

Old object model (up to v2007)


The following objects are part of the old object model for code compatibility up to version 2007.
They will be removed in a future release.

Namespace
Namespace abstraction. This object is part of the old object model for code compatibility up to
version 2007.

Property Type Description


URI string The URI of this namespace
Prefix string The prefix of this namespace
ContainsPublicClasses boolean True if the Classes collection contains at least one
non-internal Class object
Classes Class collection Collection of the classes in this namespace - step
through them using foreach

Class
For every user-defined type declared in the schema (xsd) a class is generated. This object is
part of the old object model for code compatibility up to version 2007.

Property Type Description


HasNamespace boolean True, if there is an associated Namespace object
Namespace Namespace The Namespace object this Class object is part of
NamespacePrefix string Prefix of the namespace in which the class is
NamespaceURI string URI of the namespace in which the class is
Name string Name of the type in the resulting file

© 2010 Altova GmbH User Manual


560 Code Generator The way to SPL (Spy Programming Language)

SchemaName string Name of the type as in the original schema file


HasBaseObject boolean True if this type is derived from another type, which is
also represented by a Class object.
BaseObject Class The base Class object if HasBaseObject is true
BaseNamespaceURI string Namespace URI of the base class
Base string Name of the base class
SchemaBase string Name of the base type as in the original schema file
BuiltInBase string Name of the root simple type
BuiltInSchemaBase string Name of the root simple type as in the original
schema file
IsAbstract boolean True if this is an abstract type
IsSimpleType boolean True if this is a simple type
IsComplexFromSimpleTyp boolean True if this is a complex type and is derived from a
e simple type
IsComplexType boolean True if this is a complex type
IsSequence boolean True if the top-level group-type is "sequence"
IsChoice boolean True if the top-level group-type is "choice"
IsAll boolean True if the top-level group-type is "all"
Description string Description of this type. May contain line breaks.
IsGlobal boolean True if this type is declared globally in the schema
IsAnonymous boolean True if this type is declared locally in an element
IsInternal boolean True if this is the internal root pseudo-class that
contains all global classes as members
Members Member A class representing a complexType contains one or
collection more Members.
Facets Facet A class representing a simpleType or a complexType
collection derived from a simpleType may contain Facets.

Member
Abstraction of a member-variable inside a class. Members are created for all children of a
complex type. This object is part of the old object model for code compatibility up to version
2007.

Property Type Description


NamespaceURI string The namespace URI of this Element/Attribute within XML
instance documents/streams.
Name string Name in the resulting file
SchemaName string Name as in the original schema file
XmlName string The name as it is expected to appear in XML instance
documents/streams.
Type string The name of the class which represents the schema type
SchemaType string The schema type
TypeObject Class Generated class for this type. See explanation below *
HasTypeObject boolean True if TypeObject has a valid value
Description string Description of the Element/Attribute.
Can contain line feeds.

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator The way to SPL (Spy Programming Language) 561

IsBuiltinType boolean True if the type is a built-in schema type, e.g. string,
unsignedInt, dateTime... It is the negation of
HasTypeObject.
IsSimpleType boolean True if the type of this member is a simpleType
IsComplexFromSimpleTyp boolean True if the type of this member is a complex type and is
e derived from a simple type.
IsElement boolean True if this is an element
IsAttribute boolean True if this is an attribute
NodeType string "Element" or "Attribute"
MinOcc integer minOccurs, as in schema. 1 for required attributes
MaxOcc integer maxOccurs, as in schema. 0 for prohibited attributes
IsQualified boolean True if the form of the Element/Attribute is set to
"qualified".
IsMixed boolean True if this element can have mixed content
HasTextValue boolean True if this member can contain text
Default string The default value defined in the schema
Fixed string The fixed value defined in the schema

* TypeObject:
For every type declared in the schema (xsd) a class is generated. All elements inside a
complexType are generated as members of such classes. The types of these members can
either be built-in types or user-defined types:

Built-in XML Schema types have no TypeObject, because they are mapped to predefined
classes using the map type instruction.
For each member with a user-defined type, the TypeObject represents the class generated for
this type.

Example:

<xs:complexType name="TypeA">
<xs:sequence>
<xs:element name="B" type="TypeB"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="TypeB"/>

CodeGen would create two classes:

class TypeA
{
...
TypeB B;
}

class TypeB
{
...
}

Explanation:
When class "TypeA" is generated the member B is also generated. To find out the type of B,
use the "TypeObject" method of the element which returns the class "TypeB". So we can get the
name and use it there.

© 2010 Altova GmbH User Manual


562 Code Generator The way to SPL (Spy Programming Language)

Facet
This class consists of the constraint itself, and several boolean variables. This object is part of
the old object model for code compatibility up to version 2007.

The boolean variables tell you the kind of constraint you're currently dealing with. The names of
the Boolean variables are identical to those used in the schema specification.

Property Type Description


Constraint string Holds the value of the facet
IsLength boolean
IsMinLength boolean
IsMaxLength boolean
IsMinInclusive boolean
IsMinExclusive boolean
IsMaxInclusive boolean
IsMaxExclusive boolean
IsTotalDigits boolean
IsFractionDigits boolean
IsWhiteSpace boolean
IsPattern boolean
IsEnumeration boolean
Enumeration Enumeration collection Holds a collection of
Enumeration objects if this
facet is of type enumeration.
Pattern Pattern collection Holds a collection of
Enumeration objects if this
facet is of type pattern.

Enumeration
Abstraction of an enumeration entry inside a facet. This object is part of the old object model for
code compatibility up to version 2007.

Property Type Description


Index integer Holds the index of this enumeration
value, starting with 0
Value string Holds an enumeration value

Pattern
Abstraction of a pattern entry inside a facet. This object is part of the old object model for code
compatibility up to version 2007.

Property Type Description


Index integer Holds the index of this pattern
value, starting with 0
Value string Holds a pattern value

Altova XMLSpy 2011 © 2010 Altova GmbH


Code Generator Error Codes 563

20.8 Error Codes


Operating System Error Codes
201 File not found: '%s'
202 Cannot create file '%s'
203 Cannot open file '%s'
204 Cannot copy file '%s' to '%s'

Syntax Error Codes


401 Keyword expected
402 '%s' expected
403 No output file specified
404 Unexpected end of file
405 Keyword not allowed

Runtime Error Codes


501 Unknown variable '%s'
502 Redefinition of variable '%s'
503 Variable '%s' is not a container
504 Unknown property '%s'
505 Cannot convert from %s to %s
507 Unknown function
508 Function already defined
509 Invalid parameter
510 Division by zero
511 Unknown method
512 Incorrect number of parameters
513 Stack overflow

© 2010 Altova GmbH User Manual


564 User Reference

21 User Reference
The User Reference section contains a complete description of all XMLSpy menu commands
and explains their use in general. We have tried to be comprehensive. If, however, you have
questions which are not covered in the User Reference or other parts of this documentation,
please look up the FAQs and Discussion Forums on the Altova website. If you cannot find a
suitable answer at these locations, please do not hesitate to contact the Altova Support Center.

Standard Windows commands, such as (Open, Save, Cut, Copy and Paste) are in the File
and Edit menus. These menus additionally contain XML- and Internet-related commands.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference File Menu 565

21.1 File Menu


The File menu contains commands relevant to manipulating files, in the order common to most
Windows software products.

In addition to the standard New, Open, Save, Print, Print Setup, and Exit commands, XMLSpy
offers a range of XML- and application-specific commands.

21.1.1 New
Ctrl+N

The New command is used to create a new document. Clicking New opens the Create New
Document dialog, in which you can select the type of document you wish to create. If the
document type you wish to create is not listed, select XML and change the file extension when
you save the file. Note that you can add new file types to the list in this dialog using the Tools |
Options | File types tab.

© 2010 Altova GmbH User Manual


566 User Reference File Menu

Creating templates for new documents


You can create multiple templates for various file types. These templates can then be opened
directly from the Create New Document dialog and edited. To create your own template so that
it appears in the list of documents in the Create New Document dialog, you first create the
template document and then save it to the folder that contains all the templates.

Do the following:
1. Open the XMLSpy\Template folder using Windows Explorer or your preferred
navigation tool, and select a rudimentary template file from among the files named
new.xxx (where .xxx is a file extension, such as .xml and .xslt).
2. Open the file in XMLSpy, and modify the file as required. This file will be the template
file.
3. When you are done, select File | Save as... to save the file back to the \Template
folder with a suitable name, say my-xml.xml. You now have a template called
my-xml, which will appear in the list of files in the Create New Document dialog.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference File Menu 567

4. To open the template, select File | New, and then the template (my-xml, in this case).

Please note: To delete a template, delete the template file from the template folder.

Assigning a DTD/XML Schema to a new XML document


When you create a new document of a certain type that is based on a standard schema (DTD
or XML Schema), the document is automatically opened with the correct DTD or XML Schema
association. For example, an XHTML file will be opened with the DTD
http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd associated with it. And an
XML Schema (.xsd) file is associated with the http://www.w3.org/2001/XMLSchema
schema document.

If you are creating a new file for which the schema is not known (for example, an XML file), then
you are prompted to associate a schema (DTD or XML Schema) with the document that is to be
created.

If you choose to associate a DTD or XML Schema with your document, clicking OK in the New
File dialog enables you to browse for the schema. Clicking Cancel in this dialog will create a
new file that is not associated with any schema.

Specifying the document element of a new XML document

© 2010 Altova GmbH User Manual


568 User Reference File Menu

If you select an XML Schema, there can be more than one global element in it, all of which are
potential document (or root) elements. You can select which of these is to be the root element
of the XML document in the Select a Root Element dialog, which pops up if you select Schema
in the New File dialog and if the XML Schema has more than one global element.

The new XML document is created with this element as its document element.

Assigning a StyleVision Power Stylesheet when creating a new document


When a new XML document is created, you can associate a StyleVision Power Stylesheet (
.sps file) to view the document in Authentic View. In the Create New Document dialog (see
screenshot above), when you click the Select StyleVision Stylesheet, the Create New
Document dialog (shown below) appears.

You can browse for the required StyleVision Power Stylesheet in the folder tabs displayed in the
New dialog. Alternatively, you can click the Browse button to navigate for and select the
StyleVision Power Stylesheet. The tabs that appear in the New dialog correspond to folders in
the sps/Template folder of your application folder.

Creating new XBRL taxonomies with the XBRL Taxonomy Wizard


In the Create a New Document dialog, if XBRL Taxonomy Schema (.xsd) is selected, then a
wizard guides you through the steps for creating a new XBRL taxonomy. Ths wizard is
described in the XBRL section of the documentation.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference File Menu 569

21.1.2 Open
Ctrl+O

The Open command pops up the familiar Windows Open dialog, and allows you to open any
XML-related document or text document. In the Open dialog, you can select more than one file
to open. Use the Files of Type combo box to restrict the kind of files displayed in the dialog box.
(The list of available file types can be configured in the File Types tab of the Options dialog (
Tools | Options). When an XML file is opened, it is checked for well-formedness. If the file is
not well-formed, you will get a file-not-well-formed error. Fix the error and select the menu
command XML | Check Well-Formedness (F7) to recheck. If you have opted for automatic
validation upon opening and the file is invalid, you will get an error message. Fix the error and
select the menu command XML | Validate XML (F8) to revalidate.

Selecting files via URLs and Global Resources


In several File Open and File Save dialogs, you can choose to select the required file or save a
file via a URL or a global resource (see screenshot below). Select the Switch to URL or Switch
to Global Resource to go to one of these selection processes.

Selecting files via URLs


To select a file via a URL, do the following:

© 2010 Altova GmbH User Manual


570 User Reference File Menu

1. Click the Switch to URL command. This switches to the URL mode of the Open dialog
(screenshot below).

2. Enter the URL you want to access in the Server URL field (screenshot above). If the
server is a Microsoft® SharePoint® Server, check the Microsoft® SharePoint® Server
check box. See the Microsoft® SharePoint® Server Notes below for further information
about working with files on this type of server.
3. If the server is password protected, enter your User-ID and password in the User and
Password fields.
4. Click Browse to view and navigate the directory structure of the server.
5. In the folder tree, browse for the file you want to load and click it.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference File Menu 571

The file URL appears in the File URL field (screenshot above). The Open button only
becomes active at this point.
6. Click the Open button to load the file. The file you open appears in the main window.

Note: The Browse function is only available on servers which support WebDAV and on
Microsoft SharePoint Servers. The supported protocols are FTP, HTTP, and HTTPS.

Note: To give you more control over the loading process, you can choose to load the file
through the local cache or a proxy server (which considerably speeds up the process if
the file has been loaded before). Alternatively, you may want to reload the file if you are
working, say, with an electronic publishing or database system; select the Reload
option in this case

Microsoft® SharePoint® Server Notes


Note the following points about files on Microsoft® SharePoint® Servers:

 In the directory structure that appears in the Available Files pane (screenshot below),
file icons have symbols that indicate the check-in/check-out status of files.

© 2010 Altova GmbH User Manual


572 User Reference File Menu

Right-clicking a file pops up a context menu containing commands available for that file
(screenshot above).
 The various file icons are shown below:

Checked in. Available for check-out.

Checked out by another user. Not available for check-out.

Checked out locally. Can be edited and checked-in.

 After you check out a file, you can edit it in your Altova application and save it using File
| Save (Ctrl+S).
 You can check-in the edited file via the context menu in the Open URL dialog (see
screenshot above), or via the context menu that pops up when you click the file tab in
the Main Window of your application (screenshot below).

 When a file is checked out by another user, it is not available for check out.
 When a file is checked out locally by you, you can undo the check-out with the Undo
Check-Out command in the context menu. This has the effect of returning the file
unchanged to the server.
 If you check out a file in one Altova application, you cannot check it out in another
Altova application. The file is considered to be already checked out to you. The
available commands at this point in any Altova application supporting Microsoft®
SharePoint® Server will be: Check In and Undo Check Out.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference File Menu 573

Opening and saving files via Global Resources


To open or save a file via a global resources, click Switch to Global Resource. This pops up a
dialog in which you can select the global resource. These dialogs are described in the section,
Using Global Resources. For a general description of Global Resources, see the Global
Resources section in this documentation.

21.1.3 Reload

The Reload command allows you to reload open documents. This is useful if an open
document has been modified outside XMLSpy. If a modification occurs, XMLSpy asks whether
you wish to reload the file. If you reload, then any changes you may have made to the file since
the last save will be lost. This option can be changed in the Options dialog (Tools | Options).

21.1.4 Encoding
The Encoding command lets you view the current encoding of the active document (XML or
non-XML) and to select a different encoding with which the active document will be saved the
next time.

In XML documents, if you select a different encoding than the one in use before, the encoding
specification in the XML declaration will be adjusted accordingly. For two-byte and four-byte
character encodings (UTF-16, UCS-2, and UCS-4) you can also specify the byte-order to be
used for the file. Another way to change the encoding of an XML document is to directly edit the
encoding attribute of the document's XML declaration.

Default encodings for existing and new XML and non-XML documents can be set in the
Encoding tab of the Options dialog.

Note: When saving a document, XMLSpy automatically checks the encoding specification
and opens a dialog box if it cannot recognize the encoding entered by the user. Also, if
your document contains characters that cannot be represented in the selected
encoding, you will get a warning message when you save your file.

21.1.5 Close, Close All


The Close command closes the active document window. If the file was modified (indicated by
an asterisk * after the file name in the title bar), you will be asked if you wish to save the file
first.

© 2010 Altova GmbH User Manual


574 User Reference File Menu

The Close All command closes all open document windows. If any document has been
modified (indicated by an asterisk * after the file name in the title bar), you will be asked if you
wish to save the file first.

21.1.6 Save, Save As, Save All


The Save (Ctrl+S) command saves the contents of the active document to the file from
which it has been opened. When saving a document, the file is automatically checked for
well-formedness. The file will also be validated automatically if this option has been set in the
File tab of the Options dialog (Tools | Options). The XML declaration is also checked for the
encoding specification, and this encoding is applied to the document when the file is saved.

The Save As command pops up the familiar Windows Save As dialog box, in which you enter
the name and location of the file you wish to save the active file as. The same checks and
validations occur as for the Save command.

The Save All command saves all modifications that have been made to any open
documents. The command is useful if you edit multiple documents simultaneously. If a
document has not been saved before (for example, after being newly created), the Save As
dialog box is presented for that document.

Selecting files via URLs and Global Resources


In several File Open and File Save dialogs, you can choose to select the required file or save a
file via a URL or a global resource (see screenshot below). Select the Switch to URL or Switch
to Global Resource to go to one of these selection processes.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference File Menu 575

Selecting files via URLs


To select a file via a URL, do the following:
1. Click the Switch to URL command. This switches to the URL mode of the Open dialog
(screenshot below).

© 2010 Altova GmbH User Manual


576 User Reference File Menu

2. Enter the URL you want to access in the Server URL field (screenshot above). If the
server is a Microsoft® SharePoint® Server, check the Microsoft® SharePoint® Server
check box. See the Microsoft® SharePoint® Server Notes below for further information
about working with files on this type of server.
3. If the server is password protected, enter your User-ID and password in the User and
Password fields.
4. Click Browse to view and navigate the directory structure of the server.
5. In the folder tree, browse for the file you want to load and click it.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference File Menu 577

The file URL appears in the File URL field (screenshot above). The Open button only
becomes active at this point.
6. Click the Open button to load the file. The file you open appears in the main window.

Note: The Browse function is only available on servers which support WebDAV and on
Microsoft SharePoint Servers. The supported protocols are FTP, HTTP, and HTTPS.

Note: To give you more control over the loading process, you can choose to load the file
through the local cache or a proxy server (which considerably speeds up the process if
the file has been loaded before). Alternatively, you may want to reload the file if you are
working, say, with an electronic publishing or database system; select the Reload
option in this case

Microsoft® SharePoint® Server Notes


Note the following points about files on Microsoft® SharePoint® Servers:

 In the directory structure that appears in the Available Files pane (screenshot below),
file icons have symbols that indicate the check-in/check-out status of files.

© 2010 Altova GmbH User Manual


578 User Reference File Menu

Right-clicking a file pops up a context menu containing commands available for that file
(screenshot above).
 The various file icons are shown below:

Checked in. Available for check-out.

Checked out by another user. Not available for check-out.

Checked out locally. Can be edited and checked-in.

 After you check out a file, you can edit it in your Altova application and save it using File
| Save (Ctrl+S).
 You can check-in the edited file via the context menu in the Open URL dialog (see
screenshot above), or via the context menu that pops up when you click the file tab in
the Main Window of your application (screenshot below).

 When a file is checked out by another user, it is not available for check out.
 When a file is checked out locally by you, you can undo the check-out with the Undo
Check-Out command in the context menu. This has the effect of returning the file
unchanged to the server.
 If you check out a file in one Altova application, you cannot check it out in another
Altova application. The file is considered to be already checked out to you. The
available commands at this point in any Altova application supporting Microsoft®
SharePoint® Server will be: Check In and Undo Check Out.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference File Menu 579

Opening and saving files via Global Resources


To open or save a file via a global resources, click Switch to Global Resource. This pops up a
dialog in which you can select the global resource. These dialogs are described in the section,
Using Global Resources. For a general description of Global Resources, see the Global
Resources section in this documentation.

21.1.7 Send by Mail

The Send by Mail... command lets you send XML document/s or selections from an XML
document by e-mail. You can do any of the following:
 Send an XML document as an attachment or as the content of an e-mail.
 Send a selection in an XML document as an attachment or as the content of an e-mail.
 Send a group of files (selected in the Project Window) as an attachment to an e-mail.
 Send a URL (selected in the Project Window) as an attachment or as a link.

Please note: To use this function you must have a MAPI compliant e-mail system.

Sending documents and document fragments


To send an XML document:
1. Make that document the active document in the Main Window. If you wish to send a
selection or a group of files from a project, make the selection in the document or select
the required files in the Project.
2. Click Send by Mail.... The following dialog opens:

3. Make the required choices and click OK. The selected documents/contents/URLs are
attached to the e-mail or content is inserted into the e-mail.

Sending URLs by mail


To send one or more URLs, select the URLs in the Project Window, and click Send by Mail....
The following dialog opens:

Select how the URL is to be sent and click OK.

© 2010 Altova GmbH User Manual


580 User Reference File Menu

21.1.8 Print
Ctrl+P

The Print command opens the Print dialog box, in which you can select printer options. The
currently active document, as seen in the current view, can then be printed.

Clicking the Print command in Grid View opens a Print options dialog (screenshot below),
which enables you to set printing options for the XML document. Clicking Print in this dialog
takes you to the Print dialog for printer options.

The available options for Grid View printing are described below:
 In the Types pane, you select the items you wish to have appear in the output.
 For the What option, you specify whether the current selection or the entire file is to be
printed.
 The Expand option allows you to print the document as is, or with all descendant
elements expanded fully.
 The Contents option enables you to choose between printing contents of all nodes or
printing node names only.
 In the If Contents Are Wider Than Page pane, you select what to do if contents are
wider than the page. The Split Pages option prints the entire document at normal size,
splitting contents over pages both horizontally and vertically. The pages could then be
glued together to form a poster. The First Page option prints only the first, left-hand
page of the print area. The area that overflows horizontally is not printed. This option is
useful if most of the important information in your Grid View of the document is
contained on the left side. The Shrink Horizontally option reduces the size of the output
(proportionally) until it fits horizontally on the page; the document may run on for several
pages. The Shrink Both option shrinks the document in both directions until it fits
exactly on one sheet.
 The Print button prints the document with the selected options.
 The Preview button opens a print preview window that lets you view the final output
before committing it to paper.
 The Print Setup button opens the Print Setup dialog box and allows you to adjust the
paper format, orientation, and other printer options for this print job only. Also see the
Print Setup command.

Note: You can change column widths in Grid View to optimize the print output.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference File Menu 581

WSDL and XBRL designs


Graphical views of WSDL and XBRL documents, as seen on screen, can also be printed using
the Print command.

21.1.9 Print Preview, Print Setup


The Print Preview command opens the Print dialog box. Click the Preview button to display a
print preview of the currently active document. In Print Preview mode, the Print Preview toolbar
at top left of the preview window provides print- and preview-related options.

The preview can be magnified or miniaturized using the the Zoom In and Zoom Out buttons.
When the page magnification is such that an entire page length fits in a preview window, then
the One Page / Two Page button toggles the preview to one or two pages at a time. The Next
Page and Previous Page buttons can be used to navigate among the pages. The toolbar also
contains buttons to print all pages and to close the preview window.

The Print Setup command, displays the printer-specific Print Setup dialog box, in which you
specify such printer settings as paper format and page orientation. These settings are applied to
all subsequent print jobs.

The screenshot above shows the Print Setup dialog in which an HP LaserJet 4 printer attached
to a parallel port (LPT1) is selected.

21.1.10 Recent Files, Exit


The File menu displays a list of the nine most recently used files, with the most recently opened
file shown at the top of the list. You can open any of these files by clicking its name. To open a
file in the list using the keyboard, press ALT+F to open the File menu, and then press the
number of the file you want to open.

© 2010 Altova GmbH User Manual


582 User Reference File Menu

The Exit command is used to quit XMLSpy. If you have any open files with unsaved changes,
you are prompted to save these changes. XMLSpy also saves modifications to program settings
and information about the most recently used files.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Edit Menu 583

21.2 Edit Menu


The Edit menu contains commands for editing documents in XMLSpy.

In addition to the standard Undo, Redo, Cut, Copy, Paste, Delete, Select All, Find, Find next
and Replace commands, XMLSpy offers special commands to:
 copy the selection to the clipboard as XML-Text,
 copy as structured text
 copy an XPath selector to the selected item to the clipboard.
 insert and remove bookmarks, and to navigate to bookmarks.

© 2010 Altova GmbH User Manual


584 User Reference Edit Menu

21.2.1 Undo, Redo


The Undo (Ctrl+Z) command contains support for unlimited levels of Undo. Every action can
be undone and it is possible to undo one command after another. The Undo history is retained
after using the Save command, enabling you go back to the state the document was in before
you saved your changes.

The Redo (Ctrl+Y) command allows you to redo previously undone commands, thereby
giving you a complete history of work completed. You can step back and forward through this
history using the Undo and Redo commands.

21.2.2 Cut, Copy, Paste, Delete


The Cut (Shift+Del or Ctrl+X) command copies the selected text or items to the clipboard
and deletes them from their present location.

The Copy (Ctrl+C) command copies the selected text or items to the clipboard. This can
be used to duplicate data within XMLSpy or to move data to another application.

Please note: There are two different commands for copying elements to the clipboard in textual
form: Copy as XML-Text and Copy as Structured Text. You can use the Editing tab on the Tools
| Options dialog to choose which of these two operations should be performed when using the
copy command.

The Paste (Ctrl+V) command inserts the contents of the clipboard at the current cursor
position.

The Delete (Del) command deletes the currently selected text or items without placing
them in the clipboard.

21.2.3 Copy as XML-Text


The Copy as XML-Text command lets you exchange data easily with other products that allow
data manipulation on the XML source layer. While editing your document in Grid View, you may
occasionally want to copy some elements to the clipboard in their XML-Text representation:

<row>
<para align="left">
<bold>Check the FAQ</bold>
</para>
<para>
<link mode="internal">
<link_section>support</link_section>
<link_subsection>faq30</link_subsection>
<link_text>XMLSPY 4.0 FAQ</link_text>
</link>
<link mode="internal">
<link_section>support</link_section>
<link_subsection>faq25</link_subsection>
<link_text>XMLSPY 3.5 FAQ</link_text>

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Edit Menu 585

</link>
</para>
</row>

The Copy as XML-Text command automatically formats text using the currently active settings
for saving a file. These settings can be modified in the Save File section of the File tab of the
Options dialog (Tools | Options).

21.2.4 Copy as Structured Text


The Copy as Structured Text command copies elements to the clipboard as they appear on
screen. This command is useful for copying table-like data from Grid View. The copied data can
be used within XMLSpy as well as in third-party products, enabling you to transfer XML data to
spreadsheet-like applications (such as Microsoft Excel).

If you copy this table and paste it into Excel, the data will appear in the following way:

© 2010 Altova GmbH User Manual


586 User Reference Edit Menu

Please note: The results of this command depend on the way the information is currently laid
out on screen. For example, if the XML fragment used as an example for the Copy as XML-Text
command were in the Table View of Grid View, the copied text would result in the following:

In normal Grid View, the data copied to the clipboard would look as below.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Edit Menu 587

21.2.5 Insert File Path


The Insert File Path command is enabled in the Text View and Grid View of documents of any
file type. Using it, you can insert the path to a file at the cursor selection point. Clicking the
command pops up a dialog (screenshot below) in which you select the required file.

The required file can be selected in one of the following ways: (i) by browsing for the file, URL,
or global resource (use the Browse button); (ii) by selecting the window in which the file is open
(the Window button). When done, click OK. The path to the selected file will be inserted in the
active document at the cursor selection point.

21.2.6 Insert XInclude


The Edit | Insert XInclude command is available in Text View and Grid View, and enables you
to insert a new XInclude element at the cursor selection point in Text View, or before the
selected item in both Text View and Grid View. If in Grid View the current selection is an
attribute, the XInclude element is inserted after the attribute and before the first child element of
the attribute's parent element. Selecting this command pops up the XInclude dialog (screenshot
below).

The XML file to be included is entered in the href text box (alternatively, you can browse for the

© 2010 Altova GmbH User Manual


588 User Reference Edit Menu

file by clicking the Browse button to the right of the text box). The filename will be entered in the
XML document as the value of the href attribute. The encoding and parse attributes of the
XInclude element (xi:include), and the fallback child element of xi:include can also be
inserted via the dialog. Do this by first checking the appropriate check box and then selecting/
entering the required values.

Here is an example of an XML document that uses XInclude to include two XML documents:
<?xml version="1.0" encoding="UTF-16"?>
<AddressBook xsi:schemaLocation="http://www.altova.com/sv/myaddresses
AddressBook.xsd"
xmlns="http://www.altova.com/stylevision/tutorials/myaddresses"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xi="http://www.w3.org/2001/XInclude">
<xi:include href="BusinessAddressBook.xml"/>
<xi:include href="PersonalAddressBook.xml"/>
</AddressBook>

When this XML document is parsed, it will replace the two XInclude elements with the files
specified in the respective href attributes.

xml:base
When the XML validator of XMLSpy reads an XML document and encounters the include
element in the XInclude namespace (hereafter xi:include), it replaces this element (xi:
include) with the XML document named in the href attribute of the xi:include element. The
document element (root element) of the included XML document (or the element identified by
an XPointer) will be included with an attribute of xml:base in order to preserve the base URIs of
the included element. If the resulting XML document (containing the included XML document/s
or tree fragment/s) must be valid according to a schema, then the document element of the
included document (or the top-level element of the tree fragment) must be created with a
content model that allows an attribute of xml:base. If, according to the schema, the xml:base
attribute is not allowed on this element, then the resulting document will be invalid. How to
define an xml:base attribute in an element's content model using XMLSpy's Schema View is
described in the xml: Prefixed Attributes section of the Schema View section of the
documentation.

XPointers
XMLSpy supports XPointers in XInclude. The relevant W3C recommendations are the XPointer
Framework and XPointer element() Scheme recommendations. The use of an XPointer in an
XInclude element enables a specific part of the XML document to be included, instead of the
entire XML document. XPointers are used within an XInclude element as follows:

<xi:include href="PersonalAddressBook.xml" xpointer="element(usa)"/>


<xi:include href="BusinessAddressBook.xml" xpointer="element(/1/1)"/>
<xi:include href="BobsAddressBook.xml" xpointer="element(usa/3/1)"/>
<xi:include href="PatsAddressBook.xml" xpointer="
element(usa)element(/1/1)"/>

In the element() scheme of XPointer, an NCName or a child sequence directed by integers may
be used.
 In the first xi:include element listed above, the xpointer attribute uses the element
scheme with an NCName of usa. According to the XPointer Framework, this NCName
identifies the element that has an ID of usa.
 In the second xi:include listed above, the xpointer attribute with a value of element
(/1/1) identifies, in the first step, the first child element of the document root (which, if
the document is well-formed, will be its document (or root) element). In the second step,
the first child element of the element located in the previous step is located; in our

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Edit Menu 589

example, this would be the first child element of the document element.
 The xpointer attribute of the third xi:include listed above uses a combination of
NCName and child sequence. This XPointer locates the first child element of the third
child element of the element having an ID of usa.
 If you are not sure whether your first XPointer will work, you can back it up with a
second one as shown in the fourth xi:include listed above:
xpointer="element(usa)element(/1/1)". Here, if there is no element with an ID of
usa, the back-up XPointer specifies that the first child element of the document element
is to be selected. Additional backups are also allowed. Individual XPointers may not be
separated, or they may be separated by whitespace: for example,
xpointer="element(usa)element(addresses/1) element(/1/1)".

Note: The namespace binding context is not used in the element() scheme because the
element() scheme does not support qualified names.

21.2.7 Copy XPath


The Copy XPath command is available in Text View and Grid View, and creates an XPath
expression that selects the currently selected node/s and copies the expression to the
clipboard. This enables you to paste the expression into a document (for example, in an XSLT
document). All expressions start from the document root.

The XPath expression is resolved differently in Grid View and Text View. In Grid View, if a
single element is highlighted, the XPath expression will select not that specific element but all
elements of that name at that hierarchical level of the document. In Text View that specific
element is selected. For example, if an element called LastName of the third Person element of
the second Company element is selected, the XPath expressions would be as follows:
 Grid View: /Companies/Company/Person/LastName
 Text View: /Companies/Company[2]/Person[3]/LastName

Note: In Grid View the Copy XPath command can also be accessed via the context menu.

21.2.8 Copy XPointer


The Copy XPointer command is available in Text View and Grid View. It creates an element()
scheme XPointer for the currently selected node/s and copies it to the clipboard. This enables
you to paste the XPointer into a document (for example, in the xpointer attribute of an
XInclude element in an XML document).

The element() scheme of XPointer returns results in the form element(/1/3), which selects the
third child of the document element (or root element). You should note the following points:
 Attributes cannot be represented using the element() scheme. If an attribute is selected,
the following happens: In Grid View, the Copy XPointer command is disabled; in Text
View, the XPointer of the element "parent" of that attribute is generated.
 Multiple elements cannot be selected. If selected in Grid View, the Copy XPointer
command is disabled. In Text View, the XPointer of the parent element of the selection
is generated.

Note: In Grid View the Copy XPointer command can also be accessed via the context menu.

© 2010 Altova GmbH User Manual


590 User Reference Edit Menu

21.2.9 Pretty-Print XML Text

The Pretty-Print XML Text command reformats your XML document in Text View to give a
structured display of the document, indenting each deeper level in the hierarchy by an additional
amount of the specified indentation space. This enables a clearer view of the document
structure.

To switch on the pretty-printing option, check the Use Indentation check box in the View tab of
the Options dialog (Tools | Options). After pretty-printing has been switched on, clicking the
Pretty-Print XML Text command reformats the document with indentation that shows the
hierarchy. If the Use Indentation check box is unchecked, clicking the Pretty-Print XML Text
command causes all lines to be left-aligned.

The amount of indentation is specified in Tabs pane of the Text View Settings dialog.

Note: (1) The XML document must be well-formed for this command to work.
(2) Pretty-printing adds spaces or tabs to the document when the document is saved.
(3) If pretty-printing has been switched on (Tools | Options | View | Use Indentation)
and if you change from Text View to Grid View and back to Text View, then the
document will be pretty-printed automatically.

21.2.10 Select All


Ctrl+A

The Select All command selects the contents of the entire document.

21.2.11 Find, Find Next


The Find command (Ctrl+F) pops up the Find dialog, in which you can specify the string
you want to find and other options for the search. Depending on the view you are using, the Find
dialog displays different options. To find text, enter the text in the Find What text box or use the
combo box to select from one of the last 10 search criteria, and then specify the options for the
search.

Grid View
In Grid View, the following dialog box appears. The options available are described below.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Edit Menu 591

Select the options you require or select a radio button.


 The Types pane allows you to select what XML document nodes or components you
wish to include in the search. This enables you to skip particular node types. The Set All
button activates all the type check boxes; the Clear All button deactivates all the type
check boxes.
 The Search In pane allows you to define whether the names of a node, the contents of
a node, or both should be searched for the input text string.
 The Settings pane enables you to define whether the search should be case-sensitive
and/or match the entire input string.
 The Where pane allows you to define the scope of the search.
 The Direction option specifies the search direction.

Text View
In Text View, the following dialog box appears. The options available are described below.

The following Find options are available:


 Match whole word only: Only the exact words in the text will be matched. For example,
for the find string fit, with Match Whole Word checked, only the word fit will match
the find string; the fit in fitness, for example, would not.
 Match case: Case-sensitive search (Address is not the same as address).
 Regular expression: Searches for text specified by the regular expression you enter in
the text box. See Regular expressions for a description of regular expressions.

Clicking the Advanced button opens the Types pane (screenshot below), in which you can

© 2010 Altova GmbH User Manual


592 User Reference Edit Menu

select the type of node to search.

Please note:
 The Find dialog is modeless, which means that it can remain open while you continue
to use Text View. Pressing Enter while the dialog box is open, closes the dialog box. If
text is marked prior to opening the dialog box, then the marked text is automatically
inserted into the Find What text box.
 Once the Find dialog is closed, you can repeat the current search by pressing F3 for a
forward search, or Shift+F3 for a backward search.
 The unfold button to the right of the Find What combo box, opens a secondary window
which you can use to enter regular expressions.

Regular expressions
You can use regular expressions to further refine your search criteria. A pop-up list is available
to help you build regular expressions. To access this list, click the > button to the right of the
input field for the search term.

Clicking on the required expression description inserts the corresponding expression syntax in

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Edit Menu 593

the input field. Given below is a list of regular expression syntax characters.

. Matches any character. This is a placeholder for a single character.


\( Marks the start of a region for tagging a match.
\) Marks the end of a tagged region.
\n Where n is 1 through 9 refers to the first through ninth tagged region when
replacing. For example, if the search string was Fred\([1-9]\)XXX and the
replace string was Sam\1YYY, when applied to Fred2XXX this would
generate Sam2YYY.
\< Matches the start of a word.
\> Matches the end of a word.
\x Allows you to use a character x, that would otherwise have a special
meaning. For example, \[ would be interpreted as [ and not as the start of a
character set.
[...] Indicates a set of characters, for example, [abc] means any of the characters
a, b or c. You can also use ranges, for example [a-z] for any lower case
character.
[^...] The complement of the characters in the set. For example, [^A-Za-z] means
any character except an alphabetic character.
^ Matches the start of a line (unless used inside a set, see above).
$ Matches the end of a line. Example: A+$ to find one or more A's at end of
line.
* Matches 0 or more times.
For example, Sa*m matches Sm, Sam, Saam, Saaam and so on.
+ Matches 1 or more times.
For example, Sa+m matches Sam, Saam, Saaam and so on.

The Find Next command (F3) repeats the last Find command to search for the next
occurrence of the requested text.

21.2.12 Replace

Ctrl+H

The Replace command enables you to find and replace one text string with another text string.
It features the same options as the Find... command. Depending on the view you are using, the
Replace dialog displays different find options. You can replace each item individually, or you can
use the Replace All button to perform a global search-and-replace operation.

Grid View
The screenshot below shows the various find options.

© 2010 Altova GmbH User Manual


594 User Reference Edit Menu

These options are described in the Find... section.

Text view
In Text View, selecting the Replace... command opens the Find & Replace dialog shown below.
The options are the same as for the Find... dialog. The Replace In Selection only option carries
out the find and replace operation only within the text selection.

Clicking the Advanced button opens the Types options (see Find... for details).

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Edit Menu 595

Please note: When using the Replace all command, each replacement is recorded as a single
operation, so Replace all can be undone step-by-step.

21.2.13 Find in Files


The Find in Files command is a powerful way to find and replace text quickly among a large
number of files. Clicking the command pops up the Find in Files dialog (screenshot below). The
Find in Files command is different from the Find command in that it searches all the specified
locations for the Find string at once and executes replace actions at once. A report is then
displayed in the Find in Files output bar. In the case of the Find command, however, the user
enters the search string and goes through the (single) active document one found item at a
time.

© 2010 Altova GmbH User Manual


596 User Reference Edit Menu

Find criteria
There are two broad find criteria: (i) what to find, and (ii) where to look? For a description of how
to set the text that is to be searched (what to find), see the description of the Find command. If
the text entered in the Find What text box is a regular expression, then the Regular Expression
check box must be checked. An entry helper for regular expressions can be accessed by
clicking the button. The use of regular expressions for searching is explained in the section
about the Find command.

To specify what node types and parts of an XML document should be searched, check the
Advanced XML Search check box and then check the required node types.

You can specify what files should be searched by checking either the Only in Current File check
box or the Search on Disk check box. If you choose to search on disk, you can select a folder or
a project to search (after checking the Search On Disk check box). When a project folder is
selected, external folders added to the project can be skipped. The files to be searched can be
filtered by file extension and a star (xml* or xsl*, for example). The separator between two file
extensions can be a comma or a semi-colon (xml*;xsl*, for example). The star character can
also be used as a wildcard.

The instances of the Find string at all the search locations are listed in the Find in Files output
bar. Clicking on one of the listed items opens that file in Text View and highlights the item.

Replace

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Edit Menu 597

You should note that clicking the Replace button replaces all the instances of the Find string
with the Replace string. If Open Files On Replacing was checked in the Find in Files dialog,
then the file will be opened in Text View; otherwise the replacement is done silently. All the
replaced strings are listed in the Find in Files output bar. Clicking on one of the listed items
opens that file in Text View and highlights the item.

Note: Regular expressions are not supported in the Replace field.

21.2.14 Bookmark Commands


Insert/Remove Bookmark

The Insert/Remove Bookmark command (Ctrl+F2) inserts a bookmark at the current


cursor position, or removes the bookmark if the cursor is in a line that has been bookmarked
previously. This command is only available in Text View.

Bookmarked lines are displayed in one of the following ways:


 If the bookmarks margin has been enabled, then a solid blue ellipse appears to the left
of the text in the bookmark margin.
 If the bookmarks margin has not been enabled, then the complete line containing the
cursor is highlighted.

The F2 key cycles through all the bookmarks in the document.

Remove All Bookmarks


The Remove All Bookmarks command (Ctrl+Shift+F2) removes all the currently defined
bookmarks. This command is only available in Text View. Note that the Undo command does
not undo the effects of this command.

Goto Next Bookmark

The Goto Next Bookmark command (F2) places the text cursor at the beginning of the
next bookmarked line. This command is only available in the Text View.

Goto Previous Bookmark

The Goto Previous Bookmark command (Shift+F2) places the text cursor at the
beginning of the previous bookmarked line. This command is only available in the Text View.

21.2.15 Comment In/Out


The Comment In/Out command is available in Text View and is used to comment and
uncomment XML text fragments. Text in an XML document can be commented out using the
XML start-comment and end-comment delimiters, respectively <!-- and -->. In XMLSpy, these
comment delimiters can be easily inserted using the Comment In/Out menu command.

To comment out a block of text, select the text to be commented out and then select the
command Comment In/Out, either from the Edit menu or the context menu that you get on
right-clicking the selected text. The commented text will be grayed out (see screenshot below).

© 2010 Altova GmbH User Manual


598 User Reference Edit Menu

To uncomment a commented block of text, select the commented block excluding the
comment delimiters, and select the command Comment In/Out, either from the Edit menu or
the context menu that you get on right-clicking the selected text. The comment delimiters will be
removed and the text will no longer be grayed out.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Project Menu 599

21.3 Project Menu


XMLSpy uses the familiar tree view to manage multiple files or URLs in XML projects. Files and
URLs can be grouped into folders by common extension or any arbitrary criteria, allowing for
easy structuring and batch manipulation.

Please note: Most project-related commands are also available in the context menu, which
appears when you right-click any item in the project window.

Absolute and relative paths


Each project is saved as a project file, and has the .spp extension. These files are actually
XML documents that you can edit like any regular XML File. In the project file, absolute paths
are used for files/folders on the same level or higher, and relative paths for files/folders in the
current folder or in sub-folders. For example, if your directory structure looks like this:

|-Folder1
| |

© 2010 Altova GmbH User Manual


600 User Reference Project Menu

| |-Folder2
| |
| |-Folder3
| |
| |-Folder4

If your .spp file is located in Folder3, then references to files in Folder1 and Folder2 will
look something like this:
c:\Folder1\NameOfFile.ext
c:\Folder1\Folder2\NameOfFile.ext

References to files in Folder3 and Folder4 will look something like this:
.\NameOfFile.ext
.\Folder4\NameOfFile.ext

If you wish to ensure that all paths will be relative, save the .spp files in the root directory of
your working disk.

Drag-and-drop
In the Project window, a folder can be dragged to another folder or to another location within the
same folder. A file can be dragged to another folder, but cannot be moved within the same
folder (within which files are arranged alphabetically). Additionally, files and folders can be
dragged from Windows File Explorer to the Project window.

Global resources in the context menu


When you right-click a folder in the Project window, in the context menu that appears, you can
select the Add Global Resource menu item to add a global resource. The menu command
itself pops up the Choose Global Resource dialog, which lists all the file-type and folder-type
global resources in the currently active Global Resources XML File. Select the required global
resource, and it will be added to the selected project folder.

Projects and source control providers


If you intend to add an XMLSpy project to a source control repository, please ensure that the
project files position in the hierarchical file system structure is one which enables you to add
files only from below it (taking the root directory to be the top of the directory tree).

In other words, the directory where the project file is located, essentially represents the root
directory of the project within the source control repository. Files added from above it (the
project root directory) will be added to the XMLSpy project, but their location in the repository
may be an unexpected one—if they are allowed to be placed there at all.

For example, given the directory structure show above, if a project file is saved in Folder3 and
placed under source control:
 Files added to Folder1 may not be placed under source control,
 Files added to Folder2 are added to the root directory of the repository, instead of to the
project folder, but are still under source control,
 Files located in Folder3 and Folder4 work as expected, and are placed under source
control.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Project Menu 601

21.3.1 New Project

The New Project command creates a new project in XMLSpy. If you are currently working with
another project, a prompt appears asking if you want to close all documents belonging to the
current project.

21.3.2 Open Project

The Open Project... command opens an existing project in XMLSpy. If you are currently
working with another project, the previous project is closed first.

21.3.3 Reload Project

The Reload Project command reloads the current project from disk. If you are working in a
multi-user environment, it can sometimes become necessary to reload the project from disk,
because other users might have made changes to the project.

Please note: Project files (.spp files) are actually XML documents that you can edit like any
regular XML File.

21.3.4 Close Project


The Close Project command closes the active project. If the project has been modified, you
will be asked whether you want to save the project first. When a project is modified in any way,
an asterisk is added to the project name in the Project Window's title bar.

21.3.5 Save Project

The Save Project command saves the current project. You can also save a project by making
the project window active and clicking the icon.

21.3.6 Source Control


XMLSpy now supports Microsoft SourceSafe and other compatible repositories. The Source
Control Systems supported by XMLSpy are listed in the section Supported Source Control
SystemsSystems. How to install is described in the section, Installing Source Control Systems.
This section describes the commands in the Project | Source Control submenu, which are
used to work with the Source Control System from within XMLSpy.

For more information, see the section, Source Control.

© 2010 Altova GmbH User Manual


602 User Reference Project Menu

Note: A source control project is not the same as a XMLSpy project. Source control projects
are directory dependent, whereas XMLSpyAuthentic Desktop projects are logical
constructions without direct directory dependence.

Open from Source Control


The Open from Source Control command creates an existing source control project locally.
This command can take effect only if an XMLSpy project has previously been added to source
control using the menu option Add to Source Control.

1. Select Project | Source Control | Open from Source Control. Enter your login details
in the Login dialog that appears.
2. The Create Local Project from SourceSafe dialog box appears (screenshot below).
Select the folder to contain the local project. This folder becomes the Working Folder or
Checkout Folder.

3. Select the source control project you want to download. If the folder you define does not
exist at the location, a dialog box opens prompting you to create it there. Click Yes to
confirm the new directory. The Open dialog now pops up (screenshot below).

4. Click the project file you want to create and click Open. The file opens in XMLSpy, and
the file is placed under source control. That it is under source control is indicated by the
lock symbol on the file icon in the Projects folder.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Project Menu 603

Source control symbols


Folders and files display certain symbols, the meanings of which are given below.

Checked in. Available for check-out.

Checked out by another user. Not available for check-out.

Checked out locally. Can be edited and checked-in.

Enable Source Control


The Enable Source Control command allows you to enable or disable source control for a
XMLSpy project. Selecting this option on any file or folder, enables/disables source control for
the whole project.

Enabling Source Control for a project


To enable source control for a project, do the following:
1. Click on any file or folder in the Project window.
2. Select the menu option Project | Source Control | Enable Source Code Control. The
previous check in/out status of the various files are retrieved and displayed in the
Project window.

Disabling Source Control for a project


To disable source control for a project, select the menu option Project | Source Control |
Enable Source Code Control. You are now prompted if you want to remove the binding
information from the project (see screenshot below).

To provisionally disable source control for the project select No. To permanently disable source
control for the project select Yes.

Get Latest Version


The Get Latest Version command retrieves and places the latest source control version of the
selected file(s) in the working directory. The files are retrieved as read-only and are not checked
out. No further options are available when using this command.

To get the latest version of a file, do the following:


1. Select the file(s) you want to get the latest version of in the Model Tree.
2. Select Project | Source Control | Get Latest Version.

© 2010 Altova GmbH User Manual


604 User Reference Project Menu

Get
The Get command retrieves read-only copies of the selected files and places them in the
working folder. By default, the files are not checked-out for editing. To get a file, select it in the
Project window (multiple files can be selected) and then select the Get command. This pops up
the Get dialog (screenshot below). Check the files you want to get.

Overwrite changed files check box


Overwrites those files that have been changed locally with those from the source control
database.

Select All
Selects all the files in the list box.

Advanced
Allows you to define the Replace writable and Set timestamp options in the respective combo
boxes.

The Make writable check box removes the read-only attribute of the retrieved files.

Get Folders
The Get Folders command retrieves read-only copies of files in the selected folders and places
them in the working folder. By default, the files are not checked-out for editing. To get a folder, s
elect it in the Project window and then select the Get Folders command. This pops up the Get
Folders dialog (screenshot below). Check the foldersyou want to get.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Project Menu 605

Overwrite changed files check box


Overwrites those files that have been changed locally with those from the source control
database.

Recursive (get tree) check box


Retrieves all files of the folder tree below the selected folder.

Select All
Selects all the files in the list box.

Advanced
Allows you to define the Replace writable and Set timestamp options in the respective combo
boxes.

The Make writable check box removes the read-only attribute of the retrieved files.

Check Out
The Check Out command checks out the latest version of the selected files and places writable
copies in the working directory. The files are flagged as checked out for all other users. To
check out files, do the following:
1. Select the file or folder you want to check out in the Model Tree.
2. Select Project | Source Control | Check Out.
3. In the Check Out dialog that pops up, select the files to check out, then click OK.

Note the following points:


 You can change the number of files to check out by activating the individual check

© 2010 Altova GmbH User Manual


606 User Reference Project Menu

boxes in the Files list box.


 The Checkout local version option checks out only the local versions of files, not those
from the source control database.
 The following items can be checked out: (i) single files (click on the required files; in the
Project window, Ctrl+Click); (ii) folders (click on the required folders; in the Project
window, Ctrl+Click).
 Checked out files and folders are indicated with a red check mark.

Advanced
Allows you to define the Replace writable and Set timestamp options in the respective combo
boxes.

The Make writable check box removes the read-only attribute of the retrieved files.

Check In
The Check In command checks in previously checked out files (that is, your locally updated
files) and places them in the source control database. To check in files, do the following:
1. Select the files in the Model Tree.
2. Select Project | Source Control | Check In.
3. In the Check In dialog that pops up, select the files to check in, then click OK.

Note the following points:


 As a shortcut for the Check In command, right-click a checked out item in the project
window and select Check In from the context menu.
 The following items can be checked in: (i) single files (click on the required files; in the
Project window, Ctrl+Click); (ii) folders (click on the required folders; in the Project
window, Ctrl+Click).

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Project Menu 607

 The lock symbol denotes that the file/folder is under source control, but is currently not
checked out.
 The Differences button is enabled when a line in the Files pane is selected. Clicking it
enables you to see differences between two file versions.

Undo Check Out


The Undo Check Out command rejects changes made to previously checked out files (that is,
your locally updated files) and retains the old files from the source control database. To undo a
check out, do the following:
1. Select the files in the Project window.
2. Select Project | Source Control | Undo Check Out.
3. In the Undo Check Out dialog that pops up, select the files for which check out should
be undone, then click OK.

Check out of the following items can be undone: (i) single files (click on the required files; in the
Project window, Ctrl+Click); (ii) folders (click on the required folders; in the Project window,
Ctrl+Click).

Advanced
Allows you to define the Replace writable and Set timestamp options in the respective combo
boxes.

The Make writable check box removes the read-only attribute of the retrieved files.

© 2010 Altova GmbH User Manual


608 User Reference Project Menu

Add to Source Control


The Add to Source Control command adds the selected files in a project folder to the source
control database and places them under source control. To add files to source control, do the
following:
1. In the Project window, right-click a file and select the menu option Project | Source
Control | Add to Source Control. If you select a folder
2. You will be prompted for a directory location where the file should be saved. Specify a
location and click OK.
3. In the Add to Source Control dialog that pops up, ensure that the files to be added are
checked. If the file to be added should be kept checked out, check the Keep checked
out check box. Then click OK.

The lock symbol now appears next to each of the files placed under source control. If
the files are checked out they will be shown with a red check symbol.

Remove from Source Control


The Remove from Source Control command removes previously added files from the source
control database. These files will be visible in the Project window but cannot be checked in or
out. Use the Add to Source Control command to place them back under source control. To
remove files from the source control provider, do the following:
1. In the Project window, select the files you wish to remove.
2. Select Project | Source Control | Remove from Source Control.
3. In the Remove from Source Control dialog that pops up, select the files to remove, then
click OK.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Project Menu 609

The following items can be removed from source control: (i) single files (click on the required
files; in the Project window, Ctrl+Click); (ii) folders (click on the required folders; in the Project
window, Ctrl+Click).

Share from Source Control


To use the Share from Source Control command you must have the Check in/out rights to the
project you are sharing from. To share a file from source control, do the following:
1. In the Project window, select the file you want to share and select Project | Source
Control | Share from Source Control.
2. In the Projects list, select the project folder that contains the file you want to share.

3. In the Files to share list box, select the file you want to share and click the Share
button. The file will be removed from the Files to share list.
4. Click the Close button to continue.

Branch after share


The Branch After Share option shares the file and creates a new branch to create a separate
version.

© 2010 Altova GmbH User Manual


610 User Reference Project Menu

Show History
The Show History command displays the history of a file under source control and allows you
to view detailed history info of previous versions of a file, view differences and retrieve previous
versions of the file. To show the history of a file, do the following:
1. Click on the file in the Project window.
2. Select the menu option Project | Source control | Show History. A dialog box
prompting for more information may appear (this example uses MS Source-Safe).

3. Select the appropriate entries and confirm with OK.

This dialog box provides various way of comparing and getting specific versions of the
file in question. Double-clicking an entry in the list opens the History Details dialog box
for that file. The buttons in the dialog provide the following functionality:
 Close: closes this dialog box.
 View: opens a further dialog box in which you can select the type of viewer with
which you wish to see the file.
 Details: opens a dialog box in which you can see the properties of the currently
active file.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Project Menu 611

 Get: allows you to retrieve one of the previous versions of the file in the version list
and place it in the working directory.
 Check Out: allows you to check out a previous version of the file.
 Diff: opens the Difference options dialog box, which allows you to define the
difference options when viewing the differences between two file versions. Use
CTRL+Click to mark two file versions in this window, then click Diff to view the
differences between them.
 Pin: pins or unpins a version of the file, allowing you to define the specific file version
to use when differencing two files.
 Rollback: rolls back to the selected version of the file.
 Report: Generates a history report which you can send to the printer, file, or
clipboard.
 Help: opens the online help of the source control provider plugin.

Show Differences
The Show Differences command displays the differences between the file currently in the
source control repository and the checked in/out file of the same name in the working
directory. If you have "pinned" one of the files in the history dialog box, then the pinned file will
be used in the "Compare" text box. Any two files can be selected using the Browse buttons.

To show the differences between two files, do the following:


1. Check out a file from your project. Click on the file in the project window.
2. Select the menu option Project | Source control | Show Differences. A dialog box
prompting for more information may appear at this time.

3. Select the appropriate entries and confirm with OK.

© 2010 Altova GmbH User Manual


612 User Reference Project Menu

The differences between the two files are highlighted in both windows (this example
uses MS Source-Safe).

Show Properties
The Show Properties command displays the properties of the currently selected file (
screenshot below). The properties displayed depends on the source control provider you use.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Project Menu 613

Note that this command can only be used on single files.

Refresh Status
The Refresh Status command refreshes the status of all project files independent of their
current status.

Source Control Manager


The Source Control Manager command starts your source control software with its native user
interface.

Change Source Control


The Change Source Control command pops up the Change Source Control dialog box (
screenshot below), which enables you to change the source control provider that you are using.
Click the Unbind button first, then click the Select button to select the new source control
provider.

© 2010 Altova GmbH User Manual


614 User Reference Project Menu

21.3.7 Add Files to Project

The Project | Add Files to Project... command adds files to the current project. Use this
command to add files to any folder in your project. You can either select a single file or any
group of files (using Ctrl+ click) in the Open dialog box. If you are adding files to the project,
they will be distributed among the respective folders based on the File Type Extensions defined
in the Project Properties dialog box.

21.3.8 Add Global Resource to Project


The Project | Add Global Resource to Project... command pops up the Choose Global
Resource dialog, in which you can select a global resource of file or folder type to add to the
project. If a file-type global resource is selected, then the file is added to the appropriate folder
based on the File Type Extensions defined in the Project Properties dialog box. If a folder-type
global resource is selected, that folder will be opened in a file-open dialog and you will be
prompted to select a file; the selected file is added to the appropriate folder based on the File
Type Extensions defined in the Project Properties dialog box. For a description of global
resources, see the Global Resources section in this documentation.

21.3.9 Add URL to Project

The Project | Add URL to Project... command adds a URL to the current project. URLs in a
project cause the target object of the URL to be included in the project. Whenever a batch
operation is performed on a URL or on a folder that contains a URL object, XMLSpy retrieves
the document from the URL, and performs the requested operation.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Project Menu 615

21.3.10 Add Active File to Project

The Project | Add Active File to Project command adds the active file to the current project. If
you have just opened a file from your hard disk or through an URL, you can add the file to the
current project using this command.

21.3.11 Add Active And Related Files to Project

The Project | Add Active and Related Files to Project command adds the currently active
XML document and all related files to the project. When working on an XML document that is
based on a DTD or Schema, this command adds not only the XML document but also all
related files (for example, the DTD and all external parsed entities to which the DTD refers) to
the current project.

Please note: Files referenced by processing instructions (such as XSLT files) are not
considered to be related files.

21.3.12 Add Project Folder to Project

The Project | Add Project Folder to Project... command adds a new folder to the current
project. Use this command to add a new folder to the current project or a sub-folder to a project
folder. You can also access this command from the context-menu when you right-click on a
folder in the project window.

Note: A project folder can be dragged and dropped into another project folder or to any other
location in the project. Also, a folder can be dragged from Windows (File) Explorer and
dropped into any project folder.

21.3.13 Add External Folder to Project


The Project | Add External Folder to Project command adds a new external folder to the
current project. Use this command to add a local or network folder to the current project. You
can also access this command from the context-menu when you right-click a folder in the
project window.
Please note: Files contained in external folders cannot be placed under source control.

Adding external folders to projects


To add an external folder to the project:
1. Select the menu option Project | Add External Folder to Project.
2. Select the folder you want to include from the Browse for Folder dialog box, and click
OK to confirm.

© 2010 Altova GmbH User Manual


616 User Reference Project Menu

The selected folder now appears in the project window.

3. Click the plus icon to view the folder contents.

Filtering contents of folders


To filter the contents of the folder:
1. Right-click the local folder, and select the popup menu option Properties. This opens
the Properties dialog box.

2. Click in the File extensions field and enter the file extensions of the file types you want
to see. You can separate each file type with a semicolon to define multiple types (XML

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Project Menu 617

and Schema XSDs in this example).


3. Click OK to confirm.

The Project window now only shows the XML and XSD files of the tutorial folder.

Validating external folders


To validate and check an external folder for well-formedness:
1. Select the file types you want to see or check from the external folder,

2. Click the folder and click the Check well-formedness or Validate icon
(hotkeys F7 or F8). All the files visible under the folder are checked.

If a file is malformed or invalid, then this file is opened in the Main Window, allowing you
to edit it. In this case the CompanyLast file is opened because the PhoneExt value does
not match the facet defined in the underlying schema file. This schema only allows
two-digit numbers.

3. Correct the error and restart the process to recheck the rest of the folder.

Please note: You can select discontinuous files in the folder, by holding down CTRL and

© 2010 Altova GmbH User Manual


618 User Reference Project Menu

clicking the files singly. Only these files are then checked when you click F7 or F8.

Updating a project folder


You might add or delete files in the local or network directory at any time. To update the folder
view,
 Right-click the external folder, and select the popup menu option Refresh external
folder.

Deleting files or folders:


 Right-click a folder and press the Delete key to delete the folder from the Project
window. This only deletes the folder from the Project view, and does not delete anything
on your hard disk or network.
 Right-clicking a single file and pressing Delete does not delete a file from the Project
window. You have to delete it physically and then Refresh the external folder contents.

Note: A project folder can be dragged and dropped into another project folder or to any other
location in the project. Also, a folder can be dragged from Windows (File) Explorer and
dropped into any project folder.

21.3.14 Add External Web Folder to Project


This command adds a new external web folder to the current project. You can also access this
command from the context-menu when you right-click a folder in the project window. Note that
files contained in external folders cannot be placed under source control.

Adding an external web folder to the project


To add an external web folder to the project, do the following:
1. Select the menu option Project | Add External Web Folder to Project. This opens the
Add Web Folder to Project dialog box (screenshot below).

2. Click in the Server URL field and enter the URL of the server URL. If the server is a
Microsoft® SharePoint® Server, check this option. See the Folders on a Microsoft®

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Project Menu 619

SharePoint® Server section below for further information about working with files on
this type of server.
3. If the server is password-protected, enter your User ID and password in the User and
Password fields.
4. Click Browse to connect to the server and view the available folders.

4. Click the folder you want to add to the project view. The Open button only becomes
active once you do this. The URL of the folder now appears in the File URL field.
5. Click Open to add the folder to the project.

6. Click the plus icon to view the folder contents.

© 2010 Altova GmbH User Manual


620 User Reference Project Menu

Filtering folder contents


To filter the contents of a folder, right-click the folder and select Properties from the context
menu. In the Properties dialog that pops up, click in the File Extensions field and enter the file
extensions of the file types you want to see (for example, XML and XSD files). Separate each
file type with a semicolon (for example: xml; xsd; sps). The Project window will now show that
folder only with files having the specified extension.

Validating and checking a folder for well-formedness


To check the files in a folder for well-formedness or to validate them, select the folder and then

click the Check well-formedness or Validate icon (hotkeys F7 or F8, respectively).


All the files that are visible in the folder are checked. If a file is malformed or invalid, then this
file is opened in the main window, allowing you to edit it. Correct the error and restart the
process to recheck the rest of the folder. Note that you can select discontinuous files in the
folder by holding Ctrl and clicking the files singly. Only these files are then checked when you
click F7 or F8.

Updating the contents of the project folder


Files may be added or deleted from the web folder at any time. To update the folder view,
right-click the external folder and select the context menu option Refresh.

Deleting folders and files


Since it is the Web folder that has been added to the project, it is only the Web folder (and not
files within it) that can be deleted from the project. You can delete a Web folder from a project,
by either (i) right-clicking the folder and selecting Delete, or (ii) selecting the folder and pressing
the Delete key. This only deletes the folder from the Project view; it does not delete anything on
the web server.

Note: Right-clicking a single file and pressing the Delete key does not delete a file from the
Project window. You have to delete it physically on the server and then refresh the
contents of the external folder.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Project Menu 621

Folders on a Microsoft® SharePoint® Server


When a folder on a Microsoft® SharePoint® Server has been added to a project, files in the
folder can be checked out and checked in via commands in the context menu of the file listing
in the Project window (see screenshot below). To access these commands, right-click the file
you wish to work with and select the command you want (Check Out, Check In, Undo Check
Out).

The User ID and password can be saved in the properties of individual folders in the project,
thereby enabling you to skip the verification process each time the server is accessed.

In the Project window (screenshot below), file icons have symbols that indicate the check-in/
check-out status of files. The various file icons are shown below:

Checked in. Available for check-out.

Checked out by another user. Not available for check-out.

Checked out locally. Can be edited and checked-in.

The following points should be noted:


 After you check out a file, you can edit it in your Altova application and save it using File
| Save (Ctrl+S).
 You can check-in the edited file via the context menu in the Open URL dialog (see
screenshot above), or via the context menu that pops up when you click the file tab in
the Main Window of your application (screenshot below).

 When a file is checked out by another user, it is not available for check out.
 When a file is checked out locally by you, you can undo the check-out with the Undo
Check-Out command in the context menu. This has the effect of returning the file
unchanged to the server.®®
 If you check out a file in one Altova application, you cannot check it out in another
Altova application. The file is considered to be already checked out to you. The
available commands at this point in any Altova application supporting Microsoft®
SharePoint® Server will be: Check In and Undo Check Out.

© 2010 Altova GmbH User Manual


622 User Reference Project Menu

21.3.15 Script Settings


A scripting project is assigned to an XMLSpy project as follows:
1. In the XMLSpy GUI, open the required application project.
2. Select the menu command Project | Script Settings. The Scripting dialog (screenshot
below) opens.

3. Check the Activate Project Scripts check box and select the required scripting project (
.asprj file). If you wish to run Auto-Macros when the XMLSpy project is loaded, check
the Run Auto-Macros check box.
4. Click OK to finish.

Note: To deactivate (that is, unassign) the scripting project of an XMLSpy project, uncheck
the Activate Project Scripts check box.

21.3.16 Properties

The Project | Project Properties command lets you define important settings for any of the
specific folders in your project.

To define the Project Properties for a folder:


1. Right-click on the folder you want to define the properties for.
2. Select the Properties... command from the context menu.

Please note:
If your project file is under source control, a prompt appears asking if you want to check
out the project file (*.spp). Click OK if you want to edit settings and be able to save
them.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Project Menu 623

The files specified in the Use this xxx entry will take precedence over any local assignment
directly within the XML file. For example, the OrgChart.xsl file (in the Use this XSL entry),
will always be used when transforming any of the XML files in the XML Files folder. Also, such
specified files for individual folders take precedence over files specified for ancestor folders.

File extensions
The File extensions help to determine the automatic file-to-folder distribution that occurs when
you add new files to the project (as opposed as to one particular folder).

User ID and password for external folders


Among the properties of external folders (including external Web folders) you can save the User
ID and password that might be required for accessing the server.

Validate
Define the DTD or Schema document that should be used to validate all files in the current
folder (Main Pages in this example).

XSL transformation of XML files


You can define the XSL Stylesheet to be used for XSL Transformation of all files in the folder.

If you are developing XSL Stylesheets yourself, you can also assign an example XML document
to be used to preview the XSL Stylesheet in response to an XSL Transformation command
issued from the stylesheet document, instead of the XML instance document.

XSL:FO transformation of XML files


You can define the XSL Stylesheet, containing XSL:FO markup, to be used for XSL:FO

© 2010 Altova GmbH User Manual


624 User Reference Project Menu

Transformation of all files in the folder.

Destination files of XSL transformation


For batch XSL Transformations, you can define the destination directory the transformed files
should be placed in.

If you have added one file or URL to more than one folder in your project, you can use the
Properties dialog to set the default folder whose settings should be used when you choose to
validate or transform the file in non-batch mode. To do this, use the Use settings in current
folder as default check box (see screenshot).

To access the Properties dialog and check this check box:


1. Copy an XML file in a project to a different folder.
2. Right-click the copied file in the Project window and select Properties from the context
menu.

Authentic View
The "Use config." option allows you to select a StyleVision Power Stylesheet (SPS file) when
editing XML files using Authentic View, in the current folder. After you have associated the
schema, SPS, and XML files with each other, and entered them in a project, changing the
location of any of the files could cause errors among the associations.

To avoid such errors, it is best to finalize the locations of your schema, SPS, and XML files
before associating them with each other and assigning them to a project.

21.3.17 Most Recently Used Projects


This command displays the file name and path for the nine most recently used projects,
allowing quick access to these files.

Also note, that XMLSpy can automatically open the last project that you used, whenever you
start XMLSpy. (Tools | Options | File tab, Project | Open last project on program start).

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XML Menu 625

21.4 XML Menu


The XML menu contains commands commonly used when working with XML documents. You
will find commands to insert or append elements, modify the element hierarchy, set a
namespace prefix, as well as to evaluate XPaths in the context of individual XML documents.

Among the most frequently used XML tasks are checks for the well-formedness of documents
and validity of XML documents. Commands for these tasks are in this menu.

21.4.1 Insert
The XML | Insert command, though enabled in all views, can be used in Grid View only. It has a
submenu (see screenshot) with which you can insert:
 The XML declaration and node types (Attribute, Element, Text, CDATA, Comment,
Processing Instruction) in XML documents;
 DOCTYPE declarations and external DTD declarations in XML documents;
 DTD declarations (ELEMENT, ATTLIST, ENTITY, and NOTATION) in DTD documents
and internal DTD declarations of XML documents.

© 2010 Altova GmbH User Manual


626 User Reference XML Menu

Insert Attribute

Ctrl+Shift+I

The XML | Insert | Attribute command is available in Grid View only, and inserts a new
attribute before the selected item. An inserted attribute may appear a few lines before the
current item in Grid View. This is because attributes immediately follow their parent element in
Grid View and precede all child elements of that parent element.

Insert Element

Ctrl+Shift+E

The XML | Insert | Element command is available in Grid View only, and inserts a new element
before the selected item. If the current selection is an attribute, the new element is before the
first child element of the attribute's parent element.

Insert Text

Ctrl+Shift+T

The XML | Insert | Text command is available in Grid View only, and inserts a new text row
before the selected item. If the current selection is an attribute, the text row is inserted after the
attribute and before the first child element of the attribute's parent element.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XML Menu 627

Insert CDATA

Ctrl+Shift+D

The XML | Insert | Cdata command is available in Grid View only, and inserts a new CDATA
block before the selected item. If the current selection is an attribute, the CDATA block is
inserted after the attribute and before the first child element of the attribute's parent element.

Insert Comment

Ctrl+Shift+M

The XML | Insert | Comment command is available in Grid View only, and inserts a new
comment before the selected item. If the current selection is an attribute, the new comment row
is inserted after the attribute and before the first child element of the attribute's parent element.

Insert XML

The XML | Insert | XML command is available in Grid View only, and inserts a row for the XML
declaration before the selected item. You must insert the child attributes of the XML declaration
and the values of this attribute. An XML declaration must look something like this:
<?xml version="1.0" encoding="UTF-8"?>

Please note: Since an XML document may only contain one XML declaration at the very top of
the file, this command should only be used with the topmost row selected and if an XML
declaration does not already exist.

Insert Processing Instruction

The XML | Insert | Processing Instruction command is available in Grid View only, and inserts
a new processing instruction (PI) before the selected item. If the current selection is an
attribute, the PI is inserted after the attribute and before the first child element of the attribute's
parent element.

Insert XInclude

The XML | Insert | XInclude command is available in Grid View only, and enables you to insert
a new XInclude element before the selected item. If the current selection is an attribute, the
XInclude element is inserted after the attribute and before the first child element of the
attribute's parent element. Selecting this command pops up the XInclude dialog (screenshot
below).

© 2010 Altova GmbH User Manual


628 User Reference XML Menu

The XML file to be included is entered in the href text box (alternatively, you can browse for the
file by clicking the Browse button to the right of the text box). The filename will be entered in the
XML document as the value of the href attribute. The encoding and parse attributes of the
XInclude element (xi:include), and the fallback child element of xi:include can also be
inserted via the dialog. Do this by first checking the appropriate check box and then selecting/
entering the required values.

Here is an example of an XML document that uses XInclude to include two XML documents:
<?xml version="1.0" encoding="UTF-16"?>
<AddressBook xsi:schemaLocation="http://www.altova.com/sv/myaddresses
AddressBook.xsd"
xmlns="http://www.altova.com/stylevision/tutorials/myaddresses"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xi="http://www.w3.org/2001/XInclude">
<xi:include href="BusinessAddressBook.xml"/>
<xi:include href="PersonalAddressBook.xml"/>
</AddressBook>

When this XML document is parsed, it will replace the two XInclude elements with the files
specified in the respective href attributes.

xml:base
When the XML validator of XMLSpy reads an XML document and encounters the include
element in the XInclude namespace (hereafter xi:include), it replaces this element (xi:
include) with the XML document named in the href attribute of the xi:include element. The
document element (root element) of the included XML document (or the element identified by
an XPointer) will be included with an attribute of xml:base in order to preserve the base URIs of
the included element. If the resulting XML document (containing the included XML document/s
or tree fragment/s) must be valid according to a schema, then the document element of the
included document (or the top-level element of the tree fragment) must be created with a
content model that allows an attribute of xml:base. If, according to the schema, the xml:base
attribute is not allowed on this element, then the resulting document will be invalid. How to
define an xml:base attribute in an element's content model using XMLSpy's Schema View is

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XML Menu 629

described in the xml: Prefixed Attributes section of the Schema View section of the
documentation.

XPointers
XMLSpy supports XPointers in XInclude. The relevant W3C recommendations are the XPointer
Framework and XPointer element() Scheme recommendations. The use of an XPointer in an
XInclude element enables a specific part of the XML document to be included, instead of the
entire XML document. XPointers are used within an XInclude element as follows:

<xi:include href="PersonalAddressBook.xml" xpointer="element(usa)"/>


<xi:include href="BusinessAddressBook.xml" xpointer="element(/1/1)"/>
<xi:include href="BobsAddressBook.xml" xpointer="element(usa/3/1)"/>
<xi:include href="PatsAddressBook.xml" xpointer="
element(usa)element(/1/1)"/>

In the element() scheme of XPointer, an NCName or a child sequence directed by integers may
be used.
 In the first xi:include element listed above, the xpointer attribute uses the element
scheme with an NCName of usa. According to the XPointer Framework, this NCName
identifies the element that has an ID of usa.
 In the second xi:include listed above, the xpointer attribute with a value of element
(/1/1) identifies, in the first step, the first child element of the document root (which, if
the document is well-formed, will be its document (or root) element). In the second step,
the first child element of the element located in the previous step is located; in our
example, this would be the first child element of the document element.
 The xpointer attribute of the third xi:include listed above uses a combination of
NCName and child sequence. This XPointer locates the first child element of the third
child element of the element having an ID of usa.
 If you are not sure whether your first XPointer will work, you can back it up with a
second one as shown in the fourth xi:include listed above:
xpointer="element(usa)element(/1/1)". Here, if there is no element with an ID of
usa, the back-up XPointer specifies that the first child element of the document element
is to be selected. Additional backups are also allowed. Individual XPointers may not be
separated, or they may be separated by whitespace: for example,
xpointer="element(usa)element(addresses/1) element(/1/1)".

Note: The namespace binding context is not used in the element() scheme because the
element() scheme does not support qualified names.

Insert DOCTYPE

The XML | Insert | DOCTYPE command is available in the Grid View of an XML file when a
top-level node is selected. It appends a DOCTYPE declaration at the top of the XML document.
You must enter the name of the DOCTYPE, and this name must be the same as the name of
the document element.

After you have entered the name of the DOCTYPE, you can enter the declarations you wish to
use in the internal DTD subset.

© 2010 Altova GmbH User Manual


630 User Reference XML Menu

Please note:
 A DOCTYPE declaration may only appear between the XML declaration and the XML
document element.
 You could use the Assign DTD command instead to create a DOCTYPE statement that
refers to an external DTD document.

Insert ExternalID

A DOCTYPE declaration in an XML file can contain a reference to an external resource


containing DTD declarations. This resource is referenced either through a public or system
identifier. For example:
<!DOCTYPE doc_element_name PUBLIC "publicID" "systemID">
<!DOCTYPE doc_element_name SYSTEM "systemID">

A system identifier is a URI that identifies the external resource. A public identifier is
location-independent and can be used to dereference the location of an external resource. For
example, in your XMLSpy installation, URIs for popular DTDs and XML Schemas are listed in
the catalog files named catalog.xml in the various schema folders in C:\Program
Files\Altova\Common2011\Schemas\. A public identifier in an XML document can be used to
dereference a DTD listed in these catalog files.

The XML | Insert | ExternalID command is available when a "child" item of the DOCTYPE
declaration in an XML file is selected in Grid View. This command inserts a Grid View row for an
external identifier (PUBLIC or SYSTEM). You must enter the type of identifier and its value.

The Text View corresponding to the screenshot of the Grid View shown above looks something
like this:
<!DOCTYPE OrgChart SYSTEM "orgchart.dtd" [
<!ELEMENT name (#PCDATA)>
]>

Please note: A row for External-ID can be added as a child when the DOCTYPE item is
selected, or it can be inserted or appended when one of the child items of the DOCTYPE item is
selected, for example, the ELEMENT declaration name in the example above.

Insert ELEMENT

The XML | Insert | ELEMENT command is available in Grid View only, for DTD documents or
when an item in the DOCTYPE declaration of an XML document is selected. It inserts an
ELEMENT declaration before the selected declaration.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XML Menu 631

Insert ATTLIST

The XML | Insert | ATTLIST command is available in Grid View only, for DTD documents or
when an item in the DOCTYPE declaration of an XML document is selected. It inserts an
ATTLIST declaration before the selected declaration.

Insert ENTITY

The XML | Insert | ENTITY command is available in Grid View only, for DTD documents or
when an item in the DOCTYPE declaration of an XML document is selected. It inserts an
ENTITY declaration before the selected declaration.

Insert NOTATION

The XML | Insert | NOTATION command is available in Grid View only, for DTD documents or
when an item in the DOCTYPE declaration of an XML document is selected. It inserts a
NOTATION declaration before the selected declaration.

21.4.2 Append
The XML | Append command, though enabled in all views, can be used in Grid View only. It
opens a submenu (see screenshot) with which you can append:
 The XML declaration and node types (Attribute, Element, Text, CDATA, Comment,
Processing Instruction) in XML documents;
 DOCTYPE declarations and external DTD declarations in XML documents
 DTD declarations (ELEMENT, ATTLIST, ENTITY, and NOTATION) in DTD documents
and internal DTD declarations of XML documents.

© 2010 Altova GmbH User Manual


632 User Reference XML Menu

Append Attribute

Ctrl+I

The XML | Append | Attribute command is available in Grid View only, and appends a new
attribute.

Append Element

Ctrl+E

The XML | Append | Element command is available in Grid View only, and appends an
element node after the last sibling element of the selected element. If an attribute node is
selected, then the element node is appended after the last child of the selected attribute's
parent element.

Append Text

Ctrl+T

The XML | Append | Text command is available in Grid View only, and appends a text block
after the last sibling element of the selected element. If an attribute node is selected, then the
text block is appended after the last child of the selected attribute's parent element.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XML Menu 633

Append CDATA

Ctrl+D

The XML | Append | Cdata command is available in Grid View only, and appends a CDATA
node after the last sibling of any selected node other than an attribute node. If an attribute node
is selected, then the CDATA section is appended after the last child of the selected attribute's
parent element.

Append Comment

Ctrl+M

The XML | Append | Comment command is available in Grid View only, and appends a
comment node after the last sibling of any selected node other than an attribute node. If an
attribute node is selected, then the comment node is appended after the last child of the
selected attribute's parent element.

Append XML

The XML | Append | XML command inserts a new XML declaration <?xml version="1.0"
encoding="UTF-8"?> as the first item in a document.

Please note: An XML document may contain only one XML declaration, which must appear at
the very top of the file.

Append Processing Instruction

The XML | Append | Processing Instruction command is available in Grid View only, and
appends a processing instruction node after the last sibling of any selected node other than an
attribute node. If an attribute node is selected, then the comment node is appended after the
last child of the selected attribute's parent element.

Append XInclude

The XML | Append | XInclude command is available in Grid View only, and enables you to
append an XInclude element after the last sibling of any selected node other than an attribute
node. If the current selection is an attribute, the XInclude element is appended after the the last
child of the selected attribute's parent element. Selecting this command pops up the XInclude
dialog (screenshot below).

© 2010 Altova GmbH User Manual


634 User Reference XML Menu

The XML file to be included is entered in the href text box (alternatively, you can browse for the
file by clicking the Browse button to the right of the text box). The filename will be entered in the
XML document as the value of the href attribute. The encoding and parse attributes of the
XInclude element (xi:include), and the fallback child element of xi:include can also be
inserted via the dialog. Do this by first checking the appropriate check box and then selecting/
entering the required values.

Here is an example of an XML document that uses XInclude to include two XML documents:
<?xml version="1.0" encoding="UTF-16"?>
<AddressBook xsi:schemaLocation="http://www.altova.com/sv/myaddresses
AddressBook.xsd"
xmlns="http://www.altova.com/stylevision/tutorials/myaddresses"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xi="http://www.w3.org/2001/XInclude">
<xi:include href="BusinessAddressBook.xml"/>
<xi:include href="PersonalAddressBook.xml"/>
</AddressBook>

When this XML document is parsed, it will replace the two XInclude elements with the files
specified in the respective href attributes.

xml:base
When the XML validator of XMLSpy reads an XML document and encounters the include
element in the XInclude namespace (hereafter xi:include), it replaces this element (xi:
include) with the XML document named in the href attribute of the xi:include element. The
document element (root element) of the included XML document (or the element identified by
an XPointer) will be included with an attribute of xml:base in order to preserve the base URIs of
the included element. If the resulting XML document (containing the included XML document/s
or tree fragment/s) must be valid according to a schema, then the document element of the
included document (or the top-level element of the tree fragment) must be created with a
content model that allows an attribute of xml:base. If, according to the schema, the xml:base
attribute is not allowed on this element, then the resulting document will be invalid. How to
define an xml:base attribute in an element's content model using XMLSpy's Schema View is
described in the xml: Prefixed Attributes section of the Schema View section of the

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XML Menu 635

documentation.

XPointers
XMLSpy supports XPointers in XInclude. The relevant W3C recommendations are the XPointer
Framework and XPointer element() Scheme recommendations. The use of an XPointer in an
XInclude element enables a specific part of the XML document to be included, instead of the
entire XML document. XPointers are used within an XInclude element as follows:

<xi:include href="PersonalAddressBook.xml" xpointer="element(usa)"/>


<xi:include href="BusinessAddressBook.xml" xpointer="element(/1/1)"/>
<xi:include href="BobsAddressBook.xml" xpointer="element(usa/3/1)"/>
<xi:include href="PatsAddressBook.xml" xpointer="
element(usa)element(/1/1)"/>

In the element() scheme of XPointer, an NCName or a child sequence directed by integers may
be used.
 In the first xi:include element listed above, the xpointer attribute uses the element
scheme with an NCName of usa. According to the XPointer Framework, this NCName
identifies the element that has an ID of usa.
 In the second xi:include listed above, the xpointer attribute with a value of element
(/1/1) identifies, in the first step, the first child element of the document root (which, if
the document is well-formed, will be its document (or root) element). In the second step,
the first child element of the element located in the previous step is located; in our
example, this would be the first child element of the document element.
 The xpointer attribute of the third xi:include listed above uses a combination of
NCName and child sequence. This XPointer locates the first child element of the third
child element of the element having an ID of usa.
 If you are not sure whether your first XPointer will work, you can back it up with a
second one as shown in the fourth xi:include listed above:
xpointer="element(usa)element(/1/1)". Here, if there is no element with an ID of
usa, the back-up XPointer specifies that the first child element of the document element
is to be selected. Additional backups are also allowed. Individual XPointers may not be
separated, or they may be separated by whitespace: for example,
xpointer="element(usa)element(addresses/1) element(/1/1)".

Note: The namespace binding context is not used in the element() scheme because the
element() scheme does not support qualified names.

Append DOCTYPE

The XML | Append | DOCTYPE command is available in the Grid View of an XML file when a
top-level node is selected. It appends a DOCTYPE declaration at the top of the XML document.
You must enter the name of the DOCTYPE, and this name must be the same as the name of
the document element.

After you have entered the name of the DOCTYPE, you can enter the declarations you wish to
use in the internal DTD subset.

Please note:

© 2010 Altova GmbH User Manual


636 User Reference XML Menu

 A DOCTYPE declaration may only appear between the XML declaration and the XML
document element.
 You could use the Assign DTD command instead to create a DOCTYPE statement that
refers to an external DTD document.

Append ExternalID

A DOCTYPE declaration in an XML file can contain a reference to an external resource


containing DTD declarations. This resource is referenced either through a public or system
identifier. For example:
<!DOCTYPE doc_element_name PUBLIC "publicID" "systemID">
<!DOCTYPE doc_element_name SYSTEM "systemID">

A system identifier is a URI that identifies the external resource. A public identifier is
location-independent and can be used to dereference the location of an external resource. For
example, in your XMLSpy installation, URIs for popular DTDs and XML Schemas are listed in
the catalog files named catalog.xml in the various schema folders in C:\Program
Files\Altova\Common2011\Schemas\. A public identifier in an XML document can be used to
dereference a DTD listed in these catalog files.

The XML | Append | ExternalID command is available when a "child" item of the DOCTYPE
declaration in an XML file is selected in Grid View. This command inserts a Grid View row for an
external identifier (PUBLIC or SYSTEM). You must enter the type of identifier and its value.

The Text View corresponding to the screenshot of the Grid View shown above looks something
like this:
<!DOCTYPE OrgChart SYSTEM "orgchart.dtd" [
<!ELEMENT name (#PCDATA)>
]>

Please note: A row for External-ID can be added as a child when the DOCTYPE item is
selected, or it can be inserted or appended when one of the child items of the DOCTYPE item is
selected, for example, the ELEMENT declaration name in the example above.

Append ELEMENT

The XML | Append | ELEMENT command is available in Grid View only, for DTD documents or
when an item in the DOCTYPE declaration of an XML document is selected. It appends an
ELEMENT declaration to the list of declarations.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XML Menu 637

Append ATTLIST

The XML | Append | ATTLIST command is available in Grid View only, for DTD documents or
when an item in the DOCTYPE declaration of an XML document is selected. It appends an
ATTLIST declaration to the list of declarations.

Append ENTITY

The XML | Append | ENTITY command is available in Grid View only, for DTD documents or
when an item in the DOCTYPE declaration of an XML document is selected. It appends an
ENTITY declaration to the list of declarations.

Append NOTATION

The XML | Append | NOTATION command is available in Grid View only, for DTD documents
or when an item in the DOCTYPE declaration of an XML document is selected. It appends a
NOTATION declaration to the list of declarations.

21.4.3 Add Child


The XML | Add Child command, though enabled in all views, can be used in Grid View only. It
opens a submenu (see screenshot) with which you can add the following child items to the
currently selected element.
 The XML declaration and node types (Attribute, Element, Text, CDATA, Comment,
Processing Instruction) in XML documents;
 DOCTYPE declarations and external DTD declarations in XML documents
 DTD declarations (ELEMENT, ATTLIST, ENTITY, and NOTATION) in DTD documents
and internal DTD declarations of XML documents.

© 2010 Altova GmbH User Manual


638 User Reference XML Menu

Add Child Attribute

Ctrl+Alt+I

The XML | Add Child | Attribute command is available in Grid View only and when an element
node is selected. It inserts a new attribute as a child of the selected element node.

Add Child Element

Ctrl+Alt+E

The XML | Add Child | Element command is available in Grid View only. It inserts a new
element as a child of the selected node.

Add Child Text

Ctrl+Alt+T

The XML | Add Child | Text command is available in Grid View only, and inserts new text
content as a child of the selected item.

Add Child CDATA

Ctrl+Alt+D

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XML Menu 639

The XML | Add Child | Cdata command is available in Grid View only, and inserts a new
CDATA section as a child of the selected item.

Add Child Comment

Ctrl+Alt+M

The XML | Add Child | Comment command is available in Grid View only, and inserts a new
Comment node as a child of the selected item.

Add Child XML

The XML | Add Child | XML command is available in Grid View only and when the file is empty
. It inserts a new XML declaration <?xml version="1.0" encoding="UTF-8"?> as the
first item in a document.

Please note: An XML document may contain only one XML declaration, which must appear at
the very top of the file.

Add Child Processing Instruction

The XML | Add Child | Processing Instruction command is available in Grid View only and
inserts a new Processing Instruction (PI) as a child of the selected item.

Add Child XInclude

The XML | Add Child | Processing Instruction command is available in Grid View only and
inserts a new Processing Instruction (PI) as a child of the selected item.

The XML | Add Child | XInclude command is available in Grid View only, and enables you to
insert an XInclude element as a child of the selected item. Selecting this command pops up the
XInclude dialog (screenshot below).

© 2010 Altova GmbH User Manual


640 User Reference XML Menu

The XML file to be included is entered in the href text box (alternatively, you can browse for the
file by clicking the Browse button to the right of the text box). The filename will be entered in the
XML document as the value of the href attribute. The encoding and parse attributes of the
XInclude element (xi:include), and the fallback child element of xi:include can also be
inserted via the dialog. Do this by first checking the appropriate check box and then selecting/
entering the required values.

Here is an example of an XML document that uses XInclude to include two XML documents:
<?xml version="1.0" encoding="UTF-16"?>
<AddressBook xsi:schemaLocation="http://www.altova.com/sv/myaddresses
AddressBook.xsd"
xmlns="http://www.altova.com/stylevision/tutorials/myaddresses"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xi="http://www.w3.org/2001/XInclude">
<xi:include href="BusinessAddressBook.xml"/>
<xi:include href="PersonalAddressBook.xml"/>
</AddressBook>

When this XML document is parsed, it will replace the two XInclude elements with the files
specified in the respective href attributes.

xml:base
When the XML validator of XMLSpy reads an XML document and encounters the include
element in the XInclude namespace (hereafter xi:include), it replaces this element (xi:
include) with the XML document named in the href attribute of the xi:include element. The
document element (root element) of the included XML document (or the element identified by
an XPointer) will be included with an attribute of xml:base in order to preserve the base URIs of
the included element. If the resulting XML document (containing the included XML document/s
or tree fragment/s) must be valid according to a schema, then the document element of the
included document (or the top-level element of the tree fragment) must be created with a
content model that allows an attribute of xml:base. If, according to the schema, the xml:base
attribute is not allowed on this element, then the resulting document will be invalid. How to
define an xml:base attribute in an element's content model using XMLSpy's Schema View is
described in the xml: Prefixed Attributes section of the Schema View section of the

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XML Menu 641

documentation.

XPointers
XMLSpy supports XPointers in XInclude. The relevant W3C recommendations are the XPointer
Framework and XPointer element() Scheme recommendations. The use of an XPointer in an
XInclude element enables a specific part of the XML document to be included, instead of the
entire XML document. XPointers are used within an XInclude element as follows:

<xi:include href="PersonalAddressBook.xml" xpointer="element(usa)"/>


<xi:include href="BusinessAddressBook.xml" xpointer="element(/1/1)"/>
<xi:include href="BobsAddressBook.xml" xpointer="element(usa/3/1)"/>
<xi:include href="PatsAddressBook.xml" xpointer="
element(usa)element(/1/1)"/>

In the element() scheme of XPointer, an NCName or a child sequence directed by integers may
be used.
 In the first xi:include element listed above, the xpointer attribute uses the element
scheme with an NCName of usa. According to the XPointer Framework, this NCName
identifies the element that has an ID of usa.
 In the second xi:include listed above, the xpointer attribute with a value of element
(/1/1) identifies, in the first step, the first child element of the document root (which, if
the document is well-formed, will be its document (or root) element). In the second step,
the first child element of the element located in the previous step is located; in our
example, this would be the first child element of the document element.
 The xpointer attribute of the third xi:include listed above uses a combination of
NCName and child sequence. This XPointer locates the first child element of the third
child element of the element having an ID of usa.
 If you are not sure whether your first XPointer will work, you can back it up with a
second one as shown in the fourth xi:include listed above:
xpointer="element(usa)element(/1/1)". Here, if there is no element with an ID of
usa, the back-up XPointer specifies that the first child element of the document element
is to be selected. Additional backups are also allowed. Individual XPointers may not be
separated, or they may be separated by whitespace: for example,
xpointer="element(usa)element(addresses/1) element(/1/1)".

Note: The namespace binding context is not used in the element() scheme because the
element() scheme does not support qualified names.

Add Child DOCTYPE

The XML | Add Child | DOCTYPE command is only available in the Grid View of an empty
document. It inserts a DOCTYPE declaration in an XML document. The DOCTYPE declaration
can be used to declare an internal DTD subset.

Add Child ExternalID

The XML | Add Child | ExternalID command is available only when the DOCTYPE declaration
of an XML file is selected in Grid View. This command inserts a Grid View row for an external

© 2010 Altova GmbH User Manual


642 User Reference XML Menu

identifier (PUBLIC or SYSTEM). You must enter the type of identifier and its value.

The Text View corresponding to the screenshot of the Grid View shown above looks something
like this:
<!DOCTYPE OrgChart SYSTEM "orgchart.dtd" [
<!ELEMENT name (#PCDATA)>
]>

Please note: A row for External-ID can be added as a child when the DOCTYPE item is
selected, or it can be inserted or appended when one of the child items of the DOCTYPE item is
selected, for example, the ELEMENT declaration name in the example above.

Add Child ELEMENT

The XML | Add Child | ELEMENT command is available in Grid View only, for DTD
documents, or when the DOCTYPE declaration of an XML document is selected. It appends an
ELEMENT declaration to the list of declarations.

Add Child ATTLIST

The XML | Add Child | ATTLIST command is available in Grid View only, for DTD documents,
or when the DOCTYPE declaration of an XML document is selected. It appends an ATTLIST
declaration to the list of declarations.

Add Child ENTITY

The XML | Add Child | ENTITY command is available in Grid View only, for DTD documents, or
when the DOCTYPE declaration of an XML document is selected. It appends an ENTITY
declaration to the list of declarations.

Add Child NOTATION

The XML | Add Child | NOTATION command is available in Grid View only, for DTD
documents, or when the DOCTYPE declaration of an XML document is selected. It appends an
NOTATION declaration to the list of declarations.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XML Menu 643

21.4.4 Convert To
The XML | Convert to command converts a selected item in Grid View to a different item type.
This operation is available only in Grid View on individual items that do not contain any child
node. Placing the cursor over the Convert to command displays a submenu (see screenshot)
which contains the items to which the selected item can be converted.

Please note: If the operation you select would result in a loss of data (for example, converting
an attribute to a comment would result in a loss of the attribute name), a warning dialog box will
appear.

Convert To Attribute
The XML | Convert to | Attribute command converts the selected item to a attribute.

Convert To Element
The XML | Convert to | Element command converts the selected item to an element.

Convert To Text
The XML | Convert to | Text command converts the selected item into text content.

Convert To CDATA
The XML | Convert to | Cdata command converts the selected item into a CDATA segment.

© 2010 Altova GmbH User Manual


644 User Reference XML Menu

Convert To Comment
The XML | Convert to | Comment command converts the selected item into a comment.

Convert To XML
The XML | Convert to | XML command converts the selected item to an XML declaration:
<?xml version="1.0" encoding="UTF-8"?>.

Please note: Each XML document may only contain one XML declaration and it must appear at
the very top of the file.

Convert To Processing Instruction


The XML | Convert to | Processing Instruction command converts the selected item to a new
Processing Instruction (PI).

Convert To DOCTYPE
The XML | Convert to | DOCTYPE command converts the selected item to a DOCTYPE
declaration (in an XML file).

Please note: A DOCTYPE declaration may only appear at the top of an XML instance
document between the XML Declaration and the document element of the XML document.

Convert To ExternalID
The XML | Convert to | ExternalID command converts the selected item to an external DTD
reference in a DOCTYPE declaration (PUBLIC or SYSTEM identifier).

Convert To ELEMENT
The XML | Convert to | ELEMENT command converts the selected item to an element
declaration in a DOCTYPE declaration or in an external DTD.

Convert To ATTLIST
The XML | Convert to | ATTLIST command converts the selected item to an attribute list
declaration in a DOCTYPE declaration or in an external DTD.

Convert To ENTITY
The XML | Convert to | ENTITY command converts the selected item to an entity declaration in
a DOCTYPE declaration or in an external DTD.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XML Menu 645

Convert To NOTATION
The XML | Convert to | NOTATION command converts the selected item to a notation
declaration in a DOCTYPE declaration or in an external DTD.

21.4.5 Table
The XML | Table command, though enabled in all views, can be used only in Grid View. It
displays a submenu with all the commands relevant to the Database/Table View of Grid View.

Display as Table
F12

The XML | Table | Display as Table command allows you to switch between the standard Grid
View and Database/Table View (or Table View) of a document element. The Table View
enables you to view repeated elements as a table in which the rows represent the occurrences
while the columns represent child nodes (including comments, CDATA sections, and PIs).

To switch to Table View:


1. Select any one occurrence of the repeating element you wish to view as a table.

2. Click XML | Display as Table or F12 or the toolbar icon.

© 2010 Altova GmbH User Manual


646 User Reference XML Menu

The element is displayed as a table and the toolbar icon is activated.

To switch from the Table View of a document element to the normal Grid View of that element,
select the table or any of its rows or columns, and click the toolbar icon. That table element
switches to Grid View.

Insert Row

Shift+F12

The XML | Table | Insert Row command is enabled in Database/Table View when a row or cell
is selected. It inserts a new row before the selected row. The new row corresponds to an
occurrence of the table element. Mandatory child elements are created for the new element

Append Row

Ctrl+F12

The XML | Table | Append Row command is enabled in Database/Table View when a row or
cell is selected. It appends a new row after the last row of the table. The new row corresponds
to an occurrence of the table element. Mandatory child elements are created for the new
element

Ascending Sort

The XML | Table | Ascending Sort command is enabled in Database/Table View when a
column or cell is selected. It sorts the column in either alphabetic or numeric ascending order.
XMLSpy tries to automatically determine what kind of data is used in the column, and sorts on
alphabetic or numeric order, as required. In case of uncertainty, you will be prompted for the
sort method to use (see screenshot).

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XML Menu 647

Descending Sort

The XML | Table | Descending Sort command is enabled in Database/Table View when a
column or cell is selected. It sorts the column in either alphabetic or numeric descending order.
XMLSpy tries to automatically determine what kind of data is used in the column, and sorts on
alphabetic or numeric order, as required. In case of uncertainty, you will be prompted for the
sort method to use (see screenshot).

21.4.6 Move Left

Ctrl+L

The XML | Move Left command is available in Grid View only. It moves the selected node to
the left by one level, thereby changing a child element into a sibling of its parent. This command
is often referred to as the Promote command.

21.4.7 Move Right

Ctrl+R

The XML | Move Right command is available in Grid View only. It moves the selected node to
the right by one level, thereby turning it into a child element of the preceding sibling element.
This command is often referred to as the Demote command.

© 2010 Altova GmbH User Manual


648 User Reference XML Menu

21.4.8 Enclose in Element


The XML | Enclose in Element command is enabled in Grid View only. It encloses a selected
text range in a new element. The new element is created inline around the selected text. If you
are editing a document based on a Schema or DTD, you will automatically be presented with a
list of valid choices for the name of the element in which the text is to be enclosed.

For example, in the screenshot below, the text Nanonull in the para element is highlighted.

When you select the command XML | Enclose in Element, the text Nanonull is enclosed in a
newly created inline element and a list appears offering a choice of bold or italic for the
name of the element. These elements are defined in the schema as children of para.

The selection you make will be the name of the new element. Alternatively, you can enter some
other name for the element.

21.4.9 Evaluate XPath

The XML | Evaluate XPath command opens the Output Windows if these are not open and
activates the XPath tab in the Output Windows. In the XPath tab, you can evaluate an XPath
expression on the active document and see the results in the Output Window.

21.4.10 Check Well-Formedness

F7

The XML | Check well-formedness (F7) command checks the active document for
well-formedness by the definitions of the XML 1.0 specification. Every XML document must be
well-formed. XMLSpy checks for well-formedness whenever a document is opened or saved, or
when the view is changed from Text to any other view. You can also check for well-formedness
at any time while editing by using this command.

If the well-formedness check succeeds when you explicitly invoke the check, a message is
displayed in the Validation window:

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XML Menu 649

If an error is encountered during the well-formedness check, a corresponding error message is


displayed:

Please note: The output of the Validation window has 9 tabs. The validation output is always
displayed in the active tab. Therefore, you can check well-formedness in tab1 for one schema
file and keep the result by switching to tab 2 before validating the next schema document
(otherwise tab 1 is overwritten with the validation result ).

It is generally not permitted to save a malformed XML document, but XMLSpy gives you a Save
Anyway option. This is useful when you want to suspend your work temporarily (in a not
well-formed condition) and resume it later.

Please note: You can also use the Check well-formedness command on any file, folder, or
group of files in the active project window. Click on the respective folder, and then on the Check
Well-Formedness icon.

21.4.11 Validate XML

F8

The XML | Validate (F8) command enables you to validate XML documents against DTDs,
XML Schemas, and other schemas. Validation is automatically carried out when you switch
from Text View to any other view. You can specify that a document be automatically validated
when a file is opened or saved (Tools | Options | File). The Validate command also carries
out a well-formedness check before checking validity, so there is no need to use the Check
Well-Formedness command before using the Validate command.

If a document is valid, a successful validation message is displayed in the Validation window:

© 2010 Altova GmbH User Manual


650 User Reference XML Menu

Otherwise, a message that describes the error is displayed.

Please note: You can click on the links in the error message to jump to the spot in the XML file
where the error was found.

Please note: The output of the Validation window has 9 tabs. The validation output is always
displayed in the active tab. Therefore, you can check well-formedness in tab1 for one schema
file and keep the result by switching to tab 2 before validating the next schema document
(otherwise tab 1 is overwritten with the validation result ).

The command is normally applied to the active document. But you can also apply the command
to a file, folder, or group of files in the active project. Select the required file or folder in the
Project Window (by clicking on it), and click XML | Validate or F8. Invalid files in a project will
be opened and made active in the Main Window, and the File Is Invalid error message will be
displayed.

Validating XML documents


To validate an XML file, make the XML document active in the Main Window, and click XML |
Validate or F8. The XML document is validated against the schema referenced in the XML file.
If no reference exists, an error message is displayed at the bottom of the Main Window. As long
as the XML document is open, the schema is kept in memory (see Flush Memory Cache in the
DTD/Schema menu).

Validating schema documents (DTDs and XML Schema)


XMLSpy supports major schema dialects, including DTD and XML Schema. To validate a
schema document, make the document active in the Main Window, and click XML | Validate or
F8.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XML Menu 651

Schema validation messages in the Validation window


If the schema (DTD or XML Schema) is valid, a successful validation message is displayed in
the Validation window; the Validation window pops up at the bottom of the application window. If
the schema is not valid, one or more error messages are displayed in the Validation window (
screenshot below).

The error message is divided into three parts:


1. A description of the error. The description contains links to the relevant declarations or
definitions.
2. The location of the error within the schema structure. Clicking a node in the location
path highlights that node in the document.
3. Details of the error provides more information about the error and contains a link to the
relevant paragraph in the relevant specification (the XML specification for DTD
validation; and XML Schema specification for XML Schema validation).

Please note: When the validation is done in Text View, clicking a link in the Validation window
highlights the corresponding declaration or definition in Text View. When the validation is done
in Schema View, the corresponding declaration or definition is highlighted either in the design
window of Schema View or in the relevant entry helper window.

Catalogs
XMLSpy supports a subset of the OASIS XML catalogs mechanism. The catalog mechanism
enables XMLSpy to retrieve commonly used schemas (as well as stylesheets and other files)
from local user folders. This increases the overall processing speed, enables users to work
offline (that is, not connected to a network), and improves the portability of documents (because
URIs need to be changed in the catalog files only.) The catalog mechanism in XMLSpy works
as follows:
 XMLSpy loads a file called RootCatalog.xml, which contains a list of catalog files that
will be looked up. You can enter as many catalog files to look up, each in a
nextCatalog element in RootCatalog.xml.
 The catalog files included in RootCatalog.xml are looked up and the URIs are
resolved according to the mappings specified in the catalog files. You should take care
not to duplicate mappings, as this could lead to errors.
 Two catalog files are supplied with XMLSpy. How these work is described in the
section Catalogs in XMLSpy.
 The PUBLIC or SYSTEM identifier in the DOCTYPE statement of your XML file will be used
for the catalog lookup. For popular schemas, the PUBLIC identifier is usually pre-
defined, thus requiring only the URI in the catalog file to be changed when XML
documents are used on multiple machines.

When writing your CustomCatalog.xml file (or other custom catalog file), use only the following

© 2010 Altova GmbH User Manual


652 User Reference XML Menu

subset of the OASIS catalog in order for XMLSpy to process the catalog correctly. Each of the
elements in the supported subset can take the xml:base attribute, which is used to specify the
base URI of that element.
<catalog...>
...
<public publicId="PublicID of Resource" uri="URL of local file"/>
<system systemId="SystemID of Resource" uri="URL of local file"/>
<rewriteURI uriStartString="StartString of URI to rewrite"
rewritePrefix="String to replace StartString"/>
<rewriteSystem systemIdStartString="StartString of SystemID"
rewritePrefix="Replacement string to locate resource locally"/>
<uri name="filename" uri="URL of file identified by filename"/>
...
</catalog>

Please note:
 Although the DTDs for XML Schemas are referenced from CoreCatalog.xml, you
cannot validate your XML files against either of these schemas. They are included to
provide entry helper info for editing purposes should you wish to create files according
to these older recommendations. Also see next point.
 If you create a custom file extension for a particular schema (for example, the .myhtml
extension for (HTML) files that are to be valid according to the HTML DTD), then you
can enable intelligent editing for files with these extensions by adding a line of text to
CustomCatalog.xml. For the example extension mentioned, you should add the
element <spy:fileExtHelper ext="myhtml" uri="schemas/xhtml/xhtml1-
transitional.dtd"/> as a child of the <catalog> element. This would enable
intelligent editing (auto-completion, entry helpers, etc) of .myhtml files in XMLSpy
according to the XHTML 1.0 Transitional DTD.
 For more information on catalogs, see the XML Catalogs specification.

Automating validation with Altova XML 2011


Altova XML is a free application which contains Altova's XML Validator, XSLT 1.0, XSLT 2.0,
and XQuery 1.0 engines. It can be used from the command line, via a COM interface, in Java
programs, and in .NET applications to validate XML documents, transform XML documents
using XSLT 1.0 and 2.0 stylesheets, and execute XQuery documents.

Validation tasks can therefore be automated with the use of Altova XML. For example, you can
create a batch file that calls AltovaXML to perform validation on a set of documents and sends
the output to a text file. See the AltovaXML documentation for details.

21.4.12 Validating WSDL Files


The following list contains important information about WSDL validation behavior in the
Enterprise and Professional Editions of XMLSpy:
 The Professional Edition performs only simple schema validation, i.e., it treats the
WSDL file as an XML file and validates it according to the appropriate schema defined
at http://schemas.xmlsoap.org/wsdl/.
 The Enterprise Edition provides WSDL validation that goes beyond the validation
provided by the Professional Edition. It does not validate against
http://schemas.xmlsoap.org/wsdl/ but rather uses the
http://www.altova.com/specs_wsdl.html#_document-s as well as its own logic to provide
more valuable validation information in the context of WSDL. Thus it can happen that a
WSDL file is valid in the Professional Edition, but not valid in the Enterprise Edition (see

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XML Menu 653

Example).
 There is a difference between http://schemas.xmlsoap.org/wsdl/ and
http://www.altova.com/specs_wsdl.html#_document-s.
http://schemas.xmlsoap.org/wsdl/ is missing the extensibility elements (the specification
and the schema should be the same but are not; this difference appears to be an error
in the schema).
 The fact that the Professional Edition uses http://schemas.xmlsoap.org/wsdl/ for
validation means that any extensibility elements will be considered invalid. The
Enterprise Edition used http://www.altova.com/specs_wsdl.html#_document-s, which
allows extensibility elements. Thus a WSDL file containing extensibility elements is valid
when using the Enterprise edition, and not valid when using the Professional Edition.
 The fact that the file is invalid in the Professional Edition is because we are using the
official schema provided by the W3C working group. Any errors in this schema are
beyond our control.

Example

The following example is part of a WSDL file. Notice the element "getCityTime" that has been
declared in the file. This element is mistakenly referenced as "getCityTimes". The Enterprise
Edition checks if elements that are referenced have previously been declared in the file; the
Professional Edition does not. This file (assuming that the rest of the file is valid) would be found
to be valid in the Professional Edition, but not valid in the Enterprise Edition (assuming that
"getCityTimes" is not defined somewhere else in the file).

<s:element name="getCityTime">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="city"
type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="abc">
<s:complexType>
<s:sequence>
<s:element ref="getCityTimes"/>
</s:sequence>
</s:complexType>
</s:element>

21.4.13 Update Entry Helpers

The XML | Update Entry Helpers command updates the Entry Helper windows by reloading
the underlying DTD or Schema. If you have modified the XML Schema or DTD that an open
XML document is based upon, it is advisable to update the Entry Helpers so that the intelligent
editing information reflects the changes in the schema.

21.4.14 Namespace Prefix.


The XML | Namespace Prefix... command is available in Grid View and opens a dialog box in
which you can set the namespace prefix of the selected element or attribute, and, in the case of
elements, of its descendants as well.

© 2010 Altova GmbH User Manual


654 User Reference XML Menu

You can choose to set the namespace prefix on either elements, attributes, or both. The
namespace prefix is applied to the selected element or attribute, and, if an element is selected,
to descendant nodes of the selected element.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DTD/Schema Menu 655

21.5 DTD/Schema Menu


The DTD/Schema menu contains commands that let you work efficiently with DTDs and XML
Schemas.

This section contains a complete description of all the commands in this menu.

21.5.1 Assign DTD

The DTD/Schema | Assign DTD... command is enabled when an XML file is active. It assigns
a DTD to an XML document, thus allowing the document to be validated and enabling intelligent
editing for the document. The command opens the Assign File dialog to let you specify the DTD
file you wish to assign. You can also select a file via a global resource or a URL (click the
Browse button) or a file in one of the open windows in XMLSpy (click the Window button). Note
that you can make the path of the assigned DTD file relative by clicking the Make Path Relative
To... check box. When you are done, your XML document will contain a DOCTYPE declaration
that references the assigned DTD. The DOCTYPE declaration will look something like this:
<!DOCTYPE main SYSTEM "http://link.xmlspy.com/spyweb.dtd">

Please note: A DTD can be assigned to a new XML file at the time the file is created.

© 2010 Altova GmbH User Manual


656 User Reference DTD/Schema Menu

21.5.2 Assign Schema

The DTD/Schema | Assign Schema... command is enabled when an XML document is active.
It assigns an XML Schema to an XML document, thus allowing the document to be validated
and enabling intelligent editing for the document. The command opens the Assign File dialog to
let you specify the XML Schema file you wish to assign. You can also select a file via a global
resource or a URL (click the Browse button) or a file in one of the open windows in XMLSpy
(click the Window button). Note that you can make the path of the assigned file relative by
clicking the Make Path Relative To... check box. When you are done, your XML document will
contain an XML Schema assignment with the required namespaces. The schema assignment
will look something like this:
xmlns="http://www.xmlspy.com/schemas/icon/orgchart"
xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance"
xsi:schemaLocation="http://www.xmlspy.com/schemas/icon/orgchart
http://schema.xmlspy.com/schemas/icon/orgchart.xsd"

21.5.3 Include Another DTD


The DTD/Schema | Include another DTD... command allows you to include another Document
Type Definition (DTD) or external parsed entity into the internal subset of a document type
definition, or in any DTD document. This is done by defining a corresponding external parsed
entity declaration and using that entity in the following line:

<!ENTITY % navigation.dtd SYSTEM "S:\xml\navigation.dtd">


%navigation.dtd;

The command opens the Assign File dialog to let you specify the DTD file you want to include in
your DTD.

Please note: This command is enabled in Grid View only.

21.5.4 Go to DTD

The DTD/Schema | Go to DTD command opens the DTD on which the active XML document
is based. If no DTD is assigned, then an error message is displayed.

21.5.5 Go to Schema

The DTD/Schema | Go to Schema command opens the XML Schema on which the active
XML document is based. If no XML Schema is assigned, then an error message is displayed.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DTD/Schema Menu 657

21.5.6 Go to Definition

The DTD/Schema | Go to Definition command displays the exact definition of an element or


attribute in the corresponding Document Type Definition or Schema document.

To see the item definition in Grid View


1. Click left on the item.
2. Select the menu item DTD/Schema | Go to Definition, or click on the icon.

To see the item definition in Schema View


1. Use CTRL + Double click on the item you want to see the definition of, or
2. Click the item and select menu option DTD/Schema | Go to Definition, or click on the
icon.

In both cases, the corresponding DTD or Schema file is opened, and the item definition
is highlighted.

21.5.7 Generate DTD/Schema

The DTD/Schema | Generate DTD/Schema command generates a new DTD or W3C XML
Schema from an XML document (or from a set of XML documents contained in a folder in the
project window). This command is useful when you want to generate a DTD or XML Schema
from XML documents.

© 2010 Altova GmbH User Manual


658 User Reference DTD/Schema Menu

If you generate an XML Schema, the following options are available:


 Elements: The type of elements can be defined locally or globally (Define types for
elements). If elements have the same name, a common type can be declared for use in
the definition of these elements (Generate one shared type).
 Atributes: The simple types of attributes (Define simple types for attributes) can be
defined as (i) common global types; (ii) distinct global types; (iii) local types. Attributes
with the same name and type can be defined either locally or globally.
 Simple type recognition: The recognition of types (Simple type recognition) can be set
to: (i) best possible; (ii) recognition of number datatypes only; (iii) no datatype
recognition, in which case all datatypes are set to xs:string.
 Entity resolution: In the XML document, entities may appear in element content and
attribute values. Whether they are resolved or not (Validate and resolve entities) is
therefore significant for enumeration values. Furthermore, some entities (especially
parsed entities that contain markup) can affect the content model differently depending
on whether they are resolved or not. Note that the XML document will be validated for
being correct XML before the schema is generated. If the document is invalid, the
schema generation process will be discontinued.
 Enumerations: All types of values, or string values only, can be enumerated.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DTD/Schema Menu 659

If you generate a DTD, the entity resolution and enumeration options are available.

The Generate DTD/Schema command normally operates on the active main window, but you
can also use the Generate DTD/Schema command on any file, folder, or group of files in the
active project window.

21.5.8 Convert DTD/Schema

The DTD/Schema | Convert DTD/Schema... command converts a DTD into an XML Schema
and vice versa. If you select W3C Schema, you must also specify how to represent complex
elements, as elements or as complex types.

Converting a DTD to XML Schema


When you convert a DTD to XML Schema, XMLSpy makes a few assumptions because of the
limited information available. Most notably, the values of certain DTD components are treated
literally rather than having their semantics parsed. This is because the program cannot know
which of several possible usages is intended. In these cases, you should modify the generated
conversion.

In any case, you should carefully examine the generated conversion to see if you can enhance
it. A few areas in which improvements may be required are given below.

Attribute Datatyping
DTDs allow for only 10 attribute datatypes, whereas XML Schemas, for instance, allow for 44
datatypes plus derived datatypes. You may wish to enhance a generated XML Schema, for
example, by using a more restrictive datatype. Note that when an XML Schema is converted to
DTD datatype information will be lost.

Namespaces
DTDs are not namespace-aware. As a result, if namespaces are to be specified in a DTD they
must be hard-coded into element and attribute names. This could pose challenging problems
when converting from one schema to another.

Entities
XML Schema does not have equivalents for the general entity declarations of DTDs. When
XMLSpy converts a DTD to an XML Schema, it ignores entity declarations.

Unparsed data declarations

© 2010 Altova GmbH User Manual


660 User Reference DTD/Schema Menu

DTDs and XML Schemas use different mechanisms for handling unparsed data. This is
explained in more detail below.

DTDs use the following mechanism:


1. A notation is declared consisting of a name and an identifier, e.g.
<!NOTATION gif SYSTEM "image/gif">
2. You declare the entity, e.g.
<!ENTITY cover_img SYSTEM "graphics/cover_img.gif" NDATA gif>
3. Typically, you specify an attribute type of ENTITY on the relevant attribute, e.g.
<!ELEMENT img EMPTY>
<!ATTLIST img format ENTITY #REQUIRED>

In XML Schema, the corresponding mechanism is as follows:


1. Declare a notation. This functions in the same way as for the DTD.
<xs:notation name="gif" public="image/gif"/>
Note that the public attribute is mandatory and holds the identifier. An optional
system attribute holds the system identifier and is usually an executable that can deal
with resources of the notation type.
2. You associate the notation declaration with a given attribute value using the NOTATION
datatype.
 You cannot, however, use the NOTATION datatype directly, but must derive another
datatype from the NOTATION datatype.
<xs:simpleType name="formatType">
<xs:restriction base="xs:NOTATION">
<xs:enumeration value="gif"/>
<xs:enumeration value="jpeg"/>
</xs:restriction>
</xs:simpleType>
 You associate the attribute with the datatype derived from the NOTATION datatype,
e.g.
<xs:complexType name="imgType">
<xs:attribute name="height"/>
<xs:attribute name="width"/>
<xs:attribute name="location"/>
<xs:attribute name="format" type="formatType"
use="required"/>
</xs:complexType>
<xs:element name="img" type="imgType"/>

When you convert a DTD to an XML Schema using the Convert DTD/Schema command,
XMLSpy does the following:
 Something like
<!ATTLIST image format ENTITY #REQUIRED
...>
is converted to
<xs:attribute name="format" type="xs:ENTITY" use="required"/>

 And
<!NOTATION gif SYSTEM "image/gif">
is converted to
<xs:notation name="gif" system="image/gif"/>

You should therefore make the following modifications:

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DTD/Schema Menu 661

1. In notations like <xs:notation name="gif" system="image/gif"/> replace


system with public, and add an optional system identifier if required.
2. Derive a datatype from the NOTATION datatype as described above for formatType.
3. Associate the derived datatype with the relevant attribute.

Please note: According to the XML Schema specification, you do not need to—or cannot,
depending on your viewpoint—declare an external entity.

Converting an XML Schema to a DTD


When you convert an XML Schema to a DTD, the namespace prefixes used in the XML
Schema—not the namespace URIs or the namespace declarations—are carried through to the
names of the corresponding elements and attributes in the DTD.

Note the following points:


1. Since XML parsers ignore namespaces when validating an XML document against a
DTD, the namespace declarations themselves are not converted.
2. The elementFormDefault and the attributeFormDefault attributes of the
xs:schema element determine what elements and attributes have their prefixes
included in the conversion process. If set to unqualified, then only globally declared
elements and attributes, respectively, include prefixes in the conversion. If set to
qualified, all element and attribute names have their prefixes included in the
conversion.
3. Prefixes are converted to their corresponding string value plus a colon. Elements and
attributes in default namespaces are converted to elements and attributes with names
that begin with the string: default_NS_X, where X is an integer (starting with 1 and
having a maximum value equal to the number of default namespaces used in the XML
Schema).
4. In the DTD, element names are composed of parameter entities. This enables you to
easily change the prefix in the DTD should the prefix in the XML document ever need to
change. Parameter entity definitions can be changed either in the DTD document itself
or by overriding the parameter entity definitions in the XML document's internal DTD
subset.

Please note: Namespaces have no semantic value in DTDs, and namespace prefixes carried
over from the XML Schema become merely a lexical part of the name of the element or
attribute defined in the DTD.

21.5.9 Convert to UML


The DTD/Schema | Convert to UML command converts a W3C XML Schema to an Altova
UModel Project (.ump) document (hereafter UModel project). UMP is the native format of Altova
UModel, Altova's UML modeling application. UMP files can then be viewed and edited in Altova
UModel.

To convert a schema to UML, do the following:


1. With the schema open, click the Convert to UML command. This pops up the Convert
to UML dialog (screenshot below).

© 2010 Altova GmbH User Manual


662 User Reference DTD/Schema Menu

2. In the Content Diagrams tab, select the option Generate Diagrams for XSD Globals.
This will generate, in the UModel project, a content model diagram for each global
component.
3. Select the required options from those available in the dialog. These options are
explained below.
4. If you wish to view the created project in UModel immediately, select the option to open
the project in UModel. Otherwise leave this option unselected.
5. Click OK.
6. In the Save As dialog that appears, browse for the destination folder, then enter the
name of the UMP file, and click Save.

Convert to UML options


The following options are available in the Convert to UML dialog.

In the Content Diagrams tab:


 Hyperlink diagrams creates in each diagram a link to the entry of that global component
in the Model Tree view, thus enabling the component to be quickly located in the
schema hierarchy.
 In the Style pane, the show compartments options enables various compartments to be
either shown or hidden.

In the Package Dependency Diagram tab:


 The Generate Diagram option determines whether a package dependency diagram is
generated. A package dependency diagram provides an overview of the entire
package, showing the relationships of package components to one another. Note that
the other options in this tab will be enabled only if the Generate Diagram option is
selected.
 Selecting the Hyperlink Package to Diagram option creates a link from the package
diagram to the Model Tree View.
 Three options are available for the layout of the package dependencies diagram: (i)
unorganized layout (Autolayout option unselected); (ii) hierarchical layout (Autolayout
and Hierarchical options selected); and (iii) evenly spaced (Autolayout and Force
Directed options selected). The layout can be modified by editing the diagram in
UModel.

Note: The Convert to UML feature supports W3C XML Schemas only.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DTD/Schema Menu 663

21.5.10 Generate XML from DB, Excel, EDI with MapForce


The DTD/Schema | Generate XML from DB, Excel, EDI with MapForce command launches
Altova's MapForce if the application is installed. MapForce enables you to map a schema to
another DTD, XML Schema, or database and to generate XML.

21.5.11 Design HTML/PDF/Word Output in StyleVision...


The DTD/Schema | Design HTML/PDF Output in StyleVision... command launches Altova's
StyleVision if the application is installed. StyleVision enables you to design stylesheets for
HTML, PDF, and RTF output.

21.5.12 Generate Sample XML File


The DTD/Schema | Generate Sample XML File command generates an XML file based on the
currently active schema (DTD or XML Schema) in the main window.

© 2010 Altova GmbH User Manual


664 User Reference DTD/Schema Menu

Elements to be generated
One of the following choices can be selected: (i) mandatory elements only; (ii) all elements
(mandatory and non-mandatory); (iii) mandatory and minimum number of non-mandatory
elements (for example, the first definition in a choice). If elements are defined as being
repeatable, the number of elements to be generated (for each of these repeatable elements)
can be specified.

Generate non-mandatory attributes


Activating this option generates not only mandatory attributes, but also the non-mandatory
attributes, defined in the schema.

Generate X elements if marked repeatable in Schema/DTD


Activating this option generates the number of repeatable elements you enter in the text box.

Fill elements and attributes with data


Activating this option inserts the data type descriptors/values for the respective
elements/attributes. For example: Boolean = 1, xsd:string = string, Max/Min inclusive
= the value defined in the schema.

Nillable elements and abstract types


The contents of nillable elements can be treated as non-mandatory, and elements with an
abstract type can use a non-abstract type for its xsi:type attribute.

Schema assignment for the generated XML file


The schema used to generate the XML file can be assigned to the generated XML file with a
relative or absolute path.

Add sample values if available


If the schema component has sample values assigned to it, then these will be used as the value
or content of that component. For individual components, sample values are assigned in the
Facets Entry Helper, in the Samples tab. Which value from the available sample values is
selected for a single file generation can be specified:
 A random selection.
 Each sample value in turn for each instance of the component. For each file generation,
the cycle starts anew.
 The first value always.

Root element
If the schema contains more than one global element, these are listed, and the root element
required for the sample XML file can be selected from the list.

21.5.13 Generate Program Code


The DTD/Schema | Generate Program Code... command automatically generates Java, C++,
or C# class files from definitions in the active schema (DTD or XML Schema) document.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DTD/Schema Menu 665

Please see the Code Generator section of this documentation for details about code generation.

21.5.14 Flush Memory Cache


The DTD/Schema | Flush Memory Cache command flushes all cached schema (DTD and
XML Schema) documents from memory. To speed up validation and intelligent editing, XMLSpy
caches recently used schema documents and external parsed entities in memory. Information
from these cached documents is also displayed when the Go to Definition command is
invoked.

Flush the memory cache if memory is tight on your system, or if you have used documents
based on different schemas recently.

© 2010 Altova GmbH User Manual


666 User Reference Schema Design Menu

21.6 Schema Design Menu


The Schema Design menu enables you to configure the Schema View of XMLSpy. This view
enables you to design XML Schemas in a GUI. It is available when an XML Schema document
is active in Schema View.

The commands available in this menu are described in this section.

21.6.1 Schema Settings

The Schema Design | Schema Settings command lets you define global settings for the active
schema. These settings are attributes and their values of the XML Schema document element,
xs:schema.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Schema Design Menu 667

You can make the following settings in this dialog:


 The elementFormDefault and attributeFormDefault attributes of the xs:schema
element can each be set to qualified or unqualified.
 The blockDefault, finalDefault, and version attributes can be entered in their
respective fields.
 The target namespace for the XML instance document can be set by selecting the
Target Namespace radio button, and entering the target namespace in the field. If
you declare a target namespace, you must define that namespace for use in the schema
document. Do this by entering a namespace line in the Namespace list in the bottom
pane. You can define a prefix for this namespace, or let this namespace be the default
namespace (by leaving the prefix field blank as shown in the screenshot above).

The Text View of the schema settings shown in the screenshot above will look something like
this:

© 2010 Altova GmbH User Manual


668 User Reference Schema Design Menu

Please note: These settings apply to the active schema document only.

21.6.2 Save Diagram

The Schema Design | Save Diagram... command saves the diagram of the Content Model
currently displayed in the Main Window in PNG format to any desired location.

21.6.3 Generate Documentation

The Schema Design | Generate Documentation command generates detailed documentation


about your schema in HTML, MS Word, or RTF. The documentation generated by this
command can be freely altered and used; permission from Altova to do so is not required.
Documentation is generated for components you select in the Schema Documentation dialog
(which appears when you select the Generate Documentation command; see screenshot).
Related elements (child elements, complex types, etc.) are hyperlinked in the onscreen output,
enabling you to navigate from component to component. Components with a content model
also have links to the content model definitions. Note also that schema documentation is also
generated for included and imported schema components.

Note: In order to generate documentation in MS Word format, you must have MS Word

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Schema Design Menu 669

(version 2000 or later) installed.

Clicking the Generate Documentation command opens the Schema documentation dialog:
 The required format is specified in the Output Format pane: either HTML, Microsoft
Word, or RTF. On clicking OK, you will be prompted for the name of the output file and
the location to which it should be saved.
 The documentation can be generated either as a single file or be split into multiple files.
When multiple files are generated, each file corresponds to a component. What
components are included in the output is specified using the check boxes in the Include
pane.
 For HTML output, the CSS style definitions can be either saved in a separate CSS file
or embedded in the HTML file (in the <head> element). If a separate CSS file is
created, it will be given the same name as the HTML file, but will have a .css
extension. Check or uncheck the Embed CSS in HTML check box to set the required
option.
 The Embed Diagrams option is enabled for the MS Word and RTF output options.
When this option is checked, diagrams are embedded in the result file, either in PNG or
EMF format. Otherwise diagrams are created as PNG or EMF files, which are displayed
in the result file via object links.
 When the output is HTML, all diagrams are created as document-external PNG files. If
the Create folder for diagrams check box is checked, then a folder will be created in the
same folder as the HTML file, and the PNG files will be saved inside it. This folder will
have a name of the format HTMLFilename_diagrams. If the Create folder for diagrams
check box is unchecked, the PNG files will be saved in the same folder as the HTML
file.
 Links to local files (such as diagram image files and external CSS file) can be relative or
absolute. In the Generate links to local files pane, select the appropriate radio button
according to the option you prefer.

© 2010 Altova GmbH User Manual


670 User Reference Schema Design Menu

 In the Include pane, you select which items you want to include in the documentation.
The Index option lists all related schemas at the top of the file, with their global
components organized by component type. The Check All and Uncheck All buttons
enable you to quickly select or deselect all the options in the pane.
 The Details pane lists the details that may be included for each component. Select the
details you wish to include in the documentation. The Check All and Uncheck All
buttons enable you to quickly select or deselect all the options in the pane.
 The Show Result File option is enabled for all three output options. When this option is
checked, the result files are displayed in Browser View (HTML output), MS Word (MS
Word output), and the default application for .rtf files (RTF output). You can also
select whether links in the output document are absolute or relative.

The screenshot above shows generated schema documentation with an index (all related
schemas with their global components organized by component type) at the top of the
document.

Note: When generating documentation for W3C schema documents, XMLSpy uses
application-internal versions of these documents. Consequently, other locations of
these documents are not considered, and redefinitions and other schema modifications
will not be reflected in the documentation.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Schema Design Menu 671

21.6.4 Configure View


The Schema Design | Configure view command is active in Content Model View and allows
you to configure the Content Model View. Clicking the command opens the Schema Display
Configuration dialog at the bottom right of the XMLSpy window, enabling you to see the effect of
your settings as you enter them in the dialog. The settings take effect when you click the OK
button of the dialog, and apply to the Content Model View of all XML Schema files that are
opened subsequently. These settings also apply to the schema documentation output and
printer output.

Defining property descriptor lines for the content model


You can define what properties of elements and attributes are displayed in the Content Model
View. These properties appear as grid lines in component boxes.

To define property descriptor lines:


1. Select Schema Design | Configure view. The Schema display configuration dialog
appears.

2. In the Element or Attribute tab, click the Append or Insert icon to add a
property descriptor line. The line is added in the dialog and to element boxes in the
Content Model View.
3. From the combo box, select the property you want to display. See screenshot.
4. Repeat steps 1 and 2 for as many properties as required.

© 2010 Altova GmbH User Manual


672 User Reference Schema Design Menu

The Content Model View is updated, showing the defined property descriptor lines for all
elements for which they exist.

Please note:
 For attributes, the configuration you define appears only when attributes are displayed
in the diagram (as opposed to them being displayed in a pane below the Content Model
View).
 The configured view applies to all Content Model Views opened after the configuration
is defined.

Deleting a property descriptor line from the Content Model View


To delete individual property descriptor lines, in the Schema Display Configuration dialog, select
the property descriptor line you want to delete, and click the Delete icon .

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Schema Design Menu 673

Settings for configuring the Content Model View


The Content Model View can be configured using settings in the Schema Display Configuration
dialog. How to define what property descriptor lines are displayed in Content Model View has
been described above. The other settings are described below.

Single line settings


You can define whether a property descriptor line is to contain single or double content, and
whether individual lines must appear for every element or only for elements that contain that
property. Use the appropriate radio buttons to define your settings. Note that these two settings
can be set for individual lines separately (select the required line and make the setting).

© 2010 Altova GmbH User Manual


674 User Reference Schema Design Menu

Common line settings


This option toggles the line descriptions (i.e. the name of the property) on and off.

Widths
These sliders enable you to set the minimum and maximum size of the element rectangles in
Content Model View. Change the sizes if line descriptor text is not fully visible or if you want to
standardize your display.

Distances
These sliders let you define the horizontal and vertical distances between various elements
onscreen.

Show in diagram
The Annotations check box toggles the display of annotation text on or off, as well as the
annotation text width with the slider. You can also toggle the display of the substitution groups
on or off. The Attributes and Identity Constraints appear in the Content Model diagram if their
check boxes are selected; otherwise they appear as tabs in a pane at the bottom of the Content
Model window.

Draw direction
These options define the orientation of the element tree on screen, horizontal or vertical.

Editing the content model in the diagram itself


You can change element properties directly in the content model diagram. To do this,
double-click the property you wish to edit and start entering data. If a selection is available, a
drop-down list appears, from which you can select an option. Otherwise, enter a value and
confirm with Enter.

Buttons in the Schema display configuration dialog


This dialog has the following buttons:
 The Load/Save button allows you to load and retrieve the settings you make here.
 The Predefined button, resets the display configuration to default values.
 The Clear all button empties the list box of all entries.

Enabling schema restrictions


To enable schema restrictions, check the Enable Schema Restrictions check box.

21.6.5 Zoom
The Schema Design | Zoom command controls the zoom factor of the Content Model View.
This feature is useful if you have a large content model and wish to zoom out so that the entire
content model fits in the Main Window. You can zoom between 10% and 200% of actual size.

To zoom in and out, either drag the slider or click in the entry box and enter a percentage value.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Schema Design Menu 675

21.6.6 Display All Globals


The Schema Design | Display All Globals command switches from Content Model View to
Schema Overview to display all global components in the schema. It is a toggle with the Display
Diagram command. The currently selected toggle is indicated with a check mark to its left (see
screenshot).

Alternatively, you could use the Display All Globals icon at the top of the Content Model
View to switch to the Schema Overview.

21.6.7 Display Diagram


The Schema Design | Display Diagram command switches to the Content Model View of the
selected global component—if the selected component has a content model. Global
components that have a content model (complex types, elements, and element groups) are
indicated with the icon to its left. The Display Diagram command is a toggle with the Display
All Globals command. The currently selected toggle is indicated with a check mark to its left (
screenshot below).

Alternatively, you could use the following methods to switch to Content Model View:

 Click the icon next to the component, the content model of which you want to
display.
 Double-click a component name in the Component Navigator Entry Helper (at top right).

21.6.8 Schema Extensions for Databases


This menu item pops out a sub-menu containing commands for Oracle and MS SQL Server
schema extensions.

 Enable Oracle Schema Extensions


 Oracle Schema Settings
 Enable Microsoft SQL Server Schema Extensions
 Named Schema Relationships
 Unnamed Element Relationships

Enable Oracle Schema Extensions


XMLSpy provides support for Oracle schema extensions for use with Oracle 9i Project XDB.
Using these schema extensions allows you to configure and customize how Oracle 9i Project
XDB stores XML documents. These XML documents are then accessible through SQL queries
and legacy tools. Please see the Oracle Website for more information.

© 2010 Altova GmbH User Manual


676 User Reference Schema Design Menu

When you select the Schema Design | Enable Oracle Schema Extensions command, the
following occurs:
 The XDB namespace is declared on the schema element:
xmlns:xdb="http://xmlns.oracle.com/xdb".
 An Oracle tab is created in the Details Entry Helper, enabling you to add attributes—
including XDB-specific attributes—to schema elements such as xsd:complexType
and xsd:element.

Oracle extensions can be defined for complex types, elements, and attributes. Use the
Entry Helper as you normally would in XMLSpy.

Please note: This menu command can be toggled on and off, that is, extensions can be
enabled or disabled. When Oracle extensions are enabled, the command is displayed with a
check mark to its left. Disabling Oracle extensions (by clicking the enabled command) deletes
the XDB namespace declaration and all XDB extensions in the file. A warning message
appears since this action cannot be undone.

Oracle Schema Settings


The Schema Design | Oracle Schema Settings command allows you to define global settings
for Oracle schema extensions.

In order to access this dialog, Oracle schema extensions must be enabled (using the Enable
Oracle Schema Extensions command).

Enable Microsoft SQL Server Schema Extensions


XMLSpy provides support for Microsoft SQL Server 2000 schema extensions for use with
Microsoft SQL Server. Using these schema extensions allows you to configure and customize
how Microsoft SQL Server stores XML documents. These XML documents are then accessible

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Schema Design Menu 677

through SQL queries and legacy tools. Please see the Microsoft Website for more information.

When you select the Schema Design | Enable Microsoft SQL Server Schema Extensions
command, the following occurs:
 The SQL Server namespace is declared on the schema element:
xmlns:sql="urn:schemas-microsoft-com:mapping-schema".
 An SQL Server tab is created in the Details Entry Helper, enabling you to add attributes
to schema elements such as xsd:element.

Where SQL Server extensions can be defined for a schema component, the SQL
Server tab is available in the Details Entry Helper when the component is selected. Use
the Entry Helper as you normally would in XMLSpy.

Please note: This menu command can be toggled on and off, that is, extensions can be
enabled or disabled. When SQL Server extensions are enabled, the command is displayed with
a check mark to its left. Disabling SQL Server extensions (by clicking the enabled command)
deletes the SQL Server namespace declaration and all SQL extensions in the file. A warning
message appears since this action cannot be undone.

Named Schema Relationships


The Schema Design | Named Schema Relationships command allows the definition of
named relationships to provide the information needed to create the document hierarchy. You
have to have previously enabled the SQL Server schema extensions, using the menu option
"Enable SQL Server Schema Extensions", to be able to access this menu option.

To create a named schema relationship:

1. Click the insert or append icon , to add a new row to the dialog box.
2. Click the field and enter the corresponding relationship name.
3. Click OK to confirm.

© 2010 Altova GmbH User Manual


678 User Reference Schema Design Menu

This generates a SQL relationship element, placing it just after the namespace
declaration.

Please note: Click the delete icon , to delete a row from the dialog box.

Unnamed Element Relationships


The Schema Design | Unnamed Element Relationships command allows the definition of
unnamed relationships to provide the information needed to create the document hierarchy. You
have to have previously enabled the SQL Server schema extensions, using the menu option
Enable Microsoft SQL Server Schema Extensions, to be able to access this menu option.

To create an unnamed schema relationship:

1. Click the insert or append icon , to add a new row to the dialog box.
2. Click the field and enter the corresponding relationship name.
3. Click OK to confirm.

This generates a SQL relationship element for the currently selected schema element.

Please note: Click the delete icon , to delete a row from the dialog box.

21.6.9 Connect to SchemaAgent Server

The Schema Design | Connect to SchemaAgent Server command is enabled when an XML
Schema document is active and it enables you to connect to a SchemaAgent Server. You are

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Schema Design Menu 679

able to connect to a SchemaAgent server only if a licensed Altova SchemaAgent product is


installed on your machine. When you click this command, the Connect to SchemaAgent Server
dialog (screenshot below) opens:

You can use either the local server (the SchemaAgent server that is packaged with Altova
SchemaAgent or a network server (the Altova SchemaAgent Server product, which is available
free of charge). If you select Work Locally, the local server of SchemaAgent will be started
when you click OK and a connection with it will be established. If you select Connect to
Network Server, the selected SchemaAgent Server must be running in order for a connection
to be made.

When connected to SchemaAgent Server, XMLSpy acts as a SchemaAgent client, and


provides powerful and enhanced schema editing and management functionality. For details
about SchemaAgent, the installation of SchemaAgent Server, and how to connect to
SchemaAgent Server, see Schema Agentin the Schema/WSDL View section of this user
manual. For more information about installing and working with these two products, see the
SchemaAgent user manual that is delivered with these products.

After you connect to SchemaAgent Server, a message appears in the bar at the top of the Main
Window with information about the connection. You now have full access to all schemas and
schema components in the search path/s (folder/s) defined for the SchemaAgent server to
which XMLSpy is connected.

Please note: In order for the connection to succeed, you must have Altova's SchemaAgent
Client product installed with a valid license on the same machine as that on which XMLSpy is
installed.

21.6.10 Disconnect from SchemaAgent Server

The Disconnect from SchemaAgent Server command is enabled when a connection to a


SchemaAgent Server has been made successfully. Selecting this command disconnects
XMLSpy from the SchemaAgent Server.

21.6.11 Show in SchemaAgent


The Show in SchemaAgent menu item causes the active schema and, optionally, linked
schemas to be displayed in the Altova product SchemaAgent. (This product must be installed
on the same machine as XMLSpy if you wish to use SchemaAgent functionality). The schema/s
are opened in a new SchemaAgent Design in SchemaAgent.

© 2010 Altova GmbH User Manual


680 User Reference Schema Design Menu

Mousing over the Show in SchemaAgent menu item pops out a submenu with options about
what schemas to show in SchemaAgent. These options are described in Schema Agent in the
Schema/WSDL View section of this user manual.

21.6.12 SchemaAgent Validation

The SchemaAgent Validation command enables you to validate the currently active schema
as well as schemas related to the currently active schema. This feature is described in detail in
the SchemaAgent Validation section in the Schema View section of this user manual.

21.6.13 Create Schema Subset


The Create Schema Subset. command pops up the Select Schema Components dialog (
screenshot below). In this dialog, you check the component or components you wish to create
as a single schema subset, then click Next. (Note that a check box below the pane enables
components from all referenced files to also be listed for selection.)

In the Schema Subset Generation dialog that now appears (screenshot below), enter the name/

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Schema Design Menu 681

s you want the file/s of the schema subset package to have. You must also specify the folder in
which the new schema subset files are to be saved. A schema subset package could have
multiple files if one or more of the components being created is an imported component in the
original schema. A separate schema file is created for each namespace in the schema subset.
The filenames displayed in the dialog are, by default, the names of the original files. But since
you are not allowed to overwrite the original files, use new filenames if you wish to save the files
in the same folder as the original files.

On clicking OK, the schema subset file with the namespace corresponding to that of the active
file is opened in Schema View. Any other files in the package are created but not opened in
Schema View.

21.6.14 Flatten Schema


Flattening the active schema in Schema View is the process of: (i) adding the components of all
included schemas as global components of the active schema, and (ii) deleting the included
schemas.

To flatten the active schema, select the command Schema Design | Flatten Schema. This
pops up the Flatten Schema dialog (screenshot below), which contains the names of separate
files, one for each namespace that will be in the flattened schema. These default names are the
same as the original filenames. But since you are not allowed to overwrite the original files, the
filenames must be changed if you wish to save in the same folder as the active file. You can
browse for a folder in which the flattened schema and its associated files will be saved.

© 2010 Altova GmbH User Manual


682 User Reference Schema Design Menu

On clicking OK, the flattened schema file will be opened in Schema View.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XSL/XQuery Menu 683

21.7 XSL/XQuery Menu


The XSL Transformation language lets you specify how an XML document should be converted
into other XML documents or text files. One kind of XML document that is generated with an
XSLT document is an FO document, which can then be further processed to generate PDF
output. XMLSpy contains built-in XSLT processors (for XSLT 1.0 and XSLT 2.0) and can link to
an FO processor on your system to transform XML files and generate various kinds of outputs.
The location of the FO processor must be specified in the XSL tab of the Options dialog (Tools |
Options) in order to be able to use it directly from within the XMLSpy interface.

XMLSpy also has a built-in XQuery engine, which can be used to execute XQuery documents
(with or without reference to an XML document).

Commands to deal with all the above transformations are accessible in the XSL/XQuery menu.
In addition, this menu also contains commands to work with the Altova XSLT/XQuery
Debugger.

© 2010 Altova GmbH User Manual


684 User Reference XSL/XQuery Menu

21.7.1 XSL Transformation


F10

The XSL/XQuery | XSL Transformation command transforms an XML document using an


assigned XSLT stylesheet. The transformation can be carried out using the appropriate built-in
Altova XSLT Engine (Altova XSLT 1.0 Engine for XSLT 1.0 stylesheets; Altova XSLT 2.0
Engine for XSLT 2.0 stylesheets), the Microsoft-supplied MSXML module, or an external XSLT
processor. The processor that is used in conjunction with this command is specified in the XSL
tab of the Options dialog (Tools | Options).

If your XML document contains a reference to an XSLT stylesheet, then this stylesheet is used

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XSL/XQuery Menu 685

for the transformation. (An XSLT stylesheet can be assigned to an XML document using the
Assign XSL command. If the XML document is part of a project, an XSLT stylesheet can be
specified on a per-folder basis in the Project Properties dialog. Right-click the project folder/s or
file/s you wish to transform and select XSL Transformation.) If an XSLT stylesheet has not
been assigned to an XML file, you are prompted for the XSLT stylesheet to use. You can also
select a file via a global resource or a URL (click the Browse button) or a file in one of the open
windows in XMLSpy (click the Window button).

Automating XSLT transformations with Altova XML 2011


Altova XML is a free application which contains Altova's XML Validator, XSLT 1.0, XSLT 2.0,
and XQuery 1.0 engines. It can be used from the command line, via a COM interface, in Java
programs, and in .NET applications to validate XML documents, transform XML documents
using XSLT 1.0 and 2.0 stylesheets, and execute XQuery documents.

XSLT transformation tasks can therefore be automated with the use of Altova XML. For
example, you can create a batch file that calls Altova XML to transform a set of documents. See
the Altova XML documentation for details.

Transformations to ZIP files


In order to enforce output to a ZIP file, including Open Office XML (OOXML) files such as .docx,
one must specify the ZIP protocol in the file path of the output file. For example:
filename.zip|zip/filename.xxx
filename.docx|zip/filename.xxx

Note: The directory structure might need to be created before running the transformation. If
you are generating files for an Open Office XML archive, you would need to zip the
archive files in order to create the top-level OOXML file (for example, .docx).

21.7.2 XSL-FO Transformation


Ctrl+F10

FO is an XML format that describes paged documents. An FO processor, such as the Apache
XML Project's FOP, takes an FO file as input and generates PDF as output. So, the production
of a PDF document from an XML document is a two-step process.
1. The XML document is transformed to an FO document using an XSLT (aka XSL-FO)
stylesheet.
2. The FO document is processed by an FO processor to generate PDF (or some
alternative output).

The XSL/XQuery | XSL:FO Transformation command transforms an XML document or an FO


document to PDF.
 If the XSL:FO Transformation command is executed on a source XML document,
then both of the steps listed above are executed, in sequence, one after the other. If the
XSLT (or XSL-FO) stylesheet required to transform to FO is not referenced in the XML
document, you are prompted to assign one for the transformation (screenshot below).
Note that you can also select a file via a global resource or a URL (click the Browse
button) or a file in one of the open windows in XMLSpy (click the Window button). The
transformation from XML to XSL-FO is carried out by the XSLT processor specified in
the XSL tab of the Options dialog (Tools | Options). By default the selected XSLT
processor is XMLSpy's built-in XSLT processor. The resultant FO document is directly

© 2010 Altova GmbH User Manual


686 User Reference XSL/XQuery Menu

processed with the FO processor specified in the XSL tab of the Options dialog (Tools |
Options).
 If the XSL:FO Transformation command is executed on an FO document, then the
document is processed with the FO processor specified in the XSL tab of the Options
dialog (Tools | Options).

XSL:FO Transformation output


The XSL:FO Transformation command pops up the Choose XSL:FO Output dialog (
screenshot below). (If the active document is an XML document without an XSLT assignment,
you are first prompted for an XSLT file.)

You can view the output of the FO processor directly on screen using FOP viewer or you can
generate an output file in any one of the following formats: PDF, text, an XML area tree, MIF
PCL, or PostScript. You can also switch on messages from the FO processor to show (i) the
processor's standard output message in the Messages window; and (ii) the processor's error
messages in the Messages window. To switch on either these two options, check the
appropriate check box at the bottom of the dialog.

Please note:
 The Apache FOP processor can be downloaded free of charge using the link at the
Altova Download Center. After downloading and installing FOP, you must set the path
to the FOP batch file in the XSL tab of the Options dialog (Tools | Options).
 The XSL:FO Transformation command can not only be used on the active file in the
Main Window but also on any file or folder you select in the active project. To do this,
right-click and select XSL:Transformation. The XSLT stylesheet assigned to the
selected project folder is used.

21.7.3 XSL Parameters / XQuery Variables


The XSL/XQuery | XSL Parameters/XQuery Variables command opens the XSLT Input
Parameters/XQuery External Variables dialog (see screenshot). You can enter the name of one
or more parameters you wish to pass to the XSLT stylesheet, or one or more external XQuery
variables you wish to pass to the XQuery document, and their respective values. These
parameters are used as follows in XMLSpy:

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XSL/XQuery Menu 687

 When the XSL Transformation command in the XSL/XQuery menu is used to


transform an XML document, the parameter values currently saved in the dialog are
passed to the selected XSLT document and used for the transformation.
 When the XQuery Execution command in the XSL/XQuery menu is used to process
an XQuery document, the XQuery external variable values currently saved in the dialog
are passed to the XQuery document for the execution.

Please note: Parameters or variables that you enter in the XSLT Input Parameters/XQuery
External Variables dialog are only passed on to the built-in Altova XSLT engine. Therefore, if
you are using MSXML or another external engine that you have configured, these parameters
are not passed to this engine.

Using XSLT Parameters


The value you enter for the parameter can be an XPath expression without quotes or a text
string delimited by quotes. If the active document is an XSLT document, the Get from XSL
button will be enabled. Clicking this button inserts parameters declared in the XSLT into the
dialog together with their default values. This enables you to quickly include declared
parameters and then change their default values as required.

Please note: Once a set of parameter-values is entered in the XSLT Input Parameters/XQuery
External Variables dialog, it is used for all subsequent transformations until it is explicitly deleted
or the application is restarted. Parameters entered in the XSLT Input Parameters/XQuery
External Variables dialog are specified at the application-level, and will be passed to the
respective XSLT document for every transformation that is carried out via the IDE from that
point onward. This means that:
 parameters are not associated with any particular document
 any parameter entered in the XSLT Input Parameters/XQuery External Variables dialog
is erased once XMLSpy has been closed.

Usage example for XSLT parameters


In the following example, we select the required document footer from among three possibilities
in the XML document (footer1, footer2, footer3).
<?xml version="1.0" encoding="UTF-8"?>
<document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="C:\workarea\footers\footers.xsd">
<footer1>Footer 1</footer1>
<footer2>Footer 2</footer2>
<footer3>Footer 3</footer3>
<title>Document Title</title>
<para>Paragraph text.</para>
<para>Paragraph text.</para>
</document>

© 2010 Altova GmbH User Manual


688 User Reference XSL/XQuery Menu

The XSLT file contains a local parameter called footer in the template for the root element.
This parameter has a default value of footer1. The parameter value is instantiated
subsequently in the template with a $footer value in the definition of the footer block.
<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:fo="http://www.w3.org/1999/XSL/Format">
...
<xsl:param name="footer" select="document/footer1" />
...
<xsl:template match="/">
<fo:root>
<xsl:copy-of select="$fo:layout-master-set" />
<fo:page-sequence master-reference="default-page"
initial-page-number="1" format="1">
<fo:static-content flow-name="xsl-region-after"
display-align="after">
...
<fo:inline color="#800000" font-size="10pt" font-weight="bold">
<xsl:value-of select="$footer"/>
</fo:inline>
...
</fo:static-content>
</fo:page-sequence>
</fo:root>
</xsl:template>
</xsl:stylesheet>

In the XSLT Input Parameters dialog, a new value for the footer parameter can be entered,
such as the XPath: document/footer2 (see screenshot above) or a text string. During
transformation, this value is passed to the footer parameter in the template for the root
element and is the value used when the footer block is instantiated.

Note:
 If you use the XSL:FO Transformation command (XSL/XQuery | XSL:FO
Transformation), parameters entered in the XSLT Input Parameters/XQuery External
Variables dialog are not passed to the stylesheet. In order for these parameters to be
used in PDF output, first transform from XML to FO using the XSLT Transformation
command (XSL/XQuery | XSL Transformation), and then transform the FO to PDF
using the XSL:FO Transformation command (XSL/XQuery | XSL:FO
Transformation).
 If you use an XSLT processor other than the built-in Altova XSLT Engines, parameters
you enter using the XSLT Input Parameters command will not be passed to the external
processor.

Using external XQuery variables


The value you enter for an external XQuery variable could be an XPath expression without
quotes or a text string delimited by quotes. The datatype of the external variable is specified in
the variable declaration in the XQuery document.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XSL/XQuery Menu 689

Note: Once a set of external XQuery variables are entered in the XSLT Input
Parameters/XQuery External Variables dialog, they are used for all subsequent transformations
until they are explicitly deleted or the application is restarted. Variables entered in the XSLT
Input Parameters/XQuery External Variables dialog are specified at the application-level, and
will be passed to the respective XQuery document for every execution that is carried out via the
IDE from that point onward. This means that:
 Variables are not associated with any particular document
 Any variable entered in the XSLT Input Parameters/XQuery External Variables dialog is
erased once the application (XMLSpy) has been closed down.

Usage example for external XQuery variables


In the following example, a variable $first is declared in the XQuery document and is then
used in the return clause of the FLWOR expression:
xquery version "1.0";
declare variable $first as xs:string external;
let $last := "Jones"
return concat($first, " ", $last )

This XQuery returns Peter Jones, if the value of the external variable (entered in the XSLT
Input Parameters/XQuery External Variables dialog) is Peter. Note the following:
 The external keyword in the variable declaration in the XQuery document indicates
that this variable is an external variable.
 Defining the static type of the variable is optional. If a datatype for the variable is not
specified in the variable declaration, then the variable value is assigned the type
xs:untypedAtomic.
 If an external variable is declared in the XQuery document, but no external variable of
that name is passed to the XQuery document, then an error is reported.
 If an external variable is declared and is entered in the XSLT Input Parameters/XQuery
External Variables dialog, then it is considered to be in scope for the XQuery document
being executed. If a new variable with that name is declared within the XQuery
document, the new variable temporarily overrides the in-scope external variable. For
example, the XQuery document below returns Paul Jones even though the in-scope
external variable $first has a value of Peter.
xquery version "1.0";
declare variable $first as xs:string external;
let $first := "Paul"
let $last := "Jones"
return concat($first, " ", $last )

Note: It is not an error if an external XQuery variable (or XSLT parameter) is defined in the
XSLT Input Parameters/XQuery External Variables dialog but is not used in the XQuery

© 2010 Altova GmbH User Manual


690 User Reference XSL/XQuery Menu

document. Neither is it an error if an XSLT parameter (or external XQuery variable) is defined in
the XSLT Input Parameters/XQuery External Variables dialog but is not used in an XSLT
transformation.

21.7.4 XQuery Execution

The XSL/XQuery | XQuery Execution command executes an XQuery document. It can be


invoked when an XQuery or XML file is active. When invoked from an XML file, it opens a dialog
asking for an XQuery file to associate with the XML file. You can also select a file via a global
resource or a URL (click the Browse button) or a file in one of the open windows in XMLSpy
(click the Window button).

Automating XQuery executions with Altova XML 2011


Altova XML is a free application which contains Altova's XML Validator, XSLT 1.0, XSLT 2.0,
and XQuery 1.0 engines. It can be used from the command line, via a COM interface, in Java
programs, and in .NET applications to validate XML documents, transform XML documents
using XSLT 1.0 and 2.0 stylesheets, and execute XQuery documents.

XQuery execution tasks can therefore be automated with the use of Altova XML. For example,
you can create a batch file that calls Altova XML to execute a set of XQuery documents. See
the Altova XML documentation for details.

21.7.5 Enable XSLT/XQuery Profiling


The Enable XSLT/XQuery profiling command opens the Enable XSLT/XQuery profiling dialog.
This dialog allows you to activate the Profiler, which is a tool that analyzes the time it takes for
instructions to execute during an XSLT transformation or XQuery execution.

21.7.6 Assign XSL

The XSL/XQuery | Assign XSL... command assigns an XSLT stylesheet to an XML document.
Clicking the command opens a dialog to let you specify the XSLT file you want to assign. You
can also select a file via a global resource or a URL (click the Browse button) or a file in one of
the open windows in XMLSpy (click the Window button).

An xml-stylesheet processing instruction is inserted in the XML document:


<?xml-stylesheet type="text/xsl"
href="C:\workarea\recursion\recursion.xslt"?>

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XSL/XQuery Menu 691

Please note: You can make the path of the assigned file relative by clicking the Make Path
Relative To... check box.

21.7.7 Assign XSL-FO


The XSL/XQuery | Assign XSL:FO... command assigns an XSLT stylesheet for transformation
to FO to an XML document. The command opens a dialog to let you specify the XSL or XSLT
file you want to assign and inserts the required processing instruction into your XML document:
<?xmlspyxslfo C:\Program Files\Altova\xmlspy\Examples\OrgChartFO.xsl?>

You can make the path of the assigned file relative by clicking the Make Path Relative To...
check box. You can also select a file via a global resource or a URL (click the Browse button)
or a file in one of the open windows in XMLSpy (click the Window button).

Please note: An XML document may have two XSLT files assigned to it: one for standard
XSLT transformations, a second for an XSLT transformation to FO.

21.7.8 Assign Sample XML File

The XSL/XQuery | Assign Sample XML File command assigns an XML file to an XSLT
document. The command inserts a processing instruction naming an XML file to be processed
with this XSLT file when the XSL Transformation is executed on the XSLT file:
<?altova_samplexml C:\workarea\html2xml\article.xml?>

Please note: You can make the path of the assigned file relative by clicking the Make Path
Relative To... check box. You can also select a file via a global resource or a URL (click the
Browse button) or a file in one of the open windows in XMLSpy (click the Window button).

21.7.9 Go to XSL

The XSL/XQuery | Go to XSL command opens the associated XSLT document. If your XML
document contains a stylesheet processing instruction (i.e. an XSLT assignment) such as this:
<?xml-stylesheet type="text/xsl" href="Company.xsl"?>
then the Go to XSL command opens the XSLT document in XMLSpy.

21.7.10 Start Debugger / Go

Alt+F11

The XSL/XQuery | Start Debugger/Go command starts or continues processing the


XSLT/XQuery document till the end. If breakpoints have been set, then processing will pause at
that point. If tracepoints have been set, output for these statements will be displayed in the
Trace window when the closing node of the statement with the tracepoint has been reached. If
the debugger session has not been started, then this button will start the session and stop at the
first node to be processed. If the session is running, then the XSLT/XQuery document will be

© 2010 Altova GmbH User Manual


692 User Reference XSL/XQuery Menu

processed to the end, or until the next breakpoint is encountered.

21.7.11 Stop Debugger

The XSL/XQuery | Stop Debugger command stops the debugger. This is not the same as
stopping the debugger session in which the debugger is running. This is convenient if you wish
to edit a document in the middle of a debugging session or to use alternative files within the
same debugging session. After stopping the debugger, you must restart the debugger to start
from the beginning of the XSLT/XQuery document.

21.7.12 Restart Debugger

The XSL/XQuery | Restart Debugger command clears the output window and restarts the
debugging session with the currently selected files.

21.7.13 End Debugger Session

The XSL/XQuery | End Debugger Session command ends the debugging session and returns
you to the normal XMLSpy view that was active before you started the debugging session.
Whether the output documents that were opened for the debugging session stay open depends
on a setting you make in the XSLT/XQuery Debugger Settings dialog.

21.7.14 Step Into

F11

The XSL/XQuery | Step Into command proceeds in single steps through all nodes and XPath
expressions in the stylesheet. This command is also used to re-start the debugger after it has
been stopped.

21.7.15 Step Out

Shift+F11

The XSL/XQuery | Step Out command steps out of the current node to the next sibling of the
parent node, or to the next node at the next higher level from that of the parent node.

21.7.16 Step Over

Ctrl+F11

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XSL/XQuery Menu 693

The XSL/XQuery | Step Over command steps over the current node to the next node at the
same level, or to the next node at the next higher level from that of the current node. This
command is also used to re-start the debugger after it has been stopped.

21.7.17 Show Current Execution Node

The XSL/XQuery | Show Current Execution Node command displays/selects the current
execution node in the XSLT/XQuery document and the corresponding context node in the XML
document. This is useful when you have clicked in other tabs which show or mark specific code
in the XSLT stylesheet or XML file, and you want to return to where you were before you did
this.

21.7.18 Insert/Remove Breakpoint

F9

The XSL/XQuery | Insert/Remove Breakpoint command inserts or removes a breakpoint at


the current cursor position. Inline breakpoints can be defined for nodes in both the
XSLT/XQuery and XML documents, and determine where the processing should pause. A
dashed red line appears above the node when you set a breakpoint. Breakpoints cannot be
defined on closing nodes, and breakpoints on attributes in XSLT documents will be ignored.
This command is also available by right-clicking at the breakpoint location.

21.7.19 Insert/Remove Tracepoint

Shift+F9

The XSL/XQuery | Insert/Remove Tracepoint command inserts or removes a tracepoint at the


current cursor position in an XSLT/XQuery document. For statements with a tracepoint, during
debugging, the value of the statement is displayed in the Trace window when the closing node
of that statement is reached. A dashed blue line appears above the node when you set a
tracepoint. Tracepoints cannot be defined on closing nodes. This command is also available by
right-clicking at the tracepoint location.

21.7.20 Enable/Disable Breakpoint

Ctrl+F9

The XSL/XQuery | Enable/Disable Breakpoint command (no toolbar icon exists) enables or
disables already defined breakpoints. The red breakpoint highlight turns to gray when the
breakpoint is disabled. The debugger does not stop at disabled breakpoints. To disable/enable
a breakpoint, place the cursor in that node name and click the Enable/Disable Breakpoint
command. This command is also available by right-clicking at the location where you want to
enable/disable the breakpoint.

© 2010 Altova GmbH User Manual


694 User Reference XSL/XQuery Menu

21.7.21 Enable/Disable Tracepoint

Ctrl+Shift+F9

The XSL/XQuery | Enable/Disable Tracepoint command (no toolbar icon exists) enables or
disables already defined tracepoints. The blue tracepoint highlight turns to gray when the
tracepoint is disabled. No output is displayed for statements with disabled tracepoints. To
disable/enable a tracepoint, place the cursor in that node name and click the Enable/Disable
Tracepoint command. This command is also available by right-clicking at the location where
you want to enable/disable the tracepoint.

21.7.22 Breakpoints/Tracepoints

The XSL/XQuery | Breakpoints/Tracepoints... command opens the XSLT Breakpoints /


Tracepoints dialog, which displays a list of all currently defined breakpoints and tracepoints
(including disabled breakpoints and tracepoints) in all files in the current debugging session.

The check boxes indicate whether a breakpoint or tracepoint is enabled (checked) or disabled.
You can remove the highlighted breakpoint or tracepoint by clicking the corresponding Remove
button, and remove all breakpoints by clicking the corresponding Remove All button. The Edit
Code button takes you directly to that breakpoint/tracepoint in the file.

Use the down arrow to move the highlighted breakpoint to the Tracepoints pane and the

up arrow to move the highlighted tracepoint to the Breakpoints pane.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XSL/XQuery Menu 695

In the XPath column in the Tracepoints pane, you can set an XPath for each tracepoint.

21.7.23 Debug Windows


Placing the cursor over the XSL/XQuery | Debug Windows command pops out a submenu
with a list of the various Information Windows of the XSLT/XQuery Debugger. Selecting an
Information Window from this list highlights that Information Window in the XSLT/XQuery
Debugger interface. This command can be used to effect only when a debugging session is in
progress.

21.7.24 XSLT/XQuery Settings

The XSL/XQuery | XSLT/XQuery Settings command opens the XSLT/XQuery Settings dialog,
which enables you to set user options for the Debugger. See the XSLT/XQuery Debugger
section for details.

© 2010 Altova GmbH User Manual


696 User Reference Authentic Menu

21.8 Authentic Menu


Authentic View enables you to edit XML documents based on StyleVision Power Stylesheets
(.sps files) created in Altova's StyleVision product! These stylesheets contain information
that enables an XML file to be displayed graphically in Authentic View. In addition to containing
display information, StyleVision Power Stylesheets also allow you to write data to the XML file.
This data is dynamically processed using all the capability available to XSLT stylesheets and
instantly produces the output in Authentic View.

Additionally, StyleVision Power Stylesheets can be created to display an editable XML view of a
database. The StyleVision Power Stylesheet contains information for connecting to the
database, displaying the data from the database in Authentic View, and writing back to the
database.

The Authentic menu contains commands relevant to editing XML documents in Authentic View
. For a tutorial on Authentic View, see the Tutorials section.

21.8.1 New Document


The Authentic | New Document... command enables you to open a new XML document
template in Authentic View. The XML document template is based on a StyleVision Power
Stylesheet (.sps file), and is opened by selecting the StyleVision Power Stylesheet.

Clicking the New Document... command opens the Create New Document dialog.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Authentic Menu 697

Browse for the required SPS file, and select it. This opens an XML document template in
Authentic View.

Please note: StyleVision Power Stylesheets are created using Altova StyleVision. The
StyleVision Power Stylesheet has a Template XML File assigned to it. The data in this XML file
provides the starting data of the new document template that is opened in Authentic View.

21.8.2 Edit Database Data


The Authentic | Edit Database Data... command enables you to open an editable view of a
database (DB) in Authentic View. All the information about connecting to the DB and how to
display the DB and accept changes to it in Authentic View is contained in a StyleVision Power
Stylesheet. It is such a DB-based StyleVision Power Stylesheet that you open with the Edit
Database Data... command. This sets up a connection to the DB and displays the DB data
(through an XML lens) in Authentic View.

Clicking the Edit Database Data... command opens the Edit Database Data dialog.

© 2010 Altova GmbH User Manual


698 User Reference Authentic Menu

Browse for the required SPS file, and select it. This connects to the DB and opens an editable
view of the DB in Authentic View. The design of the DB view displayed in Authentic View is
contained in the StyleVision Power Stylesheet.

Please note: If, with the Edit Database Data... command, you attempt to open a StyleVision
Power Stylesheet that is not based on a DB or to open a DB-based StyleVision Power
Stylesheet that was created in a version of StyleVision prior to the StyleVision 2005 release, you
will receive an error.

Please note: StyleVision Power Stylesheets are created using Altova StyleVision.

21.8.3 Assign/Edit a StyleVision Stylesheet


Assign a StyleVision Stylesheet
The Assign a StyleVision Stylesheet command assigns a StyleVision Power Stylesheet (SPS)
to an XML document to enable the viewing and editing of that XML document in Authentic
View. The StyleVision Power Stylesheet that is to be assigned to the XML file must be based on
the same schema as that on which the XML file is based.

To assign a StyleVision Power Stylesheet to an XML file:


1. Make the XML file the active file and select the Authentic | Assign a StyleVision
Stylesheet... command.
2. The command opens a dialog box in which you specify the StyleVision Power
Stylesheet file you wish to assign to the XML.
3. Click OK to insert the required SPS statement into your XML document. Note that you
can make the path to the assigned file relative by clicking the Make path relative to ...
check box. You can also select a file via a global resource or a URL (click the Browse
button) or a file in one of the open windows in XMLSpy (click the Window button).
<?xml version="1.0" encoding="UTF-8"?>
<?altova_sps HTML-Orgchart.sps?>

In the example above, the StyleVision Power Stylesheet is called HTML_Orgchart.sps, and it
is located in the same directory as the XML file.

Please note: Previous versions of Altova products used a processing instruction with a target or
name of xmlspysps, so a processing instruction would look something like <?xmlspysps
HTML-Orgchart.sps?>. These older processing instructions are still valid with Authentic View
in current versions of Altova products.

Edit StyleVision Stylesheet


The Authentic | Edit StyleVision Stylesheet command starts StyleVision and allows you to
edit the StyleVision Power Stylesheet immediately in StyleVision.

21.8.4 Select New Row with XML Data for Editing


The Select New Row with XML Data for Editing command enables you to select a new row
from the relevant table in an XML DB, such as IBM DB2. This row appears in Authentic View,
can be edited there, and then saved back to the DB.

When an XML DB is used as the XML data source, the XML data that is displayed in Authentic
View is the XML document contained in one of the cells of the XML data column. The Select
New Row with XML Data for Editing command enables you to select an XML document from
another cell (or row) of that XML column. Selecting the Select New Row... command pops up

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Authentic Menu 699

the Choose XML Field dialog (screenshot below), which displays the table containing the XML
column.

You can enter a filter for this table. The filter should be an SQL WHERE clause (just the condition,
without the WHERE keyword, for example: CID>1002). Click Update to refresh the dialog. In the
screenshot above, you can see the result of a filtered view. Next, select the cell containing the
required XML document and click OK. The XML document in the selected cell (row) is loaded
into Authentic View.

21.8.5 Define XML Entities


You can define entities for use in Authentic View, whether your document is based on a DTD or
an XML Schema. Once defined, these entities are displayed in the Entities Entry Helper and in
the Insert Entity submenu of the context menu. When you double-click on an entity in the
Entities Entry Helper, that entity is inserted at the cursor insertion point.

An entity is useful if you will be using a text string, XML fragment, or some other external
resource in multiple locations in your document. You define the entity, which is basically a short
name that stands in for the required data, in the Define Entities dialog. After defining an entity
you can use it at multiple locations in your document. This helps you save time and greatly
enhances maintenance.

There are two broad types of entities you can use in your document: a parsed entity, which is
XML data (either a text string or a fragment of an XML document), or an unparsed entity,
which is non-XML data such as a binary file (usually a graphic, sound, or multimedia object).
Each entity has a name and a value. In the case of parsed entities the entity is a placeholder for
the XML data. The value of the entity is either the XML data itself or a URI that points to a .xml
file that contains the XML data. In the case of unparsed entities, the value of the entity is a URI
that points to the non-XML data file.

To define an entity:

© 2010 Altova GmbH User Manual


700 User Reference Authentic Menu

1. Click Authentic | Define XML Entities.... This opens the Define Entities dialog.

2. Enter the name of your entity in the Name field. This is the name that will appear in the
Entities Entry Helper.
3. Enter the type of entity from the drop-down list in the Type field. Three types are
possible. An Internal entity is one for which the text to be used is stored in the XML
document itself. Selecting PUBLIC or SYSTEM specifies that the resource is located
outside the XML file, and will be located with the use of a public identifier or a system
identifier, respectively. A system identifier is a URI that gives the location of the
resource. A public identifier is a location-independent identifier, which enables some
processors to identify the resource. If you specify both a public and system identifier,
the public identifier resolves to the system identifier, and the system identifier is used.
4. If you have selected PUBLIC as the Type, enter the public identifier of your resource in
the PUBLIC field. If you have selected Internal or SYSTEM as your Type, the PUBLIC
field is disabled.
5. In the Value/Path field, you can enter any one of the following:
 If the entity type is Internal, enter the text string you want as the value of your entity.
Do not enter quotes to delimit the entry. Any quotes that you enter will be treated as
part of the text string.
 If the entity type is SYSTEM, enter the URI of the resource or select a resource on
your local network by using the Browse button. If the resource contains parsed data,
it must be an XML file (i.e. it must have a .xml extension). Alternatively, the resource
can be a binary file, such as a GIF file.
 If the entity type is PUBLIC, you must additionally enter a system identifier in this field.
6. The NDATA entry tells the processor that this entity is not to be parsed but to be sent to
the appropriate processor. The NDATA field should therefore be used with unparsed
entities only.

Dialog features
You can append, insert, and delete entities by clicking the appropriate buttons. You can also
sort entities on the alphabetical value of any column by clicking the column header; clicking
once sorts in ascending order, twice in descending order. You can also resize the dialog box
and the width of columns.

Once an entity is used in the XML document, it is locked and cannot be edited in the Define
Entities dialog. Locked entities are indicated by a lock symbol in the first column. Locking an
entity ensures that the XML document valid with respect to entities. (The document would be
invalid if an entity is referenced but not defined.)

Duplicate entities are flagged.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Authentic Menu 701

Limitations
 An entity contained within another entity is not resolved, either in the dialog, Authentic
View, or XSLT output, and the ampersand character of such an entity is displayed in its
escaped form, i.e. &amp;.
 External entities are not resolved in Authentic View, except in the case where an entity
is an image file and it is entered as the value of an attribute which has been defined in
the schema as being of type ENTITY or ENTITIES. Such entities are resolved when
the document is processed with an XSLT generated from the SPS.

21.8.6 Hide Markup, Show Small/Large/Mixed Markup

The Hide Markup command hides markup symbols in the Authentic View.

The Show Small Markup command shows small markup symbols in the Authentic View.

The Show Large Markup command shows large markup symbols in the Authentic View.

The Show Mixed Markup command shows mixed markup symbols in Authentic View. The
person who designs the StyleVision Power Stylesheet can specify either large markup, small
markup, or no markup for individual elements/attributes in the document. The Authentic View
user sees this customized markup in mixed markup viewing mode.

21.8.7 Append/Insert/Duplicate/Delete Row

The Append Row command appends a row to the current table in Authentic View.

The Insert Row command inserts a row into the current table in Authentic View.

The Duplicate Row command duplicates the current table row in Authentic View.

© 2010 Altova GmbH User Manual


702 User Reference Authentic Menu

The Delete Row command deletes the current table row in Authentic View.

21.8.8 Move Row Up/Down

The Move Row Up command moves the current table row up by one row in Authentic View.

The Move Row Down command moves the current table row down by one row in Authentic
View.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 703

21.9 DB Menu
The DB menu contains the following menu items:
 Query Database, which enables you to query a variety of databases.
 IBM DB2, which contains commands that provide support for DB2-specific functionality.
 SQL Server, which contains commands for managing SQL Server databases.
 Oracle databases, which contains command for working with Oracle databases.

Since all the operations described in this section require a connection to a database, this
section also includes a sub-section called Connecting to a Data Source.

21.9.1 Connecting to a Data Source


A number of commands and icons in the DB and Convert menus require a connection to a
database. XMLSpy enables you to connect to a variety of databases (see list below). It uses the
Connect to Data Source dialog (for commands in the Convert menu, screenshot below) or
Quick Connect dialog (for the DB | Query Database command) to set up and make the
connection. Both dialogs are essentially the same; they guide you through the same connection
steps. In this section, we describe how the mechanism behind these two dialogs works. In
descriptions of the DB or Convert commands that require a database connection, refer to this
section for information on making the connection.

The options for connecting to the database are:


 Using a Connection Wizard that guides you through the connection process.
 Using an existing connection.
 Using an ADO Connection.

© 2010 Altova GmbH User Manual


704 User Reference DB Menu

 Using an ODBC Connection.


 Using a global resource.

Each option is described in the subsections of this section. The descriptions in this section
explain only the connection mechanism. The dialogs that appear subsequent to the connection
process are dependent on the specific command being executed, and these dialogs are
therefore described in the sections relating to that specific command. For example, if you are
looking for a description of the command Convert | Import Database Data, the description for
the connection process is in this section, but the selection of DB tables is described in the
section Convert | Import Database Data.

Native or ODBC?
When making the connection, you will be prompted to select between making a connection
natively or making it via ODBC (see screenshot below). An ODBC connection might have
limitations, so it is recommended to use the Natively option, which is the default option. If you
experience difficulties with teh native connection, use the ODBC option.

Supported databases
The following databases are supported. After connecting to the database, the available root
objects for each of the supported databases is as follows:

Database (natively supported) Root Object


MS SQL Server 2000, 2005, and 2008 database
Oracle 9i, 10g, and 11g schema
MS Access 2003 and 2007 database
MySQL 4.x and 5.x database
IBM DB2 8.x and 9 schema
Sybase 12 database

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 705

IBM DB2 for i 5.4 and i 6.1 schema


PostgreSQL 8.0, 8.1, 8.2, 8.3 database

Note: XMLSpy fully supports the databases listed above. While Altova endeavors to support
other ODBC/ADO databases, successful connection and data processing have only
been tested with the listed databases.

Connection Wizard
In the Connect to Data Source dialog, when the Connection Wizard button is selected, the
Connection Wizard (screenshot below) pops up. The Connection Wizard helps you to connect
to the most commonly used types of databases. In this section, we go through the connection to
a Microsoft Access database and an IBM DB2 database.

MS Access
Carry out the following steps to connect to an MS Access database. Select Microsoft Access
(ADO) (screenshot below), and click Next.

In the Connect to MS Access dialog that pops up, browse for the MS Access database, and
click Next. The connection to the data source is established. For information about subsequent
dialogs, refer to the description of the command being executed.

IBM DB2
In the first screen of the Connection Wizard (see first screenshot in this section), select IBM
DB2 and click Next. The Connection dialog (screenshot below) pops up. The wizard will then

© 2010 Altova GmbH User Manual


706 User Reference DB Menu

guide you in configuring the connection to the IBM DB2 database and making the connection.
These steps consist essentially of selecting the appropriate driver to connect to the DB, then
locating the DB, and entering user information that enables you to connect.

In the Configuration dialog above, select an existing data source, or create a new data source
with an appropriate driver (additional drivers can be added to the list of available drivers by
clicking the Edit Drivers button and selecting the required drivers). In the following screen you
will be prompted for user information (ID and password). Clicking OK will establish the
connection with the database. For information about subsequent dialogs, refer to the description
of the command being executed.

Existing Connections
In the Connect to Data Source dialog, when the Existing Connections button is selected, the
Existing Connections pane opens (screenshot below), showing all the connections that are
currently established.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 707

Select the required database and click Connect. The connection to the database is established.
For information about subsequent dialogs, refer to the description of the command being
executed.

ADO Connections
The ADO Connections option enables you to connect to a DB via ADO. In this section, the
connection via ADO is described using an IBM DB2 database as the target DB. Where options
are different if another type of database is the target DB, these differences are noted.

1. In the Connect to Data Source dialog, select ADO Connections. The ADO Connections
box appears (screenshot below).

© 2010 Altova GmbH User Manual


708 User Reference DB Menu

2. Click the Build button. The Data Link Properties dialog (screenshot below) opens.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 709

3. Select Microsoft OLE DB Provider for ODBC Drivers from the drop-down list and click
Next. The Connection tab is activated. (For Microsoft SQL DBs, we recommend
Microsoft OLE DB Provider for SQL Server; for Oracle, MySQL, Sybase, and IBM DB2
DBs, Microsoft OLE DB Provider for ODBC Drivers.)

© 2010 Altova GmbH User Manual


710 User Reference DB Menu

4. Build a connection string via the Build button (the dialog which pops up prompts you for
a data source and user information). In the case of some databases (such as Microsoft
SQL Server), you do not build a connection string but instead select the server and
database from combo box listings.
5. If login information is required, enter a user name and password, and check the Allow
Saving Password check box.
6. Click OK. The Data Link Properties dialog closes. The connection string appears in the
ADO Connections box (screenshot below).

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 711

7. Click the Connect button. The connection to the data source is established. For
information about subsequent dialogs, refer to the description of the command being
executed.

ODBC Connections
This section describes how to connect to a DB via ODBC. The steps listed below describe a
connection to an IBM DB2 database, but apply also to other types of databases that can be
connected via ODBC. To connect using an ODBC connection, do the following:

1. In the Connect to Data Source dialog, select ODBC Connections.

© 2010 Altova GmbH User Manual


712 User Reference DB Menu

1. Select one of the options for specifying a Data Source Name (DSN). If you select
System DSN or User DSN, the available DSNs are displayed in the Data Source pane.
If you select File DSN, you are prompted to browse for the DSN file. Alternatively, you
can build a connection string to the DB by selecting the Build a Connection String
option.
2. If you wish to add a DSN to those in the Data Source pane, click the Create a New DSN
icon .
3. In the Create an ODBC DSN dialog that appears, select the required driver, then click
the User DSN or System DSN button.
4. In the dialog that appears (screenshot below), select the DB alias and give it a DSN.

5. Click OK to finish. The DB is added as a Data Source to the list in the Data Source
pane.
6. After you have selected the DataSource (via the System DSN or User DSN option), or
selected a DSN File (File DSN option), or built a connection string (Connection String
option), click Connect.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 713

7. When you are prompted for your user ID and password, enter these and then click OK.
The connection to the database is established. For information about subsequent
dialogs, refer to the description of the command being executed.

Note: The listing in the data source pane (when the System DSN or User DSN option is
selected) can be edited using the Edit Selected DSN, Remove Selected DSN, and
Refresh Listed DSNs icons at the bottom of the ODBC Connections screen.

Edit selected DSN.

Remove selected DSN.

Refresh listed DSNs.

Building a connection string


In the ODBC Connections screen, when you select the Build a Connection String radio button,
the Select Data Source dialog (screenshot below) pops up. You can either select a File DSN (in
the File Data Source tab), or select a data source that is available on your machine (listed in the
Machine Data Source tab).

Clicking OK pops up a dialog that prompts for user information, including the User ID and
password. When you click OK in this dialog, the connection string is entered in the ODBC
Connections screen.

© 2010 Altova GmbH User Manual


714 User Reference DB Menu

Global Resources
In the Connect to Data Source dialog, when the Global Resources button is selected, the
Global Resources pane opens (screenshot below), showing all the database-type global
resources that are defined in the currently active Global Resources XML File.

Select the required global resource and click Connect. The connection to the database is
established. For information about subsequent dialogs, refer to the description of the command
being executed.

21.9.2 Query Database


The Query Database command opens the Database Query window (screenshot below). Once
the Query Window is open, its display can be toggled on and off by clicking either the DB |
Query Database command or the Query Database toolbar icon .

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 715

Overview of the Database Query window


The Database Query window consists of three parts:
 A Browser pane at top left, which displays connection info and database tables.
 A Query pane at top right, in which the query is entered.
 A tabbed Results/Messages pane. The Results pane displays the query results in
what we call the Result Grid. The Messages pane displays messages about the query
execution, including warnings and errors.

The Database Query window has a toolbar at the top. At this point, take note of the two toolbar
icons below. The other toolbar icons are described in the section, Query Pane: Description and
Features.

Toggles the Browser pane on and off.

Toggles the Results/Messages pane on and off.

Overview of the Query Database mechanism


The Query Database mechanism is as follows. It is described in detail in the sub-sections of this
section
1. A connection to the database is established via the Database Query window. Supported
databases include: MS Access 2000 and 2003; Microsoft SQL Server; Oracle; MySQL;
Sybase; and IBM DB2.
2. The connected database or parts of it are displayed in the Browser pane, which can be

© 2010 Altova GmbH User Manual


716 User Reference DB Menu

configured to suit viewing requirements.


3. A query written in a syntax appropriate to the database to be queried is entered in the
Query pane, and the query is executed.
4. The results of the query can be viewed through various filters, edited, and saved back
to the DB.

Data Sources
In order to query a database, you have to first connect to the required database This section
describes how to:
 Connect to a database, and
 Select the required data source and root object from among multiple existing
connections.

Connecting to a database
When you click the Query Database command for the first time in a session (or when no
database connection exists), the Quick Connect dialog (screenshot below) pops up to enable
you to connect to a database. To make connections subsequently, click the Quick Connect
icon in the Database Query window.

How to connect to a database via the Quick Connect dialog is described in the section
Connecting to a Data Source.

The following databases are supported. After connecting to the database, the available root
objects for each of the supported databases is as follows:

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 717

Database (natively supported) Root Object


MS SQL Server 2000, 2005, and 2008 database
Oracle 9i, 10g, and 11g schema
MS Access 2003 and 2007 database
MySQL 4.x and 5.x database
IBM DB2 8.x and 9 schema
Sybase 12 database
IBM DB2 for i 5.4 and i 6.1 schema
PostgreSQL 8.0, 8.1, 8.2, 8.3 database

Note: XMLSpy fully supports the databases listed above. While Altova endeavors to support
other ODBC/ADO databases, successful connection and data processing have only
been tested with the listed databases.

Selecting the required data source


All the existing connections and the root objects of each are listed, respectively, in two combo
boxes in the toolbar of the Database Query window (screenshot below).

In the screenshot above, the database with the name StyleVision DB has been selected. Of
the available root objects for this database, the root object ALTOVA_USER has been selected.
The database and the root object are then displayed in the Browser pane.

Browser Pane: Viewing the DB Objects


The Browser pane provides an overview of objects in the selected database. This overview
includes database constraint information, such as whether a column is a primary or foreign key.
In IBM DB2 version 9 databases, the Browser additionally shows registered XML schemas in a
separate folder.

This section describes the following:


 The layouts available in the Browser pane.
 How to filter database objects.
 How to find database objects.

© 2010 Altova GmbH User Manual


718 User Reference DB Menu

Browser pane layouts


The default Folders layout displays database objects hierarchically. Depending on the selected
object, different context menu options are available when you right-click an item.

To select a layout for the Browser, click the Layout icon in the toolbar of the Browser pane and
select the layout from the drop-down list (screenshot below). Note that the icon changes with
the selected layout.

The available layouts are:


 Folders: Organizes database objects into folders based on object type in a hierarchical
tree, this is the default setting.
 No Schemas: Similar to the Folders layout, except that there are no database schema
folders; tables are therefore not categorized by database schema.
 No Folders: Displays database objects in a hierarchy without using folders.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 719

 Flat: Divides database objects by type in the first hierarchical level. For example,
instead of columns being contained in the corresponding table, all columns are
displayed in a separate Columns folder.
 Table Dependencies: Categorizes tables according to their relationships with other
tables. There are categories for tables with foreign keys, tables referenced by foreign
keys and tables that have no relationships to other tables.

To sort tables into User and System tables, switch to Folders, No Schemas or Flat layout, then
right-click the Tables folder and select Sort into User and System Tables. The tables are
sorted alphabetically in the User Tables and System Tables folders.

Filtering database objects


In the Browser pane (in all layouts except No Folders and Table Dependencies), schemas,
tables, and views can be filtered by name or part of a name. Objects are filtered as you type in
the characters, and filtering is case-insensitive by default.

To filter objects in the Browser, do the following:


1. Click the Filter Folder Contents icon in the toolbar of the Browser pane. Filter icons
appear next to the Tables and Views folders in the currently selected layout (screenshot
below).

2. Click the filter icon next to the folder you want to filter, and select the filtering option
from the popup menu, for example, Contains.

3. In the entry field that appears, enter the filter string (in the screenshot below, the filter
string on the Tables folder is NHE). The filter is applied as you type.

© 2010 Altova GmbH User Manual


720 User Reference DB Menu

Finding database objects


To find a specific database item by its name, you can use the Browser pane's Object Locator.
This works as follows:
1. In the toolbar of the Browser pane, click the Object Locator icon. A drop-down list
appears at the bottom of the Browser.
2. Enter the search string in the entry field of this list, for example name (screenshot below
). Clicking the drop-down arrow displays all objects that contain the search string.

3. Click the object in the list to see it in the Browser.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 721

Query Pane: Description and Features


The Query pane is an intelligent SQL editor for entering queries to the selected database. After
entering the query, clicking the Execute command of the Database Query window executes the
query and displays the result and execution messages in the Results/Messages pane. How to
work with queries is described in the next section, Query Pane: Working with Queries. In this
section, we describe the main features of the Query pane:

 SQL Editor icons in the Database Query toolbar


 SQL Editor options
 Auto-completion of SQL statements
 Definition of regions in an SQL script
 Insertion of comments in an SQL script
 Use of bookmarks

SQL Editor icons in the Database Query toolbar


The following icons in the toolbar of the Database Query window are used when working with
the SQL Editor:

Execute Executes currently selected SQL statement. If script


contains multiple statements and none is selected, then all
are executed.
Execute with Same as for Execute command, except that results (in
Data Editing Results tab) are editable.
Import SQL File Opens an SQL file in the SQL Editor.

Export SQL File Saves SQL queries to an SQL file.

Undo Undoes an unlimited number of edits in SQL Editor.

Redo Redoes an unlimited number of edits in SQL Editor.

Hide DB Query Sets whether the DB Query window should be hidden when
on XML Open an XML document is opened for editing.
Auto-Commit When an edited XML document is saved in XMLSpy,
on XML Save changes are committed to the DB if this toggle is on.
Otherwise, changes have to be explicitly committed in the
Results Pane.
Options Open the Options dialog of SQL Editor.

Open SQL Opens the SQL script in Altova's DatabaseSpy product.


Script in
DatabaseSpy

Options
Clicking the Options icon in the Database Query toolbar pops up the Options dialog (
screenshot below). A page of settings can be selected in the left-hand pane, and the options on
that page can be selected. Click the Reset to Page Defaults button to reset the options on that
page to their original settings.

© 2010 Altova GmbH User Manual


722 User Reference DB Menu

The key settings are as follows:


 General | Encoding: Options for setting the encoding of new SQL files, of existing SQL
files for which the encoding cannot be detected, and for setting the Byte Order Mark
(BOM). (If the encoding of existing SQL files can be detected, the files are opened and
saved without changing the encoding.)
 SQL Editor: Options for toggling syntax coloring and data source connections on
execution on/off. A timeout can be set for query execution, and a dialog to change the
timeout can also be shown if the specified time is exceeded. The buffer for the entry
helper information can be filled wither on connection to the data source or the first time
it is needed. The Text View settings button opens the Text View options window of
XMLSpy.
 SQL Editor | SQL Generation: The application generates SQL statements when you
drag objects from the Browser pane into the Query pane. Options for SQL statement
generation can be set in the SQL generation tab. Use the Database pane to select a
database kind and set the statement generation options individually for the different
database kinds you are working with. Activating the Apply to all databases check box
sets the options that are currently selected for all databases. Options include appending
semi-colons to statements and surrounding identifiers with escape characters.
 SQL Editor | Auto-completion: The Auto-Completion feature works by suggesting,
while you type, relevant entries from various SQL syntax categories. It is available for
the following databases: for the following databases: MS SQL Server 2000, 2005, and
2008, MS Access 2003 and 2007, and IBM DB2 v.9. When the Auto-Completion option
is switched on, the Auto-Completion window (screenshot below) appears, containing
suggestions for auto-completion. Select the required entry to insert it. You can define
whether the autocompletion popup should be triggered automatically after a delay which
you can set in the Triggering Auto-completion pane, or if the popup has to be invoked
manually. You can also select the keys to be used to insert the selected completion.
The SQL Editor can intelligently suggest autocompletion entries based on language
statistics. If this feature is activated, items that are frequently used appear on top of the
list of suggested entries. In the Auto-completion window (screenshot below) itself, note
the buttons at the bottom of the window. The Context-Sensitive Suggestion button sets
whether only entries that are relevant to the context are displayed or all possible entries
with that spelling. The Single Mode button enables you to click a category button to

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 723

select only that category. The Set All Categories button selects all categories. You can
then deselect a category by clicking its button. The Clear All Categories button de-
selects all categories. The other buttons are the various category buttons.

 SQL Editor | Result View: Options to configure the Result tab.


 SQL Editor | Fonts: Options for setting the font style of the text in the Text Editor and
in the Result View.

Definition of regions in an SQL script


Regions are sections in SQL scripts that are marked and declared to be a unit. Regions can be
collapsed and expanded to hide or display parts of the script. It is also possible to nest regions
within other regions. Regions are delimited by --region and --endregion comments,
respectively, before and after the region. Regions can optionally be given a name, which is
entered after the -- region delimiter (see screenshot below).

To insert a region, select the statement/s to be made into a region, right-click, and select Insert
Region. The expandable/collapsible region is created. Add a name if you wish. In the
screenshot above, also notice the line-numbering. To remove a region, delete the two --region
and --endregion delimiters.

Insertion of comments in an SQL script


Text in an SQL script can be commented out. These portions of the script are skipped when the
script is executed.
 To comment out a block, mark the block, right-click, and select Insert/Remove Block
Comment. To remove the block comment, mark the comment, right-click and select
Insert/Remove Block Comment.
 To comment out a line or part of a line, place the cursor at the point where the line
comment should start, right-click, and select Insert/Remove Line Comment. To
remove the line comment, mark the comment, right-click and select Insert/Remove
Line Comment.

Use of bookmarks
Bookmarks can be inserted at specific lines, and you can then navigate through the bookmarks
in the document. To insert a bookmark, place the cursor in the line to be bookmarked, right-

© 2010 Altova GmbH User Manual


724 User Reference DB Menu

click, and select Insert/Remove Bookmark. To go to the next or previous bookmark, right-
click, and select Go to Next Bookmark or Go to Previous Bookmark, respectively. To
remove a bookmark, place the cursor in the line for which the bookmark is to be removed, right-
click, and select Insert/Remove Bookmark. To remove all bookmarks, right-click, and select
Remove All Bookmarks.

Query Pane: Working with Queries


After connecting to a database, an SQL script can be entered in the SQL Editor and executed.
This section describes:
 How an SQL script is entered in the SQL Editor.
 How the script is executed in the Database Query window.

The following icons are referred to in this section:

Execute Query Executes currently selected SQL statement. If script contains


multiple statements and none is selected, then all are
executed.
Execute for Same as for Execute command, except that results (in
Data Editing Results tab) are editable.
Import SQL Opens an SQL file in the SQL Editor.
File

Creating SQL statements and scripts in the SQL Editor


The following GUI methods can be used to create SQL statements or scripts:
 Drag and drop: Drag an object from the Browser pane into the SQL Editor. An SQL
statement is generated to query the database for that object.
 Context menu: Right-click an object in the Browser pane and select Show in SQL
Editor | Select.
 Manual entry: Type SQL statements directly in SQL Editor. The Auto-completion feature
can help with editing.
 Import an SQL script: Click the Import SQL File icon in the toolbar of the Database
Query window.

Executing SQL statements


If the SQL script in the SQL Editor has more than one SQL statement, select the statement to
execute and click either the Execute icon or Execute with Data Editing icon in the toolbar of
the Database Query window. If no statement in the SQL script is selected, then all the
statements in the script are executed. The database data is retrieved and displayed as a grid in
the Results tab. If Execute with Data Editing was selected, then the retrieved data in the
Result Grid can be edited. Messages about the execution are displayed in the Messages tab.

Results and Messages


The Results/Messages pane has two tabs:
 The Results tab shows the data that is retrieved by the query.
 The Messages tab shows messages about the query execution.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 725

Results tab
The data retrieved by the query is displayed in the form of a grid in the Results tab (screenshot
below). When the query results have been generated using the Execute Query command, the
XML documents in the Results tab are indicated with the XML icon (screenshot below). If
the Execute for Data Editing command was used, XML documents are shown with the
Editable XML icon .

The following operations can be carried out in the Results tab, via the context menu that pops
up when you right-click in the appropriate location in the Results tab:
 Sorting on a column: Right-click anywhere in the column on which the records are to be
sorted, then select Sorting | Ascending/Descending/Restore Default.
 Copying to the clipboard: This consists of two steps: (i) selecting the data range; and (ii)
copying the selection. Data can be selected in several ways: (i) by clicking a column
header or row number to select the column or row, respectively; (ii) selecting individual
cells (use the Shift and/or Ctrl keys to select multiple cells); (iii) right-clicking a cell, and
selecting Selection | Row/Column/All. After making the selection, right-click, and
select Copy Selected Cells. This copies the selection to the clipboard, from where it
can be pasted into another application.
 Appending a new row: If the query was executed for editing, right-click anywhere in the
Results pane to access the Append row command.
 Deleting a row: If the query was executed for editing, right-click anywhere in a row to
access the Delete row command.
 Editing records: If the query was executed for editing, individual fields can be edited. To
commit changes, click the Commit button in the toolbar of the Results tab.
 Editing XML records: If the query was executed for editing and an editable field is an
XML field (only IBM DB2 XML databases are currently supported), clicking the Editable
XML icon in the Result Grid opens the Edit XML menu (screenshot below). An XML
field can also be opened for data editing by right-clicking the XML filed in the Folders
pane and selecting the command Edit Data.

The Open for Editing command opens the XML document in an XMLSpy window, and
the Editable XML icon changes to , in which the three dots are red. When this

© 2010 Altova GmbH User Manual


726 User Reference DB Menu

document is saved and if the Auto-Commit XML Changes icon in the Query
Database toolbar was selected when the document was opened, the changes to the
XML document are committed automatically to the database. Otherwise, saved
changes will have to be committed using the Commit button of the Results pane. (Note
that to toggle between the XML document window and the Database Query window,
you must click the DB | Query Database command.) The Load XML Document from
File command loads an external XML document to the selected field in the database.
The Save XML Document to File saves the XML document in the selected database
field to a file location you choose. The Assign XML Schema command pops up the
Choose XML Schema dialog, in which you can select an XML Schema to assign to the
XML document. This assignment is saved to the database. XML Schema assignment is
explained in more detail in the section, IBM DB2 | Assign XML Schema.
 Set NULL, Set default, Undo changes for this cell: If the query was executed for editing,
right-clicking in a cell provides access to commands that enable you to set a NULL value
or, if defined, a column default value for that cell. Changes made to a cell can be
undone with the Undo changes for this cell command; the current edited value is
replaced by the value currently in the DB.

The Results tab has the following toolbar icons:

Go to Statement Highlights the statement in the SQL Editor that produced the
current result.
Find Finds text in the Results pane. XML document content is also
searched.
Add New Line Adds a new row to the Result Grid.
Delete Row Deletes the current row in the Result Grid.
Undo Changes Undoes all changes to the Result Grid.
to Result Grid
Commit Commits changes made in the Result Grid to the database.

Messages tab
The Messages tab provides information on the previously executed SQL statement and reports
errors or warning messages.

The toolbar of the Messages tab contains icons that enable you to customize the view, navigate
it, and copy messages to the clipboard. The Filter icon enables the display of particular types of
messages to be toggled on or off. The Next and Previous icons move the selection down and

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 727

up the list, respectively. Messages can also be copied with or without their child components to
the clipboard, enabling them to be pasted in documents. The Find function enables you to
specify a search term and then search up or down the listing for this term. Finally, the Clear
icon clears the contents of the Report pane.

Note: These toolbar icon commands are also available as context menu commands.

21.9.3 IBM DB2


The IBM DB2 menu item rolls out a submenu containing commands (i) to register and
unregister schemas with an IBM DB2 database (Manage XML Schemas), and (ii) to assign
schemas for XML file validation (Assign XML Schema).

Both these mechanisms require that you connect to the required IBM DB2 database. How to
connect to the database is described in the section Connecting to a Data Source. In this section
the focus is on how to manage schemas in an IBM DB2 database and how to assign XML
Schemas to a DB XML file.

Note: The Result Grid of the Database Query window provides important functionality for
working with XML files in IBM DB2 databases. This functionality includes the ability to
open files for editing, loading XML files into a DB XML files, saving DB XML files
externally, and assigning XML Schemas to DB XML files.

Manage XML Schemas


The Manage XML Schemas feature enables schemas to be added to and dropped from
individual database schemas in an IBM DB2 database. To manage schemas, you have to do
the following:
 Connect to the IBM DB2 database
 Select the database schema for which XML Schemas need to be added or dropped
 Carry out the schema management actions.

These steps are described in detail below.

Connecting to the IBM DB2 database


Clicking the Manage XML Schemas command pops up the XML Schema Management for
Databases dialog (screenshot below).

© 2010 Altova GmbH User Manual


728 User Reference DB Menu

The first thing to do if there is no connection to the required database is to connect to it. If a
connection already exists, it appears in the Database combo box. To start the connection
process, click the Quick Connect icon in the dialog. This pops up the Quick Connect dialog,
through which you can make the connection to the database. How to use the Quick Connect
dialog is explained in the section DB Menu | Connecting to a Data Source.

Displaying the list of XML Schemas


After the connection to the IBM DB2 database has been established, the database is listed in
the combo box at left (see screenshot below). If more than one connection is currently open,
you can select the required database in this combo box. In the screenshot below, the
StyleVision DB database is selected.

The combo box at right lists all the database schemas of the currently selected IBM DB2
database. When a database schema is selected in this combo box, all the XML Schemas
registered for the selected database schema are displayed in the main pane. In the screenshot

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 729

above, all the XML Schemas registered with the Altova_User database schema are listed,
together with their locations. Checking the Show Details check box causes additional
information columns to be displayed in the main pane.

Managing the XML Schemas


The list of schemas in the main pane represents the schemas registered for the selected
database schema. After the list of XML Schemas is displayed, you can add schemas to the list
or drop (delete) schemas from the list.

To add a schema, click the Add button, browse for the required schema file, and select it. The
selected schema file is added to the list in the main pane. Clicking the Commit Changes button
registers the newly added schema with the database schema.

To drop a schema, select the schema in the main pane and click the Drop Schema button. A
Drop Flag is assigned to the schema, indicating that it is scheduled for dropping when changes
are next committed. The Drop Flag can be removed by selecting the flagged schema and
clicking the Remove Drop Flag button. When the Commit Changes button is clicked, all
schemas that have been flagged for dropping will be unregistered from the database schema.

Clicking the View Schema button opens the schema in XMLSpy. To close the XML Schema
Management dialog, click the Close button.

Reports
When the Commit Changes button is clicked, the database is modified according to the
changes you have made. A report of the Commit action is displayed in the Report pane (
screenshot below), enabling you to evaluate whether the success of the action and to debug
possible errors. Each subsequent report is displayed below the previous report.

The report pane has a toolbar containing icons that enable you to customize the display of the
report listing, navigate the listing, copy report messages, search for text, and clear the pane (
see screenshot below).

© 2010 Altova GmbH User Manual


730 User Reference DB Menu

The Filter icon enables the display of particular types of messages to be toggled on or off. The
Next and Previous icons move the selection down and up the list, respectively. Messages can
also be copied with or without their child components to the clipboard, enabling them to be
pasted in documents. The Find function enables you to specify a search term and then search
up or down the listing for this term. Finally, the Clear icon clears the contents of the Report
pane.

Assign XML Schema


The Assign XML Schema assigns a schema to an XML file opened for editing via the Result
Grid of the Database Query window. After the assignment is made, the XML file can be
validated against the assigned schema. The assignment is written to the DB when the XML file
is saved in XMLSpy.

Opening a DB XML file for editing


In the Database Query window, when a query is addressed to an XML DB and the query is
executed for data editing, the Result Grid at the bottom of the Database Query window provides
access to the XML files in the database so these can be edited (see screenshot below).

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 731

Clicking the XML icon pops up the following menu.

Selecting the Open for Editing command opens the XML document in XMLSpy, where it can
be edited.

Assigning a schema to the DB XML file


It is when the DB XML file is opened for editing in XMLSpy that the IBM DB2 | Assign XML
Schema command is enabled. With the XML document active in XMLSpy, clicking the Assign
XML Schema command pops up the Choose XML Schema dialog (screenshot below).

© 2010 Altova GmbH User Manual


732 User Reference DB Menu

A schema can be selected from among those stored in the database (these are listed in the
dropdown list of the Schema from Database combo box), or from among external files that can
be browsed. Clicking OK assigns the schema to the XML file. Note that the assignment is not
written into the XML file. When the XML file is saved in XMLSpy—and if the Auto-Commit XML
changes icon in the Query Database toolbar was selected when the document was opened
—then the schema assignment is saved to the database. Note that the schema assignment is
written to the database—and not to the XML file.

Note: The Edit XML menu in the Result Grid of the Database Query window also has an
Assign XML Schema command (see screenshot below), which also assigns a schema
to the DB XML file.

The difference between the two Assign XML Schema commands is that the command
in the DB | IBM DB2 menu enables you to assign an XML Schema while you are editing
the XML file thereby allowing you to change schema assignments while editing the XML
document and to validate the XML document immediately.

21.9.4 SQL Server


The SQL Server menu item rolls out a submenu containing the Manage XML Schemas
command.

Manage XML Schemas


XML Schema management for databases enables you to add and delete XML Schemas from
the schema repository of an XML database. After connecting to the database, XMLSpy provides
the XML Schema Management for Databases dialog, in which XML Schemas can be managed.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 733

The dialog box provides a Quick Connect icon which calls the Quick Connect wizard to
connect to a data source. If more than one connection currently exists, the required connection
can be selected from the combo box on the to left-hand side. The required root object can then
be selected from the right-hand side combo box. All the XML Schemas currently in the
repository for that root object are displayed in the dialog box. The name, location, and
namespace of each schema are listed, as well as the option for decomposition..

Note that the stored schemas can also be viewed in the Database Query window (screenshot
below), but they cannot be managed there. To manage schemas, use the XML Schema
Management for Databases dialog.

© 2010 Altova GmbH User Manual


734 User Reference DB Menu

In the XML Schema Management dialog you can do the following:


 Add a schema using the Add Schema button. The selected schema will be appended
to the list and marked for addition.
 Mark schemas in the list for deletion with the Drop Schema button. The Drop flag can
be removed with the Remove Drop Flag button.
 Open a selected schema in Schema View by clicking the View Schema button.
 Commit the addition and drop (deletion) changes with the Commit Changes button.

After changes have been committed, a report of the commit action can be viewed in the Report
tab (screenshot below).

21.9.5 Oracle XML DB


XMLSpy allows you to connect to and query Oracle XML Db databases.

The following database functions are supported:


 Add (and register) an XML schema to the Oracle XML Db. The Oracle XML DB client
must be installed for you to be able to register XML schemas through XMLSpy.
 Open and delete schemas
 Query the database using XPath statements (DBUri)
 Browse XML documents (using WebDAV)
 Create an XML document based on a schema saved in the database

General installation process:


 Download and install XMLSpy
 Install Oracle server (if necessary)
 Create an Oracle database

An Oracle XML DB Demo installation manual is provided at


http://otn.oracle.com/sample_code/tech/xml/xmldb/XDBBasicDemo.pdf. The document
describes how to install the Oracle software as well as how to configure it to work with XMLSpy.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 735

Manage XML Schemas


XML Schema management for databases enables you to add and delete XML Schemas from
the schema repository of an XML database. After connecting to the database, XMLSpy provides
the XML Schema Management for Databases dialog, in which XML Schemas can be managed.

The dialog box provides a Quick Connect icon which calls the Quick Connect wizard to
connect to a data source. If more than one connection currently exists, the required connection
can be selected from the combo box on the to left-hand side. The required root object can then
be selected from the right-hand side combo box. All the XML Schemas currently in the
repository for that root object are displayed in the dialog box. The name, location, and
namespace of each schema are listed, as well as the option for decomposition..

Note that the stored schemas can also be viewed in the Database Query window (screenshot
below), but they cannot be managed there. To manage schemas, use the XML Schema
Management for Databases dialog.

© 2010 Altova GmbH User Manual


736 User Reference DB Menu

In the XML Schema Management dialog you can do the following:


 Add a schema using the Add Schema button. The selected schema will be appended
to the list and marked for addition.
 Mark schemas in the list for deletion with the Drop Schema button. The Drop flag can
be removed with the Remove Drop Flag button.
 Open a selected schema in Schema View by clicking the View Schema button.
 Commit the addition and drop (deletion) changes with the Commit Changes button.

After changes have been committed, a report of the commit action can be viewed in the Report
tab (screenshot below).

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference DB Menu 737

Browse Oracle XML documents

This command allows you to browse the XML documents available on your server. The server
details are automatically filled in if you previously queried the database or listed schemas. If this
is not the case, then you have to enter them manually.

Use the tree view to find specific XML files. Double clicking a file in the tree view opens it. You

© 2010 Altova GmbH User Manual


738 User Reference DB Menu

can also click a file and click Open to achieve the same thing. The New Folder button adds a
new folder, the Delete button deletes the currently selected XML file.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Convert Menu 739

21.10 Convert Menu


XMLSpy provides powerful data exchange functions that allow you to:
 Import and export text, word processor, database, and XML files.
 Import database data based on an existing XML Schema.
 Create an XML Schema based on the structure of an existing database.
 Create a database structure, based on an existing XML schema

These functions are available in the Convert menu (screenshot bvelow).

21.10.1 Import Text File

This command lets you import any structured text file into XMLSpy and convert it to XML
format immediately. This is useful when you want to import legacy data from older systems. The
steps for importing data in a text file as an XML document are described below.

1. Select the menu item Convert | Import Text File. The following dialog appears:

© 2010 Altova GmbH User Manual


740 User Reference Convert Menu

2. Select one of the following:


 Map EDI, CSV, or fixed-width text data into XML (you must have installed Altova
MapForce in order to select this option)
 Convert CSV text file into XML
3. Click OK. The Text import dialog appears (screenshot below). How to use this dialog is
described below.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Convert Menu 741

Path
Enter the path to the file to import in the Path text box, or select the file using the
Browse button to the right of the text box. After the file is selected, a Grid View preview
of the XML file is displayed in the Preview pane. Any change in the options selected in
this dialog will be reflected in the preview immediately.

Delimiter
To successfully import a text file, you need to specify the field delimiter that is used to
separate columns or fields within the file. XMLSpy will auto-detect common row
separators (CR, LF, or CR+LF).

String quotes
Text files exported from legacy systems sometimes enclose textual values in quotes to
better distinguish them from numeric values. If this is the case, you can specify what
kind of quotes are being used in your file, and remove them automatically when the
data is imported.

Encoding
The data is converted into Unicode (the basis of all XML documents), so you need to
specify which character-set the file is currently encoded in. For US or Western
European Windows systems this will most likely be Codepage 1252, also referred to as
the ANSI encoding.

Byte order
If you are importing 16-bit or 32-bit Unicode (UCS-2, UTF-16, or UCS-4) files, you can
also switch between little-endian and big-endian byte order.

First row contains column names


It is also very common for text files to contain the field names in the first row within the
file. If this is the case, check this check box.

Preview
In the Preview pane you can rename column headers by clicking in a name and editing
it. The column headers will be the element or attribute names in the XML document.
You can select whether a column should be an element or an attribute in the XML
document, or whether it should not be imported into the XML document. In the
screenshot above, Col1 is an element, Col2 is an attribute, and Col3 will not be
imported.

When you are satisfied with the options, click Import. The imported data is converted
into an XML document that is displayed in Grid View.

21.10.2 Import Database Data

The Import Database Data command enables you to import data from any of a variety of
databases into an XML file. The import mechanism involves two steps:
1. A connection to the database is established.
2. The data to be imported is selected.

To import database data, do the following:


1. When you click the Import Database Data command, the Import Database Data dialog
(screenshot below) pops up.

© 2010 Altova GmbH User Manual


742 User Reference Convert Menu

2. Select Convert Database Data into XML and click OK. The Connect to a Data Source
dialog appears. (The Map Database Data into XML Based on Existing DTD/Schema
option requires the use of Altova MapForce to carry out the mapping.)
3. In the Connect to Data Source dialog, you establish a connection to the database. How
to do this for different types of databases is explained in the section, Connecting to a
Data Source.
4. After the connection to the database is established, the Import Database Data dialog
displays tabs and windows that enable you to select the database data to import. These
options are described below. After finishing, click the Import button to import the
database data.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Convert Menu 743

Data selection and import options


The Import Database Data dialog for setting the selection and import options consists of two
parts (shown separately in the screenshots below):
 an upper part with two tabs: (i) Selection, and (ii) Options.
 a lower part, which is a Preview window showing the data according to the data
selection and import options.

Selection tab
In the Selection tab (screenshot above), the Source pane (screenshot below) displays either a
representation of the tables of the database or an editable SQL statement for selecting the
required tables, each view being selected by clicking the respective radio button.

© 2010 Altova GmbH User Manual


744 User Reference Convert Menu

In the Table view, you can select the tables in the database that you want to import by checking
the table's check box (screenshot above). The contents of the table can then be displayed in the
Preview pane. The table selection can be further filtered in the Preview pane (see below).

The database structure can be displayed differently and can be filtered. The Layout icon
in the Source pane enables you to organize database objects into: (i) folders based on object
type; (ii) folders based on object type, but without schema folders; (iii) in a hierarchy, but without
folders; and (iv) categories of tables, based on their relationships with other tables.

Clicking the Filter Folder Contents icon applies a filter to the selected folder (in the
screenshot below, to the Tables folder). Clicking the filter icon on the table pops out a menu
with a list of filter possibilities. In the screenshot below, the filter has been set to display objects
that contain the text Sys in its name. The view is filtered accordingly.

Clicking the Object Locator icon pops up a text field, which behaves like a Search entry field.
You can enter a text string and the dropdown list will display all the objects whose names
contain that text string. Selecting one of these objects from the dropdown list will highlight that
object in the tree.

Options tab
In the Options tab (screenshot below), you can specify how number, date, and time values are
to be imported; whether data is imported as elements or attributes; and whether comments and
NULL fields are to be included in the import.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Convert Menu 745

When NULL fields are enabled for import, you can enter a substitution XML value for them.

Preview pane
The Preview pane (screenshot below) displays the structure of the table currently selected in
the Selection tab. When a new table is selected in the Selection tab, click the Preview button in
the Preview pane to display the table. Click the Refresh button to refresh the preview.

A field can be specified to be imported as an element or attribute, or not to be imported, by


clicking the symbol to the left of the column name. You can click through the element, attribute,
and ignore options. In the screenshot above, the Manager field has been set to be imported as
an element and the Degree field as an attribute, while the Programmer field will not be imported.

Datatype conversions
Information about the conversion of database datatypes to XML Schema datatypes is listed in
the Appendices.

21.10.3 Import Microsoft Word Document

This command enables the direct import of any Word document and conversion into XML

© 2010 Altova GmbH User Manual


746 User Reference Convert Menu

format if you have been using paragraph styles in Microsoft Word. This option requires
Microsoft Word or Microsoft Office (Version 97 or 2000).

When you select this command, the Open dialog box appears. Select the Word document you
want to import.

XMLSpy automatically generates an XML document with included CSS stylesheet. Each Word
paragraph generates an XML element, whose name is defined as the name of the
corresponding paragraph style in Microsoft Word.

21.10.4 Create XML Schema from DB Structure

The Create XML Schema from DB Structure command enables you to create an XML
Schema from the structure of any of a variety of databases. The XML Schema-creation
mechanism involves two steps:
1. A connection to the database is established.
2. Options for the database data selection and the XML Schema are specified.

To create an XML Schema from a DB structure you would do the following:


1. When you click the Create XML Schema from DB Structure command, the Connect
to Data Source dialog appears.
2. In the Connect to Data Source dialog, you establish a connection to the database. How
to do this for different types of databases is explained in the section, Connecting to a
Data Source.
3. After the connection to the database is established, the Create XML Schema from DB
Structure dialog (screenshot below) displays tabs and windows that enable you to
select the database structure to import. These options are described below. After
finishing, click the Import button to import the database data.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Convert Menu 747

Selection tab
In the Selection tab (screenshot below), the data source is listed in the Source Database pane.
The Source pane displays either a representation of the tables of the database or an editable
SQL statement for selecting the required tables.

© 2010 Altova GmbH User Manual


748 User Reference Convert Menu

In the Table view, you can select the tables in the database that you want to import by checking
the table's check box (screenshot above). The contents of the table can then be displayed in the
Preview pane. The table selection can be further filtered in the Preview pane (see below). You
can configure the display in the Source pane as described in the section Import Database Data.

Options tab
In the Options tab (screenshot below), you can specify the format of the schema, its extension
type, whether columns should be imported as elements or attributes, and the database
constraints that should be generated in the schema.

Schema format: You can select between a flat (SQL/XML Standard) and a hierarchical
schema form
 The flat schema model is based on an ISO-ANSI Working draft titled XML-Related

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Convert Menu 749

Specification (SQL/XML) (Henceforth referenced as the" SQL/XML Working Draft").


The SQL/XML Working Draft defines how to map databases to XML. Relationships are
defined in schema using identity constraints and there are no references to elements.
Hence the schema is flat structure which resembles a tree-like view of the database.
For more information on the SQL/XML working draft please see:
http://www.sqlx.org/SQLXdocs
 The hierarchical schema model displays the table dependencies visually, in a type of
tree view where dependent tables are shown as indented child elements in the content
model. Table dependencies are also displayed in the Identity constraints tab.
Tables are listed as global elements in the schema, and columns are the elements or
attributes of these global elements (The user decides whether to map the columns as
elements or as attributes). Relationships are created in a hierarchical way so that a
foreign key field in one table is actually a reference to the global element that
represents that table.

Schema extension type: Schema extension information is additional information read from a
database that is then embedded in the schema as either annotation data or attributes. There
are four extension type options when generating schemas: (i) no extensions information; (ii)
SQL/XML extensions; (iii) MS SQL Server extensions; and (iv) Oracle extensions. These are
described below:
 None: No additional information is provided by the database.
 SQL XML: SQL/XML extensions are only inserted when generating schemas in a Flat
Format. The extension information is stored in annotations, and is described in the
SQL/XML Working Draft.
 MS SQL Server: Selecting Microsoft SQL Server, generates SQL Server extensions.
See Using Annotations in XSL Schemas in the the SQL Server Books Online for
detailed information (Download from
http://www.microsoft.com/sql/techinfo/productdoc/2000/books.asp). The following
subset of annotation data are generated in the schema: sql:relation, sql:field,
sql:datatype, sql:mapped.
 Oracle: Oracle extensions are selected by default when working with an Oracle
database. Additional database information is stored as attributes. A full description of
these attributes can be found at
http://download-west.oracle.com/docs/cd/B10501_01/appdev.920/a96620/xdb05obj.htm
#1027227 (You need to have access to the Oracle Technology network to access this
page.) The following subset of attributes is currently generated: SQLName, SQLType,
SQLSchema.

Note: Although SQL Server and Oracle extensions can be generated for their respective
databases they are not restricted in this way. This proves useful when working with a
third database and wanting to generate a schema that later should be working with
either SQL Server or Oracle.

Preview pane
The Preview pane (screenshot below) displays the structure of the table currently selected in
the Selection tab. When a new table is selected in the Selection tab, click the Refresh button in
the Preview pane to refresh the preview.

© 2010 Altova GmbH User Manual


750 User Reference Convert Menu

A field can be specified to be generated as an element or attribute, or not to be generated, by


clicking the symbol to the left of the column name. You can click through the element, attribute,
and ignore options. In the screenshot above, the Manager field has been set to be generated as
an element and the Degree field as an attribute, while the Programmer field will not be
generated.

Datatype conversions
Information about the conversion of database datatypes to XML Schema datatypes is listed in
the Appendices.

21.10.5 DB Import Based on XML Schema

The DB Import Based on XML Schema command creates an XML document which is valid
according to a given XML Schema and contains data imported from a database. For this
feature, the following databases are supported:
 Microsoft Access 2000 and 2003
 Microsoft SQL Server
 Oracle
 MySQL
 Sybase
 IBM DB2

The data to be imported is determined by the table that is selected in the database. With the
required XML Schema (that on which you wish to base the import) as the active document in
Schema View, connect to the database. Then select the table/s you wish to import, and click
Import. The data is imported into an XML document, and the document has the structure of the
XML Schema that was active when the data was imported.

In the example below, data from an MS Access database is imported with an XML Schema
active in Schema View. These would be the steps to carry out for the import:
1. Open the schema file in Schema View (screenshot below).

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Convert Menu 751

2. Select the menu command DB Import based on XML Schema. This opens the
Connect to Data Source dialog.
3. Select the Microsoft Access (ADO) option and click Next.
4. Click Browse and select the database file. Then click Next.
5. In the DB Import Based on XML Schema dialog which pops up, go to the Tables tab,
select one or more tables you wish to import (for example, Altova), then click Import.
The table is imported into an XML document that is displayed in Grid View.

Datatype conversions
Information about the conversion of database datatypes to XML Schema datatypes is listed in
the Appendices.

21.10.6 Create DB Structure from XML Schema

XMLSpy allows you to create an empty database (or skeleton database) based on an existing
schema file. The method described below is generally the same for each type of database.
1. Open the schema file in Schema/WSDL View
2. Select the menu command Convert | Create DB Structure from XML Schema. This
pops up the Connect to a Data Source dialog, which enables you to connect to a
database (DB).
3. Use the steps described in the section Connecting to a Data Source to connect to the
required database. For example, to connect to a Microsoft Access database, select the
Microsoft Access radio button, and continue the process to select a database. You can
use an existing database or create a new database in which the schema structure will
be contained.
4. In the Create DB Structure from XML Schema dialog, tables are created from the
schema and displayed in a tree format at the location where they they will occur in the
DB. For example, in the screenshot below, the Address table is created and selected
for export. Tables that should not be exported should be deselected (by unchecking the
check box or selecting the appropriate item from the context menu for that table).

© 2010 Altova GmbH User Manual


752 User Reference Convert Menu

5. If you wish to drop (delete) tables in an existing DB that have the same name as tables
coming in from the schema, then check the Drop Existing Tables with the Same name
check box.

Creating DB tables with relationships


If the XML Schema from which the DB structure is generated has relationships defined in the
form of identity constraints, then these relationships are automatically created in the generated
DB structure and displayed in the Table Structure. Tables with relationships are listed under the
sections: Tables with ForeignKeys and Tables used by ForeignKeys. Tables without
relationships are listed in the Independent Tables section.

In the Relationships tab, you can create and modify table relationships. The tab lists all possible
primary-key/foreign-key relationships (screenshot below).

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Convert Menu 753

To create a relationship, do the following:


1. Select one of the possible primary-key/foreign-key relationships.
2. In the lower pane of the dialog, click the Plus button to create a relationship.
3. Select the required columns in each of the two tables from the respective dropdown
lists.

You can also remove a relationship by selecting it and then clicking the Minus button.

Notes on database structure and connecting


The schema structure, defined by the identity constraints, is mirrored in the resulting database.
The table below shows the type of database created, the restrictions, and the connecting
methods, when using the Create DB Structure from XML Schema menu command.

Directly using ODBC using ADO


MS Access (2000 and 2003) OK * OK OK

© 2010 Altova GmbH User Manual


754 User Reference Convert Menu

MS SQL Server OK * OK OK
Oracle OK * OK OK
MySQL - OK * OK 
Sybase - OK * OK
IBM DB2 - OK * OK

* Recommended connection method for each database.


 MySQL: When creating the ADO connection based on ODBC, it is recommended to use
either the User or System DSN.
- Not supported

XMLSpy will map both hierarchical and flat formatted schemas. XMLSpy recognizes both
formats automatically.
The flat format is mapped to SQL in two different ways.
 SQL Server DB, Oracle DB, or Sybase DB:
A schema that was generated in flat format, for one of the above databases, will have
the schema catalog name extracted and used in the generated SQL script as the DB
name. This means that the resulting SQL script will be executed on a target DB whose
name must be identical to the schema catalog name.
 Access (2000 or 2003), MySQL, or DB2 DB:
A schema that was generated in flat format, for one of the above databases, will ignore
the schema catalog name when the SQL script is generated. This means that the
resulting SQL script will be executed on a target database that was logged into.

Datatype conversions
Information about the conversion of XML Schema datatypes to database datatypes is listed in
the Appendices.

21.10.7 Export to Text Files

The command Convert | Export to Text Files exports XML data into text formats for exchange
with databases or legacy systems. On clicking this command, the Export XML to Text dialog
pops. It consists of two parts (shown separately in the screenshots below):
 an upper part with two tabs: (i) Selection, and (ii) Export Options.
 a lower part, which is a Preview window.

After you have selected the desired options in this dialog (described below), click the Export
button to export to text file/s.

Selection
In the Selection tab (screenshot below), you can select the destination of the file to be exported
and text generation options.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Convert Menu 755

Destination: The exported file can be saved directly to a folder. The file extension can be
specified. The filenames will be those of the elements (in the XML file) that will be exported.
Alternatively, untitled files can be exported to XMLSpy. These files will be displayed in the GUI,
and can be saved later.

Include comments: Activate this option to include a comment in the exported XML file that
shows the SQL query used to select the data, as well as a list containing one item for each
column header in the database table.

Create first row with field names: When activated, the exported tables include the database
column names.

Remove delimiters: Removes delimiters that are contained in text values in the exported data.
Set the delimiter you want to remove by using the Delimiter combo box in this tab. For example,
if this option is activated and the selected delimiter is the apostrophe, when you export the XML
value Ba'ker, the string will be Baker in the exported text.

Remove newlines: Removes newlines from exported data.

Delimiter: Select from the drop-down list the character that you wish to have removed during
export. Alternatively, enter the desired character string.

String quotes: This puts each string of data into the quotes specified in this combo box.

Encoding: Select from the drop-down list, the desired encoding for files that are generated
during export.

Byte order: If you are importing 16-bit or 32-bit Unicode (UCS-2, UTF-16, or UCS-4) files, you
can also switch between little-endian and big-endian byte order.

© 2010 Altova GmbH User Manual


756 User Reference Convert Menu

Export Options
Additional export options, which are described below, can be specified in the Export Options tab
(screenshot below):

Start point of export: You can choose to export the entire XML document or restrict your
export to the data hierarchy starting from the currently selected element. The number of
sub-levels below the start point that will be exported is specified in the Export Depth option.

Export depth: Specifies the number of sub-levels below the start point that will be exported.

Export fields: Depending on your XML data, you may want to export only elements, attributes,
or the textual content of your elements. Note that you can deselect the export of individual
elements in the Preview window.

Automatic fields: XMLSpy will produce one output file or table for each element type selected.
You can choose to automatically create primary/foreign key pairs to link your data in the
relational model, or define a primary key for each element.

Exclude namespace name: Together with the Replace Colon With Underscore radio button
this is an either/or choice. Specifies whether namespace prefixes of elements and attributes
should be excluded or whether the colon in the namespace prefix should be replaced with an
underscore.

Preview window
The Preview window (screenshot below) is displayed below the Selection and Export Options
tab.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Convert Menu 757

In the Resulting Elements from XML File pane, shows the node name that will be exported and
the name in the generated file. You can select/deselect nodes that will be exported. When an
element is selected, a preview of its structure is shown in a second pane below. In this pane,
clicking to the left of a column name toggles the export of that column on and off. In the
screenshot above, the paidnewyear column has been toggled off, so it will not be exported.

21.10.8 Export to a Database

The command Convert | Export to a Database exports XML data to a database. On clicking
this command, the Connection Wizard starts up and enables you to set up a connection to the
database you wish to update. After a connection has been established, the Export Data to
Database dialog pops. It consists of two parts (shown separately in the screenshots below):
 an upper part with two tabs: (i) Selection, and (ii) Export Options.
 a lower part, which is a Preview window.

After you have selected the desired options in this dialog (described below), click the Export
button to export to the database.

Selection
In the Selection tab, you can select the destination database and table generation options. The
destination field selects the connection to the database. You must select whether the data is
created as new tables, updates existing tables, or first tries to update an existing table and then
creates a new table if an an update is not possible. You can also set a stop action based on the
number of errors, and, optionally, SQL script logging.

Export Options
Export options, which are described below, can be specified in the Export Options tab (
screenshot below):

© 2010 Altova GmbH User Manual


758 User Reference Convert Menu

Start point of export: You can choose to export the entire XML document or restrict your
export to the data hierarchy starting from the currently selected element. The number of
sub-levels below the start point that will be exported is specified in the Export Depth option.

Export depth: Specifies the number of sub-levels below the start point that will be exported.

Export fields: Depending on your XML data, you may want to export only elements, attributes,
or the textual content of your elements. Note that you can deselect the export of individual
elements in the Preview window.

Automatic fields: XMLSpy will produce one output file or table for each element type selected.
You can choose to automatically create primary/foreign key pairs to link your data in the
relational model, or define a primary key for each element.

Exclude namespace name: Together with the Replace Colon With Underscore radio button
this is an either/or choice. Specifies whether namespace prefixes of elements and attributes
should be excluded or whether the colon in the namespace prefix should be replaced with an
underscore.
Null value and text field length: Text strings in the XML document that should be treated as
NULL values can be specified, and the length of text fields in the database can be specified.

Preview window
The Preview window (screenshot below) is displayed below the Selection and Export Options
tab.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Convert Menu 759

In the Resulting Elements from XML File pane, shows the node name that will be exported and
the name in the generated file. You can select/deselect nodes that will be exported. When an
element is selected, a preview of its structure is shown in a second pane below. In this pane,
clicking to the left of a column name toggles the export of that column on and off. In the
screenshot above, the paidnewyear column has been toggled off, so it will not be exported.

When the element's table structure shows the data, the key constraint type can be set by
clicking to the left of a column name. When the element's table structure shows field definitions,
the definitions can be edited by selecting the definition and selecting an option from the
definition's combo box (see screenshot above).

21.10.9 Convert XML to/from JSON


The Convert XML to/from JSON command converts the active document, if XML, to a JSON
document. If the active document is a JSON document, clicking the Convert XML to/from
JSON command will convert the JSON document to an XML document. The generated
document can then be saved to any location.

JSON (JavaScript Object Notation) is a data interchange format based on a subset of


JavaScript and is commonly used with JavaScript code. Code for parsing JSON is widely
available for many programming languages.

XMLSpy provides intelligent editing features for JSON documents. These are described in the
JSON Editing Features section of the documentation.

Given below is an example of a source XML document, and, below it, the JSON document
generated by the Convert XML to/from JSON command.

XML document
<?xml version="1.0" encoding="UTF-8"?>
<Person first="Jim" last="James">
<Address>
<street>4 New Street</street>
<city>New York</city>
<state>NY</state>
<code>10123</code>
</Address>
<Tel type="home">
123 123-1234
</Tel>
<Tel type="office">

© 2010 Altova GmbH User Manual


760 User Reference Convert Menu

123 987-9876
</Tel>
</Person>

JSON document
{
"XML": {
"version": 1.0,
"encoding": "UTF-8"
},
"Person": {
"first": "Jim",
"last": "James",
"Address": {
"street": "4 New Street",
"city": "New York",
"state": "NY",
"code": 10123
},
"Tel": [ { "type": "home",
"Text": "\r 123 123-1234\r "}, { "type": "office",
"Text": "\r 123 987-9876\r "} ]
}
}

To convert a JSON document to XML, make the JSON document active and click the Convert
XML to/from JSON command.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference View Menu 761

21.11 View Menu


The View menu controls the display of the active Main window and allows you to change the
way XMLSpy displays your XML documents.

This section provides a complete description of commands in the View menu.

21.11.1 Text View

This command switches the current view of the document to Text View, which enables you to
edit the document in its text form. It supports a number of advanced text editing features,
described in detail in Text View section of this document.

Please note: You can configure aspects of the Text View using options available in the various
tabs of the Options dialog (Tools | Options).

21.11.2 Grid View

This command switches the current document into Grid View.

If the previous view was the Text View, the document is automatically checked for
well-formedness.

Embedded Database/Table view


XMLSpy allows you to display recurring elements in a Database/Table View from within the Grid
View. This function is available wherever the Grid View can be activated, and can be used when
editing any type of XML file - XML, XSD, XSL etc.

For further information on this view, please see the Grid View section of this documentation.

21.11.3 Schema Design View

This command switches the current document to Schema Design View. The switch will be
successful only if the document is an XML Schema document. This view is described in detail in
the Schema View section of this documentation.

© 2010 Altova GmbH User Manual


762 User Reference View Menu

21.11.4 WSDL Design View


This command switches the current document to WSDL Design View. The switch will be
successful only if the document is a WSDL document. This view is described in detail in the
WSDL View section of this documentation.

21.11.5 XBRL Taxonomy View


This command switches the current document to XBRL Taxonomy View. The switch will be
successful only if the document is an XBRL document. This view is described in detail in the
XBRL View section of this documentation.

21.11.6 Authentic View

This command switches the current document into the Authentic View.

Authentic View enables you to edit XML documents based on StyleVision Power Stylesheet
templates created in StyleVision! The templates in StyleVision are saved as StyleVision
Power Stylesheets (*.sps files), and supply all the necessary information needed by Authentic
View.

To open a template select the File | New command and then click the Select a StyleVision
stylesheet... button. Please see the Authentic View documentation for further information.

Please note: If, when you try to switch to Authentic View, you receive a message saying that a
temporary (temp) file could not be created, contact your system administrator. The system
administrator must change the default Security ID for "non-power users" to allow them to create
folders and files.

21.11.7 Browser View

This command switches the current document into Browser View.

This view uses an XML-enabled browser to render the XML document using information from
potential CSS or XSL style-sheets.

When switching to browser view, the document is first checked for validity, if you have selected
Validate upon saving in the File tab of the Options dialog. Use the menu command Tools |
Options to open this dialog.

For further information on this view, please see the detailed description of the various views in
the Main Window section.

21.11.8 Expand
Hotkey: "+" on the numeric keypad

This command expands the selected element by one level.

The command can be used in the Grid View.

In the Grid View, the element and all its children remain selected after expansion. This allows
you to expand a large element by pressing the + key repeatedly.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference View Menu 763

You can expand and collapse any element by clicking on the gray bar to the left of each
element.

21.11.9 Collapse
Hotkey: "-" on the numeric keypad

This command collapses the selected element by one level.

The command can be used in the Grid View.

You can expand and collapse any element by clicking on the gray bar to the left of each
element.

21.11.10Expand Fully
Hotkey: "*" on the numeric keypad

This command expands all child items of the selected element, down to the last level of
nesting.

The command can be used in the Grid View.

21.11.11Collapse Unselected
Hotkey: CTRL + "-" key on the numeric keypad

This command allows you to focus on one element and its children, and ignore all the other
surrounding elements.

The command can be used in the Grid View.

Select the item that you want to work with and choose this command to collapse all other
(unselected) elements.

21.11.12Optimal Widths

This command adjusts the widths of all columns so that each has a width that exactly
accommodates in one line the longest text string in any of its cells. A maximum optimal width
can be specified in the View tab of the Options dialog (Tools | Menu). Note that optimal widths
are calculated on the basis of the visible cells of columns. This enables the optimization of the
view when individual elements are collapsed or expanded.

21.11.13Word Wrap

This command enables or disables word wrapping in the Text view.

© 2010 Altova GmbH User Manual


764 User Reference View Menu

21.11.14Go to Line/Character

Hotkey: CTRL+ g

This command goes to a specific line number and/or character position in an XML document
in the Text view.

If you are working with an external XSLT processor (see the XSL tab on the Tools | Options
dialog for details) you may often get error messages by line number and character position.
XMLSpy lets you quickly navigate to that spot, using this command:

This command works in both the Text View and Grid View, but will only be able to show an
approximate position in the grid view by highlighting the element closest to the character
position specified.

21.11.15Go to File

This command opens a document that is being referred to, from within the file you are
currently editing.

Select the file name, path name, or URL you are interested in, and choose this command from
the View menu.

You can select:


 An entire element or attribute in the Grid View
 Some characters from within any item in the Text View or Grid View.
 An enclosed string. If your text cursor is between quotes, XMLSpy will automatically use
the entire string that is enclosed in the quotes.

21.11.16Text View Settings

The Text View Settings command opens the Text View Settings dialog (screenshot below), in
which you can configure Text View. The shortcut ifor the command is available as an icon in the
Text toolbar.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference View Menu 765

Margins
In the Margins pane, the Line Number, Bookmark, and Source Folding margins can be toggled
on and off. These are separate margins and display, respectively, line numbers, bookmarks,
and source folding (icons to expand and collapse nodes). These settings determine whether the
margins are displayed in Text View or not. Bookmark commands are in the Edit menu. To
expand and collapse nodes, the Folding margin must be toggled on.

Tabs
The Tab pane enables you to set the tab size in terms of spaces. The radio buttons for inserting
either tabs or spaces determine whether documents are displayed with tab or space indentation
when pretty-printing with indentation is toggled on.

Visual Aid
The Visual Aid pane contains settings to toggle on indentation guides (dotted vertical lines that
show the indentation of the text), end-of-line markers, and whitespace markers.

Key map
The key map is a list of XMLSpy shortcuts and their associated commands.

© 2010 Altova GmbH User Manual


766 User Reference Browser Menu

21.12 Browser Menu


The commands on the Browser menu are only available in Browser View.

21.12.1 Back

Backspace (Alt + Left Arrow)

In Browser View, the Back command displays the previously viewed page. The Backspace key
also achieves the same effect. The Back command is useful if you click a link in your XML
document and want to return to your XML document.

In Schema View, the Back command takes you to the previously viewed component. The
shortcut key is Alt + Left Arrow. Using the Back command up to 500 previously viewed
positions can be re-viewed.

21.12.2 Forward

(Alt + Right Arrow)

The Forward command is only available once you have used the Back command. It moves you
forward through (i) previously viewed pages in Browser View, and (ii) previous views of schema
components in Schema View.

21.12.3 Stop

The Stop command instructs the browser to stop loading your document. This is useful if large
external files or graphics are being downloaded over a slow Internet connection, and you wish
to stop the process.

21.12.4 Refresh

F5

The Refresh (F5) command updates the Browser View by reloading the document and related
documents, such as CSS and XSL stylesheets, and DTDs.

21.12.5 Fonts
The Fonts command allows you to select the default font size for rendering the text of your XML
document. It is similar to the Font Size command in most browsers.

21.12.6 Separate Window

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Browser Menu 767

The Separate Window command opens the Browser View in a separate window, so that
side-by-side viewing is possible. If you have separated the Browser View, press F5 in editing
view to automatically refresh the corresponding Browser View. To dock separate windows back
into the interface, click the maximize button (at top right) of the active window.

© 2010 Altova GmbH User Manual


768 User Reference WSDL Menu

21.13 WSDL Menu


The commands in the WSDL menu are available when viewing a WSDL document in WSDL
View, which is graphical editor for creating and editing WSDL documents..

For a description of WSDL View, see the section WSDL View. To get started with WSDL, see
the WSDL Tutorial.

21.13.1 WSDL 1.1 Components


Mousing over the WSDL 1.1 Components menu item scrolls out a submenu (screenshot below
) from which various commands for editing WSDL 1.1 components can be selected.

Each item of the WSDL 1.1 menu (screenshot above) rolls out its own submenu, from which
commands relating to that component can be selected. The commands in each of these
submenus are described in the subsections of this section.

Messages
Insert message
Adds a new message to the WSDL document. The Messages item in the Overview entry helper
opens, and the newly created message is highlighted there.

Delete message
Deletes the selected message from the input or output element.

Add message part (parameter)


Adds a message part (parameter) to the selected message.

Delete message part (parameter)


Deletes a message part (parameter) from the selected message.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference WSDL Menu 769

Operations
Append Operation
Appends a new operation to the Operations window. The type of operation to be appended can
be selected from the submenu (screenshot below) of the Append Operation menu command.

Delete Operation
Deletes the selected operation from the Operations window.

Add Input Element


Adds an input element to the selected operation.

Add Output Element


Adds an output element to the selected operation.

Add Fault Element


Adds a Fault element to the selected operation.

Delete Input/Output/Fault Element


Deletes the selected input, output or fault element.

Add New Message to Input/Output/Fault Element


Adds a new (default) message, to the currently selected input or output message.

PortType
Insert PortType
Adds a new PortType to the PortTypes window.

Delete PortType
Deletes the selected PortType from the PortTypes window.

Binding
Insert Binding
Adds a new binding to the Bindings window.

Delete Binding
Deletes the selected binding from the Bindings window.

Append Child
Enables the addition of a new extensibility element to an input or output message. If the menu
item is unavailable, it is not allowed in this position. See the W3C WSDL Specs for more
information on Extensibilty items.

The following extensibility items are available:

© 2010 Altova GmbH User Manual


770 User Reference WSDL Menu

 soap:body
 soap:header
 soap:headerfault
 soap:fault
 mime:content
 mime:multipartrelated
 mime:part
 mime:mimeXml
 http:urlencoded
 http:urlreplacement

Delete Extensibility
Deletes the selected extensibility item.

Service
Insert Service
Adds a new service in the Services window.

Delete Service
Deletes the selected service in the Services window.

Insert Port
Adds a new port to the selected service in the Services window.

Delete Port
Deletes the selected port from the currently selected service.

21.13.2 WSDL 2.0 Components


Mousing over the WSDL 2.0 Components menu item scrolls out a submenu (screenshot below
) from which various commands for editing WSDL 2.0 components can be selected.

Each item of the WSDL 2.0 Components menu (screenshot above) rolls out its own submenu,
from which commands relating to that component can be selected. The commands in each of
these submenus are described in the subsections of this section.

Interface
The following commands are available in the Interface menu (screenshot below).

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference WSDL Menu 771

Add new interface


Adds a new interface box to the Interfaces column of the Main Window. The default name of the
interface is highlighted in the interface box, enabling you to enter a new name directly.

Delete interface
Deletes the selected interface.

Add new fault


Adds a new fault element to the selected interface. The default name of the fault is
highlighted in the interface box, enabling you to enter a new name directly.

Delete fault
Deletes the selected fault.

Add new operation


Adds a new operation element to the selected interface. The type of operation to be added is
selected from the pop-out menu (screenshot below), and may be one of the operation types
shown in the screenshot.

The default name of the operation is highlighted in the interface box, enabling you to enter a
new name directly.

Delete operation
Deletes the selected operation.

© 2010 Altova GmbH User Manual


772 User Reference WSDL Menu

Binding
The following commands are available in the Interface menu (screenshot below).

Add new binding


Adds a new binding box to the Bindings column of the Main Window. The default name of the
binding is highlighted in the binding box, enabling you to enter a new name directly.

Delete binding
Deletes the selected binding.

Add new fault


Adds a new fault element to the selected binding. A fault element in a binding contains a ref
attribute that references a fault declared in an interface. In the newly created fault in the binding,
the interface fault that is to be referenced can be selected from the combo box of the newly
created fault.

Delete fault
Deletes the selected fault.

Add new operation


Adds a new operation element to the selected binding. An operation element in a binding
contains a ref attribute that references an operation declared in an interface. In the newly
created operation in the binding, the interface operation that is to be referenced can be selected
from the combo box of the newly created binding operation.

Delete operation
Deletes the selected operation.

Service
The following commands are available in the Interface menu (screenshot below).

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference WSDL Menu 773

Add new service


Adds a new service box to the Services column of the Main Window. The default name of the
service is highlighted in the service box, enabling you to enter a new name directly. The
interface reference can be selected from the combo box for the Interface property.

Delete service
Deletes the selected service.

Add new endpoint


Adds a new endpoint element to the selected service. The default name of the endpoint is
highlighted in the service box, enabling you to enter a new name directly. The binding reference
can be selected from the combo box for the Binding property. The address of the endpoint must
be entered in the field for the Address property

Delete endpoint
Deletes the selected endpoint.

21.13.3 Types
New Schema
This option only becomes active if the WSDL file does not contain a schema element.
Please note that when using the File | New menu option, a schema element is included in the
skeleton WSDL file. The menu item cannot be selected in this case (see below).
<types>
<xs:schema/>
</types>

Edit Schema(s) in Schema View


Opens a skeleton schema file if the WSDL file does not contain a reference to a specific
schema. This is the case if you have used the File | New menu option. If a reference to a
specific schema exists, then the schema opens in the embedded Schema View of the graphical
WSDL editor.

21.13.4 Save Diagram, Generate Documentation


The Save Diagram command saves the design diagram as a PNG file.

The Generate Documentation command generates detailed documentation of the current


WSDL file. You can output the documentation as an HTML, MS Word, or RTF file.
Documentation is generated for components you select in the WSDL Documentation dialog
(which appears when you select the Generate Documentation command; see screenshot below
). Related components are hyperlinked in the onscreen output, enabling you to navigate from
component to component. Note that documentation is also generated for imported WSDL files

© 2010 Altova GmbH User Manual


774 User Reference WSDL Menu

Note: In order to generate documentation in MS Word format, you must have MS Word
(version 2000 or later) installed.

Clicking the Generate Documentation command opens the WSDL Documentation dialog (
screenshot above). Depending on whether a WSDL 1.1 document or a WSDL 2.0 document is
active, the items in the Include and Details pane of the dialog will be different. The screenshot
above shows the WSDL Documentation dialog for a WSDL 1.1 document.
 The required format is specified in the Output Format pane: either HTML, Microsoft
Word, or RTF. On clicking OK, you will be prompted for the name of the output file and
the location to which it should be saved.
 The documentation can be generated either as a single file or be split into multiple files.
When multiple files are generated, each file corresponds to a component. What
components are included in the output is specified using the check boxes in the Include
pane.
 For HTML output, the CSS style definitions can be either saved in a separate CSS file
or embedded in the HTML file (in the <head> element). If a separate CSS file is
created, it will be given the same name as the HTML file, but will have a .css
extension. Check or uncheck the Embed CSS in HTML check box to set the required
option.
 The Embed Diagrams option is enabled for the MS Word and RTF output options.
When this option is checked, diagrams are embedded in the result file, either in PNG or
EMF format. Otherwise diagrams are created as PNG or EMF files, which are displayed
in the result file via object links.
 When the output is HTML, all diagrams are created as document-external PNG files. If
the Create folder for diagrams check box is checked, then a folder will be created in the
same folder as the HTML file, and the PNG files will be saved inside it. This folder will
have a name of the format HTMLFilename_diagrams. If the Create folder for diagrams
check box is unchecked, the PNG files will be saved in the same folder as the HTML
file.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference WSDL Menu 775

 When the output is HTML, all diagrams are created as document-external PNG files.
 In the Include pane, you select which items you want to include in the documentation.
The Overview option lists all components, organized by component type, at the top of
the file. The Check All and Uncheck All buttons enable you to quickly select or
deselect all the options in the pane.
 The Details pane lists the details that may be included for each component. Select the
details you wish to include in the documentation. The Check All and Uncheck All
buttons enable you to quickly select or deselect all the options in the pane.
 The Show Result File option is enabled for all three output options. When this option is
checked, the result files are displayed in Browser View (HTML output), MS Word (MS
Word output), and the default application for .rtf files (RTF output).

21.13.5 Reparse WSDL Document


Reparses the document. This is required in some situations, for example, when a schema
associated with the WSDL document has been modified. Reparsing the WSDL document will
update it with information from the modified schema document.

21.13.6 Convert to WSDL 2.0


The Convert to WSDL 2.0 command is enabled only when a WSDL 1.1 is active in WSDL
View. It generates a WSDL 2.0 document from the active WSDL 1.1 document. Clicking this
command pops up a File Save dialog, in which you can specify the location and name of the
WSDL 2.0 file that will be generated by XMLSpy.

On clicking OK in the File Save dialog, a WSDL 2.0 document is generated and saved to the
specified location, and opened in WSDL View in a new tab. The file can then be edited as
required, just like any other WSDL 2.0 document.

21.13.7 Generate WSDL Program Code with MapForce


The Generate WSDL Program Code with MapForce command launches Altova's MapForce if
the application is installed. MapForce enables you to map a schema to another DTD, XML
Schema, or database, to generate XML, and to generate program code from the WSDL file.

© 2010 Altova GmbH User Manual


776 User Reference SOAP Menu

21.14 SOAP Menu


XMLSpy supports SOAP versions 1.1 and 1.2, and WSDL versions 1.1 and 2.0.

The SOAP: How To section that follows the menu descriptions, shows you how to use the
SOAP debugger using the nanonull.com timeservice server supplied by Altova. Please use
this service to test the SOAP debugger. The AirportWeather web service, described on the
following pages, might not always be available to you.

Use the SOAP functionality:


 To test your web services without having to implement client applications
 For quick testing of third party web services

For more info on these specifications please see:


SOAP http://www.w3.org/TR/SOAP/
WSDL http://www.w3.org/TR/wsdl

21.14.1 Create New SOAP Request


This command creates a new SOAP request document. It involves the following steps:
1. Enter the WSDL file location and connect to the server.
2. The server responds with a list of operations. Select the SOAP operation you want.
3. The server responds with a SOAP Request form in XML format. Define the SOAP
Request form.

We demonstrate the process below by creating a SOAP request for the US National Digital
Forecast Database (NDFD) SOAP Service (http://www.nws.noaa.gov/xml/).

Connecting to the SOAP server


The connection is made via a WSDL file. In our example, the URI of the WSDL file is:
http://www.weather.gov/forecasts/xml/DWMLgen/wsdl/ndfdXML.wsdl. To make the
connection, click the Create New SOAP Request command, and enter the file URI in the dialog
that appears (screenshot below).

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference SOAP Menu 777

Click OK to confirm the selection.

Select the required SOAP operation


The server responds with a list of operation which are displayed in a dialog (screenshot below).

Select an operation and click OK. We selected the NDFgenByDay operation.

Define the SOAP Request


The server responds by sending an XML file, which is displayed in the Text View of XMLSpy.
For the operation we selected, we received the following XML file.
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/ "
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/ " xmlns:xsi="
http://www.w3.org/2001/XMLSchema-instance " xmlns:xsd="http://www.w3.org/2001/XMLSchema "
xmlns:m0="http://www.weather.gov/forecasts/xml/DWMLgen/schema/DWML.xsd ">
<SOAP-ENV:Body>
<m:NDFDgenByDay xmlns:m="
http://www.weather.gov/forecasts/xml/DWMLgen/wsdl/ndfdXML.wsdl "
SOAP-ENV:encodingStyle ="http://schemas.xmlsoap.org/soap/encoding/ ">
<latitude xsi:type="xsd:decimal">0.0</latitude>
<longitude xsi:type="xsd:decimal">0.0</longitude>
<startDate xsi:type="xsd:date">1967-08-13</startDate>
<numDays xsi:type="xsd:integer">0</numDays>
<format xsi:type="m0:formatType">String</format>
</m:NDFDgenByDay>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

© 2010 Altova GmbH User Manual


778 User Reference SOAP Menu

We filled in the parameters as required by the XML (in bold below):


<SOAP-ENV:Body>
<m:NDFDgenByDay xmlns:m="
http://www.weather.gov/forecasts/xml/DWMLgen/wsdl/ndfdXML.wsdl "
SOAP-ENV:encodingStyle ="http://schemas.xmlsoap.org/soap/encoding/ ">
<latitude xsi:type="xsd:decimal">45</latitude>
<longitude xsi:type="xsd:decimal">-90</longitude>
<startDate xsi:type="xsd:date">2009-10-13</startDate>
<numDays xsi:type="xsd:integer">1</numDays>
<format xsi:type="m0:formatType">24 hourly</format>
</m:NDFDgenByDay>
</SOAP-ENV:Body>

This completes the definition of this SOAP request. In the next step, we shall send the request.

21.14.2 Send Request to Server


This command sends a SOAP request to the SOAP server. The SOAP request is an XML
document. It must be the active document in XMLSpy when the command is selected.How to
define a SOAP request is described in the description of the command Create New SOAP
Request.

After the SOAP request is sent, a response is received from the SOAP server. This response is
an XML document, which is displayed in the Text View of XMLSpy. For example, show below is
a screenshot of the XML document that was returned in response to the SOAP request we
defined in the section Create New SOAP Request.

Saving and reusing a SOAP request


XMLSpy allows you to save a SOAP request and resend it at a later time. Do this as follows:
1. Save the SOAP request XML document (File | Save as).

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference SOAP Menu 779

2. Close the SOAP request file.


3. Reopen the SOAP request XML document, and select the menu option SOAP | Send
Request to Server. (Any XML file can be used as a SOAP request document.)

21.14.3 Change SOAP Request Parameters


This command allows you to change the currently defined SOAP parameters of the SOAP
request document. To change a SOAP request, do the following:
1. Make the SOAP request document active.
2. Select the menu option Soap | Change SOAP request parameters. This opens the
SOAP Request Settings dialog box (screenshot below).

3. You can now manually enter the desired Connection Endpoint or SOAP Action settings.
If you wish to send the request as SOAP 1.2, check the check box at the bottom of the
dialog. If you are using the https protocol, you might wish to allow a host name
mismatch or an expired server certificate. To make these settings, click the HTTPS
Settings button. The HTTPS Settings dialog (screenshot below) appears.

4. In the HTTPS Settings dialog, you can allow that the host name given in the SOAP
request need not match the host name in the server certificate; do this by checking the
Allow host name mismatch check box. If you wish to allow the connection despite an
expired server certificate, then check the Allow expired server certificate check box.
Confirm the changes with OK.

About trusted certificates

© 2010 Altova GmbH User Manual


780 User Reference SOAP Menu

Altova products use Internet Explorer (IE) to access and manage trusted certificates of secure
webservers. Installing the certificate of a webserver in IE allows IE to access the webserver
without issuing a warning or aborting the process. In order to install the certificate of a secure
webserver, do the following:
 In Internet Explorer 8, open the secure website.
 Select File | Properties, and click the Certificates button.
 Click Install Certificate and start the Import Certificate Wizard. (This Wizard can also
be accessed via Tools | Internet Options| Content | Certificates | Import.)
 The certificate should be placed in the Trusted Root Certification Authorities store, for
which you can browse manually.
 Finish the Wizard steps, close the Certificates and Properties dialogs respectively by
clicking OK. You might need to restart Internet Explorer.

Note: Only change the SOAP action settings if a full list of the SOAP methods and their
corresponding SOAP actions are available to, and accessible by, you.

21.14.4 Soap Debugger Session


This command starts a SOAP debugger session.

 A dialog box is immediately opened after you select this command. You then have to
select a WSDL file location, generally a URL. You can also select a file via a global
resource (click the icon and select a global resource in the dialog that pops up) or
a file in one of the open windows in XMLSpy.
 Select the source and target ports needed for the debugger proxy server and the web
service, in the following dialog box.

This opens the SOAP debuggers proxy server in its inactive state. Clicking one of the
SOAP toolbar icons, starts the SOAP debugger and waits for the client requests.

Please see the Soap - How to section for a more detailed description.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference SOAP Menu 781

21.14.5 Go

This command activates the SOAP proxy server and processes the WSDL file until a breakpoint
is encountered. The respective SOAP document then appears in one of the SOAP document
windows.

21.14.6 Single Step

This command allows you to single-step through the incoming and outgoing SOAP requests
and responses. The SOAP debugger stops for each request and response. The proxy server is
also started if it was inactive.

21.14.7 Break on Next Request

This command causes the debugger to stop on the next SOAP request, and display the data in
the SOAP Request document window. You can directly edit the data in this window before

© 2010 Altova GmbH User Manual


782 User Reference SOAP Menu

sending it on to the web service.

21.14.8 Break on Next Response

This command causes the debugger to stop on the next SOAP Response, and display the data
in the SOAP Response document window. You can directly edit the data in this window before
sending it on to the client.

21.14.9 Stop the Proxy Server

This command stops the debugger proxy server.

21.14.10Soap Debugger Options


This command allows you to define the SOAP debugger options. Please define these settings
before you start the SOAP debugger.

Hide
You can hide the entry helpers as well as the project or info windows, enabling you to see more
of the data in the SOAP documents.

Timeout (secs)
Most clients have a timeout setting in the data receiving function. The time the debugger
remains in a breakpoint is per default 5 seconds. A data packet (http1.1 100 Continue")
message is sent to the client once every timeout period you define.

Setting the timeout period to zero suppresses the data packet; you remain in the breakpoint for
as long as you want.

This computer's address


Address of the computer on which the SOAP debugger is running. This computer must be
accessible to the Client computer.

Enter the address in the form http://computer name, where "computer name" is the web
address or IP address of the computer on which the SOAP debugger is running. Do not enter a
port number in the address. The "localhost" entry always points to your local computer.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XBRL Menu 783

21.15 XBRL Menu


The XBRL menu contains commands that are enabled when a taxonomy is being edited in
XBRL View. These commands are:
 Arcroles: defines arcroles
 Linkroles: defines linkroles
 Namespace Prefixes: manages taxonomy namespaces
 Set Target Namespace: defines and declares the target namespace of the taxonomy
 Import/Reference: imports an XBRL taxonomy or references a linkbase
 Generate Documentation: generates documentation of the current XBRL taxonomy
 View Settings: sets default for XBRL View
 Generate XBRL from DB, Excel, CSV with MapForce: launches Altova MapForce for
generating an XBRL instance file
 Present XBRL as HTML/PDF/Word with StyleVision: launches Altova StyleVision for
designing an XBRL report

For more information about XBRL, see the sections XBRL and Editing Views | XBRL View.

21.15.1 Arcroles
The Arcroles command pops up the Arc Roles dialog (screenshot below) in which arcroles can
be created for a taxonomy. Arcroles are stored in the concept definitions file, within the appinfo
element. They specify the role of an arc.

In the Taxonomies tab of the Arc Roles dialog (screenshot below), only taxonomies that are
editable or that contain an arcrole or linkrole are listed in the combo box. You can add an
arcrole to a taxonomy by clicking the Add button. Then define the arcrole's URI, ID, definition,
and cycles. To specify in which kinds of relationships the arcrole should be available, check the
boxes of the required relationship kinds. Linkbases that reference an arcrole can be added to
the Referencing Linkbase Files column.

The Linkbases tab provides another view of the taxonomy's arcroles. In this view, you add and
view arcroles according to individual linkbases (for example calculation or presentation
linkbases). Select a linkbase in the combo box and then add or delete an arcrole as required.
When you click the Add button, the Add Arcrole Reference dialog (screenshot below) pops up.

© 2010 Altova GmbH User Manual


784 User Reference XBRL Menu

Each of the entries in this dialog is a combo box that enables you to select from available
options. The Defined in Schema field enables you to select the taxonomy in which the arcrole is
defined. The ID and Role combo boxes provide the available arcroles. After you have selected
an arcrole and clicked OK, the reference is added to the linkbase. In the Taxonomies tab, the
arcrole you referenced will show the referencing linkbase in the Referencing Linkbase Files
column. If you wish to make this linkrole available for a particular kind of relationship, you will
still, however, have to check the appropriate relationship kind check box.

After an arcrole has been created in the taxonomy it can be used to specify the role of an arc in
a relationship kind for which the arc is available according to its definition. In the screenshot
above, for example, the arcrole has been made available for arcs in label relationships.

The arcrole of an arc is selected in the Details entry helper (screenshot below; arcrole
highlighted).

With the element at the to end of an arc selected, in the Details Entry Helper, select the
required item from the dropdown list of the arcrole entry.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XBRL Menu 785

21.15.2 Linkroles
The Linkroles command pops up the Link Roles dialog (screenshot below) in which linkroles
can be created for a taxonomy. Linkroles are stored in the concept definitions file, within the
appinfo element (see listing below). Linkroles are used not only in definitionLink elements
but also in the containing elements of other relationship kinds (for example, in
calculationLink and presentationLink elements).

<xs:appinfo>
<link:roleType id="SegmentRevenueAndOperatingIncome"
roleURI="
http://www.nanonull.com/taxonomy/role/SegmentRevenueAndOperatingIncome">
<link:definition>006091 - Disclosure - Segment Revenue and Operating
Income</link:definition>
<link:usedOn>link:calculationLink</link:usedOn>
<link:usedOn>link:definitionLink</link:usedOn>
<link:usedOn>link:presentationLink</link:usedOn>
</link:roleType>
</xs:appinfo>

In the listing above, notice that there are usedOn elements that specify in which kind of
relationships this linkrole may be used.

In the Taxonomies tab of the Link Roles dialog (screenshot below), you can add a linkrole to a
taxonomy file by clicking the Add button. Then define the linkrole's URI and ID (refer to listing
above). To specify for which kinds of relationships a linkrole should be available, check the
boxes of the required relationship kinds. In the Referencing Linkbase Files column, for each
linkrole, you can add or delete the linkbase files that reference the linkrole.

The Linkbases tab provides another view of the taxonomy's linkroles. In this view, you add and
view linkroles according to individual linkbases (for example calculation or presentation
linkbases). Select a linkbase in the combo box and then add or delete a linkrole as required. For
example, you could add a linkrole to the calculation linkbase. When you click the Add button,
the Add Reference to Linkbase File dialog (screenshot below) pops up.

© 2010 Altova GmbH User Manual


786 User Reference XBRL Menu

Each of the entries in this dialog is a combo box that enables you to select from available
options. The Defined in Schema field enables you to select the taxonomy in which the linkrole is
defined. The ID and Role combo boxes provide the available linkroles. After you have selected
a linkrole and clicked OK, the reference is added to the linkbase. In the Taxonomies tab, the
linkrole you referenced will show the referencing linkbase in the Referencing Linkbase Files
column. If you wish to make this linkrole available for a particular kind of relationship, you will
still, however, have to check the appropriate relationship kind check box.

After a linkrole has been created in the taxonomy it is used when creating relationships.

21.15.3 Namespace Prefixes


The Namespace Prefixes command pops up the Namespace Prefixes dialog (screenshot
below), which displays all the namespaces in the taxonomy, including those of imported
taxonomies. In the Namespace Prefixes dialog you can edit namespaces and prefixes, and set
background colors for individual namespaces. When a background color is set for a
namespace, elements in that namespaces appear in the Main Window and entry helpers with
that background color. Note that a color setting for a given namespace applies for that
namespace across all taxonomy documents opened in XBRL View.

To add or delete a namespace, use the Add or Delete buttons, respectively. A color is assigned
to a namespace via the color palette for that namespace. When you are done with editing in the

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XBRL Menu 787

Namespaces dialog, click OK to finish.

The target namespace of the taxonomy is also listed in the Namespaces dialog. The target
namespace, however, should not be modified in this dialog, but via the Set Target Namespace
command. For more information on target namespaces, see the XBRL section of the
documentation.

21.15.4 Set Target Namespace


The Set Target Namespace command enables a target namespace to be set for a taxonomy
document. Clicking the command pops up the Set Target Namespace dialog (screenshot below
). In it you can enter the desired target namespace and a prefix for it. Click OK to finish.

The target namespace will be defined and it will also be declared:


<xs:schema targetNamespace="http://www.altova.com/XBRL/Taxonomies"
xmlns:ns1="http://www.altova.com/XBRL/Taxonomies" >
...
</xs:schema>

In the listing above, the target namespace is defined with the targetNamespace attribute and it
is then declared with a prefix of ns1.

21.15.5 Import/Reference
The Import/Reference command pops up a dialog (screenshot below) in which you can specify
the schema to import or the linkbase to reference.

© 2010 Altova GmbH User Manual


788 User Reference XBRL Menu

The dialog provides the following radio button options:


 Importing a standard taxonomy: This option enables you to quickly and correctly import
a US-GAAP taxonomy or an IFRS taxonomy. Select the required standard taxonomy
from the dropdown menu of the combo box and click Next. This takes you to the
respective next dialog, for completing your specification of the required taxonomy. The
process is described in the section XSXBRL_CreatingNewTaxonomy.
 Importing any taxonomy (Reference Schema): This option enables you to import any
taxonomy by specifying the location of the taxonomy file (.xsd file). XMLSpy can extract
a target namespace from the taxonomy file (click the Extract Target Namespace
button to do this). When the taxonomy is imported, the target namespace will be
created as the value of the namespace attribute of the xs:import element.
<xs:import namespace="http://www.altova.com/nanonull "
schemaLocation="XBRL%20Examples/Nanonull/nanonull.xsd "/>

 Referencing a linkbase: A linkbase can be specified for inclusion in the taxonomy. Do


this by specifying the location of the linkbase file and clicking Finish. A reference to the
linkbase file is created in the taxonomy. The relationship type of the newly referenced
linkbase can then be specified right-clicking the filename and selecting the Set
Linkbase Kind command.

21.15.6 Generate Documentation


The Generate Documentation command generates detailed documentation of the current
XBRL taxonomy. You can output the documentation as an HTML, MS Word, or RTF file.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XBRL Menu 789

Documentation is generated for components you select in the XBRL Taxonomy Documentation
dialog (which appears when you select the Generate Documentation command; see screenshot
below). Related components are hyperlinked in the onscreen output, enabling you to navigate
from component to component.

Note: In order to generate documentation in MS Word format, you must have MS Word
(version 2000 or later) installed.

Clicking the Generate Documentation command opens the XBRL Taxonomy Documentation
dialog:
 The required format is specified in the Output Format pane: either HTML, Microsoft
Word, or RTF. On clicking OK, you will be prompted for the name of the output file and
the location to which the output file should be saved.
 The documentation can be generated either as a single file or be split into multiple files
(the Split Output to Multiple Files option). When multiple files are generated, each file
corresponds to a component. What components are included in the output is specified
using the check boxes in the Include pane.
 For HTML output, the CSS style definitions can be either saved in a separate CSS file
or embedded in the HTML file (in the <head> element). If a separate CSS file is
created, it will be given the same name as the HTML file, but will have a .css
extension. Check or uncheck the Embed CSS in HTML check box to set the required
option.
 The Embed Diagrams option is enabled for the MS Word and RTF output options.
When this option is checked, diagrams are embedded in the result file, either in PNG or
EMF format. Otherwise diagrams are created as PNG or EMF files, which are displayed
in the result file via object links.
 When the output is HTML, all diagrams are created as document-external PNG files. If
the Create folder for diagrams check box is checked, then a folder will be created in the
same folder as the HTML file, and the PNG files will be saved inside it. This folder will
have a name of the format HTMLFilename_diagrams. If the Create folder for diagrams
check box is unchecked, the PNG files will be saved in the same folder as the HTML

© 2010 Altova GmbH User Manual


790 User Reference XBRL Menu

file.
 When the output is HTML, all diagrams are created as document-external PNG files.
 In the Include pane, you select which items you want to include in the documentation.
The Overview option lists all components, organized by component type, at the top of
the file. The Check All and Uncheck All buttons enable you to quickly select or
deselect all the options in the pane.
 The Details pane lists the details that may be included for each component. Select the
details you wish to include in the documentation. The Check All and Uncheck All
buttons enable you to quickly select or deselect all the options in the pane.
 The Show Result File option is enabled for all three output options. When this option is
checked, the result files are displayed in Browser View (HTML output), MS Word (MS
Word output), and the default application for .rtf files (RTF output).
 In the Options pane, you can select (i) whether element name should be shown with
just a prefix (short qualified name) or in its expanded for (with the full namespace); and
(ii) whether imported elements should also be displayed.

21.15.7 View Settings


The View Settings command pops up the XBRL View Settings dialog (screenshot below), in
which you can specify default settings for XBRL View.

The following settings can be made:


 Display of element names can be set to the short or expanded qualified name or to
labels. These defaults apply to the Main Window and the Details entry helper. The
element-name display setting for the Global Elements entry helper is independent of the
settings made in the XBRL View Settings dialog; the settings are in the entry helper's
menu bar.
 Expand by default: In the Main Window, element details, the labels box, and the
references box can be set by default to the expanded state. Note that, if the labels or
references boxes are set to be shown expanded by default, then the expanded boxes
will be visible only when the Element details are expanded (either by default or
manually). These default settings are visible when the view is refreshed.
 Label defaults for the label link role, the label language and the kind of label (link role)
can be specified. The combo box for each property displays a list of available values.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference XBRL Menu 791

21.15.8 Generate XBRL from DB, Excel, CSV with MapForce


This command starts the generation of an XBRL instance file based on the currently active
taxonomy. The data for the instance file is obtained from an MS Excel datasheet, a database, or
a CSV file. The XBRL instance file is generated by Altova's MapForce program which you must
have installed on your machine. The command starts Altova MapForce and loads the taxonomy
into it. You can then specify the source data file and graphically design the required instance file
output.

21.15.9 Present XBRL as HTML/PDF/Word with StyleVision


This command loads the currently active taxonomy into Altova StyleVision, which enables you to
generate a design for reports based on the taxonomy. In order to use this command, you must
have Altova's StyleVision program installed on your machine.

© 2010 Altova GmbH User Manual


792 User Reference Tools Menu

21.16 Tools Menu


The tools menu allows you to:
 Check the spelling of your XML documents.
 Access the scripting environment of XMLSpy. You can create, manage and store your
own forms, macros and event handlers.
 View the currently assigned macros.
 Compare any two files to check for differences
 Compare any two folders to check for differences
 Define global resources
 Change the active configuration for global resources in XMLSpy
 Customize your version of XMLSpy: define your own toolbars, keyboard shortcuts,
menus, and macros
 Define global XMLSpy settings

21.16.1 Spelling
XMLSpy includes a built-in spelling checker.

The spelling checker can be used in the following views: Grid, Text and Authentic View. Please
note that you can check any type of XML file. The view you select influences the spelling
checker options that are made available. A schema file (*.xsd) can be checked in Text and Grid
View, but not in Schema View or XBRL View. Similarly, a WSDL file can be spell-checked in
Text View but not in WSDL VIew.

Spell checking in Text and Grid View presents you with the most options. You can additionally
check the spelling of:
 Element content
 Attribute content
 CDATA content
 Comment text

You can also define which specific element or attribute content to check or ignore. These
selections are defined in the "Spelling context" dialog box.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 793

The Tools | Spelling... command (Shift+F7) opens the Spelling dialog box, and automatically
starts checking the currently active XML document (in this screenshot, the OrgChart.xml
document in Authentic View).

Not in Dictionary
This text box contains the word that cannot be found in any of the existing dictionaries (default
and custom dictionaries). You can edit the text here and click Change to change it in the XML
document. The word is also highlighted in the XML document. The command buttons become
active at this point and allow you to decide which action to take.

Suggestions
This list box displays a list of words that resemble the unknown word (supplied from all
dictionaries). Double-clicking a word in this list automatically inserts it in the document and
continues the spell checking process.

Ignore once
This command allows you to continue checking the document while ignoring the first occurrence
of the unknown word. The same word will be flagged again if it appears in the document.

Ignore all
This command ignores all instances of the unknown word in the whole document.

Add to dictionary
This command adds the unknown word to the currently active custom dictionary. The active
dictionary is the dictionary that is selected in the Custom Dictionaries dialog box. To open this
dialog, click Options, then Spelling options, then Custom Dictionaries.

© 2010 Altova GmbH User Manual


794 User Reference Tools Menu

Change
This command replaces the currently highlighted word in the XML document with the selected
word in the Suggestions list box.

Change all
This command replaces all occurrences of the currently highlighted word in the XML document,
with the selected word in the Suggestions list box.

Recheck
The Recheck button restarts the check from the beginning of the document.

Close
This command closes the Spelling dialog box.

Options...
This command opens a dialog box depending on the current view.
 If opened from Authentic View, the Options dialog box is opened.
 If opened from the Text or Enhanced Grid view, the Spelling context dialog box is
opened.

21.16.2 Spelling Options


The Tools | Spelling options command opens either the Spelling Options or Spelling
context dialog box, depending on the view you are using to display your XML document.

Spelling Options dialog (Browser View and Schema/WSDL View)


When viewing an XML document in Browser View or Schema/WSDL View, this command
opens the Spelling Options dialog box. Use this dialog box to define the global spelling checker
options.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 795

Always suggest corrections:


Activating this option causes suggestions (from all of the dictionaries) to be displayed in the
Suggestions list box. Disabling this option causes no suggestions to be shown.

Make corrections only from main dictionary:


Activating this option causes only the default dictionary to be used; none of the custom
dictionaries are scanned for suggestions. It also disables the Custom Dictionaries button,
preventing any editing of the custom dictionaries.

Ignore words in UPPER case:


Activating this option causes all upper case words to be ignored.

Ignore words with numbers:


Activating this number causes all words containing numbers to be ignored.

Dictionary Language
Use this combo box to select the dictionary language for the spelling checking. The default
installation allows you to select English. Other language dictionaries will be made available on
the Altova download web site.

Custom dictionaries
The Custom Dictionaries... button allows you to:
 modify an existing dictionary (add or delete dictionary entries)
 create a totally new dictionary
 add an existing dictionary
 remove an existing dictionary

When you start the spell checking process, all dictionaries listed in the Custom Dictionaries
list box are searched. If you want to limit the search to specific dictionaries, use the
Remove button to delete those you do not want searched.

To add a new dictionary entry:


1. In the Custom Dictionaries dialog, click the name of the custom dictionary to which you
want to add an entry, and click Modify...
This opens the dictionary highlighted in the list box (custom.tlx in this case). A
prompt appears if none of the dictionaries has been selected.

© 2010 Altova GmbH User Manual


796 User Reference Tools Menu

2. Click in the Word: field and enter the new dictionary entry (this automatically activates
the Add button).
3. Click Add to add it to the dictionary.
4. Click OK.

To delete an entry from the dictionary:


1. In the Custom Dictionaries dialog, click the name of the custom dictionary from which
you want to delete an entry, and click Modify...
This opens the dictionary highlighted in the list box (custom.tlx in this case). A
prompt appears if none of the dictionaries has been selected.
2. Click the word in the Dictionary list box to highlight it, and click Delete.
3. Click OK.

To add a new dictionary:


1. In the Custom Dictionaries dialog, click New, and enter the name of the new custom
dictionary in the File name field.
2. Click Save to save the dictionary.
3. You can now add entries to the dictionary using the procedure above, or the Add to
Dictionary button while performing a spell check.

To add an existing dictionary:


Use this option to add previously removed (or third party) dictionaries.
1. In the Custom Dictionaries dialog, click Add and enter the name of the dictionary in the
File name field.
Dictionaries have a *.tlx extension.
2. Click Open to add the dictionary to the Custom dictionary list.

Please note:
It is not mandatory for a dictionary to have a *.tlx extension. It can have any
extension, or no extension at all, and still be added to the dictionary list box.

To remove a dictionary:
 In the Custom Dictionaries dialog, click the dictionary name in the list and click Remove
. This removes the dictionary from the list, but does not physically delete it from your
hard disk.

Spelling context dialog- Text and Enhanced Grid view

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 797

When viewing an XML document in the Text or Enhanced Grid view, this command opens the
"Spelling context" dialog box. Starting the spelling checking in the Text and Enhanced grid
view presents you with the most options, you can define the specific content which is to be
checked:
 Element content
 Attribute content
 CDATA content
 Comment text

The Spelling options... button opens the Spelling Options dialog box, which allows you to
define the global spelling checker options.

To define specific element or attribute "content" you want to check:


1. Click the All, except listed below or Only listed below radio button.

2. Click the Append element/attribute icon , and enter the tag name containing the text
you want checked (e.g., para). Press Enter to confirm.

3. Click OK to confirm these settings, and click it again in the Spelling dialog box to start
the spelling checker with these new settings.
The only element content to be checked will be the text between the para tags,
attribute content will also be checked.

© 2010 Altova GmbH User Manual


798 User Reference Tools Menu

To delete a tag name:


 Select the tag name, and press the Delete or Backspace key.

21.16.3 Scripting Editor


The Scripting Editor command opens the Scripting Editor window. How to work with the
Scripting Editor is described in the Scripting section of this documentation.

Note: The .NET Framework version 2.0 or higher will have to be installed on your machine in
order for the Scripting Editor to run.

21.16.4 Macros
Mousing over the Macros command rolls out a submenu containing containing the macros
defined in the Scripting Project that is currently active in XMLSpy (screenshot below). The active
Scripting Project is specified in the Scripting tab of the Options dialog.

Clicking a macro in the submenu (see screenshot above) runs the macro.

21.16.5 Comparisons
XMLSpy provides a comparison (or differencing) feature, with which you can compare XML and
Text files, as well as folders, in order to check for differences.

There are the following menu items in the Tools menu that enable you to perform comparison
tasks on files and folders:
 Compare open file with
 Compare directories
 Compare options

These commands are described in detail in the following sub-sections.

Compare Open File With


This command allows you to compare the open file with another file. The comparison shows
both files tiled vertically in the main window with the differences between them highlighted in
each file in green. You can compare files as XML documents (where the structure and
semantics of tags is significant) or as text documents.

To compare the open file with another file:

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 799

1. With the file active in the Main Window (only one open file can be active in the Main
Window at a given time), click Tools | Compare open file with....
2. Browse for the file you wish to compare the open file with, and select it. You can also
select a file via a global resource or a URL (click the Browse button) or a file in one of
the open windows in XMLSpy (click the Window button).
3. Click OK. The second file is opened, and the Settings dialog appears:

These settings are described under Compare Options. If you do not wish to have this
dialog appear each time you start a compare session, uncheck Show settings before
starting compare, which is at the bottom of the dialog.
4. Select the required settings, then click OK. The two files now appear in the Main
Window. Lines that are different are highlighted in green. One difference is selected at
a time and is indicated in both files in a darker green color. (Also see the 'Highlight
Colors' section below.)

© 2010 Altova GmbH User Manual


800 User Reference Tools Menu

A Compare Files control window also appears:

To select the next difference, click the Next button. The First, Last, and Previous
buttons help you to navigate among the differences and to select a difference.
The "Merge difference" pane enables you to copy the selected difference from one file
to the other. In order to enable merging, the following Compare options must be set:
Detailed differencing must be checked and Ignore node depth must be unchecked. If
you wish to undo a merge, stop the Compare session, select the file in which the
change is to be undone, and select Edit | Undo or press Ctrl + Z.
5. When you are done with reviewing and/or merging differences, click Done.

Highlight colors
The differences and merged differences in the two files are indicated by the following highlight
colors:

Difference

Current difference

Merged difference

Current merged difference

Please note:
 While the Compare session is active, no editing or change of views is allowed. Any
attempt to edit or change the view of either file will pop up a message warning that the
Compare session will be ended.
 Compare settings can be changed during a Compare session (by selecting Tools |
Compare options...), but will only take effect from the next Compare session onward;
the new settings will not affect the current session.

Compare Directories
The Compare directories command allows you to compare two directories, with or without their
sub-directories. Directories are compared to indicate missing files, and whether files of the

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 801

same name are different or not.

To compare two directories:


1. Click Tools | Compare directories. The following dialog appears.

2. Browse for the directories to compare, and check the Include subdirectories check
box if you wish to include subdirectories in the Compare.
3. Select the file types you want to compare in the Files of type field. There are three
options in the dropdown menu: (i) XML filetypes; (ii) Filetypes defined in XMLSpy; and
(iii) all filetypes. Zip archives are treated as directories, and directories and files in the
Zip archive are displayed in the results window. To ensure that Zip archives are read as
directories, make sure that the required extension is included in the Files of Type entry.
4. Click OK. The Settings dialog (described in Compare Options) appears.
5. Select the required settings for comparing files.
6. Click OK. A dialog will appear indicating the progress of the Compare.

The result will appear in a window, and will look like this:

© 2010 Altova GmbH User Manual


802 User Reference Tools Menu

Directory symbols
All directory names are given in black.
Directory is collapsed and its contents are not displayed.
Directory is expanded, indicated by the turned down corner. The contents are
displayed.
Directory contains files, all of which either cannot be compared or are not different from
the corresponding file in the compared directory.
Directory contains one or more files that do not exist in the compared directory.
Directory contains one or more files that are different from the corresponding file in the
compared directory.
Directory contains one or more files that do not exist in the compared directory and one
or more files that are different from the corresponding file in the compared directory.

File symbols
The colors in which file names appear depend on their compare status. These colors are noted
below.

This file cannot be compared (with the corresponding file in the


compared directory). A question mark appears in the middle column.
The file name appears in black.
This file is not different from the corresponding file in the compared
directory. An equals-to sign appears in the middle column. The file
name appears in black.
This file does not exist in the compared directory. The middle column is
empty. The file name appears in blue.
This file is different from the corresponding file in the compared
directory, and the last modification to this file is more recent than the
last modification to the corresponding file. The newer file appears in a
brighter red, and the icon shows the brighter red file symbol on the side
having the newer file.

Viewing options
 Select what files to show by checking or unchecking the options in the Show pane at
the bottom of the Result window.
 Open or close all subdirectories by clicking the appropriate button in the Directories
pane.
 Expand or collapse subdirectories by double-clicking the folder icon.
 The Size and Last Modified can be toggled on and off by right-clicking on either file
titlebar and clicking Size and Last Modified.

 Change column widths by dragging columns.


 The Result window can be maximized, minimized, and resized.

Comparing and merging files


Double-clicking on a line opens both files on that line in the Main Window, and directly starts a
File Compare for the two files. You can then continue as in a regular Compare session (see
Compare open file with...).

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 803

Compare Options
Click Tools | Compare options to open the Settings dialog (see screenshot). In it you make the
settings for your Compare sessions. The settings that are current when a Compare session is
started are the settings that are applied to that Compare session.

View results
Selects the view in which results are shown. You can select from the following options:
 Grid View (XML comparison)
 Text View with Textual Comparison Only unchecked (XML comparison)
 Text View with Textual Comparison Only checked (Text comparison)

If a view that provides XML comparison is selected, then the documents are treated as XML
documents, and XML Compare Options are enabled. If Text comparison is selected, only
Compare Options valid for Text comparison (Whitespaces and Case-sensitivity) are enabled; all
other Compare Options are disabled.

Please note: You can merge differences in both Grid View and Text View, and in both XML and
Text comparison modes. If you wish to undo a merge, stop the Compare session, select the file
in which the change is to be undone, and select Edit | Undo or press Ctrl + Z.

© 2010 Altova GmbH User Manual


804 User Reference Tools Menu

Detailed differencing
If unselected, differences in immediate sibling elements are represented as a single difference,
and the merge option is disabled. If selected, differences in immediate siblings are represented
as separate differences, and merging is enabled.

Please note: The Detailed differencing check box must be checked to enable merging.

Whitespaces
Whitespace characters are space, tab, carriage return, and line feed. The options here compare
files with whitespace unchanged; with whitespace normalized (i.e., all consecutive whitespace
characters are reduced to one whitespace character); and with all whitespace stripped. The
Whitespaces option is available for both XML and Text comparisons.

Case sensitivity
If the Ignore case check box is checked, then you have the option of ignoring or not ignoring
case in node names (for XML comparisons only). The Case-sensitivity option is available for
both XML and Text comparisons.

Namespace/Prefix
These are options for ignoring namespaces and prefixes when searching for differences.

Order
If Ignore order of child nodes is checked, then the position of child nodes relative to each
other does not matter. The comparison is made for the entire set of child nodes, and if the only
difference between a child node in one document and a child node in the compare document is
the relative position in the nodeset, then this difference is ignored.
Please note: Each child element node is identified by its name, its attributes, and its position. If
the names of more than one node in the sibling set are the same, then the position of these
nodes is used to identify the nodes even if the "Ignore order of child nodes" option is checked.
This option applies to each level separately.

If Ignore order of child nodes is unchecked, then differences in order are represented as
differences.

The option of ignoring the order of attributes is also available, and applies to the order of
attributes of a single element.

Entities
If "Resolve entities" is selected, then all entities in the document are resolved. Otherwise the
files are compared with the entities as is.

Text
If "Ignore text" is selected, then differences in corresponding text nodes are not reported.

Ignore node types


Check the node types that will not be compared in the Compare session. Node types that may
be ignored are Attributes, CDATA, Comments, Processing Instructions, DOCTYPE statements,
and the XML declaration.

Depth
If Ignore node depth is checked, then the additional depth of any element (i.e. more levels of
descendants) relative to the depth of the corresponding element in the compared file is ignored.
This option must be unchecked to enable merging.

Show settings before starting compare


Checking this option causes this dialog to appear whenever the Compare open file with

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 805

command is clicked. Having the Settings dialog appear before each comparison allows you to
check and modify the settings for each comparison.

If this command is unchecked, then the Compare session will start directly when a comparison
is invoked.

21.16.6 Global Resources


The Global Resources command pops up the Global Resources dialog (screenshot below), in
which you can:
 Specify the Global Resources XML File to use for global resources.
 Add file, folder, and database global resources (or aliases)
 Specify various configurations for each global resource (alias). Each configuration
maps to a specific resource.

How to define global resources is described in detail in the section, Defining Global Resources.

Note: The Altova Global Resources dialog can also be accessed via the Global Resources
toolbar (Tools | Customize | Toolbars | Global Resources).

21.16.7 Active Configuration


Mousing over the Active Configuration menu item rolls out a submenu containing all the
configurations defined in the currently active Global Resources XML File (screenshot below).

© 2010 Altova GmbH User Manual


806 User Reference Tools Menu

The currently active configuration is indicated with a bullet. In the screenshot above the
currently active configuration is Default. To change the active configuration, select the
configuration you wish to make active.

Note: The active configuration can also be selected via the Global Resources toolbar (Tools |
Customize | Toolbars | Global Resources).

21.16.8 Customize
The Customize command lets you customize XMLSpy to suit your personal needs.

Commands
The Commands tab allows you customize your menus or toolbars.

To add a command to a toolbar or menu:


1. Select the menu item Tools | Customize. The Customize dialog appears.
2. Select the All Commands category in the Categories list box. The available commands
appear in the Commands list box.
3. Click on a command in the Commands list box and drag it to an to an existing menu or
toolbar. An I-beam appears when you place the cursor over a valid position to drop the
command.
4. Release the mouse button at the position you want to insert the command.

 A small button appears at the tip of mouse pointer when you drag a command. The "x"
below the pointer means that the command cannot be dropped at the current cursor
position.
 The "x" disappears whenever you can drop the command (over a tool bar or menu).
 Placing the cursor over a menu when dragging opens it, allowing you to insert the
command anywhere in the menu.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 807

 Commands can be placed in menus or tool bars. If you created you own toolbar you
can populate it with your own commands/icons.

Please note:
You can also edit the commands in the context menus (right-click anywhere to open
the context menu), using the same method. Click the Menu tab and then select the
specific context menu available in the Context Menus combo box.

To delete a command or menu:


1. Select the menu item Tools | Customize. The Customize dialog appears.
2. Click on the menu entry or icon you want to delete, and drag with the mouse.
3. Release the mouse button whenever the "x" icon appears below the mouse pointer.
The command, or menu item, is deleted from the menu or tool bar.

Toolbars
The Toolbars tab allows you to activate or deactivate specific toolbars, as well as create your
own specialized ones.

XMLSpy toolbars contain symbols for the most frequently used menu commands. For each
symbol you get a brief "tool tip" explanation when the mouse cursor is directly over the item and
the status bar shows a more detailed description of the command.

You can drag the toolbars from their standard position to any location on the screen, where they
appear as a floating window. Alternatively you can also dock them to the left or right edge of the
main window.

 Toolbar settings defined in Grid View, Schema View, WSDL View and Text View are
valid in those views. The Browser View toolbars are independent of all the other views.

© 2010 Altova GmbH User Manual


808 User Reference Tools Menu

To activate or deactivate a toolbar


 Click the check box to activate (or deactivate) the specific toolbar.

Apply changes for all views


 Check this check box at the bottom of the dialog to apply changes to all views (and not
only to the current view). On clicking Close, all changes that were made after checking
the check box will be applied to all views.

To create a new toolbar


1. Click the New... button, and give the toolbar a name in the Toolbar name dialog box.
2. Drag commands to the toolbar in the Commands tab of the Customize dialog box.

To reset the Menu Bar


1. Click the Menu Bar entry.
2. Click the Reset button, to reset the menu commands to the state they were in when
XMLSpy was installed.

To reset all toolbar and menu commands


1. Click the Reset All button, to reset all the toolbar commands to the state they were
when the program was installed. A prompt appears stating that all toolbars and menus
will be reset.
2. Click Yes to confirm the reset.

To change a toolbar name


 Click the Rename... button to edit the name of the toolbar.

To delete a toolbar
1. Select the toolbar you want to delete in the Toolbars list box.
2. Click the Delete button.
3. A prompt appears, asking if you really want to delete the toolbar. Click Yes to confirm
the deletion.

Show text labels


This option displays explanatory text below toolbar icons when activated.

Keyboard
The Keyboard tab allows you to define (or change) keyboard shortcuts for any XMLSpy
command.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 809

To assign a new Shortcut to a command:


1. Select the All Commands category using the Category combo box. Note that if a macro
has been selected as an Associated Command, then macros can also be selected via
the category combo box and a shortcut for the macro can be set.
2. Select the command you want to assign a new shortcut to, in the Commands list box
3. Click in the Press New Shortcut Key: text box, and press the shortcut keys that are to
activate the command.
The shortcuts appear immediately in the text box. If the shortcut was assigned
previously, then that function is displayed below the text box.
4. Click the Assign button to assign the shortcut.
The shortcut now appears in the Current Keys list box.
(To clear this text box, press any of the control keys, CTRL, ALT or SHIFT).

To de-assign or delete a shortcut:


1. Click the shortcut you want to delete in the Current Keys list box.
2. Click the Remove button.
3. Click the Close button to confirm.

Set accelerator for:


Currently no function.

© 2010 Altova GmbH User Manual


810 User Reference Tools Menu

Currently assigned keyboard shortcuts:

Hotkeys by key
F1 Help Menu
F3 Find Next
F5 Refresh
F7 Check well-formedness
F8 Validate
F9 Insert/Remove breakpoint
Shift+F9 Insert/Remove tracepoint
CTRL+F9 Enable/Disable breakpoint
Shift+CTRL+F9 Enable/Disable tracepoint
F10 XSL Transformation
CTRL+F10 XSL:FO Transformation
F11 Step into
CTRL+F11 Step Over
Shift + F11 Step Out
Alt+F11 Start Debugger/Go

Num + Expand
Num - Collapse
Num * Expand fully
CTRL+Num- Collapse unselected
CTRL + G Goto line/char

CTRL+TAB Switches between open documents


CTRL+F6 Cycle through open windows

Arrow keys
(up / down) Move selection bar
Esc. Abandon edits/close dialog box
Return/Space bar confirms a selection

Alt + F4 Closes XMLSpy


CTRL + F4 Closes active window
Alt + F, 1 Open last file

CTRL + Double click Display element definition


an element (Schema view)

CTRL + N File New


CTRL + O File Open
CTRL + S File Save
CTRL + P File Print

CTRL + A Select All


Shift + Del Cut (or CTRL + X)
CTRL + C Copy
CTRL + V Paste
CTRL + Z Undo
CTRL + Y Redo
Del Delete (Delete item in Schema/Grid
View)

CTRL + F Find
F3 Find Next

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 811

CTRL + H Replace

CTRL + I Append Attribute


CTRL + E In Grid View, Append Element. in Text
View, Jump to Start/End Tag when
cursor is in other member of the pair
CTRL + T Append Text
CTRL + D Append CDATA
CTRL + M Append Comment

CTRL + SHIFT +I Insert Attribute


CTRL + SHIFT +E Insert Element
CTRL + SHIFT +T Insert Text content
CTRL + SHIFT +D Insert CDATA
CTRL + SHIFT +M Insert Comment

CTRL + ALT +I Add Child Attribute


CTRL + ALT +E Add Child Element
CTRL + ALT +T Add Child Text
CTRL + ALT +D Add Child CDATA
CTRL + ALT +M Add Child Comment

Hotkeys for Text View


CTRL + "+" Zoom In
CTRL + "-" Zoom Out
CTRL + 0 Reset Zoom
CTRL + mouse wheel forward Zoom In
CTRL + mouse wheel back Zoom Out

© 2010 Altova GmbH User Manual


812 User Reference Tools Menu

Currently assigned keyboard shortcuts:

Hotkeys by function

Abandon edits Esc.


Add Child Attribute CTRL + ALT + I
Add Child CDATA CTRL + ALT + D
Add Child Comment CTRL + ALT + M
Add Child Element CTRL + ALT + E
Add Child Text CTRL + ALT + T
Append Attribute CTRL + I
Append CDATA CTRL + D
Append Comment CTRL + M
Append Element CTRL + E (Grid View)
Append Text CTRL + T
Check well-formedness F7
Closes active window CTRL + F4
Close XMLSpy Alt + F4
Collapse Num -
Collapse unselected CTRL + Num-
Confirms a selection Return / Space bar
Copy CTRL + C
Cut SHIFT + Del (or CTRL + X)
Cycle through windows CTRL + TAB and CTRL + F6
Delete item Del
Enable/Disable breakpoint CTRL + F9
Enable/Disable tracepoint Shift + CTRL + F9
Expand Num +
Expand fully Num *
File New CTRL + N
File Open CTRL + O
File Print CTRL + P
File Save CTRL + S
Find CTRL + F
Find Next F3
Goto line/char CTRL + G
Help Menu F1
Highlight other tag in pair when CTRL + E (Text View)
cursor is inside a start or end
element tag
Insert Attribute CTRL + SHIFT + I
Insert CDATA CTRL + SHIFT + D
Insert Comment CTRL + SHIFT + M
Insert Element CTRL + SHIFT + E
Insert/Remove breakpoint F9
Insert/Remove tracepoint SHIFT+F9
Insert Text content CTRL + SHIFT + T
Move selection bar Arrow keys (up / down)
Open last file Alt + F, 1
Paste CTRL + V
Redo CTRL + Y
Refresh F5
Replace CTRL + H
Select All CTRL + A
Start Debugger/Go Alt + F11

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 813

Step Into F11


Step Out Shift + F11
Step Over CTRL + F11
To view an element definition CTRL + Double click on an element.
Undo CTRL + Z
Validate F8
XSL Transformation F10
XSL:FO Transformation CTRL + F10

In the application, you can see a list of commands, together with their shortcuts and
descriptions, in the Keyboard Map dialog (Help | Keyboard Map).

Menu
The Menu tab allows you to customize the main menu bars as well as the (popup - right click)
context menus.

You can customize both the Default and XMLSpy menu bars.

The Default menu (screenshot below) is the one visible when no XML documents of any type
are open in XMLSpy.

The XMLSpy menu is the menu bar visible when at least one XML document has been opened.

To customize a menu:
1. Select the menu bar you want to customize from the Show Menus for: combo box
2. Click the Commands tab, and drag the commands to the menu bar of your choice.

To delete commands from a menu:

© 2010 Altova GmbH User Manual


814 User Reference Tools Menu

1. Click right on the command, or icon representing the command.


2. Select the Delete option from the popup menu,

or,
1. Select Tools | Customize to open the Customize dialog box.
2. Drag the command away from the menu, and drop it as soon as the check mark icon
appears below the mouse pointer.

To reset either of the menu bars:


1. Select either the Default or XMLSpy entry in the Show Menus for combo box.
2. Click the Reset button just below the menu name.
A prompt appears asking if you are sure you want to reset the menu bar.

To customize any of the Context menus (right-click menus):


1. Select the context menu from the Select context menu combo box. The context menu
you selected appears.
2. Click the Commands tab, and drag the commands to the context menu.

To delete commands from a context menu:


1. Click right on the command, or icon representing the command.
2. Select the Delete option from the popup menu

or,
1. Select Tools | Customize to open the Customize dialog box.
2. Drag the command away from the context menu, and drop it as soon as the check
mark icon appears below the mouse pointer.

To reset any of the context menus:


1. Select the context menu from the combo box, and
2. Click the Reset button just below the context menu name.
A prompt appears asking if you are sure you want to reset the context menu.

To close a context menu window:


 Click on the Close icon at the top right of the title bar
or
 Click the Close button of the Customize dialog box.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 815

Menu shadows
 Click the Menu shadows check box, if you want all your menus to have shadows.

Macros
The Macros tab allows you to place macros (created using the XML scripting environment) in a
toolbar or menu.

To place a macro (icon) into a toolbar or menu:


1. Start the scripting environment using Tools | Switch to Scripting environment.
2. Double-click the XMLSpyMacros entry in the Modules folder of the
XMLSpyGlobalScripts project.
Previously defined macros will then be visible in the right hand window.
3. Switch back to XMLSpy, and select Tools | Customize and click on the Macros tab.
The macros defined in the scripting environment are now visible in the Macros list box
at left.
4. Click the macro name and then the Add Command button. This places the macro
name in the Associated Commands list box.
5. Click the macro name in the Associated Commands list box, and drag it to any tool bar
or menu.

To edit a macro icon:


 Click the Edit Icon button.

To delete a macro from the Associated commands list box:


 Click the Remove button.

Note: If a macro has been set as an Associated Command, you can set a keyboard shortcut

© 2010 Altova GmbH User Manual


816 User Reference Tools Menu

for it. In the Keyboard tab of the Customize dialog, select Macros in the Category
combo box, then select the required macro, and set the shortcut. You should set a
macro as an associated command in order for Macros to be available for keyboard
shortcuts.

Plug-Ins
The Plug-Ins tab allows you to place plug-ins in a toolbar or menu.

To place a plug-in icon into a toolbar or menu:


1. Click the Add Plug-In... button.

2. Select the folder and then click the plug-in file to mark it (XMLSpyPlugIn.dll in this
case).

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 817

3. Click the Open button to install the plug-in.


The plug-in name appears in the "list of active plug-ins" list, and the plug-in icon(s)
appears in a new toolbar.

To remove a plug-in:
 Click the plug-in name in the "List of active plug-ins" list and click the "Remove Plug-in"
button
.

Options
The Options tab allows you to set general environment settings.

Toolbar
When active, the Show ScreenTips on toolbars check box displays a popup when the mouse
pointer is placed over an icon in any of the icon bars. The popup contains a short description of
the icon function, as well as the associated keyboard shortcut, if one has been assigned.

The Show shortcut keys in ScreenTips check box, allows you to decide if you want to have
the shortcut displayed in the tooltip.

© 2010 Altova GmbH User Manual


818 User Reference Tools Menu

When active, the Large icons check box switches between the standard size icons, and larger
versions of the icons.

Customize Context Menu


The Customize context menu allows you to further customize icons and menu items.

To open the customize context menu:


1. First open the Customize dialog by selecting Tools | Customize.
2. Then place the mouse pointer over an icon (or menu) and click right to open the
context menu.

Reset to default
Currently no function.

Copy Button image


This option copies the icon you right-click to the clipboard.

Delete
This option deletes the icon or menu you right click. Deleting a menu deletes all menu options
contained in it!

To restore a deleted menu:


1. Select the Menu tab in the Customize dialog.
2. Select the menu you want to restore (XMLSpy or Default).
3. Click the Reset button below the menu selection combo box.

Button Appearance...
This option allows you to edit the button image as well as the button text. Currently only the
macro icons can be edited (default XMLSpy icon).

The Image only, Text only and Image and text radio buttons, let you define what you want to
edit. Click the Select User-defined Image radio button and click one of the icons.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 819

Click the Edit... button, to open the Edit button image dialog box. The Button text can be edited
if you select either Text only or Image and text options.

Image
This option changes the graphical display of an icon to the text representing it.

Text
This option changes the textual description of a function to the graphical image (icon)
representing that function.

Image and Text


This option enables the simultaneous display of an icon and its text.

Start group
This option inserts a vertical divider to the left of the icon you right clicked.

© 2010 Altova GmbH User Manual


820 User Reference Tools Menu

21.16.9 Restore Toolbars and Windows


The Restore Toolbars and Windows command closes down XMLSpy and re-starts it with the
default settings. Before it closes down a dialog pops up asking for confirmation about whether
XMLSpy should be closed (screenshot below).

This command is useful if you have been resizing, moving, or hiding toolbars or windows, and
would now like to have all the toolbars and windows as they originally were.

21.16.10Options
The Tools | Options command enables you to define global application settings. These
settings are specified in a tabbed dialog box and saved in the registry. They apply to all current
and future document windows. The Apply button in the Options dialog displays the changes in
the currently open documents and fixes the current settings. The changes are seen immediately
in the background windows.

Each tab of the Options dialog is described in detail in this section.

File
The File tab defines the way XMLSpy opens and saves documents. Related settings are in the
Encoding tab.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 821

Open/New file in Grid view


You can choose to open an existing file or create a new file either in Grid View or in Text View.
If you select Grid View, you can also choose to automatically expand all lines.

Automatic reload of changed files


If you are working in a multi-user environment, or if you are working on files that are dynamically
generated on a server, you can watch for changes to files that are currently open in the
interface. Each time XMLSpy detects a change in an open document, it will prompt you about
whether you want to reload the changed file.

Validation
If you are using DTDs or schemas to define the structure of your XML documents, you can
automatically check the document for validity whenever it is opened or saved. During Open and
Save operations, you have the option of validating files only if the file-size is less than a size you
specify in MB. If the document is not valid, an error message will be displayed. If it is valid, no
message will be displayed and the operation will proceed without any notification. XMLSpy can
also cache these files in memory to save any unnecessary reloading (e.g. when the schema
being referred to is accessed through a URL). If your schema location declaration uses an URL,
disable the "cache DTD/Schema files in memory" option to have changes made to the schema
appear immediately, and not use the cached version of the schema.

Project
When you start XMLSpy, you can open the last-used project automatically.

Save File
When saving an XML document, XMLSpy includes a short comment <!-- Edited with
XMLSpy http://www.altova.com --> near the top of the file. This option can only be
deactivated by licensed users, and takes effect when editing or saving files in the Enhanced
Grid or Schema Design View.

When saving a content model diagram (using the menu option Schema design | Generate
Documentation), XMLSpy includes the XMLSpy logo. This option can only be deactivated by
licensed users.

If a StyleVision Power Stylesheet is associated with an XML file, the 'Authentic: save link to
design file' option will cause the link to the StyleVision Power Stylesheet to be saved with the
XML file.

Line breaks
When you open a file, the character coding for line breaks in it are preserved if Preserve old is
selected. Alternatively, you can choose to code line breaks in any of three codings: CR&LF (for
PC), CR (for MacOS), or LF (for Unix).

No output formatting for


In Text View, the indentation of an element can be made to reflect its position in the element
hierarchy (see Save File). You can, however, override this indentation for individual elements.
To do this, enter the element name in the No output formatting for field. All elements entered
in this field will be formatted such that their descendant elements have no whitespace between
them (see screenshots).

Hierarchical indentation for all elements:

© 2010 Altova GmbH User Manual


822 User Reference Tools Menu

No output formatting has been specified for element xs:restriction:

After making the settings, click OK to finish and close the Options dialog.

File Types
The File types tab allows you to customize the behavior of XMLSpy on a per-file-type basis.

Choose a file type from the File Types list box to customize the functions for that particular file
type:

Windows Explorer settings


You can define the file type description and MIME-compliant content type used by Windows
Explorer and whether XMLSpy is to be the default editor for documents of this file type.

Conformance
XMLSpy provides specific editing and other features for various file types. The features for a file
type are set by specifying the conformance in this option. XMLSpy lets you set file type to
conform with XML, XQuery, ZIP, JSON, and other (text) grammars. Furthermore, XML
conformance is differentiated between XML, DTD, and XML Entity file types. A large number of
file types are defined with a default conformance that is appropriate for the file type. We
recommend that you do not modify these settings unless you are adding a new file type or
deliberately wish to set a file type to another kind of conformance.

Default view
This group lets you define the default view to be used for each file type.

Grid View
This check box lets you define whether the Grid View should automatically build tables.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 823

Text View
This text box lets you set syntax-coloring for particular file types.

Disable automatic validation


This option enables you to disable automatic validation per file type. Automatic validation
typically takes place when a file is opened or saved, or when a view is changed.

Save empty elements in short <E/> format


Some applications that use XML documents or output generated from XML documents may
have problems understanding the short <Element/> form for empty elements defined in the
XML 1.0 Specification. You can instruct XMLSpy to save elements in the longer (but also valid)
<Element></Element> form.

Add new file extension


Adds a new file type to the File types list. You must then define the settings for this new file type
using the other options in this tab.

Delete selected file extension


Deletes the currently selected file type and all its associated settings.

After making the settings, click OK to finish and close the Options dialog.

Editing
The Editing tab enables you to specify editing behaviour in XMLSpy.

Intelligent editing
While editing documents, XMLSpy provides intelligent editing based on these settings. You can
also customize various aspects of the behavior of these Entry Helpers here. Such customization
varies according to the file type. For example, the option to load entry helpers on opening the
file and sorting attributes will not be applicable to DTD or XQuery documents.

Text View

© 2010 Altova GmbH User Manual


824 User Reference Tools Menu

The Auto-complete option automatically adds unambiguous structural components. For


example, when the closing angular bracket of the start tag of an element is entered, then the
end tag of that element is automatically added if this option is enabled.

In Text View, Auto-completion and entry helpers can be disabled if a file is bigger than the size
specified in the Disable Auto-completion... combo box. This is useful if you wish to speed up the
editing of large files and can do without the auto-completion feature and entry helpers. If the file
size is bigger than that specified for this option, then the Text View context menu contains a
toggle command for switching on and off Auto-completion and entry helper use. So you can
always switch these editing aids on and off at any time during editing (in the event of files having
a size greater than the size specified for this option). If the value specified for this option is
smaller than the size of the opened file, locations indicated in error messages will not correctly
correspond to the location in Text View.

Default copy to clipboard in grid view as


You can choose the format in which data will be exported to foreign applications using the
clipboard. If you select XML-Text, the contents of the clipboard will be formatted and tagged just
like the resulting XML file itself.

The structured text mode attempts to format the clipboard contents as a table, for use in a
spreadsheet or database application. This option does not affect the internal clipboard format
that XMLSpy uses for copying and pasting.

Table view
You can also control, how XMLSpy decides when to display repeating elements in the Table
View.

After making the settings, click OK to finish and close the Options dialog.

View
The View tab enables you to customize the XML documents presentation in XMLSpy.

Grid View
Collapsed elements in the Grid View can be displayed in preview form. This displays the
attributes and their values in gray in the same line as the element. You can automatically apply
the Optimal Widths command while editing, and limit the maximum cell width and height.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 825

Pretty-print
When you select Edit | Pretty-Print XML Text, the XML document will be pretty-printed with or
without indentation according to whether the Use Indentation option in this dialog is checked or
not. When the document is pretty-printed with indentation, it will be indented according to the
settings in the Tabs pane of the Text View Settings dialog. If the document is pretty-printed,
every line in the document will be displayed with zero indentation. If pretty-printing has been
switched on with the Use Indentation setting and if you change from Text View to Grid View and
back to Text View, then the document will be pretty-printed automatically.

Program logo
You can turn off the splash screen upon program startup to speed up the application.

Window title
The window title for each document window can contain either the file name only or the full path
name.

Authentic View
XML files based on a StyleVision Power Stylesheet are automatically opened in the Authentic
View when this option is active.

Browser View
You can choose to see the browser view in a separate window, enabling side-by-side placement
of the edit and browser views.

After making the settings, click OK to finish and close the Options dialog.

Grid Fonts
The Grid fonts tab allows you to customize the appearance of text in Grid View.

Font face
You can select the font face and size to be used for displaying the various items in Grid View.
The same fonts are also used for printing, so only TrueType fonts should be selected.

Size
Select the required size. If you want to use the same font size for all items, check the Use the

© 2010 Altova GmbH User Manual


826 User Reference Tools Menu

same for all check box.

Styles
The style and color can be set using the options in this pane. The current settings are
immediately reflected in the list in the left-hand pane, so you can preview the way your
document will look.

After making the settings, click OK to finish and close the Options dialog.

Schema Fonts
The Schema fonts tab enables you to customize the appearance of text in Schema View.

Font face
You can select the font face and size to be used for displaying the various items in the Schema
Design view. The same fonts are used when printing and creating schema documentation, so
only TrueType fonts should be selected. Components prefixed with "Doc." are used in the
schema documentation.

Size
Select the required size. If you want to use the same font size for all items, click on the Use The
Same For All" check box.

Styles
The style and color can be set using the options in this pane. The current settings are
immediately reflected in the list in the left pane, so you can preview the way your document will
look.

After making the settings, click OK to finish and close the Options dialog.

WSDL Fonts
The WSDL fonts tab you to customize the appearance of text in WSDL View.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 827

Font face
You can select the font face and size to be used for displaying the various items in the WSDL
Design view. The same fonts are used when printing and creating documentation, so only
TrueType fonts should be selected.

Size
Select the required size. If you want to use the same font size for all items, click on the Use The
Same For All" check box.

Styles
The style and color can be set using the options in this pane. The current settings are
immediately reflected in the list in the left pane, so you can preview the way your document will
look.

After making the settings, click OK to finish and close the Options dialog.

XBRL Fonts
The XBRL fonts tab you to customize the appearance of text in XBRL View.

© 2010 Altova GmbH User Manual


828 User Reference Tools Menu

Font face
You can select the font face and size to be used for displaying the various items in XBRL View.
The same fonts are used when printing and creating documentation, so only TrueType fonts
should be selected.

Size
Select the required size. If you want to use the same font size for all items, click on the Use The
Same For All check box.

Styles
The style and color can be set using the options in this pane. The current settings are
immediately reflected in the list in the left pane, so you can preview the way your document will
look.

After making the settings, click OK to finish and close the Options dialog.

Text Fonts
The Text fonts tab enables you to customize the appearance of text in Text View. You can
customize the appearance of of text items according to the type of text item. For example, you
can color element names and attribute names differently.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 829

The text item types are categorized into three groups:


 XML generic
 XQuery
 CSS

To customize text fonts, do the following:


1. In the combo box at top left, select the type of document for which you wish to
customize text fonts. On doing this, the text item types for that document type appear in
the box below the combo box. (In the screenshot above, XML generic has been
selected as the document type.)
2. Select the text item type you wish to customize by clicking it. (In the screenshot above,
Attribute names has been selected.)
3. Set the font properties using the options in the panes on the right-hand side. You can
select the font-family, font-size, font-style, font-color, and background-color for the text.
Additionally, you can also select a background color for the entire Text View.

Note: The same font, style, and size is used for all text item types. Only the text color and
background color can be changed for individual text types. This enables the syntax
coloring feature.

After making the settings, click OK to finish and close the Options dialog.

Colors
The Colors tab enables you to customize the background colors used in the Table View of Grid
View. In the screenshot below, the colors have been changed from the default colors by clicking
the palette icon next to each item and then selecting the preferred color.

© 2010 Altova GmbH User Manual


830 User Reference Tools Menu

Table View
The Header unselected and Header selected options refer to the column and row headers. The
screenshot below shows headers unselected; its color is as set in the dialog above.

The Header Selected color is activated when all headers are selected (screenshot below)—not
when individual headers are selected. The screenshot below shows this using the colors
defined in the dialog shown above. All headers can be selected by clicking the cell that
intersects both headers or by selecting the element created as the table—or any of its
ancestors.

Non-existent Elements
When an element or attribute does not exist in the XML document, then it can be given different
background colors when selected and unselected. This is shown in the screenshot below, in
which the first row is selected.

Please note: In addition to the colors you define here, XMLSpy uses the regular selection and
menu color preferences set in the Display Settings in the Control Panel of your Windows
installation.

After making the settings, click OK to finish and close the Options dialog.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 831

Encoding
The Encoding tab specifies options for file encodings.

Default encoding for new XML files


The default encoding for new XML files can be set by selecting an option from the dropdown
list. A new document is created with an XML declaration containing the encoding value you
specify here. If a two- or four-byte encoding is selected as the default encoding (i.e. UTF-16,
UCS-2, or UCS-4) you can also choose between little-endian and big-endian byte-ordering.

The encoding of existing XML files will be retained and can only be changed with the File |
Encoding command.

Open XML files with unknown encoding as


If the encoding of an XML file cannot be determined or if the XML document has no encoding
specification, the file will be opened with the encoding you select in this combo box.

Open non-XML files in


Existing and new non-XML files are opened with the encoding you select in this combo box. You
can change the encoding of the document by using the File | Encoding command.

BOM (Byte Order Mark)


When a document with two-byte or four-byte character encoding is saved, the document can be
saved either with (i) little-endian byte-ordering and a little-endian BOM (Always create BOM if
not UTF-8); or (ii) the detected byte-ordering and the detected BOM (Preserve detected BOM
on saving).

After making the settings, click OK to finish and close the Options dialog.

XSL
The XSL tab (screenshot below) enables you to define options for XSLT transformations and
XSL-FO transformations carried out from within the application.

© 2010 Altova GmbH User Manual


832 User Reference Tools Menu

XSLT transformations
XMLSpy contains the Altova XSLT 1.0 Engine and Altova XSLT 2.0 Engine, which you can use
for XSLT transformations. The appropriate XSLT engine (1.0 or 2.0) is used (according to the
value of the version attribute of the xsl:stylesheet or xsl:transform element). This
applies both for XSLT transformations as well as for XSLT debugging using XMLSpy's
XSLT/XQuery Debugger.

For transforming XML documents using XSLT, you could use one of the following:
 The built-in Altova XSLT Engine (comprising the Altova XSLT 1.0 Engine and the Altova
XSLT 2.0 Engine).
 The MSXML 3.0, 4.0, or 6.0 parser (which is pre-installed). If you know which version of
the MSXML parser is running on your machine, you could select it; otherwise, you
should let the application select the version automatically. (The Choose version
automatically option is active by default.) In this case, the application tries to select the
most recent available version.
 An external XSLT processor of your choice. You must specify the command line string
for the external XSLT processor. The following variables are available for building the
command line string:
%1 = XML document to process
%2 = Output file to generate
%3 = XSLT stylesheet to use (if the XML document does not contain a reference to a
stylesheet)

For example, the command to run a simple transformation with the Saxon (XSLT 1.0)
processor is:
saxon.exe -o output.xml input.xml stylesheet.xslt
parameter-name=parameter-value
To run this command from the application, select the External XSL Transformation
Program radio button, and enter the following line in the text box:
c:\saxon\saxon.exe -o %2 %1 %3 parameter-name=parameter-value

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 833

Check the respective check boxes to show the output and error messags of the
external program in the Messages Window in XMLSpy.

Note: The parameters set in XMLSpy's XSLT Input Parameters dialog are passed to the
internal Altova XSLT Engines only. They are not passed to any other XSLT Engine that
is set up as the default XSLT processor.

The Reuse output window option causes subsequent transformations to display the result
document in the same output window. If the XML file belongs to a project and Reuse output
window option is disabled, the setting only takes effect if the Save in folder output file path (
screenshot below) in the relevant project properties is also disabled.

XSL-FO transformations
FO documents are processed using an FO processor, and the path to the executable of the FO
processor must be specified in the text box for the XSL-FO transformation engine. The
transformation is carried out using the XSL/XQuery | XSL-FO Transformation menu
command. If the source file (the active document when the command is executed in the IDE) is
an XSL-FO document, the FO processor is invoked for the transformation. If the source
document is an XML document, an XSLT transformation is required to first convert the XML
document to an XSL-FO document. This XSLT transformation can be carried out either by the
XSLT engine you have specified as the default engine for the application (see above), or by the
XSLT engine that might be built into the FO processor you have specified as the default FO
processor for the application. To select between these two options, click the appropriate radio
button.

After making the settings, click OK to finish and close the Options dialog.

Scripting
The Scripting tab (screenshot below) allows you to enable the Scripting Environment on
application startup. Check the Activate Scripting check box to do this. You can then specify the
Global Scripting Project file (see screenshot below).

To set a global scripting project for XMLSpy, check the Activate Scripting check box and then
browse for the Altova Scripting Project (.asprj) file you want. You can also specify: (i) whether

© 2010 Altova GmbH User Manual


834 User Reference Tools Menu

Auto-Macros in the scripting project should be automatically executed when XMLSpy starts, and
(ii) whether application event handler scripts in the project should be automatically executed or
not; check or uncheck the respective check boxes accordingly.

Click OK when done. Macros in the Global Scripting Project will then be displayed in the
submenu of the Macros command.

Source Control
The Source Control tab (screenshot below) enables you to specify the default logon IDs for
various source control providers and to set up user preferences.

Source Control Plugin


The current source control plugin can be selected from among the item in the dropdown list of
the combo box. This list shows the installed source control plugins. After selecting the required
source control, specify the login ID for it in the next text box. The Advanced button pops up a
dialog specific to the selected source control plugin, in which you can define settings for that
source control plugin. These settings are different for different source control plugins.

User preferences
A range of user preferences is available, including the following:
 Status updates can be performed in the background after a user-defined interval of
time, or they can be switched off entirely. Very large source control databases could
consume considerable CPU and network resources. The system can be speeded up,
however, by disabling background status updates or increasing the interval between
them..
 When opening and closing projects, files can be checked out and checked in,
respectively.
 The display of the Check Out and Check In dialogs can be suppressed.
 The Reset button is enabled if you have checked/activated the Don't show this again
option in one of the dialog boxes. On clicking the Reset button, the Don't show this
again prompt is re-enabled.

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Tools Menu 835

After making the settings, click OK to finish and close the Options dialog.

© 2010 Altova GmbH User Manual


836 User Reference Window Menu

21.17 Window Menu


To organize the individual document windows in an XMLSpy session, the Window menu
contains standard commands common to most Windows applications.

You can cascade the open document windows, tile them, or arrange document icons once you
have minimized them. You can also switch the various Entry Helper windows on or off, or switch
to an open document window directly from the menu.

21.17.1 Cascade
This command rearranges all open document windows so that they are all cascaded (i.e.
staggered) on top of each other.

21.17.2 Tile Horizontally


This command rearranges all open document windows as horizontal tiles, making them all
visible at the same time.

21.17.3 Tile Vertically


This command rearranges all open document windows as vertical tiles, making them all visible
at the same time.

21.17.4 Project Window


This command lets you switch the Project Window on or off.

This is a dockable window. Dragging on its title bar detaches it from its current position and
makes it a floating window. Click right on the title bar, to allow docking or hide the window.

21.17.5 Info Window


This command lets you switch the Info Window on or off.

This is a dockable window. Dragging on its title bar detaches it from its current position and

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Window Menu 837

makes it a floating window. Click right on the title bar, to allow docking or hide the window.

21.17.6 Entry Helpers


This command lets you switch all three Entry-Helper Windows on or off.

All three Entry helpers are dockable windows. Dragging on a title bar detaches it from its current
position and makes it a floating window. Click right on the title bar to allow docking or hide the
window.

21.17.7 Output Windows


The Output Windows are a set of three tabbed outputs: (i) Validation Results; (ii) Find in Files;
and (iii) XPath Evaluation results. The initial setting is for them to open at below the Main
Window. The Output Windows command lets you switch the Output Windows on or off.

The Output Windows window is dockable. Dragging on its title bar detaches it from its current
position and makes it a floating window. Click right on the title bar to allow docking or to hide the
window.

For a complete description of Output Windows see Output Windows in the section, Text View.

21.17.8 Project and Entry Helpers


This command toggles on and off the display of the Project Window and the Entry Helpers
together.

21.17.9 All On/Off

This command lets you switch all dockable windows on, or off:
 the Project Window
 the Info Window
 the three Entry-Helper Windows

This is useful if you want to hide all non-document windows quickly, to get the maximum
viewing area for the document you are working on.

21.17.10Currently Open Window List


This list shows all currently open windows, and lets you quickly switch between them.

You can also use the Ctrl-TAB or CTRL F6 keyboard shortcuts to cycle through the open
windows.

© 2010 Altova GmbH User Manual


838 User Reference Help Menu

21.18 Help Menu


The Help menu contains all commands required to get help or more information on XMLSpy, as
well as links to information and support pages on our web server.

The Help menu also contains the Registration dialog, which lets you enter your license
key-code once you have purchased the product.

21.18.1 Table of Contents


The Help | Table of contents command displays a hierarchical representation of all chapters
and topics contained in the online help system. Use this command to jump to the table of
contents directly from within XMLSpy.

Once the help window is open, use the three tabs to toggle between the table of contents, index
, and search panes. The Favorites tab lets you bookmark certain pages within the help system.

21.18.2 Index
The Help | Index command accesses the keyword index of the Online Help. You can also use
the Index tab in the left pane of the online help system.

The index lists all relevant keywords and lets you navigate to a topic by double-clicking the
respective keyword. If more than one topic matches the selected keyword, you are presented a
list of available topics to choose from.

21.18.3 Search
The Help | Search command performs a full-text search on the entire online help system.

1. Enter your search term in the query field and press Enter.
The online help system displays a list of available topics that contain the search term

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Help Menu 839

you've entered.
2. Double-click on any item in the list to display the corresponding topic.

21.18.4 Keyboard Map


The Help | Keyboard Map... command causes an information box to be displayed that contains
a menu-by-menu listing of all commands in XMLSpy. Menu commands are listed with a
description and shortcut keystrokes for the command.

To view commands in a particular menu, select the menu name in the Category combo box.
You can print the command by clicking the printer icon.

You should note the following points about shortcuts:


 Certain commands (and their shortcuts) are applicable only within a certain view. For
example, most of the commands in the XML menu are applicable only in Grid View.
Other commands (such as File | Save or XML | Check Well-Formedness) are
available in multiple views.
 Other cool shortcuts: For example, Shift+F10 brings up the context menu in Text View
and Schema View; Ctrl+E when the cursor is inside an element start or end tag in Text
View moves the cursor to the end or start tag, respectively.
 In the Keyboard tab of the Customize dialog, you can also set your own shortcuts for
various menu commands.

21.18.5 Activation, Order Form, Registration, Updates


Software Activation
After you download your Altova product software, you can activate it using either a free
evaluation key or a purchased permanent license key.

© 2010 Altova GmbH User Manual


840 User Reference Help Menu

 Free evaluation key. When you first start the software after downloading and installing
it, the Software Activation dialog will pop up. In it is a button to request a free evaluation
key-code. Enter your name, company, and e-mail address in the dialog that appears,
and click Request Now! The evaluation key is sent to the e-mail address you entered
and should reach you in a few minutes. Now enter the key in the key-code field of the
Software Activation dialog box and click OK to start working with your Altova product.
The software will be unlocked for a period of 30 days.
 Permanent license key. The Software Activation dialog contains a button to purchase
a permanent license key. Clicking this button takes you to Altova's online shop, where
you can purchase a permanent license key for your product. There are two types of
permanent license: single-user and multi-user. Both will be sent to you by e-mail. A
single-user license contains your license-data and includes your name, company,
e-mail, and key-code.A multi-user license contains your license-data and includes your
company name and key-code. Note that your license agreement does not allow you to
install more than the licensed number of copies of your Altova software on the
computers in your organization (per-seat license). Please make sure that you enter the
data required in the registration dialog exactly as given in your license e-mail.

Note: When you enter your license information in the Software Activation dialog, ensure that
you enter the data exactly as given in your license e-mail. For multi-user licenses, each
user should enter his or her own name in the Name field.

The Software Activation dialog can be accessed at any time by clicking the Help | Software
Activation command.

Order Form
When you are ready to order a licensed version of the software product, you can use either the
Order license key button in the Software Activation dialog (see previous section) or the Help |
Order Form command to proceed to the secure Altova Online Shop.

Registration
The first time you start your Altova software after having activated it, a dialog appears asking
whether you would like to register your product. There are three buttons in this dialog:
 OK: Takes you to the Registration Form
 Remind Me Later: Pops up a dialog in which you can select when you wish to be next
reminded.
 Cancel: Closes the dialog and suppresses it in future. If you wish to register at a later
time, you can use the Help | Registration command.

Check for Updates


Checks with the Altova server whether a newer version than yours is currently available and
displays a message accordingly.

21.18.6 Support Center, FAQ, Downloads


Support Center
If you have any questions regarding our product, please feel free to use this command to send a
query to the Altova Support Center at any time. This is the place where you'll find links to the
FAQ, support form, and e-mail addresses for contacting our support staff directly.

FAQ

Altova XMLSpy 2011 © 2010 Altova GmbH


User Reference Help Menu 841

To help you in getting the best support possible, we are providing a list of Frequently Asked
Questions (FAQ) on the Internet, that is constantly updated as our support staff encounters new
issues that are raised by our customers.

Please make sure to check the FAQ before contacting our technical support team. This will
allow you to get help more quickly.

We regret that we are not able to offer technical support by phone at this time, but our support
staff will typically answer your e-mail requests within one business day.

If you would like to make a feature suggestion for a future version of XMLSpy or if you wish to
send us any other general feedback, please use the questionnaire form.

Download components and free tools


This command is a link to the Components Download page at the Altova website, from where
you can download components, free tools, and third-party add-ins that you can use in your XML
development environment. Included among these are the Altova Validator, and XSLT and
XQuery engines.

21.18.7 On the Internet


On the Internet
This command takes you directly to the Altova web-server http://www.altova.com where you can
find out about news, product updates and additional offers from the Altova team.

Training
The Training command takes you to the Online Training page on the Altova website. Here you
can enroll for online courses to help you develop expertise in using Altova products.

21.18.8 About
This command shows the XMLSpy splash screen and copyright information dialog box, which
includes the XMLSpy logo. If you are using the 64-bit version of XMLSpy, this is indicated with
the suffix (x64) after the application name. There is no suffix for the 32-bit version.

Please note:
This dialog box shows the version number - to find the number of the actual build you are using,
please look at the status bar, which always includes the full version and build number.

© 2010 Altova GmbH User Manual


Altova XMLSpy 2011

Programmers' Reference
844

Programmers' Reference

XMLSpy as an Automation Server


XMLSpy is an Automation Server. That is, it is an application that exposes programmable
objects to other applications (called Automation Clients). As a result, an Automation Client can
directly access the objects and functionality that the Automation Server makes available. This is
beneficial to an Automation Client because it can make use of the functionality of XMLSpy. For
example, an Automation Client can use the XML validation functionality of XMLSpy. Developers
can therefore improve their applications by using the ready-made functionality of XMLSpy.

The programmable objects of XMLSpy are made available to Automation Clients via the
XMLSpy API, which is a COM API. The object model of the API and a complete description of
all available objects are provided in this documentation (see the section XMLSpyAPI). The API
can also be used with a Java implementation. A description of how this can be done is given in
the chapter Using the XMLSpy API with Java.

Customizing XMLSpy, and modifying functionality


You can customize your installation of XMLSpy by modifying and adding functionality to it. You
can also create Forms for user input and modify the user interface so that it contains new menu
commands and toolbar shortcuts. All these features are achieved by writing scripts that interact
with objects of the XMLSpy API. To aid you in carrying out these tasks efficiently, XMLSpy
offers you an in-built Scripting Environment. A complete description of the functionality available
in the Scripting Environment and how the environment is to be used is given in the Scripting
section of this documentation.

Additionally, you can manipulate XMLSpy with external scripts. For example, you could write a
script to open XMLSpy at a given time, then open an XML file in XMLSpy, validate the file, and
print it out. These external scripts would again make use of the XMLSpy API to carry out these
tasks. For a description of the XMLSpy API, see the section XMLSpyAPI.

Creating plug-ins for XMLSpy


XMLSpy enables you to create your own plug-ins and integrate them into XMLSpy. You can do
this using XMLSpy's special interface for plug-ins. A description of how to create plug-ins is
given in the section XMLSpy Plug-ins.

About Programmers' Reference


The documentation contained in the Programmers' Reference for XMLSpy consists of the
following sections:
 Release Notes, which lists changes since the previous version
 Scripting: a user reference for the Scripting Environment available in XMLSpy
 XMLSpy Plug-ins: a description of how to create plug-ins for XMLSpy
 XMLSpy API: a reference for the XMLSpy API
 Using XMLSpy API with Java: a reference for using the XMLSpy API with Java
 XMLSpy Integration: a guide and reference for how to integrate the XMLSpy GUI and
functionality.

Altova XMLSpy 2011 © 2010 Altova GmbH


Release Notes 845

1 Release Notes
For each release of the XMLSpy API, important changes since the previous release are listed
below.

Automation Interface for XMLSpy 2007: type library version 1.6


Changes since the previous release are as follows:
 The Document interface has the method GenerateDTDOrSchemaEx to automatically
generate a DTD or schema for the current XML document
 The GenerateSampleXMLDlg interface has the following additional properties:
FillAttributesWithSampleData, FillElementsWithSampleData,
ContentOfNillableElementsIsNonMandatory, TryToUseNonAbstractTypes,
Optimization, SchemaOrDTDAssignment, LocalNameOfRootElement,
NamespaceURIOfRootElement, OptionsDialogAction.
 The following properties of the GenerateSampleXMLDlg interface are obsolete and are
no longer supported: NonMandatoryElements - obsolete, TakeFirstChoice -
obsolete, FillWithSampleData - obsolete.
 The following enumerations are new: SPYAttributeTypeDefinition,
SPYSampleXMLGenerationOptimization,
SPYSampleXMLGenerationSchemaOrDTDAssignment.

Automation Interface for XMLSpy 2006sp2: type library version 1.5


Changes since XMLSpy API ver 2006:
 The CodeGeneratorDlg interface now has the properties: CompatibilityMode,
CPPSettings_GenerateVC6ProjectFile,
CPPSettings_GenerateVSProjectFile. These properties generate project files
for Visual Studio 2005.

Automation Interface for XMLSpy 2006: type library version 1.5


Important changes since the previous release (XMLSpy API 2004R4) are as follows:
 The Application interface has the following methods: ReloadSettings,
RunMacro, ScriptingEnvironment.
 The Document interface has the following additional methods: GenerateSampleXML,
SetExternalIsValid, UpdateXMLData.
 The Document interface has the additional event: OnBeforeValidate.
 The XMLData interface has the following additional declarations: CountChildren,
CountChildrenKind, HasChildrenKind, GetChild, GetChildKind.
 A new interface GenerateSampleXMLDlg has been added.

Automation Interface for XMLSpy 2004R4: type library version 1.4


Important changes since the previous release (XMLSpy API 2004R3) are as follows:
Authentic View
 AuthenticView, AuthenticRange and AuthenticDataTransfer interfaces
replace DocEdit, DocEditSelection and DocEditDataTransfer.
 The AuthenticView and AuthenticRange interfaces now supersede the old
DocEdit interface.
 The DocEdit interfaces have been renamed OldAuthentic and are now obsolete.

© 2010 Altova GmbH Programmers' Reference


846 Release Notes

 The DocEditSelection interface has been renamed AuthenticSelection and is


now obsolete.
 The DocEditDataTransfer interface has been renamed
AuthenticDataTransfer.
 The functionality of now obsolete interfaces are still available. However, usage of the
new interfaces is strongly recommended.

Improved events
All events are available as connection point events to allow for easy and flexible integration
of external clients using VBA, C++, VBScript, JScript or Perl. New events supporting the
document life cycle have been added. All events pass event context information as
parameters. Many events support cancellation of the signaled operation. See the section
Overview of Events for more details.

Extension of Document interface


 Supports generation of program code (C++, C# and Java) for schema definitions
 Supports generation of MSWord and HTML documentation for schema definitions
 Supports XSL-FO transformation
 Extension of standard properties for documents
 Direct access to data root element of XML documents

Data import and export


 Choice of database for database import.
 Import of hierarchical data, which was previously done using a hand-written SHAPE
statement with ImportFromDatabase, now requires a schema file and the use of
ImportFromSchema.

Automation Interface for XMLSpy 2004R3 - type library version 1.3


Important changes since XMLSpy API ver 5 rel 4:
Authentic View
 Completely new interfaces AuthenticView and AuthenticRange to work with
Authentic View.

Altova XMLSpy 2011 © 2010 Altova GmbH


Scripting 847

2 Scripting
The Scripting Editor of XMLSpy uses the Form Editor components of the Microsoft .NET
Framework, and thus provides access to the Microsoft .NET Framework. This means that
JScripts and VBScripts not only work with the XMLSpy API—which is a COM API and the API
of XMLSpy—but can also access and use classes of the Microsoft .NET framework.

You can therefore create and use your own macros and forms within XMLSpy, and thus add to
and modify the functionality of your installation of XMLSpy.

Note: Microsoft's .NET Framework 2.0 or higher is a system prerequisite for Scripting Editor,
and it must be installed before XMLSpy is installed.

The Scripting Editor


The Scripting Editor (screenshot below) opens in a separate window and is accessed via the
Tools | Scripting Editor menu command in the XMLSpy GUI. The programming languages
that can be used in the Scripting Environment are JScript and VBScript. The scripting
language can be changed by right-clicking the Project item in the Project window, selecting
Scripting Language, and selecting the language you want.

What you can do with the Scripting Editor


In the Scripting Editor, you can create Forms, Event Handlers, and Macros to build up a
Scripting Project. A Scripting Project can then be set as the Global Scripting Project for XMLSpy
, thus enabling scripts in the Scripting Project to be used in the application. Additionally, different
Scripting Projects can be assigned to different XMLSpy projects, thus allowing different scripts
to be used for different XMLSpy projects.

© 2010 Altova GmbH Programmers' Reference


848 Scripting

Documentation about the Scripting Editor


The documentation describing the Scripting Environment (this section) is organized into the
following parts:
 An overview, which provides a high level description of the Scripting Editor and
Scripting Projects.
 A list of steps required to create a Scripting Project.
 An explanation of Global Declarations, together with an example.
 A description of how to create Forms.
 A discussion of XMLSpy-specific event handlers.
 An explanation of how to use macros in the Scripting Editor and in XMLSpy.

Altova XMLSpy 2011 © 2010 Altova GmbH


Scripting Overview 849

2.1 Overview
The Scripting Editor provides an interface in which you can: (i) graphically design Forms while
assigning scripts for components in the Form; (ii) create Event Handlers, and (iii) create
Macros.

These Forms, Event Handlers, and Macros are organized into scripting projects, which are then
assigned to XMLSpy application projects and can be used in the application.

Variables and functions can be defined in a Global Declarations script, which is always
executed before Macro or Event Handler scripts.

This section gives an overview of the Scripting Editor and Scripting Projects. It is organized into
the following sections:
 Scripting Projects in XMLSpy, which describes how the scripting projects you create
with the Scripting Editor will be used in XMLSpy.
 The Scripting Editor GUI, which provides a detailed look at the different parts of the
Scripting Editor GUI and how they are to be used.
 Components of a Scripting Project, which explains the different components that go to
make up a scripting project.

The details about the creation of the various components (Global Declarations, Forms, Event
Handlers, and Macros) are described in their respective sections.

2.1.1 Scripting Projects in XMLSpy


All scripts and scripting information created in the Scripting Editor are stored in Altova
Scripting Projects (.asprj files).

You can create any number of Altova Scripting Projects. After a scripting project has been
created, it can be used in the following ways:
 It can be set as the global scripting project for XMLSpy. Scripts in the global scripting
project can then be called from within the application, and macros of the Global
Scripting Project can be used for all XMLSpy projects.
 It can be assigned to an XMLSpy project (as an application project). When an XMLSpy
project is open in XMLSpy, scripts in the associated scripting project can be called.

Your XMLSpy package contains a sample scripting project called SampleScripts.asprj. This
file is located in the folder: C:\Documents and Settings\<username>\My
Documents\Altova\XMLSpy2011\Examples\ and contains global declarations for a few
standard tasks.

Setting the global scripting project of an application


The global scripting project of an application is set in the Scripting tab of the Options dialog of
XMLSpy (screenshot below, Tools | Options).

© 2010 Altova GmbH Programmers' Reference


850 Scripting Overview

To set a global scripting project for XMLSpy, check the Activate Scripting check box and then
browse for the Altova Scripting Project (.asprj) file you want. You can also specify: (i) whether
Auto-Macros in the scripting project should be automatically executed when XMLSpy starts, and
(ii) whether application event handler scripts in the project should be automatically executed or
not; check or uncheck the respective check boxes accordingly.

Please note:
Nested script execution is possible, i.e. Macros can call other macros, and events are received
during macro, or event, execution.

Assigning a scripting project to an XMLSpy project


A scripting project is assigned to an XMLSpy project as follows:
1. In the XMLSpy GUI, open the required application project.
2. Select the menu command Project | Script Settings. The Scripting dialog (screenshot
below) opens.

3. Check the Activate Project Scripts check box and select the required scripting project (
.asprj file). If you wish to run Auto-Macros when the XMLSpy project is loaded, check
the Run Auto-Macros check box.
4. Click OK to finish.

Note: To deactivate (that is, unassign) the scripting project of an XMLSpy project, uncheck
the Activate Project Scripts check box.

Altova XMLSpy 2011 © 2010 Altova GmbH


Scripting Overview 851

2.1.2 The Scripting Editor GUI


The Scripting Editor GUI is shown below. It has the following parts:
 A toolbar
 A Scripting Project Tree pane (top left-hand side)
 A Properties and Events pane (bottom left)
 A Main Window with Design and Source tabs
 A Form Object Palette (right-hand side)

Scripting Editor toolbar


The Scripting Editor toolbar contains icons for:
 Standard file commands such as New, Open, Save, and Print. These commands are
used to create new scripting projects, open existing scripting projects, and save and
print scripting projects.
 Standard editing commands such as Copy, Paste, Undo, Redo, Find, and Replace.
Note that the Find and Replace commands are applied to code in the Source tab of the
Scripting Editor.

Scripting Project Tree


The Scripting Project Tree (screenshot below) shows the various components of the scripting
project, structured along four main branches: (i) Global Declarations, (ii) Forms, (iii) Events, and
(iv) Macros.

© 2010 Altova GmbH Programmers' Reference


852 Scripting Overview

The Scripting Project Tree provides access to each component of the scripting project. For
example, in order to display and edit a particular Form, expand the Forms folder in the tree (see
screenshot above), right-click the Form you wish to display or edit, and click Open from the
context menu that pops up.

A quicker way to open a Form, Event, macro, or the Global Declarations script, is to double-
click the respective icon, or text. To delete a Form or Macro from the scripting project, right-click
the component and select the Delete command from the context menu.

The Scripting Project Tree pane contains a toolbar with icons (screenshot below).

The icons, from left to right, are for: (i) creating a new macro, (ii) creating a new form, (iii)
running a macro, and (iv) debugging a macro. These commands are also available in the
context menu that appears when you right-click any component in the Scripting Project Tree.

Properties and Events


The Properties and Events pane (screenshot below) displays the following:
 Form properties, when the Form is selected
 Object properties, when an object in a Form is selected. (The screenshot below shows,
at left, the properties of the object selected in the Form at right.)
 Form events, when a Form is selected
 Object events, when an object in a Form is selected

To switch between the properties and events of the selected component, click, respectively, the
Properties icon (third from left in the Properties and Events toolbar, see screenshot above) and
the Events icon (fourth from left).

Altova XMLSpy 2011 © 2010 Altova GmbH


Scripting Overview 853

The first and second icons from left in the toolbar are, respectively, the Categorized and
Alphabetical icons. These display the properties or events either organized by category or
organized in ascending alphabetical order.

When a property or event is selected, a short description of it is displayed at the bottom of the
Properties and Events pane.

Main Window
The Main Window displays one component at a time and has one or two tabs depending on
what is being displayed. If a Global Declarations script, an Event, or a Macro is being displayed,
then a single tab, the Source tab, displays the source code of the selected component.

The Source tab supports:


 syntax coloring
 source code folding
 setting/deleting bookmarks using CTRL+F2
 autocompletion entry helper with parameter info
 Goto Brace, Goto Brace Extend
 Zoom In / Zoom Out
 full method/property signature shown next to the autocompletion entry helper
 brace highlighting during code entry

 mouse over popups; placing the mouse over a known method or property, displays its
signature (and documentation if available)

If a Form is being displayed, then the Main Window has two tabs: a Design tab showing and
enabling the layout of the Form, and a Source tab containing the source code for the Form.
Content in both the Design tab and Source tab can be edited.

Note: Since JScript and VB Script are untyped languages, entry helpers and auto-completion
is supported only in cases of "fully qualified constructs" and "predefined" names.

If names start with objDocument, objProject, objXMLData, or objAuthenticRange,


members of the corresponding interface will be shown. Auto-completion entry helper
and parameter info are shown during editing, but can also be obtained on demand by
pressing Ctrl+Space.

Form Object Palette


The Form Object Palette contains all the objects that are available for designing Forms and
looks something like the screenshot below. Registered ActiveX controls can be added to the
Form Object Palette by right-clicking the pane and selecting the Add ActiveX Control
command

© 2010 Altova GmbH Programmers' Reference


854 Scripting Overview

To insert an object from the Form Object Palette click the object you want in the palette, then
click at the location in the Form where you wish to insert the object. The object will be placed at
this location. In many cases you will need to supply some properties of the object via the
Properties and Events pane. You can drag the object to other locations as well as resize it.
Further, a number of editing commands, such as centering and stacking objects, can be
accessed via the context menu of the selected Form object.

Some Form objects, such as Timer, are not added to the Form but are created as Tray
Components in a tray at the bottom of the Main Window. You can select the object in the tray
and set properties and event handlers for the object via the Properties and Events pane. For an
example of how Tray Components are handled, see Form usage and commands.

2.1.3 Components of a Scripting Project


An Altova Scripting Project consists of the following four major components:
 Global Declarations, a component which contains definitions of variables and functions
that are available to, and can be used by, all Forms, Macros, and Event Handler scripts
in the scripting project.
 Forms, a component which contains all the Forms defined in the scripting project.
 Events, a component which contains Event Handler scripts for all application-based—
as opposed to Form-based—events.
 Macros, a component which contains all the Macros defined in the scripting project.

These components are displayed in and accessed via the Scripting Project Tree of the Scripting
Editor (screenshot below).

Altova XMLSpy 2011 © 2010 Altova GmbH


Scripting Overview 855

Given below is a brief description of each of these components.

Global Declarations
The Global Declarations component is a script that contains variables and functions that can be
used by Forms, Event Handlers, and Macros. The functions make use of the XMLSpy API to
access XMLSpy functionality. Creating a variable or function in the Global Declarations module
enables it to be accessed from all the Forms, Event Handlers and Macros in the scripting
project.

To add a variable or function, open the Global Declarations component (by right-clicking it in the
Scripting Project Tree and selecting Open) and edit the Global Declarations script in the Main
Window. In this script, add the required variable or function.

Forms
In the Scripting Editor, you can build a Form graphically using a palette of Form objects such as
text input fields and buttons. For example, you can create a Form to accept the input of an
element name and to then remove all occurrences of that element from the active XML
document.

For such a Form, a function script can be associated with a text box so as to take an input
variable, and an Event Handler can be associated with a button to start execution of the delete
functionality, which is available in the XMLSpy API. A Form is invoked by a call to it either within
a function (in the Global Declarations script) or directly in a Macro. For details of how to create
and edit Forms, see the Forms section.

Event handling
Event Handler scripts can be associated with a variety of available events. You can control
events that occur both within Forms (Form events) and within the general application interface (
application events). The script associated with an event is executed immediately upon the
triggering of that event.

Most events have parameters which provide detailed information about the event. The return
value from the script typically instructs the application about how to continue its processing (for
example, the application may not allow editing).

An Event Handler runs when the relevant event occurs in the Form or in XMLSpy. For details
about how to create event handlers, see Event Handlers.

Macros
Macros are used to implement complex or repetitive tasks. Macros do not use either
parameters or return values.

In a Macro, it is possible to access all variables and functions declared in the Global
Declarations and to display Forms for user input.

For a simple example of creating a Macro, see Writing a Macro. Also see Running Macros for a
description of the ways in which a Macro can be called. A Macro is run from within the XMLSpy
interface by clicking Tools | Macros | [MacroName].

© 2010 Altova GmbH Programmers' Reference


856 Scripting Creating a Scripting Project

2.2 Creating a Scripting Project


The broad steps for creating a Scripting Project are as follows:
1. Open the Scripting Editor by clicking the command Tools | Scripting Editor.
2. In the Scripting Editor, open a new scripting project by clicking the New icon in the
Scripting Editor toolbar. The Scripting Language dialog (screenshot below) pops up.

Select either JScript or VBScript in the combo box and click OK. The new Scripting
Project is created.
3. Click the Save icon in the Scripting Editor toolbar to save the Scripting Project as a .
asprj file.
4. A Scripting Project can be considered to be made up of several components that work
together. These components will typically be a combination of: Global Declarations,
Forms, Events, and Macros. They can be created in any order, but you should clearly
understand how they work together. The way each type of component is called and
executed is described below. How to create each type of component is described in the
respective sections about the component type.
5. After you have finished creating all the required components, save the Scripting Project
(by clicking the Save icon in the Scripting Editor toolbar).
6. Close the Scripting Editor.

Please note:
Right clicking the Project folder and selecting "Scripting Language..." lets you change
the scripting language at any time.

How Forms, Event Handlers, and Macros are called and executed
Forms, Event Handlers, and Macros are all created in the Scripting Editor. However, the way
they are called and executed is different for each and has a bearing on how you create your
scripting projects.
 A Form is invoked by a call to it either within a function in the Global Declarations script
or directly in a Macro.
 An Event Handler runs when the relevant event occurs in XMLSpy. If an Event Handler
for a single event is defined in both the Global Scripting Project and the XMLSpy
-project-specific Scripting Project, then the event handler for the project-specific
Scripting Project is executed first and that for the Global Scripting Project immediately
afterwards.
 A Macro is executed from within the XMLSpy interface by clicking Tools | Macros |
[MacroName]. In a Macro, it is possible to access all variables and functions declared
in the Global Declarations and to display Forms for user input.

Altova XMLSpy 2011 © 2010 Altova GmbH


Scripting Global Declarations 857

2.3 Global Declarations


The Global Declarations component is present by default in every Scripting Project (see
screenshot below), and therefore does not have to be created. In order to add variables and
functions to the Global Declarations script of a Scripting Project, you need to open the Global
Declarations script and add the code fragment to the Global Declarations script.

To open the Global Declarations script of a Scripting Project, right-click the Global Declarations
item in the Scripting Project Tree (screenshot above), and select Open. The Global
Declarations script opens in the Main Window.

Given below is an example function. Remember that creating a variable or function in the Global
Declarations script makes this variable or function accessible to all Forms, Event Handlers, and
Macros.

Example function
A function called RemoveAllNamespaces would have code like this:
function RemoveAllNamespaces(objXMLData)
{
if(objXMLData == null)
return;

if(objXMLData.HasChildren) {
var objChild;

// spyXMLDataElement := 4
objChild = objXMLData.GetFirstChild(4);

while(objChild) {
RemoveAllNamespaces(objChild);

try {
var nPos,txtName;
txtName = objChild.Name;

if((nPos = txtName.indexOf(":")) >= 0) {


objChild.Name = txtName.substring(nPos+1);
}

objChild = objXMLData.GetNextChild();
}
catch(Err) {
objChild = null;
}
}
}
}

© 2010 Altova GmbH Programmers' Reference


858 Scripting Global Declarations

Note:
 It is possible to define local variables and helper functions within macros and event
handlers. Example:
//return value: true allows editing
//return value: false disallows editing
var txtLocal;
function Helper()
{
txtMessage = txtLocal;
Application.ShowForm("MsgBox");
}
function On_BeforeStartEditing(objXMLData)
{
txtLocal = "On_BeforeStartEditing()";
Helper();
}
 Recursive functions are supported.

Altova XMLSpy 2011 © 2010 Altova GmbH


Scripting Forms 859

2.4 Forms
Creating and editing Forms in the Scripting Editor consists of the following steps:
1. Creating a New Form. The new Form is created and named, and has properties defined
for it.
2. Designing the Form. A Form is designed by adding Form Objects to it and assigning
values for the different Form Objects.
3. Scripting Form Events. Scripts are assigned to Form-related events.

2.4.1 Creating a New Form


Creating a new Form in the Scripting Editor involves the following steps:
1. Creating a new Form and naming it
2. Specifying the properties of the Form

Creating a new Form and naming it


To add a new Form to a scripting project, click the Add Form icon (highlighted in screenshot
below) in the toolbar of the Project Overview pane. Enter the name of the new Form.

A new Form is added to the project. It appears in the Main Window and an entry for it is created
in the Scripting Project Tree pane, under the Forms heading. Press the F2 function key to
rename the form, or right click the form name and select Rename from the context menu. In the
screenshot below, we have named the new Form Registration.

Form properties
The properties of the Form, such as its size, background color, and font properties, can be set
in the Properties pane. The screenshot below shows the size and background-color property
values in bold, in the Layout and Appearance categories, respectively.

© 2010 Altova GmbH Programmers' Reference


860 Scripting Forms

2.4.2 Form Design and Form Objects


Designing a Form consists of the following steps:
 Placing an object from the Form Object Palette in the Form design.
 Assigning values for the properties of individual Form Objects.
 Assigning scripts for Form-based events.

The Form Object Palette


The Form Object Palette contains all the objects that are available for designing Forms and
looks something like the screenshot below. Registered ActiveX controls can be added to the
Form Object Palette by right-clicking the pane and selecting the Add ActiveX Control
command

Altova XMLSpy 2011 © 2010 Altova GmbH


Scripting Forms 861

To insert an object from the Form Object Palette click the object you want in the palette, then
click at the location in the Form where you wish to insert the object. The object will be placed at
this location. In many cases you will need to supply some properties of the object via the
Properties and Events pane. You can drag the object to other locations as well as resize it.
Further, a number of editing commands, such as centering and stacking objects, can be
accessed via the context menu of the selected Form object.

Some Form objects, such as Timer, are not added to the Form but are created as Tray
Components in a tray at the bottom of the Main Window. You can select the object in the tray
and set properties and event handlers for the object via the Properties and Events pane. For an
example of how Tray Components are handled, see Form usage and commands.

Some of the most commonly used objects are described below:

Label: Adds text fields such as captions or field descriptions.

Button:Adds a button. It is possible to assign bitmaps as background images for these


buttons.

Check Box: Adds a check box, which enables Yes/No type selections.

Combo Box: Adds a combo box, which allows the user to select an option from a
drop-down menu.

List Box: Adds a list box, which displays a list of items for selection.

TextBox: Enables the user to enter a single line of text.

Rich TextBox: Enables the user to enter multiple lines of text.

Creating objects and setting their properties

© 2010 Altova GmbH Programmers' Reference


862 Scripting Forms

To create an object in the Form, first select the required object in the Form Object Palette and
then click the location in the Form where you want to insert it. After the object has been
inserted, you can resize it as well as drag it to another location in the Form.

When an object is selected in the design, you can specify its properties in the Properties and
Events pane. In the toolbar of the Properties and Events pane, click the Properties icon to
display a list of the object's properties.

For example, in the screenshot below, the Label object with the text Start Date has been
selected in the design. In the Properties and Events pane, the name of the object (which is the
name that is to be used to identify the object in code, Label1 in the screenshot below) is given
in the Design category of properties; in this case, the name of the object is Label1.

The text of the label (which is what appears in the Form) must be entered as the value of the
Text property in the Appearance category of properties.

To assign other object properties, enter values for them in the Properties and Events pane.

2.4.3 Form Events


When an object is selected in the design, clicking on the Events icon in the toolbar of the
Properties and Events pane (fourth icon from left), displays all the events available for that
object (see screenshot below). These can be displayed either by category (screenshot below)
or alphabetically.

Altova XMLSpy 2011 © 2010 Altova GmbH


Scripting Forms 863

For each event, you can enter the name of an existing event handler or function. Alternatively:
 you can double click on an event to create: (i) an empty function script in the Source tab
of the Main Window, and (ii) an association of the newly created function with the
selected event.
 double click a button in the design tab, to directly generate the handler stub in the code
window.

The screenshot below was taken after the Click event was double-clicked. Notice that an empty
event handler function called FormExample_Label1_Click has been created in the Main
Window and that, in the Properties and Events pane, this function has been associated with the
Click event.

Enter the required scripting code and save the project.

Writing the required scripts


After the visual design of the form is complete, form objects will typically be associated with
suitable scripts. The example below is a script that adds colors when a button is clicked. The
script is inserted as an event handler for the Click event of the button Button1 (the event is
available in the Properties and Events pane when the button is selected in the design):

function FormExample_Button1_Click( objSender, e_EventArgs )


{     
       // Sets the ForeColor (red) of the button.
       objSender.ForeColor = CLR.Static( "System.Drawing.Color" ).Red;
       // Sets the BackColor (blue) of the button.

© 2010 Altova GmbH Programmers' Reference


864 Scripting Forms

       objSender.BackColor = CLR.Static( "System.Drawing.Color" ).Blue;


       // Sets the form BackColor (green).
       objSender.FindForm().BackColor = CLR.Static( "System.Drawing.Color"
).Green;
}

Altova XMLSpy 2011 © 2010 Altova GmbH


Scripting Events 865

2.5 Events
The Events folder of the scripting project (see screenshot below) contains folders for the
following type of events:
 Application Events
 Document Events
 Authentic View Events
 Grid View Events
 Text View Events

Note that these events are XMLSpy-specific, as opposed to Form-based events. Each of the
folders listed above contains a set of events for which Event Handler scripts can be written.

Application Events, for example, are shown in the screenshot below.

To access the event handler script of any of these events, right-click the event and select Open
from the context menu. The script will be displayed in the Main Window (see screenshot below)
and can be edited there. After you have finished editing the script, save changes by clicking the
Save command in the toolbar of the Scripting Editor.

Note the following points:


 Event Handlers need function headers with the correct spelling of the event name.
Otherwise the Event Handler will not be called.
 It is possible to define local variables and helper functions within Macros and Event
Handlers. Example:
//return value: true allows editing
//return value: false disallows editing
var txtLocal;
function Helper()
{
txtMessage = txtLocal;
Application.ShowForm("MsgBox");
}
function On_BeforeStartEditing(objXMLData)
{
txtLocal = "On_BeforeStartEditing()";

© 2010 Altova GmbH Programmers' Reference


866 Scripting Events

Helper();
}
 While a macro is executed, Event Handlers from XMLSpy are not processed.
 In order for events to be processed, the Process Events options must be toggled on in
the Scriptings options of XMLSpy. See Scripting Projects in XMLSpy for details.
 Also see Programming Points.

Application Events

OnInitialize
The OnInitialize event is raised after the main window becomes visible but before any
project is loaded. This event is not raised if the application can't be loaded at all.

OnRunning
If the application is completely loaded and after the OnInitialize event occurs, the OnRunning
event is raised.

OnShutdown
The event is raised after any open project and all documents have been closed on shutdown of
the application. The main window is no longer visible.

Example
The following script is an Event Handler for the On_BeforeOpenProject event. It allows you to
add a script that will be executed each time before XMLSpy opens a project. The example script
below sequentially opens all XML files located in the XML folder of the project and validates
them. If the validation fails, the script shows the validation error and stops. If a file passes the
validity test, it will be closed and the next file will be opened.

Enter the following script for the On_BeforeOpenProject() event, and then save the scripting
project.

function On_BeforeOpenProject()
{
var bOK;
var nIndex,nCount;
var objItems,objXMLFolder = null;

objItems = Application.CurrentProject.RootItems;
nCount = objItems.Count;

// search for XML folder


for(nIndex = 1;nIndex <= nCount;nIndex++) {
var txtExtensions;
txtExtensions = objItems.Item(nIndex).FileExtensions;

if(txtExtensions.indexOf("xml") >= 0) {
objXMLFolder = objItems.Item(nIndex);
break;
}
}

// does XML folder exist?


if(objXMLFolder) {
var objChild,objDoc;

nCount = objXMLFolder.ChildItems.Count;

// step through associated xml files


for(nIndex = 1;nIndex <= nCount;nIndex++) {

Altova XMLSpy 2011 © 2010 Altova GmbH


Scripting Events 867

objChild = objXMLFolder.ChildItems.Item(nIndex);

try {
objDoc = objChild.Open();

// use JScript method to access out-parameters


var strError = new Array(1);
var nErrorPos = new Array(1);
var objBadData = new Array(1);

bOK = objDoc.IsValid(strError,nErrorPos,objBadData);

if(!bOK) {
// if the validation fails, we should display the
// message from XMLSpy
// of course we have to create the form "MsgBox" and
// define the global txtMessage variable
//
// txtMessage = Position:" + nErrorPos[0] + "\n" + // strError[0];
// txtMessage += "\n\nXML:\n" + objBadData[0].Name + ", " +
// objBadData[0].TextValue;
//
// Application.ShowForm("MsgBox");

break;
}

objDoc.Close(true);
objDoc = null;
}
catch(Err) {
// displaying the error description here is a good idea

// txtMessage = Err.Description;
// Application.ShowForm("MsgBox");

break;
}
}
}
}

Testing the Event Handler


Switch to XMLSpy, and open a project to see how the BeforeOpenProject event is handled.

© 2010 Altova GmbH Programmers' Reference


868 Scripting Macros

2.6 Macros
Macros automate repetitive or complex tasks. In the Scripting Environment, you can create a
script that calls application functions as well as custom functions that you have defined. This
flexibility provides you with a powerful method of automating tasks within XMLSpy. This section
about macros is organized as follows:
 Creating and Editing a Macro describes how to create a new macro and edit an existing
one.
 Running a Macro explains how a macro can be run from the Scripting Editor and from
the broader XMLSpy environment as well.
 Debugging and Setting as Auto-Macro records the debugging and set as Auto-Macro
features of the Scripting Editor.

Key points about macros


Given below is a summary of important points about macros.
 Any number of macros can be added to the active scripting project. These macros are
saved in the Altova Scripting Project file (.asprj file).
 Functions that are used in a macro can be saved as a Global Declaration. All Global
Declarations are also saved in the Altova scripting project file (.asprj file).
 The macro can be tested by running it from within the Scripting Editor, and it can be
debugged from within the Scripting Editor.
 XMLSpy can have one global Scripting Project, and a second scripting project,
assigned to the currently loaded project, active at any one time; the macros are
available to both of them. See Running a Macro for details.

2.6.1 Creating and Editing a Macro


The following operations enable you to create a new macro and edit an existing macro.

Creating a new macro


Right-click the Macro folder in the Scripting Projects tree and select Add Macro from the
context menu. (The Add Macro command can also be selected from the context menu of any
item in the Scripting Projects tree.) Alternatively, click the New Macro icon in the toolbar of the
Scripting Projects tree.

The newly created (and empty) macro document is displayed in the Main Window, and the
name of the macro is displayed in the title bar of the Scripting Editor.

Naming or renaming a macro


To name or rename a macro, click the macro name in the Scripting Project tree and press the
F2 function key, or right click the name and select Rename from the context menu.

Altova XMLSpy 2011 © 2010 Altova GmbH


Scripting Macros 869

Opening a macro
To open a macro, right-click the macro in the Macros folder of the Scripting Project tree (see
screenshot above), and select the Open command. The macro is displayed in the Main Window
and its name is displayed in the title bar of the Scripting Editor (screenshot below).

2.6.2 Running a Macro


To run a macro in the Scripting Editor, right-click the macro in the Scripting Project tree and
select the command Run Macro.

There are different ways to run a macro from XMLSpy:


 Via the Tools | Macros menu of XMLSpy.
 By creating and using a toolbar button or menu item for a macro.

Note that while a macro is executed, Event Handlers from XMLSpy are not processed. Also,
only one macro can be run at a time. After a macro (or event) is executed, the script is closed
and global variables lose their values.

The XMLSpy command to run Macros


The Tools | Macros menu command (screenshot below) opens a submenu containing the
macros defined in the Scripting Project that is currently active in XMLSpy. The active Scripting
Projects are specified in the Scripting tab of the Options dialog, or in the Scripting tab of the
project settings.

From the submenu of available macros, select the macro to run. The macro will be executed.

Toolbar icon
You can create an icon in the toolbar or a menu item that runs a selected macro. To do this,
click Tools | Customize | Macros. This causes the Customize dialog to be displayed (
screenshot below).

© 2010 Altova GmbH Programmers' Reference


870 Scripting Macros

Now do the following:


1. In the Macros tab of the Customize dialog, select the required macro from the Macros
pane. The macros in the Macros pane are those in the active Scripting Project (which is
specified in the Scripting tab of the Options dialog).
2. In the Display Text input field enter the name of the icon. This name will appear when
the cursor is placed over the icon when it is in the toolbar.
3. Click Add Command to add it to the list of commands.
4. Select the command and click Edit Icon to create a new icon.
5. Drag the finished icon from the Associated Commands pane and drop it on to the
toolbar or menu when the cursor changes from an arrow to an I-beam or line.
6. Macros can even be assigned their own shortcuts in the Keyboard tab of the Customize
dialog (see screenshot above).

To remove the toolbar icon, open the Macros tab of the Customize dialog and drag the icon out
of the toolbar and into the Associated Commands pane. Select the command in the Associated
Commands pane and click Remove to remove the command from the pane.

Item in the Tools menu


The XMLSpy API includes a function, AddMacroMenuItem(), to add macros as menu items to
the Tools menu. This function can be used to add one or more macros to the Tools | Macros
list of macros. Typically, you should do this as follows:
1. Add the macro menu item by calling the XMLSpy API function, AddMacroMenuItem().
Application.AddMacroMenuItem("DeleteElements","Delete Elements
Dialog");
 The function's first parameter (DeleteElements in the example listing above) is the
name of the macro. If you run the macro and there is an open project having scripts
associated with it, XMLSpy searches for the macro in the project scripts first.

Altova XMLSpy 2011 © 2010 Altova GmbH


Scripting Macros 871

If there are no project scripts, or if XMLSpy cannot find the macro, then it looks for
the macro in the global scripts.
 The second parameter (Delete Elements Dialog) is the display text for the
menu item.
2. Reset the Tools menu by calling ClearMacroMenu(). This removes all previously
added menu items

The best way to call these two functions is with the Autorun macro of the global scripting
project or the On_OpenProject event.

2.6.3 Debugging a Macro


To debug a macro using an installed debugger, right-click the macro in the Scripting Project tree
and select the command Debug Macro.

This pops up the Just-In-Time Debugging dialog (screenshot below), which lists the debuggers
available on the machine. Select the debugger you wish to use and click Yes.

The selected debugger starts.

© 2010 Altova GmbH Programmers' Reference


872 Scripting Programming Points

2.7 Programming Points


The following programming points should be noted:

 All namespaces and types of the following .NET components can be accessed in the
Microsoft .NET Framework:
System
System.Data
System.Design
System.Drawing
System.Windows.Forms
System.XML

 Out-parameters from methods of the XMLSpy API require special variables in JScript.
Given below are some examples.
// use JScript method to access out-parameters
var strError = new Array(1);
var nErrorPos = new Array(1);
var objBadData = new Array(1);
bOK = objDoc.IsValid(strError,nErrorPos,objBadData);END

 .NET Methods that require integer arguments should not be called directly with JScript
Number Objects which are Floating Point Values.
For example, instead of:
var objCustomColor = CLR.Static( "System.Drawing.Color" ).
FromArgb( 128, 128, 128 );
use:
var objCustomColor = CLR.Static( "System.Drawing.Color" ). FromArgb(
Math.floor( 128 ), Math.floor( 128 ), Math.floor( 128 ) );

 .NET Enum values are accessed as shown below:


var enumValStretch = CLR.Static( "System.Windows.Forms.ImageLayout"
).Stretch;

 Enumeration literals, as defined in the Altova type libraries, can now be used instead of
numerical values.
objExportXMIFileDlg.XMIType = eXMI21ForUML23;

2.7.1 Built-in Commands


This section lists:
 Built-in commands, and
 .NET interoperability commands

Built-in commands
The following built-in commands are available.

Altova XMLSpy 2011 © 2010 Altova GmbH


Scripting Programming Points 873

Function CreateForm(strFormName : String)


Instantiates a New Form object from the given Form name.
Return Value: The Form object of the given name, or null if no Form with such name exists.

ShowForm(strFormName : String)
Instantiates a New Form object from the given form name and immediately shows it as Dialog.
Return Value: A Number that represents the generated DialogResult.

lastform
This global field can be used to conveniently access the last form object that was created.
Return Value: Returns a reference to the last form object that was successfully instantiated via
CreateForm() or ShowForm().

doevents()
Processes all Windows messages currently in the message queue.
Return Value: None

watchdog(bEnable : boolean)
Long running CPU-intensive scripts cause the watchdog to ask the user if the script should be
terminated. The watchdog() method is used to disable or enable this behavior.
Return Value: None

Usage tip:
Calling watchdog(true) can also be used to reset the watchdog. This can be useful before
executing long running (CPU intensive) tasks to ensure they have the maximum allowed script
processing quota.

alert(strMessage : String) or MsgBox(strMessage : String)


Opens a MessageBox dialog that shows the given message.
Return Value: None

confirm(strMessage : String)
Opens a dialog that shows the given confirm message (typically a yes/no question).
Return Value: A Boolean that represents the users answer.

prompt(strMessage : String, strDefault : String)


Opens a dialog that shows the given prompt message and a TextBox control with a default
answer.
Return Value: A String that contains the TextBox value or null if the user selected Cancel.

.NET interoperability commands


To allow further interoperability with the .NET Framework additional functions are provided
under CLR.

CLR.Import(strNamespaceCLR : String)
This is the scripting equivalent to the C# using / VB.Net imports keyword. This allows to leave
out the given namespaces in successive calls of CLR.Create() and CLR.Static().
Return Value: None

CLR.ShowImports()

© 2010 Altova GmbH Programmers' Reference


874 Scripting Programming Points

Opens a MessageBox dialog that shows the currently imported namespaces


Return Value: None

CLR.Create(strTypeNameCLR : String, constructor arguments ...)


Creates a new .NET object instance for the given typename. If more than one argument is
passed the successive arguments are interpreted as the arguments for the constructor of the
.NET object.
Return Value: A reference to the created .NET object

CLR.Static(strTypeNameCLR : String)
Gives access to .NET types that have no instances and contain only static members.
Return Value: A reference to the static .NET object

Form usage and commands


Form usage is as follows:

With Form objects, the Form Component Tree can be accessed naturally via field
access:

For example, suppose there is a Form designed as follows:


MyForm
ButtonPanel
OkButton
CancelButton
TextEditor
AxMediaPlayer1

TrayComponents:
MyTimer

The Form can then be instantiated from script as:


var objForm = CreateForm("MyForm");

To access one its components the field access can be used:


objForm.ButtonPanel.OkButton.Enabled = false;

or
objForm.TextEditor.Text = "Hello World";

To access Tray Components use the following method on the Form object:
var objTrayComponent = <A form object>.GetTrayComponent(strComponentName
: String);

In our example to get a reference to the Timer Component to enable it use the following:
var objTimer = objForm.GetTrayComponent("MyTimer");
objTimer.Enabled = true;

For ActiveX Controls the underlying COM object can be accessed via the OCX property:
var ocx = lastform.AxMediaPlayer1.OCX; // get underlying COM object
ocx.enableContextMenu = true;
ocx.URL = "mms://apasf.apa.at/fm4_live_worldwide";

Altova XMLSpy 2011 © 2010 Altova GmbH


Scripting Programming Points 875

© 2010 Altova GmbH Programmers' Reference


876 Scripting Migrating to Scripting Editor 2010 and Later

2.8 Migrating to Scripting Editor 2010 and Later


The Scripting Editor in XMLSpy from version 2010 onwards uses a different underlying
technology than earlier versions used. Consequently, scripting projects that were created with
versions of XMLSpy prior to version 2010 might need to be modified. The following points need
to be noted.

 If a previous Scripting Projects (.prj file) is opened with the new Scripting Editor
(version 2010 and later), the visual layout of Forms will be migrated as faithfully as
possible and scripts will be copied as they are in the .prj file. You will then need to
modify the scripts to be in accordance with the new technology used by the Scripting
Editor, and which is described in this documentation.
 TheView object: The old Scripting Environment provided an artificial property named
TheView that was only accessible from inside event handlers. It was used to access the
Form that trigged the event (either directly or from one of its child controls). The new
Scripting IDE does not provide this artificial property but instead provides the same
functionality, and much more, with orthogonal built-in scripting helper functions
combined with the power of the .NET framework.
 Since all event handlers in the new Scripting Environment get a sender object as a first
parameter, the source that triggered the event is always available. By calling the .NET
function FindForm() on the sender object one can access the Form object easily.
Alternatively (if only one Form is involved) the built-in property lastform can be used.
Note that the use of lastform is not constrained to event handlers (as was the case
with TheView). It can be used everywhere in script code.

Given below is a list of methods and properties of the TheView object, each accompanied by an
alternative mechanism offered by the new Scripting Environment.

Methods
The following methods were provided by the TheView object and must be migrated as
explained:

Cancel()
In the new scripting environment the same can be achieved with: lastform.Close(); // Use
.NET Form.Close()

IsFormOpen(Name as String) as Boolean


Since for .NET Forms there is a distinction between showing a Form and instantiating a Form,
the previous concept does not directly translate. Instead the user can ask if a certain Form is
currently shown. For example:
var objFormPencilSelector = CreateForm("PencilSelector");
var objFormColorSelector = CreateForm("ColorSelector");
...
// Anywhere in code ...

if(objFormColorSelector.Visible)
{
...
}

FormFind(Name as String) as Object


The new Scripting Environment allows you to instantiate more Forms of the same kind. In the
old Scripting Environment each Form could only exist once (as a Singleton). Thus there is no
equivalent of FormFind(). In the new Scripting Environment.

Altova XMLSpy 2011 © 2010 Altova GmbH


Scripting Migrating to Scripting Editor 2010 and Later 877

OpenDoc(File as String)
The same can be achieved with: Application.OpenDocument( File as String )

PumpData()
This corresponds to the built-in function doevents() which processes all Windows messages
currently in the message queue.

RunClick(), RunInitialize(), RunTerminate()


There is no direct replacement for these methods. Call the corresponding handlers directly
instead.

Properties
The following properties were provided by the TheView object and must be migrated as
explained:

ToolTipText as String
To use tooltips in the new scripting environment, the .NET infrastructure can be used. This
allows fine-grained control of tooltip behaviour (adjusting delays, when to show, etc). For
example, to provide tooltips for a Form with two controls, the following code could to be added
to the Form's Load event handler:

//Occurs whenever the user loads the form.


function MyForm_Load( objSender, e_EventArgs )
{
// Create the ToolTip and associate with the Form container.
var toolTip = CLR.Create("System.Windows.Forms.ToolTip");

// Set up the delays for the ToolTip.


toolTip.AutoPopDelay = 3000;
toolTip.InitialDelay = 1000;
toolTip.ReshowDelay = 500;

// Force the ToolTip text to be displayed whether or not


// the form is active.
toolTip.ShowAlways = true;

// Set up the ToolTip text for several Controls.


toolTip.SetToolTip(objSender.ProgressBar1,
"Shows the progress of the operation");
toolTip.SetToolTip(objSender.Button1,
"Click Button to start the processing");
}

Color as Long
Since all Form/controls in the new Scripting Environment are .NET controls from the System.
Windows.Forms namespace, the possibilities to modify colors, background image, fonts, and all
other visual aspects are numerous. For example, every Visual Component has the properties
BackColor and ForeColor to modify the visual appearance. The following handler could be
used to change the color of a button at runtime:

function TestForm_Button1_Click( objSender, e_EventArgs )


{
objSender.BackColor = CLR.Static( "System.Drawing.Color" ).SlateBlue;
}

Please refer to the .NET documentation to find out more about this topic:

© 2010 Altova GmbH Programmers' Reference


878 Scripting Migrating to Scripting Editor 2010 and Later

http://msdn.microsoft.com/en-us/library/system.windows.forms.aspx

Altova XMLSpy 2011 © 2010 Altova GmbH


Plugins 879

3 Plugins
XMLSpy allows you to create your own IDE plug-ins and integrate them into XMLSpy.

Use plug-ins to:


 Configure your version of XMLSpy, add commands through menus, icons, buttons etc.
 React to events from XMLSpy.
 Run your specific code within XMLSpy with access to the complete XMLSpy API

XMLSpy expects your plug-in to implement the IXMLSpyPlugIn interface. See ATL sample files
for an example using C++. The relevant files are in the following folder of your XMLSpy
installation:
C:\Documents and Settings\<username>\My Documents\Altova\XMLSpy2011
\Examples\CSharpIDEPlugin

For a sample using VisualBasic, look in the following folder of your XMLSpy installation:
C:\Documents and Settings\<username>\My Documents\Altova\XMLSpy2011
\Examples\XMLSpyPlugInActiveX

© 2010 Altova GmbH Programmers' Reference


880 Plugins Registration of IDE PlugIns

3.1 Registration of IDE PlugIns


XMLSpy maintains a specific key in the Registry where it stores all registered IDE plug-ins:

HKEY_CURRENT_USER\Software\Altova\XML Spy\PlugIns

All values of this key are treated as references to registered plug-ins and must conform to the
following format:

Value name: ProgID of the plug-in


Value type: must be REG_SZ
Value data: CLSID of the component

Each time the application starts the values of the "PlugIns" key is scanned, and the registered
plug-ins are loaded.

Register plug-in manually


To register a plug-in manually, use the "Customize" dialog box of the XMLSpy "Tools" menu.
Use the "Add Plug-In..." button to specify the DLL that implements your plug-in. XMLSpy
registers the DLL as a COM server and adds the corresponding entry in its "PlugIns" key.

If you experience problems with manual registration you can check if the CLSID of your plug-in
is correctly registered in the "PlugIns" key. If this is not the case, the name of your plug-in DLL
was probably not sufficiently unique. Use a different name or perform direct registration.

Register plug-in directly


A plug-in can be directly registered as an IDE plug-in by first registering the DLL and then
adding the appropriate value to the "PlugIns" key of XMLSpy during plug-in setup for example.
The new plug-in will be activated the next time XMLSpy is launched.

Altova XMLSpy 2011 © 2010 Altova GmbH


Plugins ActiveX Controls 881

3.2 ActiveX Controls


ActiveX controls are supported. Any IDE PlugIn which is also an ActiveX control will be
displayed in a Dialog Control Bar. A sample PlugIn that is also an ActiveX control is included in
the XMLSpyPlugInActiveX folder in the Examples folder of your application folder.

© 2010 Altova GmbH Programmers' Reference


882 Plugins Configuration XML

3.3 Configuration XML


The IDE plug-in allows you to change the user interface (UI) of XMLSpy. This is done by
describing each separate modification using an XML data stream. The XML configuration is
passed to XMLSpy using the GetUIModifications method of the IXMLSpyPlugIn interface.

The XML file containing the UI modifications for the IDE PlugIn, must have the following
structure:

<ConfigurationData>
<ImageFile>path To image file</ImageFile>
<Modifications>
<Modification>
...
</Modification>
...
</Modifications>
</ConfigurationData>

You can define icons or toolbar buttons for the new menu items which are added to the UI of
XMLSpy by the plug-in. The path to the file containing the images is set using the ImageFile
element. Each image must be 16 x 16 pixels using max. 256 colors. The image references
must be arranged from left to right in a single (<ImageFile>...) line. The rightmost image index
value, is zero.

The Modifications element can have any number of Modification child elements. Each
Modification element defines a specific change to the standard UI of XMLSpy. Starting with
version 4.3, it is also possible to remove UI elements from XMLSpy.

Structure of Modification elements


All Modification elements consist of the following two child elements:

<Modification>
<Action>Type of action</Action>
<UIElement Type="type of UI element">
</UIElement>
</Modification>

Valid values for the Action element are:

Add - to add the following UI element to XMLSpy


Hide - to hide the following UI element in XMLSpy
Remove - to remove the UI element from the "Commands" list box, in the customize dialog

You can combine values of the Action element e.g. "Hide Remove"

The UIElement element describes any new, or existing UI element for XMLSpy. Possible
elements are currently: new toolbars, buttons, menus or menu items. The type attribute, defines
which UI element is described by the XML element.

Common UIElement children


The ID and Name elements are valid for all different types of XML UIElement fragments. It is
however possible, to ignore one of the values for a specific type of UIElement e.g. Name is
ignored for a separator.

<ID></ID>
<Name></Name>

If UIElement describes an existing element of the UI, the value of the ID element is predefined

Altova XMLSpy 2011 © 2010 Altova GmbH


Plugins Configuration XML 883

by XMLSpy. Normally these ID values are not known to the public. If the XML fragment
describes a new part of the UI, then the ID is arbitrary and the value should be less than 1000.
The Name element sets the textual value. Existing UI elements can be identified just by name,
for e.g. menus and menu items with associated sub menus. For new UI elements, the Name
element sets the caption e.g. the title of a toolbar, or text for a menu item.

Toolbars and Menus


To define a toolbar its necessary to specify the ID and/or the name of the toolbar. An existing
toolbar can be specified using only the name, or by the ID if it is known. To create a new toolbar
both values must be set. The type attribute must be equal to "ToolBar".

<UIElement Type="ToolBar">
<ID>1</ID>
<Name>TestPlugIn</Name>
</UIElement>

To specify an XMLSpy menu you need two parameters:


 The ID of the menu bar which contains the menu. If no XML documents are open in the
main window, the menu bar ID is 128. If one or more XML documents are open, the
menu bar ID is 129.
 The menu name. Menus do not have an associated ID value. The following example
defines the "Edit" menu of the menu bar which is active, when at least one XML
document is open:

<UIElement Type="Menu">
<ID>129</ID>
<Name>Edit</Name>
</UIElement>

An additional element is used if you want to create a new menu. The Place element defines the
position of the new menu in the menu bar:

<UIElement Type="Menu">
<ID>129</ID>
<Name>PlugIn Menu</Name>
<Place>12</Place>
</UIElement>

A value of -1 for the Place element sets the new button or menu item at the end of the menu or
toolbar.

Commands
If you add a new command, through a toolbar button or a menu item, the UIElement fragment
can contain any of these sub elements:

<MacroName></MacroName>
<Info></Info>
<ImageID></ImageID>

If MacroName is specified, XMLSpy searches for a macro with the same name in the scripting
environment and executes it each time this command is processed. The Info element contains
a short description string which is displayed in the status bar, when the mouse pointer is over
the associated command (button or menu item). ImageID defines the index of the icon the
external image file. Please note that all icons are stored in one image file.

To define a toolbar button create an UIElement with this structure:

<UIElement Type="ToolBarItem">
<!--don't reuse local IDs even the commands do the same-->
<ID>5</ID>

© 2010 Altova GmbH Programmers' Reference


884 Plugins Configuration XML

<Name>Open file from repository...</Name>


<!--Set Place To -1 If this is the first button To be inserted-->
<Place>-1</Place>
<ImageID>0</ImageID>
<ToolBarID>1</ToolBarID>
<!--instead of the toolbar ID the toolbar name could be used-->
<ToolBarName>TestPlugIn</ToolBarName>
</UIElement>

Additional elements to declare a toolbar button are Place, ToolBarID and ToolBarName.
ToolBarID and ToolBarName are used to identify the toolbar which contains the new or existing
button. The textual value of ToolBarName is case sensitive. The (UIElement) type attribute
must equal "ToolBarItem".

To define a menu item, the elements MenuID, Place and Parent are available in addition to the
standard elements used to declare a command. MenuID can be either 128 or 129. Please see
"Toolbars and Menus" for more information on these values.

The Parent element is used to identify the menu where the new menu entry should be inserted.
As sub menu items have no unique Windows ID, we need some other way to identify the parent
of the menu item.

The value of the Parent element is a path to the menu item.


The text value of the Parent element, must equal the parent menu name of the submenu,
where the submenu name is separated by a colon. If the menu has no parent, because its not a
submenu, add a colon to the beginning of the name. The type attribute must be set to
"MenuItem". Example for an UIElement defining a menu item:

<UIElement Type="MenuItem">
<!--the following element is a Local command ID-->
<ID>3</ID>
<Name>Open file from repository...</Name>
<Place>-1</Place>
<MenuID>129</MenuID>
<Parent>:PlugIn Menu</Parent>
<ImageID>0</ImageID>
</UIElement>

XMLSpy makes it possible to add toolbar separators and menus if the value of the ID element is
set to 0.

Altova XMLSpy 2011 © 2010 Altova GmbH


Plugins ATL sample files 885

3.4 ATL sample files


The following pages show how to create a simple XMLSpy IDE plug-in DLL using ATL. To build
the DLL it is necessary to know about ATL, the wizards that generate new ATL objects, as well
as MS VisualStudio.

To access the API the implementation imports the Type Library of XMLSpy. The code reads
various properties and calls methods using the smart pointers provided by the #import
statement.

In addition, the sample code uses the MFC class CString and the ATL conversion macros such
as W2T.

At a glance the steps to create an ATL DLL are as follows:


1. Open VisualStudio and select "New..." from the "File" menu.
2. Select the "Projects" tab.
3. Select "ATL COM AppWizard" and type in a project name.
4. Select "Support for MFC" if you want to use MFC classes, or if you want to create a
project for the sample code.

Having created the project files you can add an ATL object to implement the
IXMLSpyPlugIn interface:
1. Select "New ATL Object..." from the "Insert" menu.
2. Select "Simple Object" from the wizard and click "Next".
3. Type in a name for the object.
4. On the "Attributes" tab, select "Custom" for the type of interface, and disable
Aggregation.

These steps produce the skeleton code for the implementation of the IDE plug-in interface.
Please see the following pages on how to modify the code and achieve some basic
functionality.

3.4.1 Interface description (IDL)


The IDL of the newly created ATL object contains a declaration for one COM interface.
 This interface declaration must be replaced by the declaration of IXMLSpyPlugIn as
shown below.
 The IDL must also contain the definition of the SPYUpdateAction enumeration.
 Replace the generated default interface name, (created by the wizard) with
"IXMLSpyPlugIn" in the coclass declaration. The IDL should then look something like
the example code below:

Having created the ATL object, you then need to implement the IDE plug-in interface of
XMLSpy.

import "oaidl.idl";
import "ocidl.idl";

// ----- please insert the following block into your IDL file -----
typedef enum {
spyEnable = 1,
spyDisable = 2,
spyCheck = 4,
spyUncheck = 8
} SPYUpdateAction;

© 2010 Altova GmbH Programmers' Reference


886 Plugins ATL sample files

// ----- end insert block ----

// ----- E.g. Interface entry automatically generated by the ATL wizard -----
// [
// object,
// uuid(AB7CD86A-8145-429A-A1F3-270692EO8AFC),

// helpstring("IXMLSpyPlugIn Interface")
// pointer_default(unique)
// ]
// interface IXMLSpyPlugIn : IUnknown
// {
// };

// ----- end automatically generated Interface Entry

// ----- replace the Interface Entry (shown above) generated for you by the
ATL wizard, with the following block -----

[
odl,
uuid(88F2A622-4B7E-42CD-8D04-3C0E5389DD85),
helpstring("IXMLSpyPlugIn Interface")
]
interface IXMLSpyPlugIn : IUnknown
{
HRESULT _stdcall OnCommand([in] long nID, [in] IDispatch* pXMLSpy);

HRESULT _stdcall OnUpdateCommand([in] long nID, [in] IDispatch* pXMLSpy,


[out, retval] SPYUpdateAction* pAction);

HRESULT _stdcall OnEvent([in] long nEventID, [in] SAFEARRAY(VARIANT)*


arrayParameters, [in] IDispatch* pXMLSpy, [out, retval] VARIANT*
pReturnValue);

HRESULT _stdcall GetUIModifications([out, retval] BSTR* pModificationsXML);

HRESULT _stdcall GetDescription([out, retval] BSTR* pDescription);


};

// ----- end replace block -----

// ----- The code below is automatically generated by the ATL wizard and will
look slightly different in your case -----

[
uuid(24FE0D1B-3FC0-494E-B36E-1D4CE412B014),
version(1.0),
helpstring("XMLSpyIDEPlugInDLL 1.0 Type Library")
]
library XMLSPYIDEPLUGINDLLLib
{
importlib("stdole32.tlb");
importlib("stdole2.tlb");

[
uuid(3800E791-7F6B-4ACD-9E32-2AC184444501),
helpstring("XMLSpyIDEPlugIn Class")
]
coclass XMLSpyIDEPlugIn
{
[default] interface IXMLSpyPlugIn; // ----- define IXMLSpyPlugIn as the
default interface -----

Altova XMLSpy 2011 © 2010 Altova GmbH


Plugins ATL sample files 887

};
};

3.4.2 Class definition


In the class definition of the ATL object, several changes must be made. The class has to
derive from IXMLSpyPlugIn, the "Interface Map" needs an entry for IXMLSpyPlugIn, and the
methods of the IDE plug-in interface must be declared:

#ifndef __XMLSPYIDEPLUGIN_H_
#define __XMLSPYIDEPLUGIN_H_

#include "resource.h" // main symbols

/////////////////////////////////////////////////////////////////////////////
// CXMLSpyIDEPlugIn
class ATL_NO_VTABLE CXMLSpyIDEPlugIn :
public CComObjectRootEx<CComSingleThreadModel>,
public CComCoClass<CXMLSpyIDEPlugIn, &CLSID_XMLSpyIDEPlugIn>,
public IXMLSpyPlugIn
{
public:
CXMLSpyIDEPlugIn()
{
}

DECLARE_REGISTRY_RESOURCEID(IDR_XMLSPYIDEPLUGIN)
DECLARE_NOT_AGGREGATABLE(CXMLSpyIDEPlugIn)

DECLARE_PROTECT_FINAL_CONSTRUCT()

BEGIN_COM_MAP(CXMLSpyIDEPlugIn)
COM_INTERFACE_ENTRY(IXMLSpyPlugIn)
END_COM_MAP()

// IXMLSpyIDEPlugIn
public:
virtual HRESULT _stdcall OnCommand(long nID, IDispatch* pXMLSpy);

virtual HRESULT _stdcall OnUpdateCommand(long nID, IDispatch* pXMLSpy,


SPYUpdateAction* pAction);

virtual HRESULT _stdcall OnEvent(long nEventID, SAFEARRAY **arrayParameters,


IDispatch* pXMLSpy, VARIANT* pReturnValue);

virtual HRESULT _stdcall GetUIModifications(BSTR* pModificationsXML);

virtual HRESULT _stdcall GetDescription(BSTR* pDescription);


};

#endif //__XMLSPYIDEPLUGIN_H_

3.4.3 Implementation
The code below shows a simple implementation of an XMLSpy IDE plug-in. It adds a menu item
and a separator (available with XMLSpy) to the Tools menu. Inside the OnUpdateCommand()
method, the new command is only enabled when the active document is displayed using the
Grid View. The command searches for the XML element which has the current focus, and
opens any URL starting with "http://", from the textual value of the element.

/////////////////////////////////////////////////////////////////////////////
// CXMLSpyIDEPlugIn

© 2010 Altova GmbH Programmers' Reference


888 Plugins ATL sample files

#import "XMLSpy.tlb"
using namespace XMLSpyLib;

HRESULT CXMLSpyIDEPlugIn::OnCommand(long nID, IDispatch* pXMLSpy)


{
USES_CONVERSION;

if(nID == 1) {
IApplicationPtr ipSpyApp;

if(pXMLSpy) {
if(SUCCEEDED(pXMLSpy->QueryInterface(__uuidof(IApplication),(void
**)&ipSpyApp))) {
IDocumentPtr ipDocPtr = ipSpyApp->ActiveDocument;

// we assume that grid view is active


if(ipDocPtr) {
IGridViewPtr ipGridPtr = ipDocPtr->GridView;

if(ipGridPtr) {
IXMLDataPtr ipXMLData = ipGridPtr->CurrentFocus;

CString strValue = W2T(ipXMLData->TextValue);

if(!strValue.IsEmpty() && (strValue.Left(7) == _T("http://")))


::ShellExecute(NULL,_T("open")
,W2T(ipXMLData->TextValue),NULL,NULL,SW_SHOWNORMAL);
}
}
}
}
}

return S_OK;
}

HRESULT CXMLSpyIDEPlugIn::OnUpdateCommand(long nID, IDispatch* pXMLSpy,


SPYUpdateAction* pAction)
{
*pAction = spyDisable;

if(nID == 1) {
IApplicationPtr ipSpyApp;

if(pXMLSpy) {
if(SUCCEEDED(pXMLSpy->QueryInterface(__uuidof(IApplication),(void
**)&ipSpyApp))) {
IDocumentPtr ipDocPtr = ipSpyApp->ActiveDocument;

// only enable if grid view is active


if((ipDocPtr != NULL) && (ipDocPtr->CurrentViewMode == spyViewGrid))
*pAction = spyEnable;
}
}
}

return S_OK;
}

HRESULT CXMLSpyIDEPlugIn::OnEvent(long nEventID, SAFEARRAY **arrayParameters,


IDispatch* pXMLSpy, VARIANT* pReturnValue)
{
return S_OK;

Altova XMLSpy 2011 © 2010 Altova GmbH


Plugins ATL sample files 889

HRESULT CXMLSpyIDEPlugIn::GetUIModifications(BSTR* pModificationsXML)


{
CComBSTR bstrMods = _T(" \
<ConfigurationData> \
<Modifications> ");
// add "Open URL..." to Tools menu
bstrMods.Append (_T(" \
<Modification> \
<Action>Add</Action> \
<UIElement type=\"MenuItem\"> \
<ID>1</ID> \
<Name>Open URL...</Name> \
<Place>0</Place> \
<MenuID>129</MenuID> \
<Parent>:Tools</Parent> \
</UIElement> \
</Modification> "));
// add Seperator to Tools menu
bstrMods.Append (_T(" \
<Modification> \
<Action>Add</Action> \
<UIElement type=\"MenuItem\"> \
<ID>0</ID> \
<Place>1</Place> \
<MenuID>129</MenuID> \
<Parent>:Tools</Parent> \
</UIElement> \
</Modification> "));
// finish modification description
bstrMods.Append (_T(" \
</Modifications> \
</ConfigurationData>"));

return bstrMods.CopyTo(pModificationsXML);
}

HRESULT CXMLSpyIDEPlugIn::GetDescription(BSTR* pDescription)


{
CComBSTR bstrDescr = _T("ATL C++ XMLSpy IDE PlugIn;This PlugIn demonstrates
the implementation of a simple ATL DLL as a IDE PlugIn for XMLSpy.");
return bstrDescr.CopyTo(pDescription);
}

© 2010 Altova GmbH Programmers' Reference


890 Plugins IXMLSpyPlugIn

3.5 IXMLSpyPlugIn
See also

Methods
OnCommand
OnUpdateCommand
OnEvent
GetUIModifications
GetDescription

Description
If a DLL is added to XMLSpy as an IDE plug-in, it is necessary that it registers a COM
component that answers to an IXMLSpyPlugIn interface with the reserved
uuid(88F2A622-4B7E-42CD-8D04-3C0E5389DD85), for it to be recognized as a plug-in.

3.5.1 OnCommand
See also

Declaration: OnCommand(nID as long, pXMLSpy as IDispatch)

Description
The OnCommand() method of the interface implementation, is called each time a command
added by the the IDE plug-in (menu item or toolbar button) is processed. nID stores the
command ID defined by the ID element of the respective UIElement.
pXMLSpy holds a reference to the dispatch interface of the Application object of XMLSpy.

Example
Public Sub IXMLSpyPlugIn_OnCommand(ByVal nID As Long, ByVal pXMLSpy As Object)
If (Not (pXMLSpy Is Nothing)) Then
Dim objDlg
Dim objDoc As XMLSpyLib.Document
Dim objSpy As XMLSpyLib.Application
Set objSpy = pXMLSpy

If nID = 3 Or nID = 5 Then


Set objDlg = CreateObject("MSComDlg.CommonDialog")
objDlg.Filter = "XML Files (*.xml)|*.xml|All Files (*.*)|*.*||"
objDlg.FilterIndex = 1
objDlg.ShowOpen

If Len(objDlg.FileName) > 0 Then


Set objDoc = objSpy.Documents.OpenFile(objDlg.FileName, False)
Set objDoc = Nothing
End If
End If

If nID = 4 Or nID = 6 Then


Set objDlg = CreateObject("MSComDlg.CommonDialog")
objDlg.Filter = "All Files (*.*)|*.*||"
objDlg.Flags = cdlOFNPathMustExist
objDlg.ShowSave

If Len(objDlg.FileName) > 0 Then


Set objDoc = objSpy.ActiveDocument

If Not (objDoc Is Nothing) Then


objDoc.SetPathName objDlg.FileName

Altova XMLSpy 2011 © 2010 Altova GmbH


Plugins IXMLSpyPlugIn 891

objDoc.Save
Set objDoc = Nothing
End If
End If
End If

Set objSpy = Nothing


End If
End Sub

3.5.2 OnUpdateCommand
See also

Declaration: OnUpdateCommand(nID as long, pXMLSpy as IDispatch) as


SPYUpdateAction

Description
The OnUpdateCommand() method is called each time the visible state of a button or menu
item needs to be set. nID stores the command ID defined by the ID element of the respective
UIElement.

pXMLSpy holds a reference to the dispatch interface of the Application object.

Possible return values to set the update state are:

spyEnable = 1
spyDisable = 2
spyCheck = 4
spyUncheck = 8

Example
Public Function IXMLSpyPlugIn_OnUpdateCommand(ByVal nID As Long, ByVal
pXMLSpy As Object) As SPYUpdateAction
IXMLSpyPlugIn_OnUpdateCommand = spyDisable

If (Not (pXMLSpy Is Nothing)) Then


Dim objSpy As XMLSpyLib.Application
Set objSpy = pXMLSpy

If nID = 3 Or nID = 5 Then


IXMLSpyPlugIn_OnUpdateCommand = spyEnable
End If
If nID = 4 Or nID = 6 Then
If objSpy.Documents.Count > 0 Then
IXMLSpyPlugIn_OnUpdateCommand = spyEnable
Else
IXMLSpyPlugIn_OnUpdateCommand = spyDisable
End If
End If
End If
End Function

3.5.3 OnEvent
See also

Declaration: OnEvent(nEventID as long, arrayParameters as SAFEARRAY(VARIANT),


pXMLSpy as IDispatch) as VARIANT

© 2010 Altova GmbH Programmers' Reference


892 Plugins IXMLSpyPlugIn

Description
OnEvent() is called each time an event is raised from XMLSpy.

Possible values for nEventID are:

On_BeforeStartEditing =1
On_EditingFinished =2
On_FocusChanged =3
On_Beforedrag =4
On_BeforeDrop =5
On_OpenProject =6
On_OpenDocument =7
On_CloseDocument =8
On_SaveDocument =9

Events available since XMLSpy 4r4:

On_DocEditDragOver = 10
On_DocEditDrop = 11
On_DocEditKeyDown = 12
On_DocEditKeyUp = 13
On_DocEditKeyPressed = 14
On_DocEditMouseMove = 15
On_DocEditButtonUp = 16
On_DocEditButtonDown = 17
On_DocEditContextMenu = 18
On_DocEditPaste = 19
On_DocEditCut = 20
On_DocEditCopy = 21
On_DocEditClear = 22
On_DocEditSelectionChanged = 23

Events available since XMLSpy 2004:

On_DocEditDragOver = 10

Altova XMLSpy 2011 © 2010 Altova GmbH


Plugins IXMLSpyPlugIn 893

Events available since XMLSpy 2004r4 (type library version 1.4):

On_BeforeOpenProject = 25
On_BeforeOpenDocument = 26
On_BeforeSaveDocument = 27
On_BeforeCloseDocument = 28
On_ViewActivation = 29
On_DocEditKeyboardEvent = 30
On_DocEditMouseEvent = 31

Events available since XMLSpy 2006 SP1 (type library version 1.5):

On_BeforeValidate = 32

Events available since XMLSpy 2007 (type library version 1.6):

On_BeforeShowSuggestions = 33
On_ProjectOpened = 34
On_Char = 35

Events available since XMLSpy 2009 (type library version 2.2):

On_Initialize = 36
On_Running = 37
On_Shutdown = 38

The names of the events are the same as they appear in the Scripting Environment of XMLSpy.
For IDE plug-ins the names used are immaterial. The events are identified using the ID value.

arrayParameters is an array which is filled with the parameters of the currently raised event.
Order, type and meaning of the single parameters are available through the scripting
environment of XMLSpy. The events module of a scripting project, contains predefined
functions for all events prior to version 4.4. The parameters passed to the predefined functions
are identical to the array elements of the arrayParameters parameter.

Events raised from the Authentic View of XMLSpy do not pass any parameters directly. An
"event" object is used instead. The event object can be accessed through the Document object
of the active document.

pXMLSpy holds a reference to the dispatch interface of the Application object of XMLSpy.

If the return value of OnEvent() is set, then neither the IDE plug-in, nor an event handler
inside of the scripting environment will get this event afterwards. Please note that all IDE
plug-ins get/process the event before the Scripting Environment does.

3.5.4 GetUIModifications
See also

Declaration: GetUIModifications() as String

Description
The GetUIModifications() method is called during initialization of the plug-in, to get the
configuration XML data that defines the changes to the UI of XMLSpy. The method is called
when the plug-in is loaded for the first time, and at every start of XMLSpy.

© 2010 Altova GmbH Programmers' Reference


894 Plugins IXMLSpyPlugIn

See also Configuration XML for a detailed description how to change the UI.

Example
Public Function IXMLSpyPlugIn_GetUIModifications() As String
' GetUIModifications() gets the XML file with the specified modifications
of
' the UI from the config.xml file in the plug-in folder
Dim strPath As String
strPath = App.Path

If Len(strPath) > 0 Then


Dim fso As New FileSystemObject
Dim file As file

Set file = fso.GetFile(strPath & "\config.xml")

If (Not (file Is Nothing)) Then


Dim stream As TextStream
Set stream = file.OpenAsTextStream(ForReading)

' this replaces the token '**path**' from the XML file with
' the actual installation path of the plug-in to get the image
file
Dim strMods As String
strMods = stream.ReadAll
strMods = Replace(strMods, "**path**", strPath)

IXMLSpyPlugIn_GetUIModifications = strMods
Else
IXMLSpyPlugIn_GetUIModifications = ""
End If
End If
End Function

3.5.5 GetDescription
See also

Declaration: GetDescription() as String

Description
GetDescription() is used to define the description string for the plug-in entries visible in the
Customize dialog box.

Example
Public Function IXMLSpyPlugIn_GetDescription() As String
IXMLSpyPlugIn_GetDescription = "Sample Plug-in for XMLSpy;This Plug-in
demonstrates the implementation of a simple VisualBasic DLL as a Plug-in for
XMLSpy."
End Function

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API 895

4 The XMLSpy API


The COM-based XMLSpy API of XMLSpy enables other applications to use the functionality of
XMLSpy. As a result, it is now possible to automate a wide range of tasks, from validating an
XML file to modifying complex XML content (with the XMLData interface). The XMLSpy API is
also used by the built-in Scripting Environment of XMLSpy to access application functionality
(for a complete description of which, see Scripting). It is also used by IDE Plugins.

XMLSpy and the XMLSpy API follow the common specifications for automation servers set out
by Microsoft. It is possible to access the methods and properties of the XMLSpy API from
common development environments, such as those using C, C++, VisualBasic, and Delphi, and
with scripting languages like JavaScript and VBScript.

The following limitations must be considered in your client code:


 Be aware that if your client code crashes, instances of XMLSpy may still remain in the
system.
 Don't hold references to objects in memory longer than you need them, especially those
from the XMLData interface. If the user interacts between two calls of your client, then
there is no guarantee that these references are still valid.
 Terminate XMLSpy with the Application.Quit method.
 Don't forget to disable dialogs if the user interface is not visible.
 See Error handling for details of how to avoid annoying error messages.
 Free references explicitly if you are using C or C++.

This documentation
The documentation about the XMLSpy API is broadly divided into two parts.
 The first part consists of an Overview, which describes the object model for the API,
important concepts, and Usage Examples to help you get started.
 The second part is a reference section that contains descriptions of all the interface
objects of the XMLSpy API.

There have been improvements and updates made from release to release. The differences
between releases are documented in Release Notes.

© 2010 Altova GmbH Programmers' Reference


896 The XMLSpy API Overview

4.1 Overview
This overview of the XMLSpy API provides you with the object model for the API, and with a
description of the most important API processes. The following topics are covered:
 The object model
 Simple document access
 Error handling
 Events
 Import and export of data
 Using XMLData to modify document structure
 The DOM and XMLData

Changes to the API from from version to version of the type library are listed in the release
notes section.

4.1.1 Object model


The starting point for every application which uses the XMLSpy API is the Application
object. This object contains general methods like import/export support and references to the
open documents and any open project.

To create an instance of the Application object, call


CreateObject("XMLSpy.Application") from VisualBasic or a similar function from your
preferred development environment to create a COM object. There is no need to create any
other objects, to use the complete XMLSpy API (It is in fact not even possible). All other
interfaces are accessed through other objects with the Application object as the starting point.

The picture below shows you the links between the main objects of the XMLSpy API:

The application object consists of the following parts:

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Overview 897

1. Document collection and reference to the active document.

2. Reference to current project and methods for creating and opening of projects.

3. Methods to support the export to and import from databases, text files and Word
documents.

4. URL management.

5. Methods for macro menu items.

Once you have created an Application object you can start using the functionality of XMLSpy.
Most of the times you either open a project and access the documents from there or you directly
open a document via the Documents interface.

4.1.2 Simple document access


Create and open files
Use the methods of the Documents interface to create and open documents. This interface is
accessible via the Application.Documents property.

Example:

Dim objDoc As Document


Set objDoc = objSpy.Documents.OpenFile("C:\xmlfiles\myfile.xml", False)

Sometimes it is necessary to show a file dialog to the user to select a file. This usually happens
in the scripting environment and you only need to pass True as the second parameter to
OpenFile().

To create a new file use Documents.NewFile(). Any existing file with the same path will be
overwritten during the next Document.Save() call.

Documents collection
All open documents are accessible via the Documents collection. All collection objects in the
XMLSpy API conform to the Microsoft specifications. So it is possible to use the For-Each loop
in VisualBasic to iterate through the open documents.

Example:
Dim objDocs As Documents
Dim objDoc As Document

Set objDocs = objSpy.Documents

For Each objDoc In objDocs


'do something useful with your document
objDoc.AssignXSL "C:\myXSL.xsl", False
Next

Another way to access a document is the Documents.Item method. The method takes an
index as a parameter and gets the corresponding document object from the collection. Please
note that 1 is the first index value. Documents.Count retrieves the total number of documents.

Example:
Dim objDocs As Documents

© 2010 Altova GmbH Programmers' Reference


898 The XMLSpy API Overview

Dim objDoc As Document

Set objDoc = objDocs.Item(1) 'gets the first document

Validation
One common task on documents is to validate them against an assigned schema or DTD. If the
XML file has no schema or DTD already assigned, use Document.AssignSchema or
Document.AssignDTD to add the necessary references to the document.

Examples:
objSpy.ActiveDocument.AssignSchema "C:\mySchema.xsd", False

Or

objSpy.ActiveDocument.AssignDTD "C:\myDTD.dtd", False

If you want the user to select a schema or DTD, pass True as the second parameter to these
functions to display a file-dialog. These methods only put the reference into the document and
do not check the existence of the specified file. If the file path is not valid, the validation will fail.

After you have assigned a valid schema or DTD reference to your file, you are able to validate it
with Document.IsValid. IsValid needs some out-parameters that must be declared as
VARIANTs to be accessible from script languages like VBScript and JavaScript.

Example:

Dim bValid As Boolean


Dim strMsg As Variant
Dim nPos As Variant
Dim objBadXMLData As Variant

bValid = objSpy.ActiveDocument.IsValid(strMsg, nPos, objBadXMLData)

If bValid = False Then


a = MsgBox("The document is not valid:" & Chr(13) &
strMsg & Chr(13) & "position: " & nPos &
Chr(13) & "XMLData name: " & objBadXMLData.Name)
Else
a = MsgBox("The document is valid")
End If

4.1.3 Error handling


The XMLSpy API returns errors in two different ways. Every API method returns an HRESULT.
This return value informs the caller about any malfunctions during the execution of the method.
If the call was successful, the return value is equal to S_OK. C/C++ programmers generally use
HRESULT to detect any errors.

VisualBasic, scripting languages and other high-level development environments, don't give the
programmer access to the returning HRESULT of a COM call. They use the second error raising
mechanism also supported by the XMLSpy API, the IErrorInfo interface. If an error occurs
the API creates a new object that implements the IErrorInfo interface. The development
environment takes this interface, and fills its own error handling mechanism with the provided
information.

The next paragraphs describes how to deal with errors raised from the XMLSpy API in different
development environments.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Overview 899

VisualBasic
A common way to handle errors in VisualBasic is to define an error handler. This error handler
can be set with the On Error statement. Usually the handler displays a error message and
does some cleanup to avoid spare references and any kind of resource leaks. VisualBasic fills
its own Err object with the information from the IErrorInfo interface.

Example:
Sub Validate()
'place variable declarations here

'set error handler


On Error GoTo ErrorHandler

'if IsValid() fails, program execution continues


'at ErrorHandler:
bValid = objSpy.ActiveDocument.IsValid(strMsg,nPos,objBadXMLData)

'additional code comes here

'exit
Exit Sub

ErrorHandler:
Set objBadXMLData = Nothing

MsgBox("Error: " & (Err.Number - vbObjectError) & Chr(13) &


"Description: " & Err.Description)
End Sub

JavaScript
The Microsoft implementation of JavaScript (JScript) provides a try-catch mechanism to deal
with errors raised from COM calls. It is very similar to the VisualBasic approach, because you
also declare an error object containing the necessary information.

Example:

Function Validate()
{
// please insert variable declarations here

try{
bValid = objSpy.ActiveDocument.IsValid(sMsg,nPos,objBad);
}
catch(Error) {
objBad = Null;
sError = Error.description;
nErrorCode = Error.number;
Return False;
}

Return bValid;
}

C/C++
C/C++ gives you easy access to the HRESULT of the COM call and to the IErrorInterface.

H R E S U LThr;

// Call IsValid() from the XMLSpy API


If(FAILED(hr = ipDoc->IsValid(&varMsg,&varPos,&varBadData))) {
IErrorInfo *ipErrorInfo = Null;

© 2010 Altova GmbH Programmers' Reference


900 The XMLSpy API Overview

If(SUCCEEDED(::GetErrorInfo(0,&ipErrorInfo))) {
BSTRbstrDescr;
ipErrorInfo->GetDescription(&bstrDescr);

// handle Error information


wprintf(L"Error message:\t%s\n",bstrDescr);
::SysFreeString(bstrDescr);

// release Error info


ipErrorInfo->Release();
}
}

4.1.4 Events
The automation interface of XMLSPY provides a large set of events to allow for a tight
integration of XMLSPY and its clients. The way events can be used by clients depends on their
technology used to connect to XMLSPY and on the clients programming language.

XMLSPY scripting environment - macros, forms and event handlers written with the
FormEditor
The XMLSPY scripting environment automatically invokes the event handler with the
corresponding name. Use the FormEditor to add code for those events you want to handle.
The FormEditor predefines the correct signatures for all event handlers when you create a
new project. For more information see the scripting environment.

VBScript
All event handler functions start with 'On_'. To stay compatible to existing events, their
name might differ slightly from the name used on the connection point interface.
Specification of event parameters is optional so that old event handlers that did not expect
any parameters still work.

JScript
All event handler functions start with 'On_'. To stay compatible to existing events, their
name might differ slightly from the name used on the connection point interface.
Specification of event parameters is optional so that old event handlers that did not expect
any parameters still work.

XMLSPY IDE Plugin


XMLSPY Plugins get informed about outstanding events by a call to the method
IXMLSpyPlugIn.OnEvent. Different events are identified by a unique number. Parameters are
passed to the event handler packed into a save-array.
Alternatively, Plugins can use the connection point mechanism to request events on specific
objects like any other external client. See below for more information.

External clients
COM specifies the connection point mechanism to define a way how a client can register
itself at a server for callbacks. The automation interface for XMLSPY defines the necessary
event interfaces. The way to connect to those events, depends on the programming language
you use in your client.

VBA - VisualBasic for Applications


Use the Dim WithEvents statement to receive events from a dedicated object instance.

' tell VBA to connect to events once this objects gets created
Dim WithEvents objView As XMLSpyLib.AuthenticView
' initialize the object somewhere in your code
...
Set objView = objSpy.ActiveDocument.AuthenticView
...

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Overview 901

' sample event handler for the OnMouseEvent of the object in objView
Private Function objView_OnMouseEvent (ByVal i_nXPos As Long, ByVal
i_nYPos As Long,
ByVal i_eMouseEvent As
XMLSpyLib.SPYMouseEvent,
ByVal i_pRange As
XMLSpyLib.IAuthenticRange ) As Boolean
If (i_eMouseEvent = (XMLSpyLib.spyLeftButtonDownMask Or
XMLSpyLib.spyCtrlKeyDownMask)) Then
On Error Resume Next
i_pRange.Select
objView_OnMouseEvent = True
Else
objView_OnMouseEvent = False
End If
End Function

Windows Scripting Technologies - VBScript


Use the method WScript.ConnectObject to receive events.

' the event handler function


Function DocEvent_OnBeforeCloseDocument(objDocument)
Call WScript.Echo("received event - before closing document")
End Function

' create or connect to XMLSPY


Set objWshShell = WScript.CreateObject("WScript.Shell")
Set objFSO = WScript.CreateObject("Scripting.FileSystemObject")
Set objSpy = WScript.GetObject("", "XMLSpy.Application")
' If only Authentic is installed (and XMLSpy is not installed) use:
' Set objSpy = WScript.GetObject("", "AuthenticDesktop.Application")

' create document object and connect to its events


objSpy.Visible = True
Set objDoc = objSpy.Documents.OpenFile ("C:\\Program
Files\\Altova\\XMLSPY2004\\Examples\\OrgChart.xml", False)
Call WScript.ConnectObject(objDoc, "DocEvent_")

' keep running while waiting on the event


' in the meantime close the document in XMLSPY manually
Call WScript.Echo ("sleeping for 10 seconds ...")
Call WScript.Sleep (10000)

Set objDoc = Nothing


Call WScript.Echo ("stopped listening for event")
Call objSpy.Quit

Windows Scripting Technologies - JScript


Use the method WScript.ConnectObject to receive events.

// the event handler function


function DocEvent_OnBeforeCloseDocument(objDocument)
{
WScript.Echo("received event - before closing document");
}

// create or connect to XMLSPY


try
{
// create the environment and XMLSPY
objWshShell = WScript.CreateObject("WScript.Shell");
objFSO = WScript.CreateObject("Scripting.FileSystemObject");
objSpy = WScript.GetObject("", "XMLSpy.Application");
// If only Authentic is installed (and XMLSpy is not installed) use:
// objSpy = WScript.GetObject("", "AuthenticDesktop.Application")

© 2010 Altova GmbH Programmers' Reference


902 The XMLSpy API Overview

}
catch(err)
{ WScript.Echo ("Can't create WScript.Shell object or XMLSPY"); }

// create document object and connect to its events


objSpy.Visible = true;
objDoc = objSpy.Documents.OpenFile ("C:\\Program
Files\\Altova\\XMLSPY2004\\Examples\\OrgChart.xml", false);
WScript.ConnectObject(objDoc, "DocEvent_");

// keep running while waiting on the event


// in the meantime close this document in XMLSPY manually
WScript.Echo ("sleeping for 10 seconds ...");
WScript.Sleep (10000);

objDoc = null;
WScript.Echo ("stopped listening for event");
objSpy.Quit();

C++
The following is an excerpt of a C++ client using connection points via ATL

#import "XMLSpy.tlb"
// If only Authentic is installed (and XMLSpy is not installed) use:
// #import "Authentic.tlb"

using namespace XMLSpyLib;

static const int XMLSPYSE_APPLICATION_SOURCE_ID = 0;


class XMLSpySEApplicationEventPump;

// nested class to receive application events


typedef IDispEventImpl< XMLSPYSE_APPLICATION_SOURCE_ID,
XMLSpySEApplicationEventPump,
&DIID__IApplicationEvents,
&LIBID_XMLSpyLib, TYPELIB_MAJ, TYPELIB_MIN >
XMLSpySEApplicationEventImpl;

// the class receiving the application events using a sink map


class XMLSpySEApplicationEventPump :
public XMLSpySEApplicationEventImpl
{
private:
static _ATL_FUNC_INFO Info_OnBeforeOpenProject;

public:
XMLSpySEApplicationEventPump ();
~XMLSpySEApplicationEventPump();

// connection point events on XMLSpySEApplicationEventImpl


public:
void __stdcall OnBeforeOpenProject (IFileSelectionDlg
*io_ipDlg);

BEGIN_SINK_MAP(XMLSpySEApplicationEventPump)
// OnBeforeOpenProject
SINK_ENTRY_INFO(XMLSPYSE_APPLICATION_SOURCE_ID,
DIID__IApplicationEvents,
1, OnBeforeOpenProject,
&Info_OnBeforeOpenProject)
END_SINK_MAP()
};

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Overview 903

// we use here explicit declaration of event signature to avoid loading


the typelib
_ATL_FUNC_INFO XMLSpySEApplicationEventPump::Info_OnBeforeOpenProject =
{CC_STDCALL, VT_EMPTY, 1, {VT_DISPATCH}};

XMLSpySEApplicationEventPump::XMLSpySEApplicationEventPump ()
{
...
// get an IUnknown pointer to XMLSpy application from somewhere and
store it in ipXMLSPY
HRESULT hRes = XMLSpySEApplicationEventImpl::DispEventAdvise(ipXMLSPY,
&DIID__IApplicationEvents);
...
}

XMLSpySEApplicationEventPump::~XMLSpySEApplicationEventPump()
{
...
// disconnect from connection point
HRESULT hRes =
XMLSpySEApplicationEventImpl::DispEventUnadvise(ipXMLSPY,
&DIID__IApplicationEvents);
...
}

// the handler for the OnBeforeOpenProject event


void __stdcall XMLSpySEApplicationEventPump::OnBeforeOpenProject
(IFileSelectionDlg *io_ipDlg)
{
// do something with io_ipDlg here
}

4.1.5 Import and export of data


Before you implement your import and export tasks with the XMLSpy API, it is a good practice
to test the connections, parameters, SQL queries and so on in XMLSpy. This way, you are able
to verify the results and to make quick adjustments to all import or export parameters.

Most of the methods for importing and exporting data are placed in the Application object,
the remaining functions are accessible via the Document interface.

There is some preparatory work necessary, before the actual import or export can be started.
Every import/export job consists of two parts. You need to define a connection to your data and
the specific behaviour for the import/export process.

In case of an import, the connection is either a database, a text-file or a Word document. The
behaviour is basically which data (columns) should be imported in XMLSpy.

In case of an export, the connection is either a database or a text file. Specify which data
(elements of the XML file) and additional parameters (e.g. automatic key generation or number
of sub-levels) to use from the XML-structure for the behaviour.

The properties in the DatabaseConnection, TextImportExportSettings and


ExportSettings interfaces have default values. See the corresponding descriptions in the
Interfaces chapter for further information.

Import from database


These are the steps to establish a connection to an existing database for import:

1. Use a DatabaseConnection object and set the properties:


The method Application.GetDatabaseSettings returns a new object for a

© 2010 Altova GmbH Programmers' Reference


904 The XMLSpy API Overview

database connection:

Dim objImpSettings As DatabaseConnection


Set objImpSettings = objSpy.GetDatabaseSettings

You have to set either an ADO connection string,


 objImpSettings.ADOConnection = strADOConnection

or the path to an existing database file:


 objImpSettings.File = "C:\myDatabase.mdb"

To complete the settings you create a SQL select statement to define the data to be queried:
 objImpSettings.SQLSelect = "SELECT * FROM myTable"

2. Call Application.GetDatabaseImportElementList to get a collection of the


resulting columns of the SQL query:
Dim objElementList As ElementList
Set objElementList =
objSpy.GetDatabaseImportElementList(objImpSettings)

This collection gives you the opportunity to control which columns should be imported
and what type the new elements will become. Each item of the collection represents
one column to import. If you remove an item, the corresponding column will not be
imported. You can additionally modify the ElementListItem.ElementKind
property, to set the type of the created XML elements for each column.

Please consider that GetDatabaseImportElementList() executes the SQL query


and could initiate a time consuming call. To avoid this, it is possible to pass a
null-pointer (Nothing in VisualBasic) as the second parameter to
ImportFromDatabase() to import all columns as plain XML elements.

3. Start the import with Application.ImportFromDatabase:

Dim objImpDoc As Document


Set objImpDoc =
objSpy.ImportFromDatabase(objImpSettings,objElementList)

Import from Text


Importing data from a text file is similar to the import from a database. You must use other
interfaces (described in steps 1-3 below) with different methods and properties:

1. Use a TextImportExportSettings object and set the properties:


The method Application.GetTextImportExportSettings returns a new object
to specify a text file for import.
Dim objImpSettings As TextImportExportSettings
Set objImpSettings = objSpy.GetTextImportExportSettings

You have to set at least the ImportFile property to the path of the file for the import.
Another important property is HeaderRow. Set it to False, if the text file does not
contain a leading line as a header row.

objImpSettings.ImportFile = "C:\myFile.txt"
objImpSettings.HeaderRow = False

Call Application.GetTextImportElementList to get a collection of all columns

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Overview 905

inside the text file:

Dim objElementList As ElementList


Set objElementList = objSpy.GetTextImportElementList(objImpSettings)

3. Start the import with Application.ImportFromText:

Dim objImpDoc As Document


Set objImpDoc = objSpy.ImportFromText(objImpSettings,objElementList)

Export to database

1. Use a DatabaseConnection object and set the necessary properties.


All properties except SQLSelect are important for the export. ADOConnection or
File defines the target for the output. You need to set only one of them.

2. Fill an ExportSettings object with the required values.


These properties are the same options as those available in the export dialog of
XMLSpy. Select the menu option Convert | Export to Text files/Database to see the
options and try a combination of export settings. After that it is easy to transfer these
settings to the properties of the interface.

Call "Application.GetExportSettings" to get a ExportSettings object:

Dim objExpSettings As ExportSettings


Set objExpSettings = objSpy.GetExportSettings

objExpSettings.CreateKeys = False
objExpSettings.ExportAllElements = False
objExpSettings.SubLevelLimit = 2

3. Build an element list with Document.GetExportElementList.


The element list enables you to eliminate XML elements from the export process. It also
gives you information about the record and field count in the RecordCount and
FieldCount properties. Set the ExportSettings.ElementList property to this
collection. It is possible to set the element list to null/Nothing (default) to export all
elements.

4. Call Document.ExportToDatabase to execute the export.


The description of the ExportToDatabase method contains also a code example for
a database export.

Export to text

1. Use a TextImportExportSettings object and set the necessary properties.

2. Fill an ExportSettings object with the required values.


See item number 2 from "Export to database" earlier on this page.

3. Build an element list with Document.GetExportElementList.


See item number 3 from "Export to database" earlier on this page.

4. Call Document.ExportToText to execute the export.


The description of the ExportToText method contains also a code example for a
database export.

© 2010 Altova GmbH Programmers' Reference


906 The XMLSpy API Overview

4.1.6 Using XMLData to modify document structure


XMLData gives you access to the elements of an currently open XML file. It enables you to
perform all necessary modifications to the elements of the XML structure. The main functionality
of XMLData is:

1. Access to the names and values of all kinds of elements (e.g. elements, attributes)

2. Creation of new elements of all kinds.

3. Insertion and appending of new elements.

4. Erasing of existing child elements.

Structure of XMLData
Before you can use the XMLData interface, you have to know how an existing XML file is
mapped into a XMLData structure. One major thing you must be aware of is, that XMLData has
no separate branch of objects for attributes.

The attributes of an element are also children of the element. The XMLData.Kind property,
gives you the opportunity to distinguish between the different types of children of an element.

Example:

This XML code,

<ParentElement>
<FirstChild attr1="Red" attr2="Black">
This is the value of FirstChild
</FirstChild>
<SecondChild>
<!--Your Comment-->
</DeepChild>
</SecondChild>
This is Text
</ParentElement>

is mapped to the following XMLData object structure:

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Overview 907

The parent of all XML elements inside of a document is the property Document.RootElement
. The first element of a document's content - without the XML prolog - is accessible with the
property Docum ent.DataRoot . Use one of these XMLData objects to get references to all other
XML elements in the structure.

Name and value of elements


To get and to modify the name and value of all types of XML elements use the XMLData.Name
and XMLData.TextValue properties. It is possible that several kinds of XMLData objects and
empty elements do not have a text value associated.

Creation and insertion of new XMLData objects


The creation of a new XML language entity requires the following steps:

1. Create the new XMLData object:


Use the Document.CreateChild method to create a new XMLData object. Set name
and value after you have inserted the new XML entity (see point 3).
2. Find the correct location for the new XMLData object:
To insert a new XMLData object you have to get a reference to the parent first. If the
new child is to become the last child of the parent, use the XMLData.AppendChild
method to insert the XMLData object. If the new child should be located elsewhere in
the sequence of child objects, use the XMLData.GetFirstChild and
XMLData.GetNextChild to move the iterator to the child before which the new child
should be inserted.
3. Insert the new child with XMLData.InsertChild. The new child will be inserted
immediately before the current child.

© 2010 Altova GmbH Programmers' Reference


908 The XMLSpy API Overview

The following example adds a third child between <FirstChild> and the <SecondChild>
element:
Dim objParent As XMLData
Dim objChild As XMLData
Dim objNewChild As XMLData

Set objNewChild = objSpy.ActiveDocument.CreateChild(spyXMLDataElement)

'objParent is set to <ParentElement>


'GetFirstChild(-1) gets all children of the parent element
'and move to <SecondChild>
Set objChild = objParent.GetFirstChild(-1)
Set objChild = objParent.GetNextChild

objParent.InsertChild objNewChild
objNewChild.Name = "OneAndAHalf"
Set objNewChild = Nothing

Child elements should be inserted in a special order. Please avoid inserting attributes into a
sequence after any other child elements, i.e. make sure that attributes are placed first.

Copying of existing XMLData objects


If you want to insert existing XMLData objects at a different place in the same document or into
another document you can't use the XMLData.InsertChild and XMLData.AppendChild
methods. These methods only work for new XMLData objects.

Instead of using InsertChild or AppendChild you have to copy the object hierarchy
manually. The following function written in JavaScript is an example for recursively copying
XMLData:

// -----------------------------------------------------------
// XMLSpy scripting environment - GlobalDeclarations - JScript
// return a deep copy of the XMLData Object.
// the new object is owned by the document sepcified in objDoc
// -----------------------------------------------------------
function XMLDataDeepCopy(objXMLData, objDoc)
{
// create new element of same kind
var objNew = objDoc.CreateChild(objXMLData.Kind);

// copy name, some element have default names and do not


// allow to modifying these names.
try
{ objNew.Name = objXMLData.Name; }
catch (e)
{
if ((e.number & 0xffff) != 1513) // modification operation not allowed
throw(e);
}

// copy the text value


objNew.TextValue = objXMLData.TextValue;

// copy and insert all children


if(objXMLData.HasChildren)
{
var objChild = objXMLData.GetFirstChild(-1);

while(objChild)
{
try

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Overview 909

{
objNew.AppendChild(XMLDataDeepCopy(objChild, objDoc));
objChild = objXMLData.GetNextChild();
}
catch(e)
{
if ((e.number & 0xffff) == 1503) // end of list
objChild = null;
else
throw(e);
}
}
}

return objNew;
}

Erasing of XMLData objects


XMLData provides two methods for the deletion of child objects,
XMLData.EraseAllChildren and XMLData.EraseCurrentChild.

To erase XMLData objects you need access to the parent of the elements you want to remove.
Use XMLData.GetFirstChild and XMLData.GetNextChild to get a reference to the
parent XMLData object.

See the method descriptions of EraseAllChildren and EraseCurrentChild for examples


how to erase XML elements.

4.1.7 The DOM and XMLData


The XMLData interface gives you full access to the XML structure behind the current document
with less methods than DOM and is much simpler. The XMLData interface is a minimalist
approach to reading and modifying existing, or newly created XML data. You might however,
want to use a DOM tree because you can access one from an external source or you just prefer
the MSXML DOM implementation.

The ProcessDOMNode() and ProcessXMLDataNode() functions provided below convert


any segments of an XML structure between XMLData and DOM.

To use the ProcessDOMNode() function:


 pass the root element of the DOM segment you want to convert in objNode and
 pass the plugin object with the CreateChild() method in objCreator

To use the ProcessXMLDataNode() function:


 pass the root element of the XMLData segment in objXMLData and
 pass the DOMDocument object created with MSXML in xmlDoc

////////////////////////////////////////////////////////////////
// DOM To XMLData conversion
Function ProcessDOMNode(objNode,objCreator)
{
var objRoot;
objRoot = CreateXMLDataFromDOMNode(objNode,objCreator);

If(objRoot) {

© 2010 Altova GmbH Programmers' Reference


910 The XMLSpy API Overview

If((objNode.nodeValue != Null) && (objNode.nodeValue.length > 0))


objRoot.TextValue = objNode.nodeValue;
// add attributes
If(objNode.attributes) {
var Attribute;
var oNodeList = objNode.attributes;

For(var i = 0;i < oNodeList.length; i++) {


Attribute = oNodeList.item(i);

var newNode;
newNode = ProcessDOMNode(Attribute,objCreator);

objRoot.AppendChild(newNode);
}
}
If(objNode.hasChildNodes) {
try {
// add children
var Item;
oNodeList = objNode.childNodes;

For(var i = 0;i < oNodeList.length; i++) {


Item = oNodeList.item(i);

var newNode;
newNode = ProcessDOMNode(Item,objCreator);

objRoot.AppendChild(newNode);
}
}
catch(err) {
}
}
}
Return objRoot;
}

Function CreateXMLDataFromDOMNode(objNode,objCreator)
{
var bSetName = True;
var bSetValue = True;

var nKind = 4;

switch(objNode.nodeType){
Case 2:nKind = 5;break;
Case 3:nKind = 6;bSetName = False;break;
Case 4:nKind = 7;bSetName = False;break;
Case 8:nKind = 8;bSetName = False;break;
Case 7:nKind = 9;break;
}
var objNew = Null;
objNew = objCreator.CreateChild(nKind);

If(bSetName)
objNew.Name = objNode.nodeName;

If(bSetValue && (objNode.nodeValue != Null))


objNew.TextValue = objNode.nodeValue;

Return objNew;
}
////////////////////////////////////////////////////////////////
// XMLData To DOM conversion

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Overview 911

Function ProcessXMLDataNode(objXMLData,xmlDoc)
{
var objRoot;
objRoot = CreateDOMNodeFromXMLData(objXMLData,xmlDoc);

If(objRoot) {
If(IsTextNodeEnabled(objRoot) && (objXMLData.TextValue.length > 0))
objRoot.appendChild(xmlDoc.createTextNode(objXMLData.TextValue));

If(objXMLData.HasChildren) {
try {
var objChild;
objChild = objXMLData.GetFirstChild(-1);

While(True) {
If(objChild) {
var newNode;
newNode = ProcessXMLDataNode(objChild,xmlDoc);

If(newNode.nodeType == 2){
// child node is an attribute
objRoot.attributes.setNamedItem(newNode);
}
Else
objRoot.appendChild(newNode);
}
objChild = objXMLData.GetNextChild();
}
}
catch(err) {
}
}
}
Return objRoot;
}

Function CreateDOMNodeFromXMLData(objXMLData,xmlDoc)
{
switch(objXMLData.Kind){
Case 4:Return xmlDoc.createElement(objXMLData.Name);
Case 5:Return xmlDoc.createAttribute(objXMLData.Name);
Case 6:Return xmlDoc.createTextNode(objXMLData.TextValue);
Case 7:Return xmlDoc.createCDATASection(objXMLData.TextValue);
Case 8:Return xmlDoc.createComment(objXMLData.TextValue);
Case 9:Return
xmlDoc.createProcessingInstruction(objXMLData.Name,objXMLData.TextValue);
}

Return xmlDoc.createElement(objXMLData.Name);
}
Function IsTextNodeEnabled(objNode)
{
switch(objNode.nodeType) {
Case 1:
Case 2:
Case 5:
Case 6:
Case 11:Return True;
}
Return False;
}

4.1.8 Obsolete Authentic View Row operations


If the schema on which an XML document is based specifies that an element is repeatable,
such a structure can be represented in Authentic View as a table. When represented as a table,

© 2010 Altova GmbH Programmers' Reference


912 The XMLSpy API Overview

rows and their contents can be manipulated individually, thereby allowing you to manipulate
each of the repeatable elements individually. Such row operations would be performed by an
external script.

If an external script is to perform row operations then two steps must occur:
 The first step checks whether the cursor is currently in a row using a property. Such a
check could be, for example, IsRowInsertEnabled, which returns a value of either
TRUE or FALSE.
 If the return value is TRUE then a row method, such as RowAppend, can be called. (
RowAppend has no parameters and returns no value.)

The following is a list of properties and methods available for table operations. Each property
returns a BOOL, and the methods have no parameter.

Property Method Table operations


IsRowInsertEnabled RowInsert, superseded by Insert row operation
AuthenticRange.InsertRow
IsRowAppendEnabled RowAppend, superseded by Append row
AuthenticRange.AppendRow operation
IsRowDeleteEnabled RowDelete, superseded by Delete row operation
AuthenticRange.DeleteRow
IsRowMoveUpEnabled RowMoveUp, superseded by Move XML data up
AuthenticRange.MoveRowUp one row
IsRowMoveDownEnabled RowMoveDown, superseded by Move XML data down
AuthenticRange.MoveRowDown one row
IsRowDuplicateEnabled RowDuplicate, superseded by Duplicate currently
AuthenticRange.DuplicateRow selected row

4.1.9 Obsolete Authentic View Editing operations


When XML data is displayed as data in Authentic View, it is possible to manipulate individual
elements using standard editing operations such as cut, copy, and paste. However, not all XML
data nodes can be edited. So, in order to carry out an editing operation, first a property is used
to test whether editing is possible, and then a method is called to perform the editing operation.

The only method that does not have a test is the method EditSelectAll, which automatically
selects all elements displayed in the document.

The following is a list of properties and methods that perform editing operations. Each property
returns a BOOL, and the methods have no parameter.

Property Method Editing operation


IsEditUndoEnabled EditUndo, superseded by Undo an editing operation
AuthenticView.Undo
IsEditRedoEnabled EditRedo, superseded by Redo an editing operation
AuthenticView.Redo
IsEditCopyEnabled EditCopy, superseded by Copy selected text to the
AuthenticRange.Copy clipboard

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Overview 913

IsEditCutEnabled EditCut, superseded by Cut selected text to the


AuthenticRange.Cut clipboard
IsEditPasteEnabled EditPaste, superseded by Paste from clipboard to
AuthenticRange.Paste current cursor position
IsEditClearEnabled EditClear, superseded by Clear selected text from
AuthenticRange.Delete XML document

© 2010 Altova GmbH Programmers' Reference


914 The XMLSpy API Usage Examples

4.2 Usage Examples


The automation interface of XMLSpy can be used in many different ways and accessed from
different programming languages. In this section you will find sample code that show the
capabilities of the new AuthenticView and AuthenticRange interfaces. These samples should
make it easier for you to get started with your own project. Although they are more complex
then those you will find in the descriptions of the various methods and properties, they are
fragments and might require additional code or small adaptations in order for them to be
properly executed in your environment.

The listed code samples are:


 JScript: Bubble Sort Dynamic Tables
 VBScript: Using object-level events

This section also briefly describes some operations that can be performed within Authentic View
. This is to give you an idea of what is possible with the XMLSpy API.

Note: In the examples, GetObject("", "XMLSpy.Application")

4.2.1 JScript: Bubble Sort Dynamic Tables


The following JScript snippet will sort any dynamic table by the table column identified by the
current cursor position. The sort process is performed on screen. The undo buffer is available
for all performed operations.

If you can run JScript on you computer - as you most likely will - copy the following code into a
file with extension 'js'. Execute the script by double-clicking it in Windows Explorer, or run it from
the command line.

// some useful XMLSpy enum constants


var spyAuthenticTag = 6;
var spyAuthenticTable = 9;
var spyAuthenticTableRow = 10;
var spyAuthenticTableColumn = 11;

var spyAuthenticRangeBegin = 2;

// example call for the sort table function


try
{
var objSpy = WScript.GetObject("", "XMLSpy.Application");
// If only Authentic is installed (and XMLSpy is not installed) use:
// var objSpy = WScript.GetObject("", "AuthenticDesktop.Application")

// use current selection to indicate which column to sort


SortCurrentTable (objSpy.ActiveDocument.AuthenticView.Selection);
}
catch (err)
{ WScript.Echo ("Please open a document in authentic view, and select a
table column\n" +
"Error : (" + (err.number & 0xffff) + ")" +
err.description); }

// we assume that XMLSpy is running, a document with a dynamic table


// is open, and the cursor is in a table column that will
// be used for sorting.
function SortCurrentTable (objCursor)
{
if (objCursor.IsInDynamicTable())

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Usage Examples 915

{
// calculate current column index
var nColIndex = 0;
while (true)
{
// go left column-by-column
try { objCursor.GotoPrevious(spyAuthenticTableColumn); }
catch (err) { break; }
nColIndex++;
}

// count number of table rows, so the bubble loops become simpler.


// goto begin of table
var objTableStart =
objCursor.ExpandTo(spyAuthenticTable).CollapsToBegin().Clone();
var nRows = 1;
while (true)
{
// go down row-by-row
try { objTableStart.GotoNext(spyAuthenticTableRow); }
catch (err) { break; }
nRows++;
}

// bubble sort through table


for (var i = 0; i < nRows - 1; i++)
{
// select correct column in first table row
var objBubble =
objCursor.ExpandTo(spyAuthenticTable).CollapsToBegin().Clone();
objBubble.Goto (spyAuthenticTableColumn, nColIndex,
spyAuthenticRangeBegin).ExpandTo(spyAuthenticTag);

// bubble this row down as far as necessary


for (var j = 0; j < nRows - i - 1; j++)
{
var strField1 = objBubble.Text;
// now look for the comparison table cell: start of next row and right
of the correct column
var strField2 = objBubble.GotoNext(spyAuthenticTableRow).
Goto (spyAuthenticTableColumn, nColIndex,
spyAuthenticRangeBegin).
ExpandTo(spyAuthenticTag).Text;
if (strField1 > strField2)
{
objBubble.MoveRowUp(); // swap the rows
// and re-calculate objBubble to select the cell to bubble
objBubble.GotoNext(spyAuthenticTableRow).
Goto (spyAuthenticTableColumn, nColIndex,
spyAuthenticRangeBegin).
ExpandTo(spyAuthenticTag);
}
}
}
}
else
WScript.Echo ("please, select a table cell first");
}

4.2.2 VBScript: Using object-level events


Authentic view now supports event connection on a per-object basis. Implementation of this
feature is based on COM connection points and is available in environments that support this
mechanism.

© 2010 Altova GmbH Programmers' Reference


916 The XMLSpy API Usage Examples

The following example is a VB code snippet that shows how to connect to object-level events
from within a VB project.

'
----------------------------------------------------------------------------
' VB code snippet - connecting to object level events
'
----------------------------------------------------------------------------
Dim objSpy As XMLSpyLib.Application
' use VBA keyword WithEvents to automatically connect to object-level event
Dim WithEvents objView As XMLSpyLib.AuthenticView

' this is the event callback routine that will be connected to the
' OnSelectionChanged event of object objView
Private Sub objView_OnSelectionChanged (ByVal i_ipNewRange As
XMLSpyLib.IAuthenticRange)
MsgBox ("new selection: " & i_ipNewRange.Text)
End Sub

' this is the event callback routine that will be connected to the
' OnSelectionChanged event of object objView
Private Sub objView_OnSelectionChanged (ByVal i_ipNewRange As
XMLSpyLib.IAuthenticRange)
MsgBox ("new selection: " & i_ipNewRange.Text)
End Sub

' this is the event callback routine that will be connected to the
' OnMouseEvent event of object objView.
' If you click with the left mouse button while pressing a control key,
' the current selection will be set to the tag below the current
' mouse cursor position
Private Function objView_OnMouseEvent(ByVal i_nXPos As Long, ByVal i_nYPos
As Long, ByVal i_eMouseEvent As XMLSpyLib.SPYMouseEvent, ByVal i_pRange As
XMLSpyLib.IAuthenticRange) As Boolean
If (i_eMouseEvent = (XMLSpyLib.spyLeftButtonDownMask Or
XMLSpyLib.spyCtrlKeyDownMask)) Then
On Error Resume Next
i_pRange.Select
objView_OnMouseEvent = True
Else
objView_OnMouseEvent = False
End If
End Function

' connect to running XMLSpy application


' this code will most likely be in some Form_Load() subroutine
Set objSpy = GetObject("", "XMLSpy.Application")
' If only Authentic is installed (and XMLSpy is not installed) use:
' objSpy = GetObject("", "AuthenticDesktop.Application")

objSpy.ShowApplication (True)
If (objSpy.ActiveDocument Is Nothing) Then
Dim objDoc As XMLSpyLib.Document
Rem replace path below With a valid absolute path On your machine
Set objDoc = objSpy.Documents.OpenFile("InputData\orgchart.xml", False)
End If

If (objSpy.ActiveDocument.CurrentViewMode <> spyViewAuthentic) Then


objSpy.ActiveDocument.SwitchViewMode (spyViewAuthentic)
End If
Set objView = objSpy.ActiveDocument.AuthenticView
' now the object objView is set and selection change events are received

' continue here with something useful ...


' and serve the windows message loop

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Usage Examples 917

' if you want to stop receiving events from object objView


' add the following line somewhere appropriate
Set objView = Nothing

© 2010 Altova GmbH Programmers' Reference


918 The XMLSpy API Interfaces

4.3 Interfaces
Object Hierarchy
Application
SpyProject
SpyProjectItems
SpyProjectItem
Documents
Document
GridView
AuthenticView
AuthenticRange
AuthenticDataTransfer (previously DocEditDataTransfer)
OldAuthenticView (previously DocEditView, now obsolete, superseded by
AuthenticView and AuthenticRange)
AuthenticSelection (previously DocEditSelection, now obsolete,
superseded by AuthenticRange)
AuthenticEvent (previously DocEditEvent, now obsolete)
AuthenticDataTransfer (previously DocEditDataTransfer)
TextView
XMLData
Dialogs
CodeGeneratorDlg
FileSelectionDlg
SchemaDocumentationDlg
GenerateSampleXMLDlg
DTDSchemaGeneratorDlg
FindInFilesDlg
WSDLDocumentationDlg
WSDL20DocumentationDlg
XBRLDocumentationDlg
DatabaseConnection
ExportSettings
TextImportExportSettings
ElementList
ElementListItem

Enumerations

Description
This chapter contains the reference of the XMLSpy 1.5 Type Library.

Most of the given examples are written in VisualBasic. These code snippets assume that there
is a variable defined and set, called objSpy of type Application. There are also some code
samples written in JavaScript.

4.3.1 Application
See also

Methods
GetDatabaseImportElementList
GetDatabaseSettings
GetDatabaseTables
ImportFromDatabase
CreateXMLSchemaFromDBStructure

GetTextImportElementList

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 919

GetTextImportExportSettings
ImportFromText

ImportFromWord

ImportFromSchema

GetExportSettings

NewProject
OpenProject

AddMacroMenuItem
ClearMacroMenu

ShowForm

ShowApplication

URLDelete
URLMakeDirectory

Fi
ndInFi
l
es

Quit

Properties
Application
Parent

ActiveDocument
Documents

CurrentProject

Dialogs

WarningNumber
WarningText

Status
MajorVersion
MinorVersion
Edition
IsAPISupported
ServicePackVersion

Description
Application is the root for all other objects. It is the only object you can create by CreateObject
(VisualBasic) or other similar COM related functions.

Example

Dim objSpy As Application


Set objSpy = CreateObject("XMLSpy.Application")

© 2010 Altova GmbH Programmers' Reference


920 The XMLSpy API Interfaces

Events

OnBeforeOpenDocument
See also

Event: OnBeforeOpenDocument(objDialog as FileSelectionDlg)

Description
This event gets fired whenever a document gets opened via the OpenFile or OpenURL menu
command. It is sent after a document file has been selected but before the document gets
opened. The file selection dialog object is initialized with the name of the selected document file.
You can modify this selection. To continue the opening of the document leave the
Fi
l
eSel
ecti
onDl
g.Di
al
ogActi
on property of io_objDialog at its default value spyDialogO K . To
abort the opening of the document set this property to spyDialogCancel .

Examples
Given below are examples of how this event can be scripted.

XMLSpy scripting environment - VBScript:


Function On_BeforeOpenDocument(objDialog)
End Function

XMLSpy scripting environment - JScript:


functi
on On_BeforeOpenDocument(objDialog)
{
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (26, ...) //nEventId=26

OnBeforeOpenProject
See also

Event: OnBeforeOpenProject(objDialog as FileSelectionDlg)

Description
This event gets fired after a project file has been selected but before the project gets opened.
The file selection dialog object is initialized with the name of the selected project file. You can
modify this selection. To continue the opening of the project leave the
Fi
l
eSel
ecti
onDl
g.Di
al
ogActi
on property of io_objDialog at its default value spyDialogO K . To
abort the opening of the project set this property to spyDialogCancel .

Examples
Given below are examples of how this event can be scripted.

XMLSpy scripting environment - VBScript:


Function On_BeforeOpenProject(objDialog)
End Function

XMLSpy scripting environment - JScript:


functi
on On_BeforeOpenProject(objDialog)

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 921

{
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (25, ...) //nEventId=25

OnDocumentOpened
See also

Event: OnDocumentOpened(objDocument as Document)

Description
This event gets fired whenever a document opens in XMLSpy. This can happen due to opening
a file with the OpenFile or OpenURL dialog, creating a new file or dropping a file onto XMLSpy.
The new document gets passed as parameter. The operation cannot be canceled.

Examples
Given below are examples of how this event can be scripted.

XMLSpy scripting environment - VBScript:


Function On_OpenDocument(objDocument)
End Function

XMLSpy scripting environment - JScript:


functi
on On_OpenDocument(objDocument)
{
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (7, ...) //nEventId=7

OnProjectOpened
See also

Event: OnProjectOpened(objProject as SpyProject)

Description
This event gets fired whenever a project gets opened in XMLSpy. The new project gets passed
as parameter.

Examples
Given below are examples of how this event can be scripted.

XMLSpy scripting environment - VBScript:


Function On_OpenProject(objProject)
End Function

XMLSpy scripting environment - JScript:


functi
on On_OpenProject(objProject)
{

© 2010 Altova GmbH Programmers' Reference


922 The XMLSpy API Interfaces

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (6, ...) //nEventId=6

ActiveDocument
See also

Property: ActiveDocument as Document

Description
Reference to the active document. If no document is open, ActiveDocum ent is null (nothing).

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

AddMacroMenuItem
See also

Method: AddMacroMenuItem(strMacro as String,strDisplayText as String)

Description
Adds a menu item to the Tools menu. This new menu item invokes the macro defined by
strM acro . See also "Calling macros from XMLSpy".

Errors
1111 The application object is no longer valid.
1100 Invalid parameter or invalid address for the return parameter was
specified.
1108 Number of macro items is limited to 16 items.

Application
See also

Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

ClearMacroMenu
See also

Method: ClearMacroMenu()

Return Value

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 923

None

Description
Removes all menu items from the Tools menu. See also Calling macros from XMLSpy".

Errors
1111 The application object is no longer valid.

CreateXMLSchemaFromDBStructure
See also

Method: CreateXMLSchemaFromDBStructure(pImportSettings as
DatabaseConnection,pTables as ElementList)

Description
CreateXMLSchemaFromDBStructure creates from a database specified in
pImportSettings for the defined tables in pTables new XML Schema document(s)
describing the database tables structure.

The parameter pTables specifies which table structures the XML Schema document should
contain. This parameter can be NULL, specifying that all table structures will be exported.

See also GetDataBaseTables.

Errors
1112 Invalid database specified.
1120 Database import failed.

CurrentProject
See also

Property: CurrentProject as SpyProject

Description
Reference to the active document. If no project is open, CurrentProj
ect is null (nothing).

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

Dialogs
See also

Property: Dialogs as Dialogs (read-only)

Description
Access the built-in dialogs of XMLSpy.

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

© 2010 Altova GmbH Programmers' Reference


924 The XMLSpy API Interfaces

Documents
See also

Property: Documents as Documents

Description
Collection of all open documents. See also Simple document access.

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

Edition
See also

Property: Edition as String

Description
Returns the edition of the application. Eg: Enterprise, Professional, Standard

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

FindInFiles
See also

Method: FindInFiles(pSettings as FindInFilesDlg) as FindInFilesResults

Description
Returns a FindInFilesResults object containing information about the files that matched the
specified settings.

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

GetDatabaseImportElementList
See also

Method: GetDatabaseImportElementList(pImportSettings as
DatabaseConnection)as ElementList

Description
The function returns a collection of El
em entLi
stItem s where the properties
ElementListItem.Name contain the names of the fields that can be selected for import and
the properties ElementListItem.ElementKind are initialized either to spyXMLDataAttr or
spyXMLDataElement, depending on the value passed in
DatabaseConnection.AsAttributes. This list serves as a filter to what finally gets
imported by a future call to ImportFromDatabase. Use ElementList.RemoveElement to
exclude fields from import.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 925

Properties mandatory to be filled out for the database connection are one of
DatabaseConnection.File, DatabaseConnection.ADOConnection and
DatabaseConnection.ODBCConnection, as well as DatabaseConnection.SQLSelect.
Use the property DatabaseConnection.AsAttributes to initialize
ElementListItem.ElementKind of the resulting element list to either spyXMLDataAttr or
spyXMLDataElement, respectively.

Example
See example at ImportFromDatabase.

Errors
1111 The application object is no longer valid.
1100 Invalid parameter or invalid address for the return parameter was
specified.
1107 Import from database failed.
1112 Invalid database specified.
1114 Select statement is missing.
1119 database element list import failed.

GetDatabaseSettings
See also

Method: GetDatabaseSettings() as DatabaseConnection

Description
GetDatabaseSettings creates a new object of database settings. The object is used to
specify database connection parameters for the methods GetDatabaseTables,
GetDatabaseImportElementList, ImportFromDatabase, ImportFromSchema and
ExportToDatabase.

Example
See example of ImportFromDatabase.

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

GetDatabaseTables
See also

Method: GetDatabaseTables(pImportSettings as DatabaseConnection)as


ElementList

Description
GetDatabaseTables reads the table names from the database specified in pImportSettings.
Properties mandatory to be filled out for the database connection are one of
DatabaseConnection.File, DatabaseConnection.ADOConnection and
DatabaseConnection.ODBCConnection. All other properties are ignored.
The function returns a collection of ElementListItems where the properties
ElementListItem.Name contain the names of tables stored in the specified database. The
remaining properties of ElementListItem are unused.

Errors

© 2010 Altova GmbH Programmers' Reference


926 The XMLSpy API Interfaces

1111 The application object is no longer valid.


1100 Invalid parameter or invalid address for the return parameter was
specified.
1112 Invalid database specified.
1113 Error while reading database table information.
1118 Database table query failed.

Example
Dim objImpSettings As DatabaseConnection
Set objImpSettings = objSpy.GetDatabaseSettings
objImpSettings.ADOConnection = TxtADO.Text

'store table names in list box


ListTables.Clear

Dim objList As ElementList


Dim objItem As ElementListItem
On Error GoTo ErrorHandler
Set objList = objSpy.GetDatabaseTables(objImpSettings)

For Each objItem In objList


ListTables.AddItem objItem.Name
Next

GetExportSettings
See also

Method: GetExportSettings()as ExportSettings (read-only)

Description
GetExportSetti
ngs creates a new object of common export settings. This object is used to pass
the parameters to the export functions and defines the behaviour of the export calls. See also
the export functions from Document and the examples at Import and Export.

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

GetTextImportElementList
See also

Method: GetTextImportElementList(pImportSettings as
TextImportExportSettings)as ElementList

Description
GetTextIm portElem entLi
st retrieves importing information about the text-file as specified in
pIm portSetti
ngs . The function returns a collection of El
em entLi
stItem s where the properties
ElementListItem.Name contain the names of the fields found in the file. The values of
remaining properties are undefined.

If the text-file does not contain a column header, set pImportSetti


ngs. HeaderRow to fse . The
al
resulting element list will contain general column names like 'Field1' and so on.

See also Import and export of data.

Errors

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 927

1111 The application object is no longer valid.


1100 Invalid parameter or invalid address for the return parameter was
specified.
1107 Import from database failed.
1115 Error during text element list import. Cannot create parser for import file.
1116 Error during text element list import.

Example
' ---------------------------------------------------------
' VBA client code fragment - import selected fields from text file
' ---------------------------------------------------------
Dim objImpSettings As TextImportExportSettings
Set objImpSettings = objSpy.GetTextImportExportSettings

objImpSettings.ImportFile = "C:\ImportMe.txt"
objImpSettings.HeaderRow = False

Dim objList As ElementList


Set objList = objSpy.GetTextImportElementList(objImpSettings)

'exclude first column


objList.RemoveItem 1

Dim objImpDoc As Document


On Error Resume Next
Set objImpDoc = objSpy.ImportFromText(objImpSettings, objList)
CheckForError

GetTextImportExportSettings
See also

Method: GetTextImportExportSettings() as TextImportExportSettings (read-only)

Description
GetTextImportExportSettings creates a new object of common import and export
settings for text files. See also the example for
Application.GetTextImportElementList and Import and Export.

See also Import and export of data.

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

ImportFromDatabase
See also

Method: ImportFromDatabase(pImportSettings as DatabaseConnection


,pEl
em entLi
st as ElementList)as Document

Return Value
Creates a new document containing the data imported from the database.

Description
Im portFrom Database imports data from a database as specified in pIm portSetti
ngs and creates
a new document containing the data imported from the database. Properties mandatory to be

© 2010 Altova GmbH Programmers' Reference


928 The XMLSpy API Interfaces

filled out are one of DatabaseConnection.File,


DatabaseConnection.ADOConnection or DatabaseConnection.ODBCConnection
and DatabaseConnection.SQLSelect. Additionally, you can use
DatabaseConnection.AsAttributes, DatabaseConnection.ExcludeKeys,
DatabaseConnection.IncludeEmptyElements and NumberDateTimeFormat to further
parameterize import.

The parameter pEl st specifies which fields of the selected data gets written into the
em entLi
newly created document, and which are created as elements and which as attributes. This
parameter can be NULL, specifying that all selected fields will be imported as XML elements.

See GetDatabaseSettings and GetDatabaseImportElementList for necessary steps


preceding any import of data from a database.

Errors
1111 The application object is no longer valid.
1100 Invalid parameter or invalid address for the return parameter was
specified.
1107 Import from database failed.
1112 Invalid database specified.
1114 Select statement is missing.
1117 Transformation to XML failed.
1120 Database import failed.

Example
Dim objImpSettings As DatabaseConnection
Set objImpSettings = objSpy.GetDatabaseSettings

objImpSettings.ADOConnection = strADOConnection
objImpSettings.SQLSelect = "SELECT * FROM MyTable"

Dim objDoc As Document


On Error Resume Next
Set objDoc = objSpy.ImportFromDatabase(objImpSettings,
objSpy.GetDatabaseImportElementList(objImpSettings))
' CheckForError here

ImportFromSchema
See also

Method: ImportFromSchema(pImportSettings as DatabaseConnection,strTable as


String,pSchemaDoc as Document)as Document

Return Value
Creates a new document filled with data from the specified database as specified by the
schema definition in pSchemaDoc.

Description
Im portFrom Schem a imports data from a database specified in pIm portSetti
ngs . Properties
mandatory to be filled out are one of DatabaseConnection.File,
DatabaseConnection.ADOConnection or DatabaseConnection.ODBCConnection.
Additionally, you can use DatabaseConnection.AsAttributes,
DatabaseConnection.ExcludeKeys and NumberDateTimeFormat to further
parameterize import. All other properties get ignored.

Im portFrom Schem a does not use and explicit SQL statement to select the data. Instead, it

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 929

expects a structure definition of the document to create in form of an XML schema document in
pSchemaDoc. From this definition the database select statement is automatically deduced.
Specify in strTable the table name of the import root that will become the root node in the new
document.

See GetDatabaseSettings and GetDatabaseTables for necessary steps preceding an


import from a database based on a schema definition. To create the schema definition file use
command 'create database schema' from the 'convert' menu of XMLSpy.

Errors
1111 The application object is no longer valid.
1100 Invalid parameter or invalid address for the return parameter was
specified.
1107 Import from database failed.
1112 Invalid database specified.
1120 Database import failed.
1121 Could not create validator for the specified schema.
1122 Failed parsing schema for database import.

ImportFromText
See also

Method: ImportFromText(pImportSettings as TextImportExportSettings,


pElementList as ElementList)as Document

Description
ImportFromText imports the text file as specified in pImportSettings. The parameter
pElementList can be used as import filter. Either pass the list returned by a previous call to
GetTextImportElementList or nul to import all columns. To avoid import of unnecessary
columns use ElementList.RemoveElement to remove the corresponding field names from
pEl st before calling Im portFrom Text .
em entLi
The method returns the newly created document containing the imported data. This document
is the same as the active document of XMLSpy.

See also Import and export of data.

Errors
1111 The application object is no longer valid.
1100 Invalid parameter or invalid address for the return parameter was
specified.
1107 Import from text file failed.
1117 Transformation to XML failed.

Example
' ---------------------------------------------------------
' VBA client code fragment - import from text file
' ---------------------------------------------------------
Dim objImpSettings As TextImportExportSettings
Set objImpSettings = objSpy.GetTextImportExportSettings

objImpSettings.ImportFile = strFileName
objImpSettings.HeaderRow = False

Dim objImpDoc As Document


On Error Resume Next
Set objImpDoc = objSpy.ImportFromText(objImpSettings,
objSpy.GetTextImportElementList(objImpSettings))

© 2010 Altova GmbH Programmers' Reference


930 The XMLSpy API Interfaces

CheckForError

ImportFromWord
See also

Method: ImportFromWord(strFile as String) as Document

Description
Im portFrom W ord imports the MS-Word Document st
rFi
l
e into a new XML document.

Errors
1111 The application object is no longer valid.
1100 Invalid parameter or invalid address for the return parameter was
specified.
Import from document failed.

IsAPISupported
See also

Property: IsAPISupported as Boolean

Description
Returns the whether the API is supported in this version or not.

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

MajorVersion
See also

Property: MajorVersion as Integer

Description
Returns the versions major number of the application.

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

MinorVersion
See also

Property: MinorVersion as Integer

Description
Returns the versions minor number of the application.

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 931

NewProject
See also

Method: NewProject(strPath as String,bDiscardCurrent as Boolean)

Description
NewProject creates a new project.

If there is already a project open that has been modified and bDiscardCurrent is false, then
NewProj ect() fails.

Errors
1111 The application object is no longer valid.
1102 A project is already open but bDiscardCurrent is true.
1103 Creation of new project failed.

OpenProject
See also

Method: OpenProject(strPath as String,bDiscardCurrent as Boolean,bDialog as


Boolean)

Parameters
strPath
Path and file name of the project to open. Can be empty if bDi
al
og is true.

bDi
scardCurrent
Discard currently open project and possible lose changes.

bDi
al
og
Show dialogs for user input.

Return Value
None

Description
OpenProject opens an existing project. If there is already a project open that has been modified
and bDiscardCurrent is false, then OpenProject() fails.

Errors
1111 The application object is no longer valid.
1100 Invalid parameter or invalid address for the return parameter was
specified.
1101 Cannot open specified project.
1102 A project is already open but bDiscardCurrent is true.

Parent
See also

Property: Parent as Application (read-only)

© 2010 Altova GmbH Programmers' Reference


932 The XMLSpy API Interfaces

Description
Access the XMLSpy application object.

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

Quit
See also

Method: Quit()

Return Value
None

Description
This method terminates XMLSpy. All modified documents will be closed without saving the
changes. This is also true for an open project.

If XMLSpy was automatically started as an automation server by a client program, the


application will not shut down automatically when your client program shuts down if a project or
any document is still open. Use the Quit method to ensure automatic shut-down.

Errors
1111 The application object is no longer valid.

ReloadSettings
See also

Method: ReloadSettings

Return Value

Description
The application settings are reloaded from the registry.

Available with TypeLibrary version 1.5

Errors
1111 The application object is no longer valid.

RunMacro
See also

Method: RunMacro(strMacro as String)

Return Value

Description
Calls the specified macro either from the project scripts (if present) or from the global scripts.

Available with TypeLibrary version 1.5

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 933

Errors
1111 The application object is no longer valid.

ScriptingEnvironment
See also

Property: ScriptingEnvironment as IUnknown (read-only)

Description
Reference to any active scripting environment. This property makes it possible to access the
TypeLibrary of the XMLSpyFormEditor.exe application which is used as the current scripting
environment.

Available with TypeLibrary version 1.5

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

ServicePackVersion
See also

Property: ServicePackVersion as Long

Description
Returns the Service Pack version number of the application. Eg: 1 for 2010 R2 SP1

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

ShowApplication
See also

Method: ShowApplication(bShow as Boolean)

Return Value
None

Description
The method shows (bShow = True) or hides (bShow = Fal
se) XMLSpy.

Errors
1110 The application object is no longer valid.

ShowFindInFiles
See also

Method: ShowFindInFiles (pSetti


ngs as Fi
ndInFi
l
esDl
g ) as Boolean

Return Value
Returns false if the user pressed the Cancel button, true otherwise.

© 2010 Altova GmbH Programmers' Reference


934 The XMLSpy API Interfaces

Description
Displays the FindInFiles dialog preset with the given settings. The user modifications of the
settings are stored in the passed dialog object.

Errors
1111 The application object is no longer valid.
1100 Invalid parameter or invalid address for the return parameter was
specified.

ShowForm
See also

Method: ShowForm(strFormName as String) as Long

Return Value
Returns zero if the user pressed a Cancel button or the form calls TheView.Cancel() .

Description
Displays the form strForm Nam e .

Forms, event handlers and macros can be created with the Scripting Environment. Select
"Switch to scripting environment" from the Tools menu to invoke the Scripting Environment.

Errors
1111 The application object is no longer valid.
1100 Invalid parameter or invalid address for the return parameter was
specified.

Status
See also

Property: Status as ENUMApplicationStatus

Description
Returns the current status of the running application.

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

URLDelete
See also

Method: URLDelete(strURL as String,strUser as String,strPassword as String)

Return Value
None

Description
The method deletes the file at the URL strURL .

Errors

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 935

1111 The application object is no longer valid.


1109 Error deleting file at specified URL.

URLMakeDirectory
See also

Method: URLMakeDirectory(strURL as String,strUser as String,strPassword as String


)

Return Value
None

Description
The method creates a new directory at the URL strURL .

Errors
1111 The application object is no longer valid.
1100 Invalid parameter specified.

Visible
See also

Property: Visible as Boolean

Description
Sets or gets the visibility attribute of XMLSpy. This standard automation property makes usage of
ShowAppli
cati
on obsolete.

Errors
1110 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

WarningNumber
See also

Property: WarningNumber as integer

Description
Some methods fill the property W arningNum ber with additional information if an error occurs.

Currently just Documents.OpenFile fills this property.

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

WarningText
See also

Property: WarningText as String

© 2010 Altova GmbH Programmers' Reference


936 The XMLSpy API Interfaces

Description
Some methods fill the property W arni
ngText with additional information if an error occurs.

Currently just Documents.OpenFile fills this property.

Errors
1111 The application object is no longer valid.
1100 Invalid address for the return parameter was specified.

4.3.2 AuthenticContextMenu
The context menu interface provides the mean for the user to customize the context menus
shown in Authentic. The interface has the methods listed in this section.

CountItems
Method: CountItems()

Return Value
Returns number of menu items.

Errors
2501 Invalid object.

DeleteItem
Method: DeleteItem(position as integer)

Return Value
Deletes an existing menu item.

Errors
2501 Invalid object
2502 Invalid index

GetItemText
Method: GetItemText(position as integer) menu item name as string

Return Value
Gets the menu item's name.

Errors
2501 Invalid object
2502 Invalid index

InsertItem
Method: InsertItem(position as integer, menu item name as string, macro name
as string)

Return Value
Inserts a user-defined menu item. The menu item will start a macro, so a valid macro name must be
submitted.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 937

Errors
2501 Invalid object
2502 Invalid index
2503 No such macro
2504 Internal error

SetItemText
Method: SetItemText(position as integer, menu item name as string)

Return Value
Sets the menu item's name.

Errors
2501 Invalid object
2502 Invalid index

4.3.3 AuthenticDataTransfer
Renamed from DocEditDataTransfer to AuthenticDataTransfer
The DocEditView object is renamed to OldAuthenticView .
DocEdi
tSelecti
on is renamed to Authenti
cSel
ecti
on .
DocEditEvent is renamed to Authenti cEvent .
DocEditDataTransfer is renamed to Authenti
cDataTransfer .

Their usage—except for Authenti cDataTransfer —is no longer recommended. We


will continue to support existing functionality for a yet undefined period of time but
no new features will be added to these interface. All functionality available up to
now in DocEditView, DocEditSelection, DocEditEvent and
DocEditDataTransfer is now available via AuthenticView,
AuthenticRange and AuthenticDataTransfer. Many new features have
been added.

For examples on migrating from DocEdit to Authentic see the description of the
different methods and properties of the different DocEdit objects.

See also

Methods

getData

Properties

dropEffect
ownDrag
type

Description

The events O nDragO ver and O nBeforeDrop provide information about the object being dragged

© 2010 Altova GmbH Programmers' Reference


938 The XMLSpy API Interfaces

with an instance of type Authenti


cDataTransfer . It contains a description of the dragged object
and its content. The latter is available either as string or a pointer to a COM object supporting
the IUnkown interface.

dropEffect
See also

Property: dropEffect as long

Description
The property stores the drop effect from the default event handler. You can set the drop effect if
you change this value and return TRUE for the event handler (or set
AuthenticEvent.cancelBubble to T R U Eif you are still using the now obsolete
Authenti
cEvent interface).

Errors
2101 Invalid address for the return parameter was specified.

getData
See also

Method: getData() as Variant

Description
Retrieve the data associated with the dragged object. Depending on
AuthenticDataTransfer.type, that data is either a string or a COM interface pointer of
type IUnknown .

Errors
2101 Invalid address for the return parameter was specified.

ownDrag
See also

Property: ownDrag as Boolean (read-only)

Description
The property is T R U Eif the current dragging source comes from inside Authentic View.

Errors
2101 Invalid address for the return parameter was specified.

type
See also

Property: type as String (read-only)

Description
Holds the type of data you get with the DocEditDataTransfer.getData method.

Currently supported data types are:

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 939

OWN data from Authentic View itself


TEXT plain text
UNICODETEXT plain text as UNICODE

Errors
2101 Invalid address for the return parameter was specified.

4.3.4 AuthenticEventContext
The EventContext interface gives access to many properties of the context in which a macro is
executed.

EvaluateXPath
Method: EvaluateXPath (string expression) as string

Return Value
The method evaluates the XPath expression in the context of the node within which the event was
triggered and returns a string.

Description
EvaluateXPath() executes an XPath expressions with the given event context. The result is
returned as string, in the case of a sequence it is a space-separated string.

Errors
2201 Invalid object.
2202 No context.
2209 Invalid parameter.
2210 Internal error.
2211 XPath error.

GetEventContextType
Method: GetEventContextType () as EventContextType enumeration

Return Value
Returns the context node type.

Description
GetEventContextType allows the user to determine whether the macro is in an XML node or in
an XPath atomic item context. The enumeration AuthenticEventContextType is defined as
follows:

authenticEventContextXML,
authenticEventContextAtomicItem,
authenticEventContextOther

If the context is a normal XML node, the GetXMLNode() function gives access to it (returns NULL
if not).

Errors
2201 Invalid object.
2202 No context.
2209 Invalid parameter.

© 2010 Altova GmbH Programmers' Reference


940 The XMLSpy API Interfaces

GetNormalizedTextValue
Method: GetNormalizedTextValue() value as string

Return Value
Returns the value of the current node as string

Errors
2201 Invalid object.
2202 No context.
2203 Invalid context
2209 Invalid parameter.

GetVariableValue
Method: GetVariableValue(name as string, value as string)

Return Value
Gets the value of the named variable.

Description
GetVariableValue gets the variable's value in the scope of the context.

nZoom = parseInt( AuthenticView.EventContext.GetVariableValue( 'Zoom' ) );


if ( nZoom > 1 )
{
       AuthenticView.EventContext.SetVariableValue( 'Zoom', nZoom - 1 );
}

Errors
2201 Invalid object.
2202 No context.
2204 No such variable in scope
2205 Variable cannot be evaluated
2206 Variable returns sequence
2209 Invalid parameter

GetXMLNode
Method: GetXMLNode() XMLData object

Return Value
Returns the context XML node or NULL

Errors
2201 Invalid object.
2202 No context.
2203 Invalid context
2209 Invalid parameter.

IsAvailable
Method: IsAvailable()

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 941

Return Value
Returns true if EventContext is set.

Errors
2201 Invalid object.

SetVariableValue
Method: SetVariableValue(name as string, value as string)

Return Value
Sets the value of the named variable.

Description
SetVariableValue sets the variable's value in the scope of the context.

nZoom = parseInt( AuthenticView.EventContext.GetVariableValue( 'Zoom' ) );


if ( nZoom > 1 )
{
       AuthenticView.EventContext.SetVariableValue( 'Zoom', nZoom - 1 );
}

Errors
2201 Invalid object.
2202 No context.
2204 No such variable in scope
2205 Variable cannot be evaluated
2206 Variable returns sequence
2207 Variable read-only
2208 No modification allowed

4.3.5 AuthenticRange
See also

The first table lists the properties and methods of AuthenticRange that can be used to navigate
through the document and select specific portions.

Properties Methods
Appl i
cati
on Clone M oveBegin
Fi
rstTextPosi
ti
on CollapsToBegin M oveEnd
FirstXM LData CollapsToEnd NextCursorPositi
on
FirstXM LDataOffset ExpandTo Previ
ousCursorPositi
on
LastTextPosi ti
on G oto Sel
ect
LastXM LData G otoNext SelectNext
LastXM LDataOffset GotoPrevious SelectPrevi
ous
Parent IsEm pty SetFrom Range
IsEqual

The following table lists the content modification methods, most of which can be found on the
right/button mouse menu.

Properties Edit operations Dynamic table operations


Text Copy AppendR ow
Cut DeleteRow

© 2010 Altova GmbH Programmers' Reference


942 The XMLSpy API Interfaces

Delete DuplicateRow
IsCopyEnabled InsertRow
IsCutEnabled IsFirstRow
IsDeleteEnabl
ed IsInDynam icTable
IsPasteEnabled IsLastRow
Paste M oveR ow D ow n
M oveR ow U p

The following methods provide the functionality of the Authentic entry helper windows for range
objects.

Operations of the entry helper windows


Elements Attributes Entities
CanPerform ActionW ith GetEl em entAttri
buteValue GetEntityNam es
CanPerform Action GetElem entAttributeNam es I
nsert
Ent
i
y
Perform Acti
on GetElem entHierarchy
HasEl em entAttri
bute
IsTextStateAppli
ed
SetElem entAttri
buteValue

Description
AuthenticRange objects are the 'cursor' selections of the automation interface. You can use
them to point to any cursor position in the Authentic view, or select a portion of the document.
The operations available for AuthenticRange objects then work on this selection in the same
way, as the corresponding operations of the user interface do with the current user interface
selection. The main difference is that you can use an arbitrary number of AuthenticRange
objects at the same time, whereas there is exactly one cursor selection in the user interface.

To get to an initial range object use AuthenticView.Selection, to obtain a range


corresponding with the current cursor selection in the user interface. Alternatively, some trivial
ranges are accessible via the read/only properties AuthenticView.DocumentBegin,
AuthenticView.DocumentEnd, and AuthenticView.WholeDocument. The most flexible
method is AuthenticView.Goto, which allows navigation to a specific portion of the
document within one call. For more complex selections, combine the above, with the various
navigation methods on range objects listed in the first table on this page.

Another method to select a portion of the document is to use the position properties of the
range object. Two positioning systems are available and can be combined arbitrarily:
 Absolute text cursor positions, starting with position 0 at the document beginning, can
be set and retrieved for the beginning and end of a range. For more information see
FirstTextPosition and LastTextPosition. This method requires complex
internal calculations and should be used with care.
 The XMLData element and a text position inside this element, can be set and retrieved
for the beginning and end of a range. For more information see FirstXMLData,
FirstXMLDataOffset, LastXMLData, and LastXMLDataOffset. This method is
very efficient but requires knowledge on the underlying document structure. It can be
used to locate XMLData objects and perform operations on them otherwise not
accessible through the user interface.

Modifications to the document content can be achieved by various methods:


 The Text property allows you to retrieve the document text selected by the range
object. If set, the selected document text gets replaced with the new text.
 The standard document edit functions Cut, Copy, Paste and Delete.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 943

 Table operations for tables that can grow dynamically.


 Methods that map the functionality of the Authentic entry helper windows.
 Access to the XMLData objects of the underlying document to modify them directly.

AppendRow
See also

Method: AppendRow()as Boolean

Description
If the beginning of the range is inside a dynamic table, this method inserts a new row at the end
of the selected table. The selection of the range is modified to point to the beginning of the new
row. The function returns true if the append operation was successful, otherwise false.

Errors
2001 The authentic range object or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

Examples
' ---------------------------------------------------------
' XMLSpy scripting environment - VBScript
' Append row at end of current dynamically growable table
' ---------------------------------------------------------
Dim objRange
' we assume that the active document is open in authentic view mode
Set objRange = Application.ActiveDocument.AuthenticView.Selection

' check if we can insert something


If objRange.IsInDynamicTable Then
objRange.AppendRow
' objRange points to beginning of new row
objRange.Select
End If

Application
See also

Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
2001 The authentic range object or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

CanPerformAction
See also

Method: CanPerformAction (eAction as SPYAuthenticActions,strElementName as


String) as Boolean

Description
CanPerform Action and its related methods enable access to the entry-helper functions of

© 2010 Altova GmbH Programmers' Reference


944 The XMLSpy API Interfaces

Authentic. This function allows easy and consistent modification of the document content,
without having to know exactly where the modification will take place. The beginning of the
range object is used to locate the next valid location where the specified action can be
performed. If the location can be found, the method returns True, otherwise it returns False.

HINT: To find out all valid element names for a given action, use CanPerformActionWith.

Errors
2001 The authentic range object or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.
2007 Invalid action was specified.

Examples
See PerformAction.

CanPerformActionWith
See also

Method: CanPerformActionWith (eAction as SPYAuthenticActions,


out_arrElementNames as Variant)

Description
Perform ActionW ith and its related methods, enable access to the entry-helper functions of
Authentic. These function allows easy and consistent modification of the document content
without having to know exactly where the modification will take place.

This method returns an array of those element names that the specified action can be
performed with.

HINT: To apply the action use CanPerformActionWith.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.
2007 Invalid action was specified.

Examples
See PerformAction.

Clone
See also

Method: Clone() as AuthenticRange

Description
Returns a copy of the range object.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 945

CollapsToBegin
See also

Method: CollapsToBegin() as AuthenticRange

Description
Sets the end of the range object to its begin. The method returns the modified range object.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

CollapsToEnd
See also

Method: CollapsToEnd() as AuthenticRange

Description
Sets the beginning of the range object to its end. The method returns the modified range
object.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

Copy
See also

Method: Copy() as Boolean

Description
Returns False if the range contains no portions of the document that may be copied.
Returns True if text, and in case of fully selected XML elements the elements as well, has been
copied to the copy/paste buffer.

Errors
2001 The authentic range object or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

Cut
See also

Method: Cut() as Boolean

Description
Returns False if the range contains portions of the document that may not be deleted.
Returns True after text, and in case of fully selected XML elements the elements as well, has
been deleted from the document and saved in the copy/paste buffer.

Errors

© 2010 Altova GmbH Programmers' Reference


946 The XMLSpy API Interfaces

2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

Delete
See also

Method: Delete() as Boolean

Description
Returns False if the range contains portions of the document that may not be deleted.
Returns True after text, and in case of fully selected XML elements the elements as well, has
been deleted from the document.

Errors
2001 The authentic range object or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

DeleteRow
See also

Method: DeleteRow() as Boolean

Description
If the beginning of the range is inside a dynamic table, this method deletes the selected row.
The selection of the range gets modified to point to the next element after the deleted row. The
function returns true, if the delete operation was successful, otherwise false.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

Examples
' ---------------------------------------------------------
' XMLSpy scripting environment - VBScript
' Delete selected row from dynamically growing table
' ---------------------------------------------------------
Dim objRange
' we assume that the active document is open in authentic view mode
Set objRange = Application.ActiveDocument.AuthenticView.Selection

' check if we are in a table


If objRange.IsInDynamicTable Then
objRange.DeleteRow
End If

DuplicateRow
See also

Method: DuplicateRow() as Boolean

Description
If the beginning of the range is inside a dynamic table, this method inserts a duplicate of the
current row after the selected one. The selection of the range gets modified to point to the

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 947

beginning of the new row. The function returns true if the duplicate operation was successful,
otherwise false.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

Examples
' ---------------------------------------------------------
' XMLSpy scripting environment - VBScript
' duplicate row in current dynamically growable table
' ---------------------------------------------------------
Dim objRange
' we assume that the active document is open in authentic view mode
Set objRange = Application.ActiveDocument.AuthenticView.Selection

' check if we can insert something


If objRange.IsInDynamicTable Then
objRange.DuplicateRow
' objRange points to beginning of new row
objRange.Select
End If

EvaluateXPath
Method: EvaluateXPath (string expression) as string

Return Value
The method returns a string

Description
EvaluateXPath() executes an XPath expressions with the context node being the beginning of
the range selection. The result returned as string, in the case of a sequence it is a
space-separated string. If XML context node is irrelevant, the user may provide any node, like
AuthenticView.XMLDataRoot.

Errors
2001 Invalid object
2005 Invalid parameter
2008 Internal error
2202 Missing context node
2211 XPath error

ExpandTo
See also

Method: ExpandTo (eKind as SPYAuthenticElementKind), as AuthenticRange

Description
Selects the whole element of type eKind , that starts at, or contains, the first cursor position of
the range. The method returns the modified range object.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2003 Range expansion would be beyond end of document.
2005 Invalid address for the return parameter was specified.

© 2010 Altova GmbH Programmers' Reference


948 The XMLSpy API Interfaces

FirstTextPosition
See also

Property: FirstTextPosition as Long

Description
Set or get the left-most text position index of the range object. This index is always less or equal
to LastTextPosition. Indexing starts with 0 at document beginning, and increments with
every different position that the text cursor can occupy. Incrementing the test position by 1, has
the same effect as the cursor-right key. Decrementing the test position by 1 has the same effect
as the cursor-left key.

If you set Fi
rstTextPosi
ti
on to a value greater than the current LastTextPosition,
LastTextPosition gets set to the new Fi rstTextPosi
ti
on .

HINT: Use text cursor positions with care, since this is a costly operation compared to XMLData
based cursor positioning.

Errors
2001 The authentic range object, or its related view object is not valid.
2005 Invalid address for the return parameter was specified.
2006 A text position outside the document was specified.

Examples
' ---------------------------------------
' XMLSpy scripting environment - VBScript
' ---------------------------------------
Dim objAuthenticView
' we assume that the active document is open in authentic view mode
Set objAuthenticView = Application.ActiveDocument.AuthenticView

nDocStartPosition = objAuthenticView.DocumentBegin.FirstTextPosition
nDocEndPosition = objAuthenticView.DocumentEnd.FirstTextPosition

' let's create a range that selects the whole document


' in an inefficient way
Dim objRange
' we need to get a (any) range object first
Set objRange = objAuthenticView.DocumentBegin
objRange.FirstTextPosition = nDocStartPosition
objRange.LastTextPosition = nDocEndPosition

' let's check if we got it right


If objRange.isEqual(objAuthenticView.WholeDocument) Then
MsgBox "Test using direct text cursor positioning was ok"
Else
MsgBox "Ooops!"
End If

FirstXMLData
See also

Property: FirstXMLData as XMLData

Description
Set or get the first XMLData element in the underlying document that is partially, or completely
selected by the range. The exact beginning of the selection is defined by the

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 949

FirstXMLDataOffset attribute.

Whenever you set FirstXM LData to a new data object, FirstXMLDataOffset gets set to the
first cursor position inside this element. Only XMLData objects that have a cursor position may
be used. If you set FirstXM LData / FirstXMLDataOffset selects a position greater then the
current LastXMLData / LastXMLDataOffset, the latter gets moved to the new start position.

HINT: You can use the FirstXMLData and LastXMLData properties, to directly access and
manipulate the underlying XML document in those cases where the methods available with the
AuthenticRange object are not sufficient.

Errors
2001 The authentic range object, or its related view object is not valid.
2005 Invalid address for the return parameter was specified.
2008 Internal error
2009 The XMLData object cannot be accessed.

Examples
' -----------------------------------------------
' XMLSpy scripting environment - VBScript
' show name of currently selected XMLData element
' -----------------------------------------------
Dim objAuthenticView
' we assume that the active document is open in authentic view mode
Set objAuthenticView = Application.ActiveDocument.AuthenticView

Dim objXmlData
Set objXMLData = objAuthenticView.Selection.FirstXMLData
' authentic view adds a 'text' child element to elements
' of the document which have content. So we have to go one
' element up.
Set objXMLData = objXMLData.Parent
MsgBox "Current selection selects element " & objXMLData.Name

FirstXMLDataOffset
See also

Property: FirstXMLDataOffset as Long

Description
Set or get the cursor position offset inside FirstXMLData element for the beginning of the
range. Offset positions are based on the characters returned by the Text property, and start
with 0. When setting a new offset, use -1 to set the offset to the last possible position in the
element. The following cases require specific attention:
 The textual form of entries in Combo Boxes, Check Boxes and similar controls can be
different from what you see on screen. Although the data offset is based on this text,
there only two valid offset positions, one at the beginning and one at the end of the
entry. An attempt to set the offset to somewhere in the middle of the entry, will result in
the offset being set to the end.
 The textual form of XML Entities might differ in length from their representation on the
screen. The offset is based on this textual form.

If FirstXM LData / FirstXMLDataOffset selects a position after the current LastXMLData /


LastXMLDataOffset, the latter gets moved to the new start position.

Errors

© 2010 Altova GmbH Programmers' Reference


950 The XMLSpy API Interfaces

2001 The authentic range object, or its related view object is not valid.
2005 Invalid offset was specified.
Invalid address for the return parameter was specified.

Examples
' ---------------------------------------------
' XMLSpy scripting environment - VBScript
' Select the complete text of an XMLData element
' using XMLData based selection and ExpandTo
' ---------------------------------------------
Dim objAuthenticView
' we assume that the active document is open in authentic view mode
Set objAuthenticView = Application.ActiveDocument.AuthenticView

' first we use the XMLData based range properties


' to select all text of the first XMLData element
' in the current selection
Dim objRange
Set objRange = objAuthenticView.Selection
objRange.FirstXMLDataOffset = 0 ' start at beginning of element text
objRange.LastXMLData = objRange.FirstXMLData ' select only one element
objRange.LastXMLDataOffset = -1 ' select till its end

' the same can be achieved with the ExpandTo method


Dim objRange2
Set objRange2 = objAuthenticView.Selection.ExpandTo(spyAuthenticTag)

' were we successful?


If objRange.IsEqual(objRange2) Then
objRange.Select()
Else
MsgBox "Oops"
End If

GetElementAttributeNames
See also

Method: GetElementAttributeNames (strElementName as String,


out_arrAttributeNames as Variant)

Description
Retrieve the names of all attributes for the enclosing element with the specified name. Use the
element/attribute pairs, to set or get the attribute value with the methods
GetElementAttributeValue and SetElementAttributeValue.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid element name was specified.
Invalid address for the return parameter was specified.

Examples
See SetElementAttributeValue.

GetElementAttributeValue
See also

Method: GetElementAttributeValue (strElementName as String, strAttributeName


as String) as String

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 951

Description
Retrieve the value of the attribute specified in strAttri
buteNam e , for the element identified with
strElem entNam e . If the attribute is supported but has no value assigned, the empty string is
returned. To find out the names of attributes supported by an element, use
GetElementAttributeNames, or HasElementAttribute.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid element name was specified.
Invalid attribute name was specified.
Invalid address for the return parameter was specified.

Examples
See SetElementAttributeValue.

GetElementHierarchy
See also

Method: GetElementHierarchy (out_arrElementNames as Variant)

Description
Retrieve the names of all XML elements that are parents of the current selection. Inner
elements get listed before enclosing elements. An empty list is returned whenever the current
selection is not inside a single XM LD ata element.

The names of the element hierarchy, together with the range object uniquely identify XM LD ata
elements in the document. The attributes of these elements can be directly accessed by
GetElementAttributeNames, and related methods.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

C# Examples
' --------------------------------------------
' C#
' --------------------------------------------

namespace ConsoleApplication1
{
class Program
{
static void Main(string[] args)
{
XMLSpyLib.Application app = new XMLSpyLib.Application();

app.ShowApplication(true);

XMLSpyLib.AuthenticView view = app.ActiveDocument.AuthenticView;


XMLSpyLib.AuthenticRange range = view.DocumentBegin;

object o = null;
range.GetElementHierarchy(ref o);

object[] elements = (object[])o;

© 2010 Altova GmbH Programmers' Reference


952 The XMLSpy API Interfaces

foreach (string e in elements)


{
Console.WriteLine(e);
}
}
}
}

Also see: SetElementAttributeValue.

GetEntityNames
See also

Method: GetEntityNames (out_arrEntityNames as Variant)

Description
Retrieve the names of all defined entities. The list of retrieved entities is independent of the
current selection, or location. Use one of these names with the InsertEntity function.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

Examples
See: GetElementHierarchy and InsertEntity.

GetVariableValue
Method: GetVariableValue(name as string, value as string)

Return Value
Gets the value of the named variable.

Errors
2001 Invalid object.
2202 No context.
2204 No such variable in scope
2205 Variable cannot be evaluated
2206 Variable returns sequence
2209 Invalid parameter

Goto
See also

Method: Goto (eKind as SPYAuthenticElementKind, nCount as Long, eFrom as


SPYAuthenticDocumentPosition) as AuthenticRange

Description
Sets the range to point to the beginning of the nCount element of type eKind . The start position
is defined by the parameter eFrom .

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 953

Use positive values for nCount to navigate to the document end. Use negative values to
navigate to the beginning of the document. The method returns the modified range object.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2003 Target lies after end of document.
2004 Target lies before begin of document.
2005 Invalid element kind specified.
Invalid start position specified.
Invalid address for the return parameter was specified.

GotoNext
See also

Method: GotoNext (eKind as SPYAuthenticElementKind) as AuthenticRange

Description
Sets the range to the beginning of the next element of type eKind . The method returns the
modified range object.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2003 Target lies after end of document.
2005 Invalid element kind specified.
Invalid address for the return parameter was specified.

Examples
' --------------------------------------------
' XMLSpy scripting environment - VBScript
' Scan through the whole document word-by-word
' --------------------------------------------
Dim objAuthenticView
' we assume that the active document is open in authentic view mode
Set objAuthenticView = Application.ActiveDocument.AuthenticView

Dim objRange
Set objRange = objAuthenticView.DocumentBegin
Dim bEndOfDocument
bEndOfDocument = False

On Error Resume Next


While Not bEndOfDocument
objRange.GotoNext(spyAuthenticWord).Select
If ((Err.number - vbObjecterror) = 2003) Then
bEndOfDocument = True
Err.Clear
ElseIf (Err.number <> 0) Then
Err.Raise ' forward error
End If
Wend

GotoNextCursorPosition
See also

Method: GotoNextCursorPosition() as AuthenticRange

Description

© 2010 Altova GmbH Programmers' Reference


954 The XMLSpy API Interfaces

Sets the range to the next cursor position after its current end position. Returns the modified
object.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2003 Target lies after end of document.
2005 Invalid address for the return parameter was specified.

GotoPrevious
See also

Method: GotoPrevious (eKind as SPYAuthenticElementKind) as AuthenticRange

Description
Sets the range to the beginning of the element of type eKind which is before the beginning of
the current range. The method returns the modified range object.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2004 Target lies before beginning of document.
2005 Invalid element kind specified.
Invalid address for the return parameter was specified.

Examples
' --------------------------------------------
' XMLSpy scripting environment - VBScript
' Scan through the whole document tag-by-tag
' --------------------------------------------
Dim objAuthenticView
' we assume that the active document is open in authentic view mode
Set objAuthenticView = Application.ActiveDocument.AuthenticView

Dim objRange
Set objRange = objAuthenticView.DocumentEnd
Dim bEndOfDocument
bBeginOfDocument = False

On Error Resume Next


While Not bBeginOfDocument
objRange.GotoPrevious(spyAuthenticTag).Select
If ((Err.number - vbObjecterror) = 2004) Then
bBeginOfDocument = True
Err.Clear
ElseIf (Err.number <> 0) Then
Err.Raise ' forward error
End If
Wend

GotoPreviousCursorPosition
See also

Method: GotoPreviousCursorPosition() as AuthenticRange

Description
Set the range to the cursor position immediately before the current position. Returns the
modified object.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 955

Errors
2001 The authentic range object, or its related view object is no longer valid.
2004 Target lies before begin of document.
2005 Invalid address for the return parameter was specified.

HasElementAttribute
See also

Method: HasElementAttribute (strElementName as String, strAttributeName as


String) as Boolean

Description
Tests if the enclosing element with name strElem entNam e , supports the attribute specified in
strAttri
buteNam e .

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid element name was specified.
Invalid address for the return parameter was specified.

InsertEntity
See also

Method: InsertEntity (strEntityName as String)

Description
Replace the ranges selection with the specified entity. The specified entity must be one of the
entity names returned by GetEntityNames.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Unknown entry name was specified.

Examples
' ---------------------------------------------------------
' XMLSpy scripting environment - VBScript
' Insert the first entity in the list of available entities
' ---------------------------------------------------------
Dim objRange
' we assume that the active document is open in authentic view mode
Set objRange = Application.ActiveDocument.AuthenticView.Selection

' first we get the names of all available entities as they


' are shown in the entry helper of XMLSpy
Dim arrEntities
objRange.GetEntityNames arrEntities

' we insert the first one of the list


If UBound(arrEntities) >= 0 Then
objRange.InsertEntity arrEntities(0)
Else
MsgBox "Sorry, no entities are available for this document"
End If

© 2010 Altova GmbH Programmers' Reference


956 The XMLSpy API Interfaces

InsertRow
See also

Method: InsertRow() as Boolean

Description
If the beginning of the range is inside a dynamic table, this method inserts a new row before the
current one. The selection of the range, gets modified to point to the beginning of the newly
inserted row. The function returns true if the insert operation was successful, otherwise false.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

Examples
' -------------------------------------------------------------
' XMLSpy scripting environment - VBScript
' Insert row at beginning of current dynamically growing table
' -------------------------------------------------------------
Dim objRange
' we assume that the active document is open in authentic view mode
Set objRange = Application.ActiveDocument.AuthenticView.Selection

' check if we can insert something


If objRange.IsInDynamicTable Then
objRange.InsertRow
' objRange points to beginning of new row
objRange.Select
End If

IsCopyEnabled
See also

Property: IsCopyEnabled as Boolean (read-only)

Description
Checks if the copy operation is supported for this range.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

IsCutEnabled
See also

Property: IsCutEnabled as Boolean (read-only)

Description
Checks if the cut operation is supported for this range.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 957

IsDeleteEnabled
See also

Property: IsDeleteEnabled as Boolean (read-only)

Description
Checks if the delete operation is supported for this range.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

IsEmpty
See also

Method: IsEmpty() as Boolean

Description
Tests if the first and last position of the range are equal.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

IsEqual
See also

Method: IsEqual (objCmpRange as AuthenticRange) as Boolean

Description
Tests if the start and end of both ranges are the same.

Errors
2001 One of the two range objects being compared, is invalid.
2005 Invalid address for a return parameter was specified.

IsFirstRow
See also

Property: IsFirstRow() as Boolean (read-only)

Description
Test if the range is in the first row of a table. Which table is taken into consideration depends on
the extend of the range. If the selection exceeds a single row of a table, the check is if this table
is the first element in an embedding table. See the entry helpers of the user manual for more
information.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

© 2010 Altova GmbH Programmers' Reference


958 The XMLSpy API Interfaces

IsInDynamicTable
See also

Method: IsInDynamicTable() as Boolean

Description
Test if the whole range is inside a table that supports the different row operations like 'insert',
'append', duplicate, etc.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

IsLastRow
See also

Property: IsLastRow() as Boolean (read-only)

Description
Test if the range is in the last row of a table. Which table is taken into consideration depends on
the extend of the range. If the selection exceeds a single row of a table, the check is if this table
is the last element in an embedding table. See the entry helpers of the user manual for more
information.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

IsPasteEnabled
See also

Property: IsPasteEnabled as Boolean (read-only)

Description
Checks if the paste operation is supported for this range.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

IsSelected
Property: IsSelected as Boolean

Description
Returns true() if selection is present. The selection range still can be empty: that happens when
e.g. only the cursor is set.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 959

IsTextStateApplied
See also

Method: IsTextStateApplied (i_strElementName as String) as Boolean

Description
Checks if all the selected text is embedded into an XML Element with name i_strElem entNam e .
Common examples for the parameter i_strElem entNam e are "strong", "bold" or "italic".

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

LastTextPosition
See also

Property: LastTextPosition as Long

Description
Set or get the rightmost text position index of the range object. This index is always greater or
equal to FirstTextPosition. Indexing starts with 0 at the document beginning, and
increments with every different position that the text cursor can occupy. Incrementing the test
position by 1, has the same effect as the cursor-right key. Decreasing the test position by 1 has
the same effect as the cursor-left key.

If you set LastTextPosi


ti
on to a value less then the current FirstTextPosition,
FirstTextPosition gets set to the new LastTextPosi ti
on .

HINT: Use text cursor positions with care, since this is a costly operation compared to XMLData
based cursor positioning.

Errors
2001 The authentic range object, or its related view object is not valid.
2005 Invalid address for the return parameter was specified.
2006 A text position outside the document was specified.

Examples
' ---------------------------------------
' XMLSpy scripting environment - VBScript
' ---------------------------------------
Dim objAuthenticView
' we assume that the active document is open in authentic view mode
Set objAuthenticView = Application.ActiveDocument.AuthenticView

nDocStartPosition = objAuthenticView.DocumentBegin.FirstTextPosition
nDocEndPosition = objAuthenticView.DocumentEnd.FirstTextPosition

' let's create a range that selects the whole document


' in an inefficient way
Dim objRange
' we need to get a (any) range object first
Set objRange = objAuthenticView.DocumentBegin
objRange.FirstTextPosition = nDocStartPosition
objRange.LastTextPosition = nDocEndPosition

' let's check if we got it right

© 2010 Altova GmbH Programmers' Reference


960 The XMLSpy API Interfaces

If objRange.isEqual(objAuthenticView.WholeDocument) Then
MsgBox "Test using direct text cursor positioning was ok"
Else
MsgBox "Oops!"
End If

LastXMLData
See also

Property: LastXMLData as XMLData

Description
Set or get the last XM LD ata element in the underlying document that is partially or completely
selected by the range. The exact end of the selection is defined by the LastXMLDataOffset
attribute.

Whenever you set LastXM LData to a new data object, LastXMLDataOffset gets set to the
last cursor position inside this element. Only XM LD ata objects that have a cursor position may
be used. If you set LastXM LData / LastXMLDataOffset, select a position less then the
current FirstXMLData / FirstXMLDataOffset, the latter gets moved to the new end
position.

HINT: You can use the FirstXMLData and LastXMLData properties to directly access and
manipulate the underlying XML document in those cases, where the methods available with the
AuthenticRange object are not sufficient.

Errors
2001 The authentic range object, or its related view object is not valid.
2005 Invalid address for the return parameter was specified.
2008 Internal error
2009 The XM LD ata object cannot be accessed.

LastXMLDataOffset
See also

Property: LastXMLDataOffset as Long

Description
Set or get the cursor position inside LastXMLData element for the end of the range.

Offset positions are based on the characters returned by the Text property and start with 0.
When setting a new offset, use -1 to set the offset to the last possible position in the element.
The following cases require specific attention:
 The textual form of entries in Combo Boxes, Check Boxes and similar controls can be
different from what you see on the screen. Although, the data offset is based on this
text, there only two valid offset positions, one at the beginning and one at the end of the
entry. An attempt to set the offset to somewhere in the middle of the entry, will result in
the offset being set to the end.
 The textual form of XML Entities might differ in length from their representation on the
screen. The offset is based on this textual form.

If LastXMLData / LastXMLDataOffset selects a position before FirstXMLData /


FirstXMLDataOffset, the latter gets moved to the new end position.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 961

Errors
2001 The authentic range object, or its related view object is not valid.
2005 Invalid offset was specified.
Invalid address for the return parameter was specified.

Examples
' ---------------------------------------------
' XMLSpy scripting environment - VBScript
' Select the complete text of an XMLData element
' using XMLData based selection and ExpandTo
' ---------------------------------------------
Dim objAuthenticView
' we assume that the active document is open in authentic view mode
Set objAuthenticView = Application.ActiveDocument.AuthenticView

' first we use the XMLData based range properties


' to select all text of the first XMLData element
' in the current selection
Dim objRange
Set objRange = objAuthenticView.Selection
objRange.FirstXMLDataOffset = 0 ' start at beginning of element text
objRange.LastXMLData = objRange.FirstXMLData ' select only one element
objRange.LastXMLDataOffset = -1 ' select till its end

' the same can be achieved with the ExpandTo method


Dim objRange2
Set objRange2 = objAuthenticView.Selection.ExpandTo(spyAuthenticTag)

' were we successful?


If objRange.IsEqual(objRange2) Then
objRange.Select()
Else
MsgBox "Ooops"
End If

MoveBegin
See also

Method: MoveBegin (eKind as SPYAuthenticElementKind, nCount as Long) as


AuthenticRange

Description
Move the beginning of the range to the beginning of the nCount element of type eKind . Counting
starts at the current beginning of the range object.

Use positive numbers for nCount to move towards the document end, use negative numbers to
move towards document beginning. The end of the range stays unmoved, unless the new
beginning would be larger than it. In this case, the end is moved to the new beginning. The
method returns the modified range object.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2003 Target lies after end of document.
2004 Target lies before beginning of document.
2005 Invalid element kind specified.
Invalid address for the return parameter was specified.

© 2010 Altova GmbH Programmers' Reference


962 The XMLSpy API Interfaces

MoveEnd
See also

Method: MoveEnd (eKind as SPYAuthenticElementKind, nCount as Long) as


AuthenticRange

Description
Move the end of the range to the begin of the nCount element of type eKind . Counting starts at
the current end of the range object.

Use positive numbers for nCount to move towards the document end, use negative numbers to
move towards document beginning. The beginning of the range stays unmoved, unless the new
end would be less than it. In this case, the beginning gets moved to the new end. The method
returns the modified range object.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2003 Target lies after end of document.
2004 Target lies before begin of document.
2005 Invalid element kind specified.
Invalid address for the return parameter was specified.

MoveRowDown
See also

Method: MoveRowDown() as Boolean

Description
If the beginning of the range is inside a dynamic table and selects a row which is not the last
row in this table, this method swaps this row with the row immediately below. The selection of
the range moves with the row, but does not otherwise change. The function returns true if the
move operation was successful, otherwise false.

Errors
2001 The authentic range object or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

MoveRowUp
See also

Method: MoveRowUp() as Boolean

Description
If the beginning of the range is inside a dynamic table and selects a row which is not the first
row in this table, this method swaps this row with the row above. The selection of the range
moves with the row, but does not change otherwise. The function returns true if the move
operation was successful, otherwise false.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 963

Examples
See JScript - Bubble Sort Dynamic Tables.

Parent
See also

Property: Parent as AuthenticView (read-only)

Description
Access the view that owns this range object.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

Paste
See also

Method: Paste() as Boolean

Description
Returns False if the copy/paste buffer is empty, or its content cannot replace the current
selection.
Otherwise, deletes the current selection, inserts the content of the copy/paste buffer, and
returns True.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.

PerformAction
See also

Method: PerformAction (eAction as SPYAuthenticActions, strElementName as


String) as Boolean

Description
Perform Acti
on and its related methods, give access to the entry-helper functions of Authentic.
This function allows easy and consistent modification of the document content without a need to
know exactly where the modification will take place. The beginning of the range object is used
to locate the next valid location where the specified action can be performed. If no such location
can be found, the method returns False. Otherwise, the document gets modified and the range
points to the beginning of the modification.

HINT: To find out element names that can be passed as the second parameter use
CanPerformActionWith.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2005 Invalid address for the return parameter was specified.
2007 Invalid action was specified.

© 2010 Altova GmbH Programmers' Reference


964 The XMLSpy API Interfaces

Examples
' --------------------------------------------
' XMLSpy scripting environment - VBScript
' Insert the innermost element
' --------------------------------------------
Dim objRange
' we assume that the active document is open in authentic view mode
Set objRange = Application.ActiveDocument.AuthenticView.Selection

' we determine the elements that can be inserted at the current position
Dim arrElements()
objRange.CanPerformActionWith spyAuthenticInsertBefore, arrElements

' we insert the first (innermost) element


If UBound(arrElements) >= 0 Then
objRange.PerformAction spyAuthenticInsertBefore, arrElements(0)
' objRange now points to the beginning of the inserted element
' we set a default value and position at its end
objRange.Text = "Hello"
objRange.ExpandTo(spyAuthenticTag).CollapsToEnd().Select
Else
MsgBox "Can't insert any elements at current position"
End If

Select
See also

Method: Select()

Description
Makes this range the current user interface selection. You can achieve the same result using: '
objRange.Parent.Selection = objRange'

Errors
2001 The authentic range object or its related view object is no longer valid.

Examples
' ---------------------------------------
' XMLSpy scripting environment - VBScript
' ---------------------------------------
Dim objAuthenticView
' we assume that the active document is open in authentic view mode
Set objAuthenticView = Application.ActiveDocument.AuthenticView

' set current selection to end of document


objAuthenticView.DocumentEnd.Select()

SelectNext
See also

Method: SelectNext (eKind as SPYAuthenticElementKind) as AuthenticRange

Description
Selects the element of type eKind after the current end of the range. The method returns the
modified range object.

Errors
2001 The authentic range object, or its related view object is no longer valid.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 965

2003 Target lies after end of document.


2005 Invalid element kind specified.
Invalid address for the return parameter was specified.

Examples
' --------------------------------------------
' XMLSpy scripting environment - VBScript
' Scan through the whole document word-by-word
' --------------------------------------------
Dim objAuthenticView
' we assume that the active document is open in authentic view mode
Set objAuthenticView = Application.ActiveDocument.AuthenticView

Dim objRange
Set objRange = objAuthenticView.DocumentBegin
Dim bEndOfDocument
bEndOfDocument = False

On Error Resume Next


While Not bEndOfDocument
objRange.SelectNext(spyAuthenticWord).Select
If ((Err.number - vbObjecterror) = 2003) Then
bEndOfDocument = True
Err.Clear
ElseIf (Err.number <> 0) Then
Err.Raise ' forward error
End If
Wend

SelectPrevious
See also

Method: GotoPrevious (eKind as SPYAuthenticElementKind) as AuthenticRange

Description
Selects the element of type eKind before the current beginning of the range. The method
returns the modified range object.

Errors
2001 The authentic range object, or its related view object is no longer valid.
2004 Target lies before begin of document.
2005 Invalid element kind specified.
Invalid address for the return parameter was specified.

Examples
' --------------------------------------------
' XMLSpy scripting environment - VBScript
' Scan through the whole document tag-by-tag
' --------------------------------------------
Dim objAuthenticView
' we assume that the active document is open in authentic view mode
Set objAuthenticView = Application.ActiveDocument.AuthenticView

Dim objRange
Set objRange = objAuthenticView.DocumentEnd
Dim bEndOfDocument
bBeginOfDocument = False

On Error Resume Next

© 2010 Altova GmbH Programmers' Reference


966 The XMLSpy API Interfaces

While Not bBeginOfDocument


objRange.SelectPrevious(spyAuthenticTag).Select
If ((Err.number - vbObjecterror) = 2004) Then
bBeginOfDocument = True
Err.Clear
ElseIf (Err.number <> 0) Then
Err.Raise ' forward error
End If
Wend

SetElementAttributeValue
See also

Method: SetElementAttributeValue (strElementName as String, strAttributeName


as String, strAttributeValue as String)

Description
Retrieve the value of the attribute specified in strAttri
buteNam e for the element identified with
strElem entNam e . If the attribute is supported but has no value assigned, the empty string is
returned. To find out the names of attributes supported by an element, use
GetElementAttributeNames, or HasElementAttribute.

Errors
2001 The authentic range object or its related view object is no longer valid.
2005 Invalid element name was specified.
Invalid attribute name was specified.
Invalid attribute value was specified.

Examples
' --------------------------------------------
' XMLSpy scripting environment - VBScript
' Get and set element attributes
' --------------------------------------------
Dim objRange
' we assume that the active document is open in authentic view mode
Set objRange = Application.ActiveDocument.AuthenticView.Selection

' first we find out all the elements below the beginning of the range
Dim arrElements
objRange.GetElementHierarchy arrElements

If IsArray(arrElements) Then
If UBound(arrElements) >= 0 Then
' we use the top level element and find out its valid attributes
Dim arrAttrs()
objRange.GetElementAttributeNames arrElements(0), arrAttrs

If UBound(arrAttrs) >= 0 Then


' we retrieve the current value of the first valid
attribute
Dim strAttrVal
strAttrVal = objRange.GetElementAttributeValue
(arrElements(0), arrAttrs(0))
msgbox "current value of " & arrElements(0) & "//" &
arrAttrs(0) & " is: " & strAttrVal

' we change this value and read it again


strAttrVal = "Hello"
objRange.SetElementAttributeValue arrElements(0),
arrAttrs(0), strAttrVal

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 967

strAttrVal = objRange.GetElementAttributeValue
(arrElements(0), arrAttrs(0))
msgbox "new value of " & arrElements(0) & "//" &
arrAttrs(0) & " is: " & strAttrVal
End If
End If
End If

SetFromRange
See also

Method: SetFromRange (objSrcRange as AuthenticRange)

Description
Sets the range object to the same beginning and end positions as objSrcRange .

Errors
2001 One of the two range objects, is invalid.
2005 Null object was specified as source object.

SetVariableValue
Method: SetVariableValue(name as string, value as string)

Return Value
Sets the value of the named variable.

Errors
2201 Invalid object.
2202 No context.
2204 No such variable in scope
2205 Variable cannot be evaluated
2206 Variable returns sequence
2207 Variable read-only
2208 No modification allowed

Text
See also

Property: Text as String

Description
Set or get the textual content selected by the range object.

The number of characters retrieved are not necessarily identical, as there are text cursor
positions between the beginning and end of the selected range. Most document elements
support an end cursor position different to the beginning cursor position of the following
element. Drop-down lists maintain only one cursor position, but can select strings of any length.
In the case of radio buttons and check boxes, the text property value holds the string of the
corresponding XML element.

© 2010 Altova GmbH Programmers' Reference


968 The XMLSpy API Interfaces

If the range selects more then one element, the text is the concatenation of the single texts.
XML entities are expanded so that '&' is expected as '&amp;'.

Setting the text to the empty string, does not delete any XML elements. Use Cut, Delete or
PerformAction instead.

Errors
2001 The authentic range object or its related view object is no longer valid.
2005 Invalid address for a return parameter was specified.

4.3.6 AuthenticView
See also

Properties Methods Events


Appl
i
cati
on G oto O nBeforeCopy
AsXM LString IsRedoEnabled O nBeforeCut
Docum entBegin IsUndoEnabled OnBeforeDelete
Docum entEnd Pri
nt O nBeforeDrop
Event R edo O nBeforePaste
MarkupVisi
bi
l
ty U ndo O nDragO ver
Parent UpdateXM LInstanceEntities O nKeyBoardEvent
Sel
ecti
on O nM ouseEvent
XM LDataRoot O nSelectionChanged
W holeDocum ent

Description
AuthenticView and its child objects AuthenticRange and AuthenticDataTransfer provide
you with an interface for Authentic View, which allow easy and consistent modification of
document contents. These interfaces replace the following interfaces which are marked now as
obsolete:
OldAuthenticView (old name was DocEditView)
AuthenticSelection (old name was DocEditSelection, superseded by
AuthenticRange)
AuthenticEvent (old name was DocEditEvent)Interfaces

AuthenticView gives you easy access to specific features such as printing, the multi-level
undo buffer, and the current cursor selection, or position.

AuthenticView uses objects of type AuthenticRange to make navigation inside the


document straight-forward, and to allow for the flexible selection of logical text elements. Use
the properties DocumentBegin, DocumentEnd, or WholeDocument for simple selections,
while using the Goto method for more complex selections. To navigate relative to a given
document range, see the methods and properties of the AuthenticRange object.

Examples
' ---------------------------------------
' XMLSpy scripting environment - VBScript
' secure access to authentic view object
' ---------------------------------------
Dim objDocument
Set objDocument = Application.ActiveDocument
If (Not objDocument Is Nothing) Then
' we have an active document, now check for view mode
If (objDocument.CurrentViewMode <> spyViewAuthentic) Then
If (Not objDocument.SwitchViewMode (spyViewAuthentic)) Then

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 969

MsgBox "Active document does not support authentic view


mode"
Else
' now it is safe to access the authentic view object
Dim objAuthenticView
Set objAuthenticView = objDocument.AuthenticView
' now use the authentic view object

End If
End If
Else
MsgBox "No document is open"
End If

Events

OnBeforeCopy
See also

Event: OnBeforeCopy() as Boolean

XMLSpy scripting environment - VBScript:


Function On_AuthenticBeforeCopy()
'On_Authenti
cBeforeCopy=Fal
se 'todi
sabl
eoperati
on
End Function

XMLSpy scripting environment - JScript:


functi
on On_AuthenticBeforeCopy()
{
/ret
urnfal
se;/
*t
odi
sabl
eoperat
i
on*/
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (21, ...) //nEventId=21

Description
This event gets triggered before a copy operation gets performed on the document. Return True
(or nothing) to allow copy operation. Return False to disable copying.

OnBeforeCut
See also

Event: OnBeforeCut() as Boolean

XMLSpy scripting environment - VBScript:


Function On_AuthenticBeforeCut()
'On_Authenti
cBeforeCut=Fal
se 'todi
sabl
eoperati
on
End Function

XMLSpy scripting environment - JScript:


functi
on On_AuthenticBeforeCut()
{
/ret
urnfal
se;/
*t
odi
sabl
eoperat
i
on*/
}

© 2010 Altova GmbH Programmers' Reference


970 The XMLSpy API Interfaces

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (20, ...) //nEventId=20

Description
This event gets triggered before a cut operation gets performed on the document. Return True
(or nothing) to allow cut operation. Return False to disable operation.

OnBeforeDelete
See also

Event: OnBeforeDelete() as Boolean

XMLSpy scripting environment - VBScript:


Function On_AuthenticBeforeDelete()
'On_Authenti
cBeforeDel
ete=Fal
se 'todi
sabl
eoperati
on
End Function

XMLSpy scripting environment - JScript:


functi
on On_AuthenticBeforeDelete()
{
/ret
urnfal
se;/
*t
odi
sabl
eoperat
i
on*/
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (22, ...) //nEventId=22

Description
This event gets triggered before a delete operation gets performed on the document. Return
True (or nothing) to allow delete operation. Return False to disable operation.

OnBeforeDrop
See also

Event: OnBeforeDrop (i_nXPos as Long, i_nYPos as Long, i_ipRange as


AuthenticRange, i_ipData as cancelBoolean

XMLSpy scripting environment - VBScript:


Function On_AuthenticBeforeDrop(nXPos, nYPos, objRange, objData)
'On_Authenti
cBeforeDrop=Fal
se 'todi
sabl
eoperati
on
End Function

XMLSpy scripting environment - JScript:


functi
on On_AuthenticBeforeDrop(nXPos, nYPos, objRange, objData)
{
/ret
urnfal
se;/
*t
odi
sabl
eoperat
i
on*/
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (11, ...) //nEventId=11

Description
This event gets triggered whenever a previously dragged object gets dropped inside the

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 971

application window. All event related information gets passed as parameters.

The first two parameters specify the mouse position at the time when the event occurred. The
parameter objRange passes a range object that selects the XML element below the mouse
position. The value of this parameter might be NULL. Be sure to check before you access the
range object. The parameter objData allows to access information about the object being
dragged.

Return False to cancle the drop operation. Return True (or nothing) to continue normal
operation.

Examples
'
----------------------------------------------------------------------------
' VB code snippet - connecting to object level events
'
----------------------------------------------------------------------------
' access XMLSpy (without checking for any errors)
Dim objSpy As XMLSpyLib.Application
Set objSpy = GetObject("", "XMLSpy.Application")

' this is the event callback routine connected to the OnBeforeDrop


' event of object objView
Private Function objView_OnBeforeDrop(ByVal i_nXPos As Long, ByVal i_nYPos
As Long,
ByVal i_ipRange As IAuthenticRange,
ByVal i_ipData As
IAuthenticDataTransfer) As Boolean

If (Not i_ipRange Is Nothing) Then


MsgBox ("Dropping on content is prohibited");
Return False;
Else
Return True;
End If
End Function

' use VBA keyword WithEvents to connect to object-level event


Dim WithEvents objView As XMLSpyLib.AuthenticView
Set objView = objSpy.ActiveDocument.AuthenticView

' continue here with something useful ...


' and serve the windows message loop

OnBeforePaste
See also

Event: OnBeforePaste (objData as Variant, strType as String) as Boolean

XMLSpy scripting environment - VBScript:


Function On_AuthenticBeforePaste(objData, strType)
'On_Authenti
cBeforePaste=Fal
se 'todi
sabl
eoperati
on
End Function

XMLSpy scripting environment - JScript:


functi
on On_AuthenticBeforePaste(objData, strType)
{
/ret
urnfal
se;/
*t
odi
sabl
eoperat
i
on*/
}

© 2010 Altova GmbH Programmers' Reference


972 The XMLSpy API Interfaces

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (19, ...) //nEventId=19

Description
This event gets triggered before a paste operation gets performed on the document. The
parameter strType is one of "TEXT", "UNICODETEXT" or "IUNKNOWN". In the first two
cases objData contains a string representation of the object that will be pasted. In the later
case, objData contains a pointer to an IUnknown COM interface.

Return True (or nothing) to allow paste operation. Return False to disable operation.

OnBeforeSave
Event: OnBeforeSave (SaveAs flag) as Boolean

Description: OnBeforeSave gives the opportunity to e.g. warn the user about overwriting the
existing XML document, or to make the document read-only when specific circumstances are
not met. The event will be fired before the file dialog is shown. (Please note, that the event fires
when saving the XML document, and not when saving the SPS design in StyleVision.)

OnDragOver
See also

Event: OnDragOver (nXPos as Long, nYPos as Long, eMouseEvent as SPYMouseEvent,


objRange as AuthenticRange, objData as AuthenticDataTransfer) as Boolean

XMLSpy scripting environment - VBScript:


Function On_AuthenticDragOver(nXPos, nYPos, eMouseEvent, objRange,
objData)
'On_Authenti
cDragOver=Fal
se 'todi
sabl
eoperati
on
End Function

XMLSpy scripting environment - JScript:


functi
on On_AuthenticDragOver(nXPos, nYPos, eMouseEvent, objRange, objData)
{
/ret
urnfal
se;/
*t
odi
sabl
eoperat
i
on*/
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (10, ...) //nEventId=10

Description
This event gets triggered whenever an object from within our outside of Authentic View gets
dragged with the mouse over the application window. All event related information gets passed
as parameters.

The first three parameters specify the mouse position, the mouse button status and the status
of the virtual keys at the time when the event occurred. The parameter objRange passes a
range object that selects the XML element below the mouse position. The value of this
parameter might be NULL. Be sure to check before you access the range object. The
parameter objData allows to access information about the object being dragged.

Return False to cancel the drag operation. Return True (or nothing) to continue normal

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 973

operation.

Examples
'
----------------------------------------------------------------------------
' VB code snippet - connecting to object level events
'
----------------------------------------------------------------------------
' access XMLSpy (without checking for any errors)
Dim objSpy As XMLSpyLib.Application
Set objSpy = GetObject("", "XMLSpy.Application")

' this is the event callback routine connected to the OnDragOver


' event of object objView
Private Function objView_OnDragOver(ByVal i_nXPos As Long, ByVal i_nYPos As
Long,
ByVal i_eMouseEvent As SPYMouseEvent,
ByVal i_ipRange As IAuthenticRange,
ByVal i_ipData As
IAuthenticDataTransfer) As Boolean

If (((i_eMouseEvent And spyShiftKeyDownMask) <> 0) And


(Not i_ipRange Is Nothing)) Then
MsgBox ("Floating over element " &
i_ipRange.FirstXMLData.Parent.Name);
End If

Return True;
End Function

' use VBA keyword WithEvents to connect to object-level event


Dim WithEvents objView As XMLSpyLib.AuthenticView
Set objView = objSpy.ActiveDocument.AuthenticView

' continue here with something useful ...


' and serve the windows message loop

OnKeyboardEvent
See also

Event: OnKeyboardEvent (eKeyEvent as SPYKeyEvent, nKeyCode as Long,


nVirtualKeyStatus as Long) as Boolean

XMLSpy scripting environment - VBScript:


Function On_AuthenticKeyboardEvent(eKeyEvent, nKeyCode,
nVirtualKeyStatus)
'On_Authenti
cKeyboardEvent=True 'tocancelbubbl
i
ngofevent
End Function

XMLSpy scripting environment - JScript:


functi
on On_AuthenticKeyboardEvent(eKeyEvent, nKeyCode, nVirtualKeyStatus)
{
//returnfal
se;/
*tocancelbubbl
i
ngofevent*/
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (30, ...) //nEventId=30

Description
This event gets triggered for WM_KEYDOWN, WM_KEYUP and WM_CHAR Windows

© 2010 Altova GmbH Programmers' Reference


974 The XMLSpy API Interfaces

messages.

The actual message type is available in the eKeyEvent parameter. The status of virtual keys is
combined in the parameter nVirtualKeyStatus. Use the bit-masks defined in the enumeration
datatype SPYVirtualKeyMask, to test for the different keys or their combinations.

REMARK: The following events from the scripting environment and IDE Plugin of XMLSpy are
still supported but become obsolete with this event:
On_AuthenticKeyUp() IXMLSpyPlugIn.OnEvent (13, ...) //nEventId=
13
On_AuthenticKeyDown() IXMLSpyPlugIn.OnEvent (12, ...) //nEventId=
12
On_AuthenticKeyPressed() IXMLSpyPlugIn.OnEvent (14, ...) //nEventId=
14

Examples
'
----------------------------------------------------------------------------
' VB code snippet - connecting to object level events
'
----------------------------------------------------------------------------
' access XMLSpy (without checking for any errors)
Dim objSpy As XMLSpyLib.Application
Set objSpy = GetObject("", "XMLSpy.Application")

' this is the event callback routine connected to the OnKeyboard


' event of object objView
Private Function objView_OnKeyboardEvent(ByVal i_keyEvent As Long, ByVal
io_pnKeyCode As Long, ByVal i_nVirtualKeyStatus As Long) As Boolean
If ((i_keyEvent = XMLSpyLib.spyKeyUp) And ((i_nVirtualKeyStatus And
XMLSpyLib.spyCtrlKeyMask) <> 0)) Then
MsgBox ("Ctrl " & io_pnKeyCode & " pressed")
objView_OnKeyboardEvent = True
Else
objView_OnKeyboardEvent = False
End If
End Function

' use VBA keyword WithEvents to connect to object-level event


Dim WithEvents objView As XMLSpyLib.AuthenticView
Set objView = objSpy.ActiveDocument.AuthenticView

' continue here with something useful ...


' and serve the windows message loop

OnLoad
Event: OnLoad ()

Description: OnLoad can be used e.g. to restrict some AuthenticView functionality, as shown in
the example below:

function On_AuthenticLoad(  )
{
       // We are disabling all entry helpers in order to prevent user from
manipulating XML tree
       AuthenticView.DisableElementEntryHelper();
       AuthenticView.DisableAttributeEntryHelper();
      
       // We are also disabling the markup buttons for the same purpose
       AuthenticView.SetToolbarButtonState( 'AuthenticMarkupSmall',

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 975

authenticToolbarButtonDisabled );
       AuthenticView.SetToolbarButtonState( 'AuthenticMarkupLarge',
authenticToolbarButtonDisabled );
       AuthenticView.SetToolbarButtonState( 'AuthenticMarkupMixed',
authenticToolbarButtonDisabled );
}

In the example the status of the Markup Small, Markup Large, Markup Mixed toolbar buttons
are manipulated with the help of button identifiers. See complete list.

OnMouseEvent
See also

Event: OnMouseEvent (nXPos as Long, nYPos as Long, eMouseEvent as SPYMouseEvent


, objRange as AuthenticRange) as Boolean

XMLSpy scripting environment - VBScript:


Function On_AuthenticMouseEvent(nXPos, nYPos, eMouseEvent, objRange)
'On_AuthenticM ouseEvent=True 'tocancelbubbl
ingofevent
End Function

XMLSpy scripting environment - JScript:


functi
on On_AuthenticMouseEvent(nXPos, nYPos, eMouseEvent, objRange)
{
//returnfal
se;/
*tocancelbubbl
i
ngofevent*/
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (31, ...) //nEventId=31

Description
This event gets triggered for every mouse movement and mouse button Windows message.

The actual message type and the mouse buttons status, is available in the eMouseEvent
parameter. Use the bit-masks defined in the enumeration datatype SPYMouseEvent to test for
the different messages, button status, and their combinations.

The parameter objRange identifies the part of the document found at the current mouse cursor
position. The range objects always selects a complete tag of the document. (This might change
in future versions, when a more precise positioning mechanism becomes available). If no
selectable part of the document is found at the current position, the range object is null.

REMARK: The following events from the scripting environment and IDE Plugin of XMLSpy are
still supported but become obsolete with this event:
On_AuthenticMouseMove() IXMLSpyPlugIn.OnEvent (15, ...)
//nEventId=15
On_AuthenticButtonUp() IXMLSpyPlugIn.OnEvent (16, ...) /
nEventId = 16
On_AuthenticButtonDown() IXMLSpyPlugIn.OnEvent (17, ...)
//nEventId=17
On_AuthenticButtonDoubleClick() IXMLSpyPlugIn.OnEvent (24, ...) /
nEventId = 24

Examples
'

© 2010 Altova GmbH Programmers' Reference


976 The XMLSpy API Interfaces

----------------------------------------------------------------------------
' VB code snippet - connecting to object level events
'
----------------------------------------------------------------------------
' access XMLSpy (without checking for any errors)
Dim objSpy As XMLSpyLib.Application
Set objSpy = GetObject("", "XMLSpy.Application")

' this is the event callback routine connected to the OnMouseEvent


' event of object objView. If you click with the left mouse button
' while pressing a control key, the current selection will be set
' to the tag below the current mouse cursor position
Private Function objView_OnMouseEvent(ByVal i_nXPos As Long, ByVal i_nYPos
As Long, ByVal i_eMouseEvent As XMLSpyLib.SPYMouseEvent, ByVal i_pRange As
XMLSpyLib.IAuthenticRange) As Boolean
If (i_eMouseEvent = (XMLSpyLib.spyLeftButtonDownMask Or
XMLSpyLib.spyCtrlKeyDownMask)) Then
On Error Resume Next
i_pRange.Select
objView_OnMouseEvent = True
Else
objView_OnMouseEvent = False
End If
End Function

' use VBA keyword WithEvents to connect to object-level event


Dim WithEvents objView As XMLSpyLib.AuthenticView
Set objView = objSpy.ActiveDocument.AuthenticView

' continue here with something useful ...


' and serve the windows message loop

OnSelectionChanged
See also

Event: OnSelectionChanged (objNewSelection as AuthenticRange)

XMLSpy scripting environment - VBScript:


Function On_AuthenticSelectionChanged (objNewSelection)
End Function

XMLSpy scripting environment - JScript:


functi
on On_AuthenticSelectionChanged (objNewSelection)
{
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (23, ...) //nEventId=23

Description
This event gets triggered whenever the selection in the user interface changes.

Examples
'
----------------------------------------------------------------------------
' VB code snippet - connecting to object level events
'
----------------------------------------------------------------------------
' access XMLSpy (without checking for any errors)
Dim objSpy As XMLSpyLib.Application
Set objSpy = GetObject("", "XMLSpy.Application")

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 977

' this is the event callback routine connected to the OnSelectionChanged


' event of object objView
Private Sub objView_OnSelectionChanged (ByVal i_ipNewRange As
XMLSpyLib.IAuthenticRange)
MsgBox ("new selection: " & i_ipNewRange.Text)
End Sub

' use VBA keyword WithEvents to connect to object-level event


Dim WithEvents objView As XMLSpyLib.AuthenticView
Set objView = objSpy.ActiveDocument.AuthenticView

' continue here with something useful ...


' and serve the windows message loop

OnToolbarButtonClicked
Event: OnToolbarButtonClicked (Button identifier)

Description: OnToolbarButtonClicked is fired when a toolbar button was clicked by user. The
parameter button identifier helps to determine which button was clicked. The list of predefined
button identifiers is below:

 AuthenticPrint
 AuthenticPrintPreview
 AuthenticUndo
 AuthenticRedo
 AuthenticCut
 AuthenticCopy
 AuthenticPaste
 AuthenticClear
 AuthenticMarkupHide
 AuthenticMarkupLarge
 AuthenticMarkupMixed
 AuthenticMarkupSmall
 AuthenticValidate
 AuthenticChangeWorkingDBXMLCell
 AuthenticSave
 AuthenticSaveAs
 AuthenticReload
 AuthenticTableInsertRow
 AuthenticTableAppendRow
 AuthenticTableDeleteRow
 AuthenticTableInsertCol
 AuthenticTableAppendCol
 AuthenticTableDeleteCol
 AuthenticTableJoinCellRight
 AuthenticTableJoinCellLeft
 AuthenticTableJoinCellAbove
 AuthenticTableJoinCellBelow
 AuthenticTableSplitCellHorizontally
 AuthenticTableSplitCellVertically
 AuthenticTableAlignCellContentTop
 AuthenticTableCenterCellVertically

© 2010 Altova GmbH Programmers' Reference


978 The XMLSpy API Interfaces

 AuthenticTableAlignCellContentBottom
 AuthenticTableAlignCellContentLeft
 AuthenticTableCenterCellContent
 AuthenticTableAlignCellContentRight
 AuthenticTableJustifyCellContent
 AuthenticTableInsertTable
 AuthenticTableDeleteTable
 AuthenticTableProperties
 AuthenticAppendRow
 AuthenticInsertRow
 AuthenticDuplicateRow
 AuthenticMoveRowUp
 AuthenticMoveRowDown
 AuthenticDeleteRow
 AuthenticDefineEntities

For custom buttons the user might add his own identifiers. Please, note that the user must take
care, as the identifiers are not checked for uniqueness. The same identifiers can be used to
identify buttons in the Set/GetToolbarState() COM API calls. By adding code for different
buttons, the user is in the position to completely redefine the AuthenticView toolbar behavior,
adding own methods for table manipulation, etc.

OnToolbarButtonExecuted
Event: OnToolbarButtonExecuted (Button identifier)

Description: OnToolbarButtonClicked is fired when a toolbar button was clicked by user. The
parameter button identifier helps to determine which button was clicked. See the list of
predefined button identifiers.

OnToolbarButtonExecuted is fired after the toolbar action was executed. It is useful e.g. to add
update code, as shown in the example below:

//event fired when a toolbar button action was executed


function On_AuthenticToolbarButtonExecuted( varBtnIdentifier )
{
       // After whatever command user has executed - make sure to update
toolbar button states
       UpdateOwnToolbarButtonStates();
}

In this case UpdateOwnToolbarButtonStates is a user function defined in the Global


Declarations.

OnUserAddedXMLNode
Event: OnUserAddedXMLNode (XML node)

Description: OnUserAddedXMLNode will be fired when the user adds an XML node as a primary
action. This happens in the situations, where the user clicks on
 auto-add hyperlinks (see example OnUserAddedXMLNode.sps)
 the Insert…, Insert After…, Insert Before… context menu items
 Append row, Insert row toolbar buttons
 Insert After…, Insert Before… actions in element entry helper (outside StyleVision)

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 979

The event doesn’t get fired on Duplicate row, or when the node was added externally (e.g. via
COM API), or on Apply (e.g. Text State Icons), or when in XML table operations or in DB
operations.

The event parameter is the XML node object, which was added giving the user an opportunity to
manipulate the XML node added. An elaborate example for an event handler can be found in
the OnUserAddedXMLNode.sps file.

Application
See also

Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
2000 The authentic view object is no longer valid.
2005 Invalid address for the return parameter was specified.

AsXMLString
See also

Property: AsXMLString as String

Description
Returns or sets the document content as an XML string. Setting the content to a new value
does not change the schema file or sps file in use. If the new XMLString does not match the
actual schema file error 2011 gets returned.

Errors
2000 The authentic view object is no longer valid.
2011 AsXMLString was set to a value which is no valid XML for the current
schema file.

ContextMenu
Property: ContextMenu as ContextMenu

Description
The property ContextMenu gives access to customize the context menu. The best place to do it
is in the event handler OnContextMenuActivated.

Errors
2000 Invalid object.
2005 Invalid parameter.

CreateXMLNode
Method: CreateXMLNode (nKind as SPYXMLDataKind) as XMLData

Return Value

© 2010 Altova GmbH Programmers' Reference


980 The XMLSpy API Interfaces

The method returns the new XMLData object.

Description
To create a new XMLData object use the CreateXMLNode() method. See also Using XMLData.

Errors
2000 Invalid object.
2012 Cannot create XML node.

DisableAttributeEntryHelper
Method: DisableAttributeEntryHelper()

Description
DisableAttributeEntryHelper() disables the attribute entry helper in XMLSpy, Authentic
Desktop and Authentic Browser plug-in.

Errors
2000 Invalid object.

DisableElementEntryHelper
Method: DisableElementEntryHelper()

Description
DisableElementEntryHelper() disables the element entry helper in XMLSpy, Authentic
Desktop and Authentic Browser plug-in.

Errors
2000 Invalid object.

DisableEntityEntryHelper
Method: DisableEntityEntryHelper()

Description
DisableEntityEntryHelper() disables the entity entry helper in XMLSpy, Authentic
Desktop and Authentic Browser plug-in.

Errors
2000 Invalid object.

DocumentBegin
See also

Property: DocumentBegin as AuthenticRange (read-only)

Description
Retrieve a range object that points to the beginning of the document.

Errors
2000 The authentic view object is no longer valid.
2005 Invalid address for the return parameter was specified.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 981

DocumentEnd
See also

Property: DocumentEnd as AuthenticRange (read-only)

Description
Retrieve a range object that points to the end of the document.

Errors
2000 The authentic view object is no longer valid.
2005 Invalid address for the return parameter was specified.

DoNotPerformStandardAction
Method: DoNotPerformStandardAction ()

Description
DoNotPerformStandardAction() serves as cancel bubble for macros, and stops further
execution after macro has finished.

Errors
2000 Invalid object.

EvaluateXPath
Method: EvaluateXPath (XMLData, string expression) as string

Return Value
The method returns a string

Description
EvaluateXPath() executes an XPath expressions with the given XML context node. The result
returned as string, in the case of a sequence it is a space-separated string.

Errors
2000 Invalid object.
2005 Invalid parameter.
2008 Internal error.
2013 XPath error.

Event
See also

Property: Event as Authenti


cEvent (read-only)

Description
This property gives access to parameters of the last event in the same way as
OldAuthenti
cVi
ew.event does. Since all events for the scripting environment and external clients
are now available with parameters this Event property should only be used from within
IDE-Plugins.

Errors
2000 The authentic view object is no longer valid.
2005 Invalid address for the return parameter was specified.

© 2010 Altova GmbH Programmers' Reference


982 The XMLSpy API Interfaces

EventContext
Property: EventContext as EventContext

Description
EventContext property gives access to the running macros context. See the EventContext
interface description for more below details.

Errors
2000 Invalid object.

GetToolbarButtonState
Method: GetToolbarButtonState (ButtonIdentifier as string) as
AuthenticToolbarButtonState

Return Value
The method returns AuthenticToolbarButtonState

Description
Get/SetToolbarButtonState queries the status of a toolbar button, and lets the user disable
or enable the button, identified via its button identifier (see list above). One usage is to disable
toolbar buttons permanently. Another usage is to put SetToolbarButtonState in the
OnSelectionChanged event handler, as toolbar buttons are updated regularly when the
selection changes in the document.

Toolbar button states are given by the listed enumerations.

The default state means that the enable/disable of the button is governed by AuthenticView.
When the user sets the button state to enable or disable, the button remains in that state as
long as the user does not change it.

Errors
2000 Invalid object.
2005 Invalid parameter.
2008 Internal error.
2014 Invalid button identifier.

Goto
See also

Method: Goto (eKind as SPYAuthenticElementKind, nCount as Long, eFrom as


SPYAuthenticDocumentPosition) as AuthenticRange

Description
Retrieve a range object that points to the beginning of the nCount element of type eKind. The
start position is defined by the parameter eFrom. Use positive values for nCount to navigate to
the document end. Use negative values to navigate towards the beginning of the document.

Errors
2000 The authentic view object is no longer valid.
2003 Target lies after end of document.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 983

2004 Target lies before beginning of document.


2005 Invalid element kind specified.
The document position to start from is not one of spyAuthenticDocumentBegin
or spyAuthenticDocumentEnd.
Invalid address for the return parameter was specified.

Examples
' ---------------------------------------
' XMLSpy scripting environment - VBScript
' ---------------------------------------
Dim objAuthenticView
' we assume that the active document is open in authentic view mode
Set objAuthenticView = Application.ActiveDocument.AuthenticView

On Error Resume Next


Dim objRange
' goto beginning of first table in document
Set objRange = objAuthenticView.Goto (spyAuthenticTable, 1,
spyAuthenticDocumentBegin)
If (Err.number = 0) Then
objRange.Select()
Else
MsgBox "No table found in document"
End If

IsRedoEnabled
See also

Property: IsRedoEnabled as Boolean (read-only)

Description
True if redo steps are available and Redo is possible.

Errors
2000 The authentic view object is no longer valid.
2005 Invalid address for the return parameter was specified.

IsUndoEnabled
See also

Property: IsUndoEnabled as Boolean (read-only)

Description
True if undo steps are available and Undo is possible.

Errors
2000 The authentic view object is no longer valid.
2005 Invalid address for the return parameter was specified.

MarkupVisibility
See also

Property: MarkupVisibility as SPYAuthenticMarkupVisibility

© 2010 Altova GmbH Programmers' Reference


984 The XMLSpy API Interfaces

Description
Set or get current visibility of markup.

Errors
2000 The authentic view object is no longer valid.
2005 Invalid enumeration value was specified.
Invalid address for the return parameter was specified.

Parent
See also

Property: Parent as Document (read-only)

Description
Access the document shown in this view.

Errors
2000 The authentic view object is no longer valid.
2005 Invalid address for the return parameter was specified.

Print
See also

Method: Print (bWithPreview as Boolean, bPromptUser as Boolean)

Description
Print the document shown in this view. If bWithPreview is set to True, the print preview dialog
pops up. If bPromptUser is set to True, the print dialog pops up. If both parameters are set to
False, the document gets printed without further user interaction.

Errors
2000 The authentic view object is no longer valid.

Redo
See also

Method: Redo() as Boolean

Description
Redo the modification undone by the last undo command.

Errors
2000 The authentic view object is no longer valid.
2005 Invalid address for the return parameter was specified.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 985

Selection
See also

Property: Selection as AuthenticRange

Description
Set or get current text selection in user interface.

Errors
2000 The authentic view object is no longer valid.
2002 No cursor selection is active.
2005 Invalid address for the return parameter was specified.

Examples
' ---------------------------------------
' XMLSpy scripting environment - VBScript
' ---------------------------------------
Dim objAuthenticView
' we assume that the active document is open in authentic view mode
Set objAuthenticView = Application.ActiveDocument.AuthenticView

' if we are the end of the document, re-start at the beginning


If (objAuthenticView.Selection.IsEqual(objAuthenticView.DocumentEnd)) Then
objAuthenticView.Selection = objAuthenticView.DocumentBegin
Else
' objAuthenticView.Selection =
objAuthenticView.Selection.GotoNextCursorPosition()
' or shorter:
objAuthenticView.Selection.GotoNextCursorPosition().Select
End If

SetToolbarButtonState
Method: SetToolbarButtonState (ButtonIdentifier as string,
AuthenticToolbarButtonState state)

Description
Get/SetToolbarButtonState queries the status of a toolbar button, and lets the user disable
or enable the button, identified via its button identifier (see list above). One usage is to disable
toolbar buttons permanently. Another usage is to put SetToolbarButtonState in the
OnSelectionChanged event handler, as toolbar buttons are updated regularly when the
selection changes in the document.

Toolbar button states are given by the listed enumerations.

The default state means that the enable/disable of the button is governed by AuthenticView.
When the user sets the button state to enable or disable, the button remains in that state as
long as the user does not change it.

Errors
2000 Invalid object.
2008 Internal error.
2014 Invalid button identifier.

© 2010 Altova GmbH Programmers' Reference


986 The XMLSpy API Interfaces

Undo
See also

Method: Undo() as Boolean

Description
Undo the last modification of the document from within this view.

Errors
2000 The authentic view object is no longer valid.
2005 Invalid address for the return parameter was specified.

UpdateXMLInstanceEntities
See also

Method: UpdateXMLInstanceEntities()

Description
Updates the internal representation of the declared entities, and refills the entry helper. In
addition, the validator is reloaded, allowing the XML file to validate correctly. Please note that
this may also cause schema files to be reloaded.

Errors
The method never returns an error.

Example
// -----------------------------------------
// XMLSpy scripting environment - JavaScript
// -----------------------------------------
if(Application.ActiveDocument &&
(Application.ActiveDocument.CurrentViewMode == 4))
{
var objDocType;
objDocType =
Application.ActiveDocument.DocEditView.XMLRoot.GetFirstChild(10);

if(objDocType)
{
var objEntity = Application.ActiveDocument.CreateChild(14);
objEntity.Name = "child";
objEntity.TextValue = "SYSTEM \"child.xml\"";
objDocType.AppendChild(objEntity);

Application.ActiveDocument.AuthenticView.UpdateXMLInstanceEntities();
}
}

WholeDocument
See also

Property: WholeDocument as AuthenticRange (read-only)

Description
Retrieve a range object that selects the whole document.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 987

Errors
2000 The authentic view object is no longer valid.
2005 Invalid address for the return parameter was specified.

XMLDataRoot
See also

Property: XMLDataRoot as XMLData (read-only)

Description
Returns or sets the top-level XMLData element of the current document. This element typically
describes the document structure and would be of kind spyXMLDataXMLDocStruct,
spyXMLDataXMLEntityDocStruct or spyXMLDataDTDDocStruct..

Errors
2000 The authentic view object is no longer valid.
2005 Invalid address for the return parameter was specified.

4.3.7 CodeGeneratorDlg
See also
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Properties and Methods

Standard automation properties


Appl
i
cati
on
Parent

Programming language selection properties


Program m ingLanguage
Tem plateFileNam e
Com pati
bil
i
tyM ode

Settings for C++ code


CPPSettings_DO M Type
CPPSettings_LibraryType
CPPSettings_UseM FC
CPPSettings_GenerateVC6ProjectFile
CPPSettings_GenerateVSProjectFile

Settings for C# code


CSharpSettings_ProjectType

Dialog handling for above code generation properties


PropertySheetDi
alogActi
on

Output path selection properties


OutputPath
OutputPathDi
alogActi
on

Presentation of result
OutputResul
tDi
alogActi
on

© 2010 Altova GmbH Programmers' Reference


988 The XMLSpy API Interfaces

Description
Use this object to configure the generation of program code for schema files. The method
G enerateProgram Code expects a CodeGeneratorDlg as parameter to configure code
generation as well as the associated user interactions.

Application
See also
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
2200 The object is no longer valid.
2201 Invalid address for the return parameter was specified.

CompatibilityMode
Property: CompatibilityMode as Boolean
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Description
Set to t
rue to generate code compatible to XMLSpy 2005R3. Set to f
al
se to use newly added
code-generation features.

Errors
2200 The object is no longer valid.
2201 Invalid action passed as parameter or an invalid address was specified
for the return parameter.

CPPSettings_DOMType
Property: CPPSettings_DOMType as SPYDOMType
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Description
Defines one of the settings that configure generation of C++ code.

Errors
2200 The object is no longer valid.
2201 Invalid action passed as parameter or an invalid address was specified
for the return parameter.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 989

CPPSettings_GenerateVC6ProjectFile
Property: CPPSettings_GenerateVC6ProjectFile as Boolean
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Description
Defines one of the settings that configure generation of C++ code.

Errors
2200 The object is no longer valid.
2201 Invalid action passed as parameter or an invalid address was specified
for the return parameter.

CPPSettings_GenerateGCCMakefile
Property: CPPSettings_GenerateGCCMakefile as Boolean
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Description
Creates makefiles to compile the generated code under Linux with GCC.

Errors
2200 The object is no longer valid.
2201 Invalid action passed as parameter or an invalid address was specified
for the return parameter.

CPPSettings_GenerateVSProjectFile
Property: CSharpSettings_GenerateVSProjectFile as SPYProjectType
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Description
Defines one of the settings that configure generation of C++ code. Only
spyVisualStudio2005Project (=4) and spyVisualStudio2008Project (=5) and
spyVisualStudio2010Project (=6) are valid project types.

Errors
2200 The object is no longer valid.
2201 Invalid action passed as parameter or an invalid address was specified
for the return parameter.

CPPSettings_LibraryType
Property: CPPSettings_LibraryType as SPYLibType
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Description
Defines one of the settings that configure generation of C++ code.

© 2010 Altova GmbH Programmers' Reference


990 The XMLSpy API Interfaces

Errors
2200 The object is no longer valid.
2201 Invalid action passed as parameter or an invalid address was specified
for the return parameter.

CPPSettings_UseMFC
Property: CPPSettings_UseMFC as Boolean
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Description
Defines one of the settings that configure generation of C++ code.

Errors
2200 The object is no longer valid.
2201 Invalid action passed as parameter or an invalid address was specified
for the return parameter.

CSharpSettings_ProjectType
Property: CSharpSettings_ProjectType as SPYProjectType
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Description
Defines the only setting to configure generation of C# code.

Errors
2200 The object is no longer valid.
2201 Invalid action passed as parameter or an invalid address was specified
for the return parameter.

OutputPath
Property: OutputPath as String
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Description
Selects the base directory for all generated code.

Errors
2200 The object is no longer valid.
2201 Invalid address for the return parameter was specified.

OutputPathDialogAction
Property: OutputPathDialogAction as SPYDialogAction
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Description

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 991

Defines how the sub-dialog for selecting the code generation output path gets handled. Set this
value to spyDialogUserInput(2) to show the dialog with the current value of the OutputPath
property as default. Use spyDialogOK(0) to hide the dialog from the user.

Errors
2200 The object is no longer valid.
2201 Invalid action passed as parameter or an invalid address was specified
for the return parameter.

OutputResultDialogAction
Property: OutputResultDialogAction as SPYDialogAction
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Description
Defines how the sub-dialog that asks to show the result of the code generation process gets
handled. Set this value to spyDialogUserInput(2) to show the dialog. Use spyDialogOK(0) to
hide the dialog from the user.

Errors
2200 The object is no longer valid.
2201 Invalid action passed as parameter or an invalid address was specified
for the return parameter.

Parent
See also
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Property: Parent as Dialogs (read-only)

Description
Access the parent of the object.

Errors
2200 The object is no longer valid.
2201 Invalid address for the return parameter was specified.

ProgrammingLanguage
Property: ProgrammingLanguage as ProgrammingLanguage
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Description
Selects the output language for the code to be generated.

CAUTION: Setting this property to one of C++, C# or Java, changes the property
TemplateFileName to the appropriate template file delivered with XMLSpy as well. If you want
to generate C++, C# or Java code based on your own templates, set first the programming
language and then select your template file.

Errors

© 2010 Altova GmbH Programmers' Reference


992 The XMLSpy API Interfaces

2200 The object is no longer valid.


2201 Invalid address for the return parameter was specified.

PropertySheetDialogAction
Property: PropertySheetDialogAction as SPYDialogAction
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Description
Defines how the sub-dialog that configures the code generation process gets handled. Set this
value to spyDialogUserInput(2) to show the dialog with the current values as defaults. Use
spyDialogOK(0) to hide the dialog from the user.

Errors
2200 The object is no longer valid.
2201 Invalid action passed as parameter or an invalid address was specified
for the return parameter.

TemplateFileName
Property: TemplateFileName as String
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Description
Selects the code generation template file. XMLSpy comes with template files for C++, C# or
Java in the SPL folder of your installation directory.

Setting this property to one of the code generation template files of your XMLSpy installation
automatically sets the ProgrammingLanguage property to its appropriate value.

Errors
2200 The object is no longer valid.
2201 Invalid address for the return parameter was specified.

4.3.8 DatabaseConnection
See also

Properties for import and export


File or
ADOConnection or
ODBCConnection

Properties for import only


DatabaseKind
SQLSelect
AsAttributes
ExcludeKeys
IncludeEmptyElements
NumberDateTimeFormat
NullReplacement
CommentIncluded

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 993

Properties for export only


CreateMissingTables
CreateNew
TextFieldLen
DatabaseSchema

Properties for XML Schema from DB Structure generation


PrimaryKeys
ForeignKeys
UniqueKeys
SchemaExtensionType
SchemaFormat
ImportColumnsType

Description
DatabaseConnection specifies the parameters for the database connection.

Please note that the properties of the DatabaseConnection interface are referring to the settings
of the import and export dialogs of XMLSpy.

ADOConnection
See also

Property: ADOConnection as St
ri
ng

Description
The property ADOConnection contains a connection string. Either use this property or
ODBCConnection or File to refer to a database.

Errors
No error codes are returned.

Example

Dim objSpyConn As DatabaseConnection


Set objSpyConn = objSpy.GetDatabaseSettings

Dim objADO As DataLinks


Set objADO = CreateObject("DataLinks")

If Not (objADO Is Nothing) Then


Dim objConn As Connection
Set objConn = objADO.PromptNew
objSpyConn.ADOConnection = objConn.ConnectionString
End If

AsAttributes
See also

Property: AsAttributes as Boolean

Description
Set AsAttributes to true if you want to initialize all import fields to be imported as attributes.
Default is false and will initialize all fields to be imported as elements. This property is used only
in calls to Appl
i
cati
on.GetDatabaseIm portEl
em entList .

© 2010 Altova GmbH Programmers' Reference


994 The XMLSpy API Interfaces

Errors
No error codes are returned.

CommentIncluded
See also

Property: CommentIncluded as Boolean

Description
This property tells whether additional comments are added to the generated XML. Default is
true. This property is used only when importing from databases.

Errors
No error codes are returned.

CreateMissingTables
See also

Property: CreateMissingTables as Boolean

Description
If CreateMissingTables is true, tables which are not already defined in the export database
will be created during export. Default is true. This property is used only when exporting to
databases.

Errors
No error codes are returned.

CreateNew
See also

Property: CreateNew as Boolean

Description
Set CreateNew true if you want to create a new database on export. Any existing database will
be overwritten. See also DatabaseConnection.File. Default is false. This property is used
only when exporting to databases.

Errors
No error codes are returned.

DatabaseKind
See also

Property: DatabaseKind as SPYDatabaseKind

Description
Select the kind of database that gets access. The default value is spyDB_Unspecified(7) and is
sufficient in most cases. This property is used only when importing from databases.

Errors

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 995

No error codes are returned.

DatabaseSchema
See also

Property: DatabaseSchema as String

Description
This property specifies the Schema used for export in Schema aware databases. Default is "".
This property is used only when exporting to databases.

Errors
No error codes are returned.

ExcludeKeys
See also

Property: ExcludeKeys as Boolean

Description
Set ExcludeKeys to true if you want to exclude all key columns from the import data. Default
is false. This property is used only when importing from databases.

Errors
No error codes are returned.

File
See also

Property: File as St
ri
ng

Description
The property File sets the path for the database during export or import. This property can
only be used in conjunction with a Microsoft Access database. Either use this property or
ODBCConnection or ADOConnection to refer to the database.

See also Import and Export.

Errors
No error codes are returned.

ForeignKeys
See also

Property: ForeignKeys as Boolean

Description
Specifies whether the Foreign Keys constraint is created or not. Default is true. This property is
used only when creating a XML Schema from a DB structure.

© 2010 Altova GmbH Programmers' Reference


996 The XMLSpy API Interfaces

Errors
No error codes are returned.

ImportColumnsType
See also

Property: ImportColumnsType as SPYImportColumnsType

Description
Defines if column information from the DB is saved as element or attribute in the XML Schema.
Default is as element. This property is used only when creating a XML Schema from a DB
structure.

Errors
No error codes are returned.

IncludeEmptyElements
See also

Property: IncludeEmptyElements as Boolean

Description
Set IncludeEmptyElements to false if you want to exclude all empty elements. Default is
true. This property is used only when importing from databases.

Errors
No error codes are returned.

NullReplacement
See also

Property: NullReplacement as String

Description
This property contains the text value that is used during import for empty elements (null values).
Default is "". This property is used only when importing from databases.

Errors
No error codes are returned.

NumberDateTimeFormat
See also

Property: NumberDateTimeFormat as SPYNumberDateTimeFormat

Description
The property NumberDateTimeFormat sets the format of numbers and date- and time-values.
Default is spySystemLocale. This property is used only when importing from databases.

Errors
No error codes are returned.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 997

ODBCConnection
See also

Property: ODBCConnection as St
ri
ng

Description
The property ODBCConnection contains a ODBC connection string. Either use this property
or ADOConnection or File to refer to a database.

Errors
No error codes are returned.

PrimaryKeys
See also

Property: PrimaryKeys as Boolean

Description
Specifies whether the Primary Keys constraint is created or not. Default is true. This property is
used only when creating a XML Schema from a DB structure.

Errors
No error codes are returned.

SchemaExtensionType
See also

Property: SchemaExtensionType as SPYSchemaExtensionType

Description
Defines the Schema extension type used during the Schema generation. This property is used
only when creating a XML Schema from a DB structure.

See also Create XML Schema from DB Structure.

Errors
No error codes are returned.

SchemaFormat
See also

Property: SchemaFormat as SPYSchemaFormat

Description
Defines the Schema format used during the Schema generation. This property is used only
when creating a XML Schema from a DB structure.

See also Create XML Schema from DB Structure.

Errors
No error codes are returned.

© 2010 Altova GmbH Programmers' Reference


998 The XMLSpy API Interfaces

SQLSelect
See also

Property: SQLSelect as St
ri
ng

Description
The SQL query for the import is stored in the property SQLSelect. This property is used only when
importing from databases. See also Import and Export.

Errors
No error codes are returned.

TextFieldLen
See also

Property: TextFieldLen as l
ong

Description
The property TextFieldLen sets the length for created text fields during the export. Default is
255. This property is used only when exporting to databases.

Errors
No error codes are returned.

UniqueKeys
See also

Property: UniqueKeys as Boolean

Description
Specifies whether the Unique Keys constraint is created or not. Default is true. This property is
used only when creating a XML Schema from a DB structure.

Errors
No error codes are returned.

4.3.9 Dialogs
See also

Properties and Methods

Standard automation properties


Appl
i
cati
on
Parent

Various dialog objects


CodeG eneratorDlg
Fi
l
eSel
ecti
onDl
g
Schem aDocum entationDlg
GenerateSampleXMLDlg
DTDSchemaGeneratorDlg

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 999

FindInFilesDlg
WSDLDocumentationDlg
WSDL20DocumentationDlg
XBRLDocumentationDlg

Description
The Dialogs object provides access to different built-in dialogs of XMLSpy. These dialog objects
allow to initialize the fields of user dialogs before they get presented to the user or allow to
simulate complete user input by your program.

Application
See also

Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
2300 The object is no longer valid.
2301 Invalid address for the return parameter was specified.

CodeGeneratorDlg
See also
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Property: CodeGeneratorDlg as CodeGeneratorDlg (read-only)

Description
Get a new instance of a code generation dialog object. You will need this object to pass the
necessary parameters to the code generation methods. Initial values are taken from last usage
of the code generation dialog.

Errors
2300 The Dialogs object or one of its parents is no longer valid.
2301 Invalid address for the return parameter was specified.

FileSelectionDlg
See also

Property: FileSelectionDlg as FileSelectionDlg (read-only)

Description
Get a new instance of a file selection dialog object.

File selection dialog objects are passed to you with the some events that signal opening or
saving of documents and projects.

Errors
2300 The Dialogs object or one of its parents is no longer valid.

© 2010 Altova GmbH Programmers' Reference


1000 The XMLSpy API Interfaces

2301 Invalid address for the return parameter was specified.

Parent
See also

Property: Parent as Application (read-only)

Description
Access the XMLSpy application object.

Errors
2300 The object is no longer valid.
2301 Invalid address for the return parameter was specified.

SchemaDocumentationDlg
See also

Property: SchemaDocumentationDlg as SchemaDocumentationDlg (read-only)

Description
Get a new instance of a dialog object that parameterizes generation of schema documentation.
See Document.GenerateSchemaDocumentation for its usage.

Errors
2300 The Dialogs object or one of its parents is no longer valid.
2301 Invalid address for the return parameter was specified.

GenerateSampleXMLDlg
See also

Property: GenerateSampleXMLDlg as GenerateSampleXMLDlg (read-only)

Description
Get a new instance of a dialog object that parameterizes generation of a sample XML based on
a W3C schema or DTD. See GenerateSampleXML for its usage.

Errors
2300 The Dialogs object or one of its parents is no longer valid.
2301 Invalid address for the return parameter was specified.

DTDSchemaGeneratorDlg
See also

Property: DTDSchemaGeneratorDlg as DTDSchemaGeneratorDlg (read-only)

Description
Get a new instance of a dialog object that parameterizes generation of a schema or DTD. See
Document.GenerateDTDOrSchemaEx for its usage.

Errors
2300 The Dialogs object or one of its parents is no longer valid.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1001

2301 Invalid address for the return parameter was specified.

FindInFilesDlg
See also

Property: FindInFilesDlg as FindInFilesDlg (read-only)

Description
Get a new instance of a dialog object that parameterizes the search (or replacement) of strings
in files. See Application.FindInFiles for its usage.

Errors
2300 The Dialogs object or one of its parents is no longer valid.
2301 Invalid address for the return parameter was specified.

WSDLDocumentationDlg
See also

Property: WSDLDocumentationDlg as WSDLDocumentationDlg (read-only)

Description
Get a new instance of a dialog object that parameterizes generation of WSDL documentation.
See Document.GenerateWSDLDocumentation for its usage.

Errors
2300 The Dialogs object or one of its parents is no longer valid.
2301 Invalid address for the return parameter was specified.

WSDL20DocumentationDlg
See also

Property: WSDL20DocumentationDlg as WSDL20DocumentationDlg (read-only)

Description
Get a new instance of a dialog object that parameterizes generation of WSDL 2.0
documentation. See Document.GenerateWSD20LDocumentation for its usage.

Errors
2300 The Dialogs object or one of its parents is no longer valid.
2301 Invalid address for the return parameter was specified.

XBRLDocumentationDlg
See also

Property: XBRL20DocumentationDlg as XBRL20DocumentationDlg (read-only)

Description
Get a new instance of a dialog object that parameterizes generation of WSDL 2.0
documentation. See Document.GenerateXBRLDocumentation for its usage.

Errors

© 2010 Altova GmbH Programmers' Reference


1002 The XMLSpy API Interfaces

2300 The Dialogs object or one of its parents is no longer valid.


2301 Invalid address for the return parameter was specified.

4.3.10 Document
See also

Properties and Methods

Standard automation properties


Application
Parent

Various document properties and methods


SetActiveDocument
Encoding
SetEncoding (obsolete)
Suggestions

XML validation
IsWellFormed
IsValid
SetExternalIsValid

Document conversion and transformation


AssignDTD
AssignSchema
AssignXSL
AssignXSLFO
ConvertDTDOrSchema
ConvertDTDOrSchemaEx
GenerateDTDOrSchema
GenerateDTDOrSchemaEx
CreateSchemaDiagram
ExecuteXQuery
TransformXSL
TransformXSLEx
TransformXSLFO
GenerateProgramCode (EnterpriseEdi
ti
ononl
y)
GenerateSchemaDocumentation
GenerateSampleXML
GenerateWSDL20Documentation
GenerateWSDLDocumentation
GenerateXBRLDocumentation
ConvertToWSDL20

Document export
GetExportElementList
ExportToText
ExportToDatabase
CreateDBStructureFromXMLSchema
GetDBStructureList

File saving and naming


FullName
Name
Path
GetPathName (obsolete)
SetPathName (obsolete)

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1003

Title
IsModified
Saved
SaveAs
Save
SaveInString
SaveToURL
Close

View access
CurrentViewMode
SwitchViewMode
AuthenticView
GridView
DocEditView (obsolete)

Access to XMLData
RootElement
DataRoot
CreateChild
UpdateViews
StartChanges
EndChanges
UpdateXMLData

Description
Document objects represent XML documents opened in XMLSpy.

Use one of the following properties to access documents that are already open XMLSpy:
Application.ActiveDocument
Application.Documents

Use one of the following methods to open a new document in XMLSpy:


Documents.OpenFile
Documents.OpenURL
Documents.OpenURLDialog
Documents.NewFile
Documents.NewFileFromText
SpyProjectItem.Open
Application.ImportFromDatabase
Application.ImportFromSchema
Application.ImportFromText
Application.ImportFromWord
Document.ConvertDTDOrSchema
Document.GenerateDTDOrSchema

Events

OnBeforeSaveDocument
See also

Event: OnBeforeSaveDocument(objDocument as Document,objDialog as


FileSelectionDlg)

XMLSpy scripting environment - VBScript:

© 2010 Altova GmbH Programmers' Reference


1004 The XMLSpy API Interfaces

Function On_BeforeSaveDocument(objDocument,objDialog)
End Function

' old handler - now obsolete


' return string to save to new file name
' return empty string to cancel save operation
' return nothing to save to original name
Function On_SaveDocument(objDocument,strFilePath)
End Function

XMLSpy scripting environment - JScript:


functi
on On_BeforeSaveDocument(objDocument,objDialog)
{
}

// old handler - now obsolete


// return string to save to new file name
// return empty string to cancel save operation
// return nothing to save to original name
functi
on On_SaveDocument(objDocument,strFilePath)
{
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (27, ...) //nEventId=27

Description
This event gets fired on any attempt to save a document. The file selection dialog object is
initialized with the name chosen for the document file. You can modify this selection. To
continue saving the document leave the Fi l
eSel
ecti
onDl
g.Di
al
ogActi
on property of io_objDialog
at its default value spyDialogO K . To abort saving of the document set this property to
spyDialogCancel .

OnBeforeCloseDocument
See also

Event: OnBeforeCloseDocument(objDocument as Document)asBoolean

XMLSpy scripting environment - VBScript:


Function On_BeforeCloseDocument(objDocument)
'On_BeforeCloseDocum ent=False 'toprohibitclosingofdocum ent
End Function

XMLSpy scripting environment - JScript:


functi
on On_BeforeCloseDocument(objDocument)
{
//returnfal
se;/
*toprohi
bi
tcl
osi
ngofdocument*/
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (28, ...) //nEventId=28

Description
This event gets fired on any attempt to close a document. To prevent the document from being
closed return false.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1005

OnBeforeValidate
See also

Event: OnBeforeValidate(objDocument as Document,bOnLoading as Boolean,


bOnCommand as Boolean)as Boolean

XMLSpy scripting environment - VBScript:


Function On_BeforeValidate(objDocument,bOnLoading, bOnCommand)
On_BeforeVal
i
date=bCancel
Defaul
tVal
i
dati
on 'set by the script if
necessary
End Function

XMLSpy scripting environment - JScript:


functi
on On_BeforeValidate(objDocument,eViewMode,bActivated)
{
return bCancel
Defaul
tVal
i
dati
on //set by the script if necessary
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (32, ...) //nEventId=32

Description
This event gets fired before the document is validated. It is possible to suppress the default
validation by returning false from the event handler. In this case the script should also set the
validation result using the SetExternalIsValid method.

bOnLoading is true if the the event is raised on the initial validation on loading the document.

bOnCommand is true whenever the user selected the Validate command from the Toolbar or
menu.

Available with TypeLibrary version 1.5

OnCloseDocument
See also

Event: OnCloseDocument(objDocument as Document)

XMLSpy scripting environment - VBScript:


Function On_Close Document(objDocument)
End Function

XMLSpy scripting environment - JScript:


functi
on On_Close Document(objDocument)
{
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (8, ...) //nEventId=8

Description
This event gets fired as a result of closing a document. Do not modify the document from within
this event.

© 2010 Altova GmbH Programmers' Reference


1006 The XMLSpy API Interfaces

OnViewActivation
See also

Event: OnViewActivation(objDocument as Document,eViewMode as SPYViewModes,


bActivated as Boolean)

XMLSpy scripting environment - VBScript:


Function On_ViewActivation(objDocument,eViewMode,bActivated)
End Function

XMLSpy scripting environment - JScript:


functi
on On_ViewActivation(objDocument,eViewMode,bActivated)
{
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (29, ...) //nEventId=29

Description
This event gets fired whenever a view of a document becomes visible (i.e. becomes the active
view) or invisible (i.e. another view becomes the active view or the document gets closed).
However, the first view activation event after a document gets opened cannot be received, since
there is no document object to get the event from. Use the Application.O nDocum entO pened
event instead.

Application
See also

Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
1400 The object is no longer valid.
1407 Invalid address for the return parameter was specified.

AssignDTD
See also

Method: AssignDTD(strDTDFile as String, bDialog as Boolean)

Description
The method places a reference to the DTD file "strDTDFile" into the document. Note that no
error occurs if the file does not exist, or is not accessible. If bDialog is true XMLSpy presents
a dialog to set the file.

See also Simple document access.

Errors
1400 The object is no longer valid.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1007

1409 You are not allowed to assign a DTD to the document.

AssignSchema
See also

Method: AssignSchema (strSchemaFile as String, bDialog as Boolean)

Description
The method places a reference to the schema file "strSchemaFile" into the document. Note that
no error occurs if the file does not exist or is not accessible. If bDialog is true XMLSpy
presents a dialog to set the file.

See also Simple document access.

Errors
1400 The object is no longer valid.
1409 You are not allowed to assign a schema file to the document.

AssignXSL
See also

Method: AssignXSL (strXSLFile as String, bDialog as Boolean)

Description
The method places a reference to the XSL file "strXSLFile" into the document. Note that no
error occurs if the file does not exist or is not accessible. If bDialog is true XMLSpy presents a
dialog to set the file.

Errors
1400 The object is no longer valid.
1409 You are not allowed to assign an XSL file to the document.

AssignXSLFO
See also

Method: AssignXSLFO (strXSLFOFile as String, bDialog as Boolean)

Description
The method places a reference to the XSLFO file "strXSLFile" into the document. Note that no
error occurs if the file does not exist or is not accessible. If bDialog is true XMLSpy presents a
dialog to set the file.

Errors
1400 The object is no longer valid.
1409 You are not allowed to assign an XSL file to the document.

AsXMLString
See also

Property: AsXMLString as String

© 2010 Altova GmbH Programmers' Reference


1008 The XMLSpy API Interfaces

Description
This property can be used to get or set the document content.

Errors
1400 The document object is no longer valid.
1404 Cannot create XMLData object.
1407 View mode cannot be switched.

AuthenticView
See also

Method: AuthenticView as AuthenticView (read-only)

Description
Returns an object that gives access to properties and methods specific to Authentic view. The
object returned is only valid if the current document is opened in Authentic view mode. The
lifetime of an object ends with the next view switch. Any attempt to access objects or any of its
children afterwards will result in an error indicating that the object is invalid.

AuthenticView and DocEditView both provide automation access to the Authentic view
mode of XMLSpy. Functional overlap is intentional. A future version of Authentic View will
include all functionality of DocEditView and its sub-objects, thereby making usage of
DocEditView obsolete.

Errors
1400 The object is no longer valid.
1417 Document needs to be open in authentic view mode.

Examples
' ---------------------------------------
' XMLSpy scripting environment - VBScript
' secure access to authentic view object
' ---------------------------------------
Dim objDocument
Set objDocument = Application.ActiveDocument
If (Not objDocument Is Nothing) Then
' we have an active document, now check for view mode
If (objDocument.CurrentViewMode <> spyViewAuthentic) Then
If (Not objDocument.SwitchViewMode (spyViewAuthentic)) Then
MsgBox "Active document does not support authentic view
mode"
Else
' now it is safe to access the authentic view object
Dim objAuthenticView
Set objAuthenticView = objDocument.AuthenticView
' now use the authentic view object

End If
End If
Else
MsgBox "No document is open"
End If

Close
See also

Method: Close (bDiscardChanges as Boolean)

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1009

Description
To close the document call this method. If bDiscardChanges is true and the document is
modified, the document will be closed but not saved.

Errors
1400 The object is no longer valid.
1401 Document needs to be saved first.

ConvertDTDOrSchema
See also

Method: ConvertDTDOrSchema (nFormat as SPYDTDSchemaFormat,


nFrequentElements as SPYFrequentElements)

Parameters
nFormat
Sets the schema output format to DTD, or W3C.

nFrequentElements
Create complex elements as elements or complex types.

Description
ConvertDTDOrSchema takes an existing schema format and converts it into a different format.
For a finer tuning of DTD / schema conversion, use ConvertDTDOrSchemaEx.

Errors
1400 The object is no longer valid.
1412 Error during conversion.

ConvertDTDOrSchemaEx
See also

Method: ConvertDTDOrSchemaEx (nFormat as SPYDTDSchemaFormat,


nFrequentElements as SPYFrequentElements, sOutputPath as String,
nOutputPathDialogAction as SPYDialogAction)

Parameters
nFormat
Sets the schema output format to DTD, or W3C.

nFrequentElements
Create complex elements as elements or complex types.

sOutputPath
The file path for the newly generated file.

nOutputPathDialogAction
Defines the dialog interaction for this call.

Description
ConvertDTDOrSchemaEx takes an existing schema format and converts it into a different
format.

© 2010 Altova GmbH Programmers' Reference


1010 The XMLSpy API Interfaces

Errors
1400 The object is no longer valid.
1412 Error during conversion.

ConvertToWSDL20
Method: ConvertToWSDL20 (sFilePath as String, bShowDialogs as Boolean)

Parameters
sFilePath
This specifies the file name of the converted WSDL. In case the source WSDL includes files
which also must be converted, then only the directory part of the given path is used and the file
names are generated automatically.

bShowDialogs
Defines whether file/folder selection dialogs are shown.

Description
Converts the WSDL 1.1 document to a WSDL 2.0 file. It will also convert any referenced WSDL
files that are referenced from within this document.

Errors
1400 The document object is no longer valid.
1407 Invalid parameters have been passed or an empty file name has been
specified as output target.
1417 The document is not opened in WSDL view, maybe it is not an '.wsdl' file.
1421 Feature is not available in this edition.
1433 WSDL 1.1 to WSDL 2.0 conversion failed.

CreateChild
See also

Method: CreateChild (nKind as SPYXMLDataKind) as XMLData

Return Value
The method returns the new XMLData object.

Description
To create a new XMLData object use the CreateChild() method. See also Using XMLData.

Errors
1400 The object is no longer valid.
1404 Cannot create XMLData object.
1407 Invalid address for the return parameter was specified.

CreateDBStructureFromXMLSchema
See also

Method: CreateDBStructureFromXMLSchema (pDatabase as DatabaseConnection,


pTables as ElementList, bDropTableWithExistingName as Boolean) as String

Description
CreateDBStructureFromXMLSchema exports the given tables to the specified database.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1011

The function returns the SQL statements that were necessary to perform the changes.

See also GetDBStructureList.

Errors
1429 Database selection missing.
1430 Document export failed.

CreateSchemaDiagram
See also

Method: CreateSchemaDiagram (nKind as SPYSchemaDefKind, strName as String,


strFile as String)

Return Value
None.

Description
The method creates a diagram of the schema type strName of kind nKind and saves the
output file into strFile.

Errors
1400 The object is no longer valid.
1414 Failed to save diagram.
1415 Invalid schema definition type specified.

CurrentViewMode
See also

Method: CurrentViewMode as SPYViewModes

Description
The property holds the current view mode of the document. See also
Document.SwitchViewMode.

Errors
1400 The object is no longer valid.
1407 Invalid address for the return parameter was specified.

DataRoot
See also

Property: DataRoot as XMLData (read-only)

Description
This property provides access to the document's first XMLData object of type
spyXMLDataElement. This is typically the root element for all document content data. See
XMLSpyDocument.RootElement to get the root element of the whole document including XML

© 2010 Altova GmbH Programmers' Reference


1012 The XMLSpy API Interfaces

prolog data. If the CurrentViewMode is not spyViewGrid or spyViewAuthentic an


UpdateXMLData may be necessary to get access to the latest XMLData.

Errors
1400 The document object is no longer valid.
1407 Invalid address for the return parameter was specified.

DocEditView
See also

Method: DocEditView as DocEditView

Description
Holds a reference to the current Authentic View object.

Errors
1400 The object is no longer valid.
1407 Invalid address for the return parameter was specified.
1417 Document needs to be open in authentic view mode.

Encoding
See also

Property: Encoding as String

Description
This property provides access to the document's encoding value. However, this property can
only be accessed when the document is opened in spyViewGrid, spyViewText or
spyViewAuthentic. See CurrentViewMode on how to detect that a document's actual view
mode.

This property makes the method SetEncoding obsolete.

Possible values are, for example:

8859-1,
8859-2,
ASCII, ISO-646,
850,
1252,
1255,
SHIFT-JIS, MS-KANJI,
BIG5, FIVE,
UTF-7,
UTF-8,
UTF-16

Errors
1400 The document object is no longer valid.
1407 Invalid address for the return parameter was specified.
1416 Operation not supported in current view mode.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1013

EndChanges
See also

Method: EndChanges()

Description
Use the method EndChanges to display all changes since the call to
Document.StartChanges.

Errors
1400 The object is no longer valid.

ExecuteXQuery
See also

Method: ExecuteXQuery (strXMLFileName as String)

Description
Execute the XQuery statements contained in the document. Use the XML file specified as XML
source for the transformation. If your XQuery script does not use an XML source set the
parameter strXM LFileNam e to an empty string.

Errors
1400 The document object is no longer valid.
1423 XQuery transformation error.
1424 Not all files required for operation could be loaded. Most likely, the file
specified in strXM LFileNam e does not exist or is not valid.

ExportToDatabase
See also

Method: ExportToDatabase (pFromChild as XMLData, pExportSettings as


ExportSettings, pDatabase as DatabaseConnection)

Description
ExportToDatabase exports the XML document starting with the element pFromChild. The
parameter pExportSettings defines the behaviour of the export (see
Application.GetExportSettings). The parameter pDatabase specifies the destination
of the export (see Application.GetDatabaseSettings).

Errors
1400 The object is no longer valid.
1407 Invalid parameter or invalid address for the return parameter was
specified.
1416 Error during export.
1429 Database selection missing.
1430 Document export failed.

Example

Dim objDoc As Document


Set objDoc = objSpy.ActiveDocument

© 2010 Altova GmbH Programmers' Reference


1014 The XMLSpy API Interfaces

'set the behaviour of the export with ExportSettings


Dim objExpSettings As ExportSettings
Set objExpSettings = objSpy.GetExportSettings

'set the destination with DatabaseConnection


Dim objDB As DatabaseConnection
Set objDB = objSpy.GetDatabaseSettings

objDB.CreateMissingTables = True
objDB.CreateNew = True
objDB.File = "C:\Export.mdb"

objDoc.ExportToDatabase objDoc.RootElement, objExpSettings, objDB


If Err.Number <> 0 Then
a = MsgBox("Error: " & (Err.Number - vbObjectError) & Chr(13) &
"Description: " & Err.Description)
End If

ExportToText
See also

Method: ExportToText (pFromChild as XMLData, pExportSettings as


ExportSettings, pTextSettings as TextImportExportSettings)

Description
ExportToText exports tabular information from the document starting at pFrom Child into one
or many text files. Columns of the resulting tables are generated in alphabetical order of the
column header names. Use GetExportElementList to learn about the data that will be
exported. The parameter pExportSettings defines the specifics for the export. Set the property
ExportSettings.ElementList to the - possibly modified - list returned by
GetExportElementList to avoid exporting all contained tables. The parameter
pTextSetti
ngs defines the options specific to text export and import. You need to set the
property TextImportExportSettings.DestinationFolder before you call ExportToText
.

See also Import and export of data.

Errors
1400 The object is no longer valid.
1407 Invalid parameter or invalid address for the return parameter was
specified.
1416 Error during export.
1430 Document export failed.

Example
' ---------------------------------------------------------
' VBA client code fragment - export document to text files
' ---------------------------------------------------------
Dim objDoc As Document
Set objDoc = objSpy.ActiveDocument

Dim objExpSettings As ExportSettings


Set objExpSettings = objSpy.GetExportSettings
objExpSettings.ElementList = objDoc.GetExportElementList(
objDoc.RootElement,
objExpSettings)

Dim objTextExp As TextImportExportSettings


Set objTextExp = objSpy.GetTextExportSettings

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1015

objTextExp.HeaderRow = True
objTextExp.DestinationFolder = "C:\Exports"

On Error Resume Next


objDoc.ExportToText objDoc.RootElement, objExpSettings, objTextExp

If Err.Number <> 0 Then


a = MsgBox("Error: " & (Err.Number - vbObjectError) & Chr(13) &
"Description: " & Err.Description)
End If

FullName
See also

Property: FullName as String

Description
This property can be used to get or set the full file name - including the path - to where the
document gets saved. The validity of the name is not verified before the next save operation.

This property makes the methods GetPathName and SetPathName obsolete.

Errors
1400 The document object is no longer valid.
1402 Empty string has been specified as full file name.

GenerateDTDOrSchema
See also

Method: GenerateDTDOrSchema (nFormat as SPYDTDSchemaFormat, nValuesList as


integer, nDetection as SPYTypeDetection, nFrequentElements as
SPYFrequentElements)

Parameters
nFormat
Sets the schema output format to DTD, or W3C.

nValuesList
Generate not more than this amount of enumeration-facets per type. Set to -1 for unlimited.

nDetection
Specifies granularity of simple type detection.

nFrequentElements
Shall the types for all elements be defined as global? Use that value spyGlobalComplexType to
define them on global scope. Otherwise, use the value spyGlobalElements.

Description
Use this method to automatically generate a DTD or schema for the current XML document.
For a finer tuning of DTD / schema generation, use GenerateDTDOrSchemaEx.

Errors
1400 The object is no longer valid.
1407 Invalid parameter or invalid address for the return parameter was
specified.

© 2010 Altova GmbH Programmers' Reference


1016 The XMLSpy API Interfaces

GenerateDTDOrSchemaEx
See also

Method: GenerateDTDOrSchemaEx ( objDlg as DTDSchemaGeneratorDlg ) as Document

Description
Use this method to automatically generate a DTD or schema for the current XML document. A
DTDSchemaGeneratorDlg object is used to pass information to the schema/DTD generator.
The generation process can be configured to allow user interaction or run without further user
input.

Errors
1400 The object is no longer valid.
1407 Invalid parameter or invalid address for the return parameter was
specified.

GenerateProgramCode
Method: GenerateProgramCode (objDlg as CodeGeneratorDlg)
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Description
Generate Java, C++ or C# class files from the XML Schema definitions in your document. A
CodeGeneratorDlg object is used to pass information to the code generator. The generation
process can be configured to allow user interaction or run without further user input.

Errors
1400 The document object is no longer valid.
1407 An empty file name has been specified.
1421 Feature not available in this edition

GenerateSampleXML
Method: GenerateSampleXML (objDlg as GenerateSampleXMLDlg) as Document

Description
Generates a sample XML if the document is a schema or DTD. Use
Dialogs.GenerateSampleXMLDlg to get an initialized set of options.

Available with TypeLibrary version 1.5

Errors
1400 The document object is no longer valid.

GenerateSchemaDocumentation
Method: GenerateSchemaDocumentation (objDlg as SchemaDocumentationDlg)

Description
Generate documentation for a schema definition file in HTML, MS-Word, or RTF format. The
parameter objDlg is used to parameterize the generation process. Use
Dialogs.Schem aDocum entationDlg to get an initialized set of options. As a minimum, you will

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1017

need to set the property Schem aDocum entationDlg.OutputFile before starting the generation
process.

Errors
1400 The document object is no longer valid.
1407 Invalid parameters have been passed or an empty file name has been
specified as output target.
1417 The document is not opened in schema view, maybe it is not an '.xsd'
file.
1421 Feature is not available in this edition.
1422 Error during generation

GenerateWSDL20Documentation
Method: GenerateWSDL20Documentation (objDlg as WSDL20DocumentationDlg)

Description
Generate documentation for a WSDL definition file in HTML, MS-Word, or RTF format. The
parameter objDlg is used to parameterize the generation process. Use
Dialogs.W SDL20Docum entationDlg to get an initialized set of options. As a minimum, you will
need to set the property W SDL20Docum entationDlg.OutputFile before starting the generation
process.

Errors
1400 The document object is no longer valid.
1407 Invalid parameters have been passed or an empty file name has been
specified as output target.
1417 The document is not opened in schema view, maybe it is not an '.xsd'
file.
1421 Feature is not available in this edition.
1422 Error during generation

GenerateWSDLDocumentation
Method: GenerateWSDLDocumentation (objDlg as WSDLDocumentationDlg)

Description
Generate documentation for a WSDL definition file in HTML, MS-Word, or RTF format. The
parameter objDlg is used to parameterize the generation process. Use
Dialogs.W SDLDocum entationDlg to get an initialized set of options. As a minimum, you will
need to set the property W SDLDocum entationDlg.OutputFile before starting the generation
process.

Errors
1400 The document object is no longer valid.
1407 Invalid parameters have been passed or an empty file name has been
specified as output target.
1417 The document is not opened in schema view, maybe it is not an '.xsd'
file.
1421 Feature is not available in this edition.
1422 Error during generation

© 2010 Altova GmbH Programmers' Reference


1018 The XMLSpy API Interfaces

GenerateXBRLDocumentation
Method: GenerateXBRLDocumentation (objDlg as XBRLDocumentationDlg)

Description
Generate documentation for a WSDL definition file in HTML, MS-Word, or RTF format. The
parameter objDlg is used to parameterize the generation process. Use
Dialogs.XBRLDocum entationDlg to get an initialized set of options. As a minimum, you will need
to set the property XBRLDocum entationDlg.OutputFile before starting the generation process.

Errors
1400 The document object is no longer valid.
1407 Invalid parameters have been passed or an empty file name has been
specified as output target.
1417 The document is not opened in schema view, maybe it is not an '.xsd'
file.
1421 Feature is not available in this edition.
1422 Error during generation

GetDBStructureList
See also

Method: GetDBStructureList (pDatabase as DatabaseConnection) as ElementList

Description
GetDBStructureList creates a collection of elements from the Schema document for which
tables in the specified database are created. The function returns a collection of
Elem entLi
stItem s where the properties ElementListItem.Name contain the names of the
tables.

See also CreateDBStructureFromXMLSchema.

Errors
1400 The object is no longer valid.
1427 Failed creating parser for the specified XML.
1428 Export of element list failed.
1429 Database selection missing.

GetExportElementList
See also

Method: GetExportElementList (pFromChild as XMLData, pExportSettings as


ExportSettings) as ElementList

Description
GetExportElementList creates a collection of elements to export from the document,
depending on the settings in pExportSettings and starting from the element pFromChild.
The function returns a collection of El
em entLi
stItem s where the properties
ElementListItem.Name contain the names of the tables that can be exported from the
document. The property ElementListItem.FieldCount contains the number of columns in

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1019

the table. The property ElementListItem.RecordCount contains the number of records in


the table. The property ElementListItem.ElementKind is unused.

See also Import and export of data.

Errors
1400 The object is no longer valid.
1407 Invalid parameter or invalid address for the return parameter was
specified.
1427 Failed creating parser for the specified XML.
1428 Export of element list failed.

GetPathName (obsolete)

Superseded by Document.FullName
// ----- javascript sample -----
// instead of:
// strPathName = Application.ActiveDocument.GetPathName();
// use now:
strPathName = Application.ActiveDocument.FullName;

See also

Method: GetPathName() as String

Description
The method GetPathName gets the path of the active document.

See also Document.SetPathName (obsolete).

GridView
See also

Property: GridView as GridView

Description
This property provides access to the grid view functionality of the document.

Errors
1400 The object is no longer valid.
1407 Invalid address for the return parameter was specified.
1417 Document needs to be open in enhanced grid view mode.

IsModified
See also

Property: IsModified as Boolean

Description
True if the document is modified.

© 2010 Altova GmbH Programmers' Reference


1020 The XMLSpy API Interfaces

Errors
1400 The object is no longer valid.
1407 Invalid address for the return parameter was specified.

IsValid
See also

Method: IsValid (strError as Variant, nErrorPos as Variant, pBadData as Variant) as


Boolean

Return Value
True if the document is valid, false if not.

Description
IsValid() validates the document against its associated schema or DTD. strError gives you the
same error message as XMLSpy, if you validate the file within the editor.

nErrorPos is obsolete and only present for compatibility reasons. pBadData is a reference to the
XMLData object raising the error. It is only available if the document is currently displayed in
TextView, GridView or AuthenticView.

Errors
1400 The object is no longer valid.
1407 Invalid parameter or invalid address for the return parameter was
specified.
1408 Unable to validate file.

Examples

For an example written in VBA see Overview - Simple document access

' ---------------------------------------
' XMLSpy scripting environment - VBScript
' ---------------------------------------
Dim errorText
Dim errorPos
Dim badData

' validate the active document


Set doc = Application.ActiveDocument
valid = doc.IsValid(errorText, errorPos, badData)

If (Not valid) Then


' create the validation error message text
Text = errorText

If ( Not IsEmpty(badData) ) Then


Text = Text & "(" & badData.Name & "/" & badData.TextValue & ")"
End If

Call MsgBox("validation error[" & errorPos & "]: " & Text)
End If

// ---------------------------------------
// XMLSpy scripting environment - JScript
// ---------------------------------------
// define as arrays to support their usage as return parameters

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1021

var errorText = new Array(1);


var errorPos = new Array(1);
var badData = new Array(1);

// validate the active document


var doc = Application.ActiveDocument;
var valid = doc.IsValid(errorText, errorPos, badData);

if (! valid)
{
// compose the error description
var text = errorText;

// access that XMLData object only if filled in


if (badData[0] != null)
text += "(" + badData[0].Name + "/" + badData[0].TextValue + ")"
;

MsgBox("validation error[" + errorPos + "]: " + text);


}

IsWellFormed
See also

Method: IsWellFormed (pData as XMLData, bWithChildren as Boolean, strError as


Variant, nErrorPos as Variant, pBadXMLData as Variant) as Boolean

Return Value
True if the document is well formed.

Description
IsWellFormed checks the document for well-formedness starting at the element pData.

If the document is not well formed, strError contains an error message, nErrorPos the
position in the file and pBadXMLData holds a reference to the element which breaks the
well-formedness. These out-parameters are defined as VARIANTs to support scripting
languages like VBScript.

Errors
1400 The object is no longer valid.
1407 Invalid parameter or invalid address for the return parameter was
specified.

Example

See IsValid.

Name
See also

Property: Name as String (read-only)

Description
Use this property to retrieve the name - not including the path - of the document file. To change
the file name for a document use the property FullName.

© 2010 Altova GmbH Programmers' Reference


1022 The XMLSpy API Interfaces

Errors
1400 The document object is no longer valid.
1407 Invalid address for the return parameter was specified.

Parent
See also

Property: Parent as Documents (read-only)

Description
Access the parent of the document object.

Errors
1400 The document object is no longer valid.
1407 Invalid address for the return parameter was specified.

Path
See also

Property: Path as String (read-only)

Description
Use this property to retrieve the path - not including the file name - of the document file. To
change the file name and path for a document use the property FullName.

Errors
1400 The document object is no longer valid.
1407 Invalid address for the return parameter was specified.

RootElement
See also

Property: RootElement as XMLData (read-only)

Description
The property RootElement provides access to the root element of the XML structure of the
document including the XML prolog data. To access the first element of a document's content
navigate to the first child of kind spyXMLDataElement or use the Document.DataRoot property.
If the CurrentViewMode is not spyViewGrid or spyViewAuthentic an UpdateXMLData may be
necessary to get access to the latest XMLData.

Errors
1400 The document object is no longer valid.
1407 Invalid address for the return parameter was specified.

Save
See also

Method: Save()

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1023

Description
The method writes any modifications of the document to the associated file. See also
Document.FullName.

Errors
1400 The document object is no longer valid.
1407 An empty file name has been specified.
1403 Error when saving file, probably the file name is invalid.

SaveAs
See also

Method: SaveAs (strFileName as String)

Description
Save the document to the file specified. If saving was successful, the FullName property gets
set to the specified file name.

Errors
1400 The document object is no longer valid.
1407 An empty file name has been specified.
1403 Error when saving file, probably the file name is invalid.

Saved
See also

Property: Saved as Boolean (read-only)

Description
This property can be used to check if the document has been saved after the last modifications.
It returns the negation of IsModified.

Errors
1400 The document object is no longer valid.
1407 Invalid address for the return parameter was specified.

SaveInString
See also

Method: SaveInString (pData as XMLData, bMarked as Boolean) as String

Parameters
pData
XMLData element to start. Set pData to Document.RootElement if you want to copy the
complete file.

bMarked
If bMarked is true, only the elements selected in the grid view are copied.

Return Value
Returns a string with the XML data.

© 2010 Altova GmbH Programmers' Reference


1024 The XMLSpy API Interfaces

Description
SaveInString starts at the element pData and converts the XMLData objects to a string
representation.

Errors
1400 The object is no longer valid.
1407 Invalid parameter or invalid address for the return parameter was
specified.

SaveToURL
See also

Method: SaveToURL (strURL as String, strUser as String, strPassword as String)

Return Value

Description
SaveToURL() writes the document to the URL strURL. This method does not set the
permanent file path of the document.

Errors
1400 The object is no longer valid.
1402 Invalid URL specified.
1403 Error while saving to URL.

SetActiveDocument
See also

Method: SetActiveDocument()

Description
The method sets the document as the active and brings it to the front.

Errors
1400 The object is no longer valid.

SetEncoding (obsolete)

Superseded by Document.Encoding
// ----- javascript sample -----
// instead of:
// Application.ActiveDocument.SetEncoding("UTF-16");
// use now:
Application.ActiveDocument.Encoding = "UTF-16";

See also

Method: SetEncoding (strEncoding as String)

Description
SetEncoding sets the encoding of the document like the menu item "File/Encoding..." in

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1025

XMLSpy. Possible values for strEncoding are, for example:

8859-1,
8859-2,
ASCII, ISO-646,
850,
1252,
1255,
SHIFT-JIS, MS-KANJI,
BIG5, FIVE,
UTF-7,
UTF-8,
UTF-16

© 2010 Altova GmbH Programmers' Reference


1026 The XMLSpy API Interfaces

SetExternalIsValid
See also

Method: SetExternalIsValid (bValid as Boolean)

Parameters

bValid
Sets the result of an external validation process.

Description
The internal information set by this method is only queried on cancelling the default validation in
any OnBeforeValidate handler.

Available with TypeLibrary version 1.5

Errors
1400 The object is no longer valid.

SetPathName (obsolete)

Superseded by Document.FullName
// ----- javascript sample -----
// instead of:
// Application.ActiveDocument.SetPathName("C:\\myXMLFiles\\test.xml");
// use now:
Application.ActiveDocument.FullName = "C:\\myXMLFiles\\test.xml";

See also

Method: SetPathName (strPath as String)

Description
The method SetPathName sets the path of the active document. SetPathName only copies
the string and does not check if the path is valid. All succeeding save operations are done into
this file.

StartChanges
See also

Method: StartChanges()

Description
After StartChanges is executed XMLSpy will not update its editor windows until
Document.EndChanges is called. This increases performance of complex tasks to the XML
structure.

Errors
1400 The object is no longer valid.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1027

Suggestions
Property: Suggestions as Array

Description
This property contains the last valid user suggestions for this document. The XMLSpy
generated suggestions can be modified before they are shown to the user in the
OnBeforeShowSuggestions event.

Errors
1400 The object is no longer valid.
1407 Invalid parameter or invalid address for the return parameter was
specified.

SwitchViewMode
See also

Method: SwitchViewMode (nMode as SPYViewModes) as Boolean

Return value
Returns true if view mode is switched.

Description
The method sets the current view mode of the document in XMLSpy. See also
Document.CurrentViewMode.

Errors
1400 The object is no longer valid.
1407 Invalid address for the return parameter was specified.
1417 Invalid view mode specified.

TextView
See also

Property: TextView as TextView

Description
This property provides access to the text view functionality of the document.

Errors
1400 The object is no longer valid.
1407 Invalid address for the return parameter was specified.

Title
See also

Property: Title as String (read-only)

Description
Title contains the file name of the document. To get the path and filename of the file use
FullName.

© 2010 Altova GmbH Programmers' Reference


1028 The XMLSpy API Interfaces

Errors
1400 The document object is no longer valid.
1407 Invalid address for the return parameter was specified.

TransformXSL
See also

Method: TransformXSL()

Description
TransformXSL processes the XML document via the associated XSL file. See
Document.AssignXSL on how to place a reference to a XSL file into the document.

Errors
1400 The document object is no longer valid.
1411 Error during transformation process.

TransformXSLEx
See also

Method: TransformXSL(nAction as SPYDialogAction)

Description
TransformXSL processes the XML document via the associated XSL file. See
Document.AssignXSL on how to place a reference to a XSL file into the document.

Errors
1400 The document object is no longer valid.
1411 Error during transformation process.

TransformXSLFO
See also

Method: TransformXSLFO()

Description
TransformXSLFO processes the XML document via the associated XSLFO file. See
AssignXSLFO on how to place a reference to a XSLFO file into the document. You need to
assign a FOP processor to XMLSpy before you can use this method.

Errors
1400 The document object is no longer valid.
1411 Error during transformation process.

TreatXBRLInconsistencies AsErrors
Property: TreatXBRLInconsistenciesAsErrors as Boolean

Description
If this is set to true the Document.IsValid() method will return false for XBRL instances
containing inconsistencies as defined by the XBRL Specification. The default value of this
property is false.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1029

Errors
1400 The document object is no longer valid.
1407 Invalid address for the return parameter was specified.

UpdateViews
See also

Method: UpdateViews()

Description
To redraw the Enhanced Grid View and the Tree View call UpdateViews. This can be
important after you changed the XMLData structure of a document. This method does not
redraw the text view of XMLSpy.

Errors
1400 The document object is no longer valid.

UpdateXMLData
See also

Method: UpdateXMLData() as Boolean

Description
The XMLData tree is updated from the current view. Please note that this can fail in case of the
TextView if the current XML text is not well-formed. This is not necessary if CurrentViewMode
is spyViewGrid or spyViewAuthentic because these views keep the XMLData updated.

Available with TypeLibrary version 1.5

Errors
1400 The document object is no longer valid.

4.3.11 Documents
See also

Properties
Count
Item

Methods
NewFile
OpenFile
OpenURL
OpenURLDialog
NewFileFromText

Description

© 2010 Altova GmbH Programmers' Reference


1030 The XMLSpy API Interfaces

This object represents the set of documents currently open in XMLSpy. Use this object to open
further documents or iterate through already opened documents.

Examples
' ---------------------------------------
' XMLSpy scripting environment - VBScript
' iterate through open documents
' ---------------------------------------
Dim objDocuments
Set objDocuments = Application.Documents

For Each objDoc In objDocuments


'do something useful with your document
objDoc.SetActiveDocument()
Next

// ---------------------------------------
// XMLSpy scripting environment - JScript
// close all open documents
// ---------------------------------------
for (var iter = new Enumerator (Application.Documents);
! iter.atEnd();
iter.moveNext())
{
// MsgBox ("Closing file " + iter.item().Name);
iter.item().Close (true);
}

Count
See also

Property: Count as long

Description
Count of open documents.

Item
See also

Method: Item (n as long) as Document

Description
Gets the document with the index n in this collection. Index is 1-based.

NewFile
See also

Method: NewFile (strFile as String, strType as String) as Document

Parameters
st
rFi
l
e
Full path of new file.

strType
Type of new file as string (i.e. "xml", "xsd", ... )

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1031

Return Value
Returns the new file.

Description
NewFile creates a new file of type strType (i.e. "xml"). The newly created file is also the
ActiveDocument.

NewFileFromText
See also

Method: NewFileFromText (strText as String, strType as String) as Document

Parameters
st
rText
The content of the new document in plain text.

strType
Type of the document to create (i.e. "xml").

Return Value
The method returns the new document.

Description
NewFileFromText creates a new document with strText as its content.

OpenFile
See also

Method: OpenFile (strPath as String, bDialog as Boolean) as Document

Parameters
strPath
Path and file name of file to open.

bDi
al
og
Show dialogs for user input.

Return Value
Returns the opened file on success.

Description
OpenFile opens the file strPath . If bDi
al
og is TRUE, a file-dialog will be displayed.

Example
Dim objDoc As Document
Set objDoc = objSpy.Documents.OpenFile(strFile, False)

OpenURL
See also

Method: OpenURL (strURL as String, nURLType as SPYURLTypes, nLoading as

© 2010 Altova GmbH Programmers' Reference


1032 The XMLSpy API Interfaces

SPYLoading, strUser as String, strPassword as String) as Document

Parameters
strURL
URL to open as document.

nU R LType
Type of document to open. Set to -1 for auto detection.

nLoading
Set nLoading to 0 (zero) if you want to load it from cache or proxy. Otherwise set nLoading to 1.

strUser
Name of the user if required. Can be empty.

strPassword
Password for authentification. Can be empty.

Return Value
The method returns the opened document.

Description
O penU R Lopens the URL strURL.

OpenURLDialog
See also

Method: OpenURLDialog (strURL as String, nURLType as SPYURLTypes, nLoading as


SPYLoading, strUser as String, strPassword as String) as Document

Parameters
strURL
URL to open as document.

nU R LType
Type of document to open. Set to -1 for auto detection.

nLoading
Set nLoading to 0 (zero) if you want to load it from cache or proxy. Otherwise set nLoading to 1.

strUser
Name of the user if required. Can be empty.

strPassword
Password for authentification. Can be empty.

Return Value
The method returns the opened document.

Description
O penURLDialog displays the "open URL" dialog to the user and presets the input fields with the given
parameters.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1033

4.3.12 DTDSchemaGeneratorDlg
See also

Properties and Methods

Standard automation properties


Appl
i
cati
on
Parent

D TD Schem aForm at
Val ueList
TypeDetection
FrequentElem ents
M ergeAllEqualNam ed
Resol veEntiti
es
Attri
buteTypeDefi ni
ti
on
Gl obalAttri
butes
OnlyStringEnum s
M axEnum Length
OutputPath
OutputPathDi alogActi
on

Description
Use this object to configure the generation of a schema or DTD. The method
GenerateDTDOrSchemaEx expects a DTDSchemaGeneratorDlg as parameter to configure the
generation as well as the associated user interactions.

Application
Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
3000 The object is no longer valid.
3001 Invalid address for the return parameter was specified.

AttributeTypeDefinition
Property: AttributeTypeDefinition as SPYAttributeTypeDefinition

Description
Specifies how attribute definitions get merged.

Errors
3000 The object is no longer valid.
3001 Invalid address for the return parameter was specified.

DTDSchemaFormat
Property: DTDSchemaFormat as SPYDTDSchemaFormat

© 2010 Altova GmbH Programmers' Reference


1034 The XMLSpy API Interfaces

Description
Sets the schema output format to DTD, or W3C.

Errors
3000 The object is no longer valid.
3001 Invalid address for the return parameter was specified.

FrequentElements
Property: FrequentElements as SPYFrequentElements

Description
Shall the types for all elements be defined as global? Use that value spyGlobalComplexType to
define them on global scope. Otherwise, use the value spyGlobalElements.

Errors
3000 The object is no longer valid.
3001 Invalid address for the return parameter was specified.

GlobalAttributes
Property: GlobalAttributes as Boolean

Description
Shall attributes with same name and type be resolved globally?

Errors
3000 The object is no longer valid.
3001 Invalid address for the return parameter was specified.

MaxEnumLength
Property: MaxEnumLength as Integer

Description
Specifies the maximum number of characters allowed for enumeration names. If one value is
longer than this, no enumeration will be generated.

Errors
3000 The object is no longer valid.
3001 Invalid address for the return parameter was specified.

MergeAllEqualNamed
Property: MergeAllEqualNamed as Boolean

Description
Shall types of all elements with the same name be merged into one type?

Errors
3000 The object is no longer valid.
3001 Invalid address for the return parameter was specified.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1035

OnlyStringEnums
Property: OnlyStringEnums as Boolean

Description
Specifies if enumerations will be created only for plain strings or all types of values.

Errors
3000 The object is no longer valid.
3001 Invalid address for the return parameter was specified.

OutputPath
Property: OutputPath as String

Description
Selects the file name for the generated schema/DTD.

Errors
3000 The object is no longer valid.
3001 Invalid address for the return parameter was specified.

OutputPathDialogAction
Property: OutputPathDialogAction as SPYDialogAction

Description
Defines how the sub-dialog for selecting the schema/DTD output path gets handled. Set this
value to spyDialogUserInput(2) to show the dialog with the current value of the OutputPath
property as default. Use spyDialogOK(0) to hide the dialog from the user.

Errors
3000 The object is no longer valid.
3001 Invalid address for the return parameter was specified.

Parent
Property: Parent as Dialogs (read-only)

Description
Access the parent of the object.

Errors
3000 The object is no longer valid.
3001 Invalid address for the return parameter was specified.

ResolveEntities
Property: ResolveEntities as Boolean

Description

© 2010 Altova GmbH Programmers' Reference


1036 The XMLSpy API Interfaces

Shall all entities be resolved before generation starts? If yes, an info-set will be built.

Errors
3000 The object is no longer valid.
3001 Invalid address for the return parameter was specified.

TypeDetection
Property: TypeDetection as SPYTypeDetection

Description
Specifies granularity of simple type detection.

Errors
3000 The object is no longer valid.
3001 Invalid address for the return parameter was specified.

ValueList
Property: ValueList as Integer

Description
Generate not more than this amount of enumeration-facets per type. Set to -1 for unlimited.

Errors
3000 The object is no longer valid.
3001 Invalid address for the return parameter was specified.

4.3.13 ElementList
See also

Properties
Count
Item

Methods
RemoveElement

Description
Element lists are used for different purposes during export and import of data. Depending on
this purpose, different properties of ElementListItem are used.

It can hold
 a list of table names returned by a call to Application.GetDatabaseTables,
 a list of field names retuned by a call to
Application.GetDatabaseImportElementList or
Application.GetTextImportElementList,
 a field name filter list used in Application.ImportFromDatabase and
Application.ImportFromText,
 a list of table names and counts for their rows and columns as returned by calls to
GetExportElementList or

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1037

 a field name filter list used in Document.ExportToDatabase and


Document.ExportToText.

Count
See also

Property: Count as long (read-only)

Description
Count of elements in this collection.

Item
See also

Method: Item(n as long) as ElementListItem

Description
Gets the element with the index n from this collection. The first item has index 1.

RemoveElement
See also

Method: RemoveElement(Index as long)

Description
Rem oveElem ent removes the element Index from the collection. The first Item has index 1.

4.3.14 ElementListItem
See also

Properties
Name

ElementKind

FieldCount
RecordCount

Description
An element in an ElementList. Usage of its properties depends on the purpose of the
element list. For details see ElementList.

ElementKind
See also

Property: ElementKind as SPYXMLDataKind

Description
Specifies if a field should be imported as XML element (data value of spyXM LDataElem ent ) or
attribute (data value of spyXM LDataAttr ).

© 2010 Altova GmbH Programmers' Reference


1038 The XMLSpy API Interfaces

FieldCount
See also

Property: FieldCount as long (read-only)

Description
Count of fields (i.e. columns) in the table described by this element. This property is only valid
after a call to Docum ent.GetExportElem entList .

Name
See also

Property: Name as String (read-only)

Description
Name of the element. This is either the name of a table or a field, depending on the purpose of
th element list.

RecordCount
See also

Property: RecordCount as long (read-only)

Description
Count of records (i.e. rows) in the table described by this element. This property is only valid
after a call to Docum ent.GetExportElem entList .

4.3.15 ExportSettings
See also

Properties

ElementList

EntitiesToText

ExportAllElements
SubLevelLimit

FromAttributes
FromSingleSubElements
FromTextValues

CreateKeys
IndependentPrimaryKey

Namespace

ExportCompleteXML
StartFromElement

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1039

Description
ExportSetti
ngs contains options used during export of XML data to a database or text file. See
Import and export of data for a general overview.

CreateKeys
See also

Property: CreateKeys as Boolean

Description
This property turns creation of keys (i.e. primary key and foreign key) on or off. Default is True.

ElementList
See also

Property: ElementList as ElementList

Description
Default is empty list. This list of elements defines which fields will be exported. To get the list of
available fields use Docum ent.GetExportElem entList . It is possible to prevent exporting
columns by removing elements from this list with ElementList.RemoveElement before
passing it to Docum ent.ExportToDatabase or Docum ent.ExportToText .

EntitiesToText
See also

Property: EntitiesToText as Boolean

Description
Defines if XML entities should be converted to text or left as they are during export. Default is
True.

ExportAllElements
See also

Property: ExportAllElements as Boolean

Description
If set to t
rue , all elements in the document will be exported. If set to fse , then
al
ExportSettings.SubLevelLimit is used to restrict the number of sub levels to export.
Default is t rue .

ExportCompleteXML
See also

Property: ExportCompleteXML as Boolean

Description
Defines whether the complete XML is exported or only the element specified by

© 2010 Altova GmbH Programmers' Reference


1040 The XMLSpy API Interfaces

StartFromElement and its children. Default is True.

FromAttributes
See also

Property: FromAttributes as Boolean

Description
SetFrom Attri
butes to false if no export data should be created from attributes. Default is True.

FromSingleSubElements
See also

Property: FromSingleSubElements as Boolean

Description
SetFrom SingleSubElem ents to false if no export data should be created from elements. Default
is True.

FromTextValues
See also

Property: FromTextValues as Boolean

Description
SetFrom TextValues to false if no export data should be created from text values. Default is
True.

IndependentPrimaryKey
See also

Property: IndependentPrimaryKey as Boolean

Description
Turns creation of independent primary key counter for every element on or off. If
ExportSettings.CreateKeys is False, this property will be ignored. Default is True.

Namespace
See also

Property: Namespace as SPYExportNamespace

Description
The default setting removes all namespace prefixes from the element names. In some
database formats the colon is not a legal character. Default is spyN oN am espace .

StartFromElement
See also

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1041

Property: StartFromElement as String

Description
Specifies the start element for the export. This property is only considered when
ExportCompleteXML is false.

SubLevelLimit
See also

Property: SubLevelLimit as Integer

Description
Defines the number of sub levels to include for the export. Default is 0. This property is ignored
if ExportSettings.ExportAllElements is t rue .

4.3.16 FileSelectionDlg
See also

Properties and Methods

Standard automation properties


Appl
i
cati
on
Parent

Dialog properties
FullNam e

Acceptance or cancellation of action that caused event


Di
al
ogActi
on

Description
The dialog object allows you to receive information about an event and pass back information to
the event handler in the same way as with a user dialog. Use the Fil
eSel
ecti
onDl
g.Ful
l
Nam e to
select or modify the file path and set the Fi
l
eSel
ecti
onDl
g.Di
al
ogActi
on property to cancel or
agree with the action that caused the event.

Application
See also

Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
2400 The object is no longer valid.
2401 Invalid address for the return parameter was specified.

© 2010 Altova GmbH Programmers' Reference


1042 The XMLSpy API Interfaces

DialogAction
Property: DialogAction as SPYDialogAction

Description
If you want your script to perform the file selection operation without any user interaction
necessary, simulate user interaction by either setting the property to spyDialogOK(0) or
spyDialogCancel(1).
To allow your script to fill in the default values but let the user see and react on the dialog, use
the value spyDialogUserInput(2). If you receive a FileSelectionDlg object in an event handler,
spyDialogUserInput(2) is not supported and will be interpreted as spyDialogOK(0).

Errors
2400 The object is no longer valid.
2401 Invalid value for dialog action or invalid address for the return parameter
was specified.

FullName
Property: FullName as String

Description
Access the full path of the file the gets selected by the dialog. Most events that pass a
FileSelectionDlg object to you allow you modify this value and thus influence the action that
caused the event (e.g. load or save to a different location).

Errors
2400 The object is no longer valid.
2401 Invalid address for the return parameter was specified.

Parent
See also

Property: Parent as Dialogs (read-only)

Description
Access the parent of the object.

Errors
2400 The object is no longer valid.
2401 Invalid address for the return parameter was specified.

4.3.17 FindInFilesDlg
See also

Properties and Methods

Standard automation properties


Appl
i
cati
on
Parent

Fi
nd
RegularExpression

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1043

Replace
DoReplace
ReplaceO nDisk
M atchW holeW ord
M atchCase
SearchLocation
StartFol
der
Incl
udeSubfol ders
SearchInProj ectFi
l
esDoExternal
Fil
eExtension
AdvancedXM LSearch
XM LElem entN am es
XM LElem entContents
XM LAttributeNam es
XM LAttributeContents
X M LC om m ents
XM LC D ata
XM LPI
XM LR est
ShowResult

Description
Use this object to configure the search (or replacement) for strings in files. The method
FindInFiles expects a FindInFilesDlg as parameter.

AdvancedXMLSearch
Property: AdvancedXMLSearch as Boolean

Description
Specifies if the XML search properties (XMLElementNames, XMLElementContents,
XMLAttributeNames, XMLAttributeContents, XMLComments, XMLCData, XMLPI and XMLRest
) are considered. The default is false.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

Application
Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

DoReplace
Property: DoReplace as Boolean

Description
Specifies if the matched string is replaced by the string defined in Replace. The default is false.

© 2010 Altova GmbH Programmers' Reference


1044 The XMLSpy API Interfaces

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

FileExtension
Property: FileExtension as String

Description
Specifies the file filter of the files that should be considered during the search. Multiple file filters
must be delimited with a semicolon (eg: *.xml;*.dtd;a*.xsd). Use the wildcards * and ? to define
the file filter.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

Find
Property: Find as String

Description
Specifies the string to search for.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

IncludeSubfolders
Property: IncludeSubfolders as Boolean

Description
Specifies if subfolders are searched too. The default is true.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

MatchCase
Property: MatchCase as Boolean

Description
Specifies if the search is case sensitive. The default is true.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

MatchWholeWord
Property: MatchWholeWord as Boolean

Description
Specifies whether the whole word or just a part of it must match. The default is false.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1045

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

Parent
Property: Parent as Dialogs (read-only)

Description
Access the parent of the object.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

RegularExpression
Property: RegularExpression as Boolean

Description
Specifies if Find contains a regular expression. The default is false.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

Replace
Property: Replace as String

Description
Specifies the replacement string. The matched string is only replaced if DoReplace is set true.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

ReplaceOnDisk
Property: ReplaceOnDisk as Boolean

Description
Specifies if the replacement is done directly on disk. The modified file is not opened. The default
is false.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

SearchInProjectFilesDoExternal
Property: SearchInProjectFilesDoExternal as Boolean

Description
Specifies if the external folders in the open project are searched, when a project search is

© 2010 Altova GmbH Programmers' Reference


1046 The XMLSpy API Interfaces

performed. The default is false.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

SearchLocation
Property: SearchLocation as SPYFindInFilesSearchLocation

Description
Specifies the location of the search. The default is spyFindInFiles_Documents.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

ShowResult
Property: ShowResult as Boolean

Description
Specifies if the result is displayed in the Find in Files output window. The default is false.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

StartFolder
Property: StartFolder as String

Description
Specifies the folder where the disk search starts.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

XMLAttributeContents
Property: XMLAttributeContents as Boolean

Description
Specifies if attribute contents are searched when AdvancedXMLSearch is true. The default is
true.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

XMLAttributeNames
Property: XMLAttributeNames as Boolean

Description

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1047

Specifies if attribute names are searched when AdvancedXMLSearch is true. The default is
true.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

XMLCData
Property: XMLCData as Boolean

Description
Specifies if CData tags are searched when AdvancedXMLSearch is true. The default is true.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

XMLComments
Property: XMLComments as Boolean

Description
Specifies if comments are searched when AdvancedXMLSearch is true. The default is true.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

XMLElementContents
Property: XMLElementContents as Boolean

Description
Specifies if element contents are searched when AdvancedXMLSearch is true. The default is
true.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

XMLElementNames
Property: XMLElementNames as Boolean

Description
Specifies if element names are searched when AdvancedXMLSearch is true. The default is
true.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

© 2010 Altova GmbH Programmers' Reference


1048 The XMLSpy API Interfaces

XMLPI
Property: XMLPI as Boolean

Description
Specifies if XML processing instructions are searched when AdvancedXMLSearch is true. The
default is true.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

XMLRest
Property: XMLRest as Boolean

Description
Specifies if the rest of the XML (which is not covered by the other XML search properties) is
searched when AdvancedXMLSearch is true. The default is true.

Errors
3500 The object is no longer valid.
3501 Invalid address for the return parameter was specified.

4.3.18 FindInFilesResult
See also

Properties and Methods

Standard automation properties


Appl
i
cati
on
Parent

Count
Item

Path
Docum ent

Description
This object represents a file that matched the search criteria. It contains a list of
FindInFilesResultMatch objects that describe the matching position.

Application
Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
3700 The object is no longer valid.
3701 Invalid address for the return parameter was specified.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1049

Count
Property: Count as long (read-only)

Description
Count of elements in this collection.

Document
Property: Path as Document (read-only)

Description
This property returns the Document object if the matched file is already open in XMLSpy.

Errors
3700 The object is no longer valid.
3701 Invalid address for the return parameter was specified.

Item
Method: Item(n as long) as FindInFilesResultMatch

Description
Gets the element with the index n from this collection. The first item has index 1.

Parent
Property: Parent as FindInFilesResults (read-only)

Description
Access the parent of the object.

Errors
3700 The object is no longer valid.
3701 Invalid address for the return parameter was specified.

Path
Property: Path as String (read-only)

Description
Returns the path of the file that matched the search criteria.

Errors
3700 The object is no longer valid.
3701 Invalid address for the return parameter was specified.

4.3.19 FindInFilesResultMatch
See also

Properties and Methods

© 2010 Altova GmbH Programmers' Reference


1050 The XMLSpy API Interfaces

Standard automation properties


Appl
i
cati
on
Parent

Li
ne
Posi
t
i
on
Length
Li
neText
Replaced

Description
Contains the exact position in the file of the matched string.

Application
Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
3800 The object is no longer valid.
3801 Invalid address for the return parameter was specified.

Length
Property: Length as Long (read-only)

Description
Returns the length of the matched string.

Errors
3800 The object is no longer valid.
3801 Invalid address for the return parameter was specified.

Line
Property: Line as Long (read-only)

Description
Returns the line number of the match. The line numbering starts with 0.

Errors
3800 The object is no longer valid.
3801 Invalid address for the return parameter was specified.

LineText
Property: LineText as String (read-only)

Description
Returns the text of the line.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1051

Errors
3800 The object is no longer valid.
3801 Invalid address for the return parameter was specified.

Parent
Property: Parent as FindInFilesResult (read-only)

Description
Access the parent of the object.

Errors
3800 The object is no longer valid.
3801 Invalid address for the return parameter was specified.

Position
Property: Position as Long (read-only)

Description
Returns the start position of the match in the line. The position numbering starts with 0.

Errors
3800 The object is no longer valid.
3801 Invalid address for the return parameter was specified.

Replaced
Property: Replaced as Boolean (read-only)

Description
True if the matched string was replaced.

Errors
3800 The object is no longer valid.
3801 Invalid address for the return parameter was specified.

4.3.20 FindInFilesResults
See also

Properties and Methods

Standard automation properties


Appl
i
cati
on
Parent

Count
Item

Description

© 2010 Altova GmbH Programmers' Reference


1052 The XMLSpy API Interfaces

This is the result of the FindInFiles method. It is a list of FindInFilesResult objects.

Application
Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
3600 The object is no longer valid.
3601 Invalid address for the return parameter was specified.

Count
Property: Count as long (read-only)

Description
Count of elements in this collection.

Item
Method: Item(n as long) as FindInFilesResult

Description
Gets the element with the index n from this collection. The first item has index 1.

Parent
Property: Parent as Application (read-only)

Description
Access the parent of the object.

Errors
3600 The object is no longer valid.
3601 Invalid address for the return parameter was specified.

4.3.21 GenerateSampleXMLDlg
See also

Properties and Methods

Standard automation properties


Appl
i
cati
on
Parent

NonMandatoryAttributes
RepeatCount
FillAttributesWithSampleData
FillElementsWithSampleData
ContentOfNillableElementsIsNonMandatory
TryToUseNonAbstractTypes

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1053

Optimization
SchemaOrDTDAssignment
LocalNameOfRootElement
NamespaceURIOfRootElement
OptionsDialogAction

Properties that are no longer supported


NonMandatoryElements - obsolete
TakeFirstChoice - obsolete
FillWithSampleData - obsolete

Description
Used to set the parameters for the generation of sample XML instances based on a W3C
schema or DTD.

Application
Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
2200 The object is no longer valid.
2201 Invalid address for the return parameter was specified.

Parent
Property: Parent as Dialogs (read-only)

Description
Access the parent of the object.

Errors
2200 The object is no longer valid.
2201 Invalid address for the return parameter was specified.

NonMandatoryAttributes
Property: NonMandatoryAttributes as Boolean

Description
If true attributes which are not mandatory are created in the sample XML instance file.

Errors
2200 The object is no longer valid.
2201 Invalid address for the return parameter was specified.

NonMandatoryElements - obsolete
Property: NonMandatoryElements as Boolean

Description
Do no longer use this property. Use Optimization, instead.

© 2010 Altova GmbH Programmers' Reference


1054 The XMLSpy API Interfaces

Errors
0001 The property is no longer accessible.

TakeFirstChoice - obsolete
Property: TakeFirstChoice as Boolean

Description
Do no longer use this property.

Errors
0001 The property is no longer accessible.

RepeatCount
Property: RepeatCount as long

Description
Number of elements to create for repeated types.

Errors
2200 The object is no longer valid.
2201 Invalid address for the return parameter was specified.

FillWithSampleData - obsolete

Property: FillWithSampleData as Boolean

Description
Do no longer access this property. Use FillAttributesWithSampleData and
FillElementsWithSampleData, instead.

Errors
0001 The property is no longer accessible.

FillElementsWithSampleData
Property: FillElementsWithSampleData as Boolean

Description
If true, elements will have sample content.

Errors
2200 The object is no longer valid.
2201 Invalid address for the return parameter was specified.

FillAttributesWithSampleData
Property: FillAttributesWithSampleData as Boolean

Description
If true, attributes will have sample content.

Errors
2200 The object is no longer valid.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1055

2201 Invalid address for the return parameter was specified.

ContentOfNillableElementsIsNonMandatory
Property: ContentOfNillableElementsIsNonMandatory as Boolean

Description
If true, the contents of elements that are nillable will not be treated as mandatory.

Errors
2200 The object is no longer valid.
2201 Invalid address for the return parameter was specified.

TryToUseNonAbstractTypes
Property: TryToUseNonAbstractTypes as Boolean

Description
If true, tries to use a non-abstract type for xsi:type, if element has an abstract type.

Errors
2200 The object is no longer valid.
2201 Invalid address for the return parameter was specified.

Optimization
Property: Optimization as SPYSampleXMLGenerationOptimization

Description
Specifies which elements will be generated.

Errors
2200 The object is no longer valid.
2201 Invalid address for the return parameter was specified.

SchemaOrDTDAssignment
Property: SchemaOrDTDAssignment as
SPYSampleXMLGenerationSchemaOrDTDAssignment

Description
Specifies in which way a reference to the related schema or DTD - which is this document - will
be generated into the sample XML.

Errors
2200 The object is no longer valid.
2201 Invalid address for the return parameter was specified.

LocalNameOfRootElement
Property: LocalNameOfRootElement as String

Description
Specifies the local name of the root element for the generated sample XML.

Errors

© 2010 Altova GmbH Programmers' Reference


1056 The XMLSpy API Interfaces

2200 The object is no longer valid.


2201 Invalid address for the return parameter was specified.

NamespaceURIOfRootElement
Property: NamespaceURIOfRootElement as String

Description
Specifies the namespace URI of the root element for the generated sample XML.

Errors
2200 The object is no longer valid.
2201 Invalid address for the return parameter was specified.

OptionsDialogAction
Property: OptionsDialogAction as SPYDialogAction

Description
To allow your script to fill in the default values and let the user see and react on the dialog, set
this property to the value spyDialogUserInput(2). If you want your script to define all the options
in the schema documentation dialog without any user interaction necessary, use
spyDialogOK(0). Default is spyDialogOK.

Errors
2200 The object is no longer valid.
2201 Invalid value has been used to set the property.
Invalid address for the return parameter was specified.

4.3.22 GridView
See also

Methods
Deselect
Select

SetFocus

Properties
CurrentFocus

IsVisible

Description
GridView Class

Events

OnBeforeDrag
See also

Event: OnBeforeDrag()asBoolean

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1057

XMLSpy scripting environment - VBScript:


Function On_BeforeDrag()
'On_BeforeStartEdi
ti
ng=Fal
se 'toprohi
bi
tdraggi
ng
End Function

XMLSpy scripting environment - JScript:


functi
on On_BeforeDrag()
{
/ret
urnf
al
se;/
*t
oprohi
bi
tdraggi
ng*/
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (4, ...) //nEventId=4

Description
This event gets fired on an attempt to drag an XMLData element on the grid view. Return false
to prevent dragging the data element to a different position.

OnBeforeDrop
See also

Event: OnBeforeDrop(objXMLData as XMLData)asBoolean

XMLSpy scripting environment - VBScript:


Function On_BeforeDrop(objXMLData)
'On_BeforeStartEdi
ti
ng=Fal
se 'toprohi
bi
tdroppi
ng
End Function

XMLSpy scripting environment - JScript:


functi
on On_BeforeDrop(objXMLData)
{
/ret
urnf
al
se;/
*t
oprohi
bi
tdroppi
ng*/
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (5, ...) //nEventId=5

Description
This event gets fired on an attempt to drop a previously dragged XMLData element on the grid
view. Return false to prevent the data element to be moved from its original position to the drop
destination position.

OnBeforeStartEditing
See also

Event: OnBeforeStartEditing(objXMLData as XMLData,bEditingName asBoolean)as


Boolean

XMLSpy scripting environment - VBScript:


Function On_BeforeStartEditing(objXMLData,bEditingName)
'On_BeforeStartEdi
ti
ng=Fal
se'toprohi
bi
tedi
ti
ngthefi
el
d

© 2010 Altova GmbH Programmers' Reference


1058 The XMLSpy API Interfaces

End Function

XMLSpy scripting environment - JScript:


functi
on On_BeforeStartEditing(objXMLData,bEditingName)
{
/ret
urnf
al
se;/
*t
oprohi
bi
tedi
t
ngt
hef
i
el
d*/
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (1, ...) //nEventId=1

Description
This event gets fired before the editing mode for a grid cell gets entered. If the parameter
bEditingName is true, the name part of the element will be edited, it its value is false, the value
part will be edited.

OnEditingFinished
See also

Event: OnEditingFinished(objXMLData as XMLData,bEditingName asBoolean)

XMLSpy scripting environment - VBScript:


Function On_EditingFinished(objXMLData,bEditingName)
End Function

XMLSpy scripting environment - JScript:


functi
on On_EditingFinished(objXMLData,bEditingName)
{
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (2, ...) //nEventId=2

Description
This event gets fired when the editing mode of a grid cell gets left. The parameter
bEditingName specifies if the name part of the element has been edited.

OnFocusChanged
See also

Event: OnFocusChanged(objXMLData as XMLData,bSetFocus asBoolean,


bEditingName asBoolean)

XMLSpy scripting environment - VBScript:


Function On_FocusChanged(objXMLData,bSetFocus,bEditingName)
End Function

XMLSpy scripting environment - JScript:


functi
on On_FocusChanged(objXMLData,bSetFocus,bEditingName)
{
}

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1059

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (3, ...) //nEventId=3

Description
This event gets fired whenever a grid cell receives or looses the cursor focus. If the parameter
bEditingName is true, focus of the name part of the grid element has changed. Otherwise, focus
of the value part has changed.

CurrentFocus
See also

Property: CurrentFocus as XMLData

Description
Holds the XML element with the current focus. This property is read-only.

Deselect
See also

Method: Deselect(pData as XMLData)

Description
Deselects the element pData in the grid view.

IsVisible
See also

Property: IsVisible as Boolean

Description
True if the grid view is the active view of the document. This property is read-only.

Select
See also

Method: Select (pData as XMLData)

Description
Selects the XML element pData in the grid view.

SetFocus
See also

Method: SetFocus (pFocusData as XMLData)

Description
Sets the focus to the element pFocusData in the grid view.

© 2010 Altova GmbH Programmers' Reference


1060 The XMLSpy API Interfaces

4.3.23 SchemaDocumentationDlg
See also

Properties and Methods

Standard automation properties


Application
Parent

Interaction and visibility properties


SetOutputFile
OutputFileDialogAction
OptionsDialogAction
ShowProgressBar
ShowResult

Document generation options and methods


OutputFormat
EmbedDiagrams
DiagramFormat
MultipleOutputFiles
EmbedCSSInHTML
CreateDiagramsFolder
GenerateRelativeLinks

IncludeAll
IncludeIndex
IncludeGlobalAttributes
IncludeGlobalElements
IncludeLocalAttributes
IncludeLocalElements
IncludeGroups
IncludeComplexTypes
IncludeSimpleTypes
IncludeAttributeGroups
IncludeRedefines
IncludeReferencedSchemas

AllDetails
ShowDiagram
ShowNamespace
ShowType
ShowChildren
ShowUsedBy
ShowProperties
ShowSingleFacets
ShowPatterns
ShowEnumerations
ShowAttributes
ShowIdentityConstraints
ShowAnnotations
ShowSourceCode

Description
This object combines all options for schema document generation as they are available through
user interface dialog boxes in XMLSpy. The document generation options are initialized with the
values used during the last generation of schema documentation. However, before using the

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1061

object you have to set the SetOutputFile property to a valid file path. Use
OptionsDialogAction, OutputFileDialogAction and ShowProgressBar to specify
the level of user interaction desired. You can use I
ncl
udeAl
l and All
Det
ai
l
s to set whole option
groups at once or the individual properties to operate on a finer granularity.

AllDetails
See also

Method: AllDetails (i_bDetailsOn as Boolean )

Description
Use this method to turn all details options on or off.

Errors
2900 The object is no longer valid.

Application
See also

Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

CreateDiagramsFolder
See also

Property: CreateDiagramsFolder as Boolean

Description
Set this property to t
rue , to create a directory for the created images. Otherwise the diagrams
will be created next to the documentation. This property is only available when the diagrams are
not embedded. The property is initialized with the value used during the last call to
Docum ent.G enerateW SDLDocum entation . The default for the first run is false.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

© 2010 Altova GmbH Programmers' Reference


1062 The XMLSpy API Interfaces

DiagramFormat
See also

Property: DiagramFormat as SPYImageKind

Description
This property specifies the generated diagram image type. This property is not available for
HTML documentation. The property is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is PNG.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

EmbedCSSInHTML
See also

Property: EmbedCSSInHTML as Boolean

Description
Set this property to true , to embed the CSS data in the generated HTML document. Otherwise a
separate file will be created and linked. This property is only available for HTML documentation.
The property is initialized with the value used during the last call to
Docum ent.G enerateW SDLDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

EmbedDiagrams
See also

Property: EmbedDiagrams as Boolean

Description
Set this property to true , to embed the diagrams in the generated document. This property is not
available for HTML documentation. The property is initialized with the value used during the last
call to Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

GenerateRelativeLinks
See also

Property: GenerateRelativeLinks as Boolean

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1063

Description
Set this property to t
rue , to create relative paths to local files. This property is not available for
HTML documentation. The property is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is false.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

IncludeAll
See also

Method: IncludeAll (i_bInclude as Boolean )

Description
Use this method to mark or unmark all include options.

Errors
2900 The object is no longer valid.

IncludeAttributeGroups
See also

Property: IncludeAttributeGroups as Boolean

Description
Set this property to t rue , to include attribute groups in the schema documentation. The property
is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

IncludeComplexTypes
See also

Property: IncludeComplexTypes as Boolean

Description
Set this property to true , to include complex types in the schema documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateSchem aDocum entation .
The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

© 2010 Altova GmbH Programmers' Reference


1064 The XMLSpy API Interfaces

IncludeGlobalAttributes
See also

Property: IncludeGlobalAttributes as Boolean

Description
Set this property to t rue , to include global attributes in the schema documentation. The property
is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

IncludeGlobalElements
See also

Property: IncludeGlobalElements as Boolean

Description
Set this property to t rue , to include global elements in the schema documentation. The property
is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

IncludeGroups
See also

Property: IncludeGroups as Boolean

Description
Set this property to true , to include groups in the schema documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateSchem aDocum entation .
The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

IncludeIndex
See also

Property: IncludeIndex as Boolean

Description
Set this property to true , to include an index in the schema documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateSchem aDocum entation .

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1065

The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

IncludeLocalAttributes
See also

Property: IncludeLocalAttributes as Boolean

Description
Set this property to t rue , to include local attributes in the schema documentation. The property
is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

IncludeLocalElements
See also

Property: IncludeLocalElements as Boolean

Description
Set this property to true , to include local elements in the schema documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateSchem aDocum entation .
The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

IncludeRedefines
See also

Property: IncludeRedefines as Boolean

Description
Set this property to true , to include redefines in the schema documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateSchem aDocum entation .
The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

IncludeReferencedSchemas
See also

© 2010 Altova GmbH Programmers' Reference


1066 The XMLSpy API Interfaces

Property: IncludeReferencedSchemas as Boolean

Description
Set this property to t rue , to include referenced schemas in the schema documentation. The
property is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

IncludeSimpleTypes
See also

Property: IncludeSimpleTypes as Boolean

Description
Set this property to true , to include simple types in the schema documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateSchem aDocum entation .
The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

MultipleOutputFiles
See also

Property: MultipleOutputFiles as Boolean

Description
Set this property to t
rue , to split the documentation files. The property is initialized with the value
used during the last call to Docum ent.G enerateSchem aDocum entation . The default for the first
run is false.

Errors
2900 The object is no longer valid.
2901 Invalid value has been used to set the property.
Invalid address for the return parameter was specified.

OptionsDialogAction
See also

Property: OptionsDialogAction as SPYDialogAction

Description
To allow your script to fill in the default values and let the user see and react on the dialog, set
this property to the value spyDialogUserInput(2). If you want your script to define all the options
in the schema documentation dialog without any user interaction necessary, use
spyDialogOK(0). Default is spyDialogOK.

Errors

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1067

2900 The object is no longer valid.


2901 Invalid value has been used to set the property.
Invalid address for the return parameter was specified.

OutputFileDialogAction
See also

Property: OutputFileDialogAction as SPYDialogAction

Description
To allow the user to select the output file with a file selection dialog, set this property to
spyDialogUserInput(2). If the value stored in OutputFile should be taken and no user interaction
should occur, use spyDialogOK(0). Default is spyDialogOK.

Errors
2900 The object is no longer valid.
2901 Invalid value has been used to set the property.
Invalid address for the return parameter was specified.

OutputFormat
See also

Property: OutputFormat as SPYSchem aDocum entationForm at

Description
Defines the kind of documentation that will be generated: HTML (value=0), MS-Word (value=1),
or RTF (value=2). The property gets initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is HTML.

Errors
2900 The object is no longer valid.
2901 Invalid value has been used to set the property.
Invalid address for the return parameter was specified.

Parent
See also

Property: Parent as Dialogs (read-only)

Description
Access the parent of the object.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

SetOutputFile
See also

Property: SetOutputFile as St
ri
ng

© 2010 Altova GmbH Programmers' Reference


1068 The XMLSpy API Interfaces

Description
Full path and name of the file that will contain the generated documentation. In case of HTML
output, additional '.png' files will be generated based on this filename. The default value for this
property is an empty string and needs to be replaced before using this object in a call to
Docum ent.G enerateSchem aDocum entation .

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

ShowAnnotations
See also

Property: ShowAnnotations as Boolean

Description
Set this property to t
rue , to show the annotations to a type definition in the schema
documentation. The property is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

ShowAttributes
See also

Property: ShowAttributes as Boolean

Description
Set this property to true , to show the type definitions attributes in the schema documentation.
The property is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

ShowChildren
See also

Property: ShowChildren as Boolean

Description
Set this property to t
rue , to show the children of a type definition as links in the schema
documentation. The property is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1069

2901 Invalid address for the return parameter was specified.

ShowDiagram
See also

Property: ShowDiagram as Boolean

Description
Set this property to true , to show type definitions as diagrams in the schema documentation.
The property is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

ShowEnumerations
See also

Property: ShowEnumerations as Boolean

Description
Set this property to t
rue , to show the enumerations contained in a type definition in the schema
documentation. The property is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

ShowIdentityConstraints
See also

Property: ShowIdentityConstraints as Boolean

Description
Set this property to t
rue , to show a type definitions identity constraints in the schema
documentation. The property is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

ShowNamespace
See also

Property: ShowNamespace as Boolean

© 2010 Altova GmbH Programmers' Reference


1070 The XMLSpy API Interfaces

Description
Set this property to t
rue , to show the namespace of type definitions in the schema
documentation. The property is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

ShowPatterns
See also

Property: ShowPatterns as Boolean

Description
Set this property to true , to show the patterns of a type definition in the schema documentation.
The property is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

ShowProgressBar
See also

Property: ShowProgressBar as Boolean

Description
Set this property to t
rue , to make the window showing the document generation progress
visible. Use fse , to hide it. Default is f
al se .
al

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

ShowProperties
See also

Property: ShowProperties as Boolean

Description
Set this property to true , to show the type definition properties in the schema documentation.
The property is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1071

ShowResult
See also

Property: ShowResult as Boolean

Description
Set this property to t
rue , to automatically open the resulting document when generation was
successful. HTML documentation will be opened in XMLSpy. To show Word documentation,
MS-Word will be started. The property gets initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

ShowSingleFacets
See also

Property: ShowSingleFacets as Boolean

Description
Set this property to true , to show the facets of a type definition in the schema documentation.
The property is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

ShowSourceCode
See also

Property: ShowSourceCode as Boolean

Description
Set this property to t
rue , to show the XML source code for type definitions in the schema
documentation. The property is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

ShowType
See also

Property: ShowType as Boolean

Description

© 2010 Altova GmbH Programmers' Reference


1072 The XMLSpy API Interfaces

Set this property to t rue , to show the type of type definitions in the schema documentation. The
property is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

ShowUsedBy
See also

Property: ShowUsedBy as Boolean

Description
Set this property to t
rue , to show the used-by relation for type definitions in the schema
documentation. The property is initialized with the value used during the last call to
Docum ent.G enerateSchem aDocum entation . The default for the first run is true.

Errors
2900 The object is no longer valid.
2901 Invalid address for the return parameter was specified.

4.3.24 SpyProject
See also

Methods
CloseProject
SaveProject
SaveProjectAs

Properties
RootItems
ProjectFile

Description
ect Class
SpyProj

CloseProject
See also

Declaration: CloseProject(bDiscardChanges as Boolean, bCloseFiles as Boolean,


bDialog as Boolean)

Parameters
bDiscardChanges
Set bDiscardChanges to FALSE if you want to save the changes of the open project files and
the project.

bCloseFiles
Set bCloseFiles to TRUE to close all open project files.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1073

bDialog
Show dialogs for user input.

Description
CloseProject closes the current project.

ProjectFile
See also

Declaration: ProjectFile as String

Description
Path and filename of the project.

RootItems
See also

Declaration: RootItems as SpyProjectItems

Description
Root level of collection of project items.

SaveProject
See also

Declaration: SaveProject

Description
SaveProject saves the current project.

SaveProjectAs
See also

Declaration: SaveProjectAs (strPath as String, bDialog as Boolean)

Parameters
strPath
Full path with file name of new project file.

bDialog
If bDialog is TRUE, a file-dialog will be displayed.

Description
SaveProjectAs stores the project data into a new location.

4.3.25 SpyProjectItem
See also

Methods

© 2010 Altova GmbH Programmers' Reference


1074 The XMLSpy API Interfaces

Open

Properties
ChildItems
ParentItem
FileExtensions
ItemType
Name
Path
ValidateWith
XMLForXSLTransformation
XSLForXMLTransformation
XSLTransformationFileExtension
XSLTransformationFolder

Description
SpyProjectItem Class

ChildItems
See also

Declaration: ChildItems as SpyProjectItems

Description
If the item is a folder, Chi
l
dItem s is the collection of the folder content.

FileExtensions
See also

Declaration: FileExtensions as String

Description
Used to set the file extensions if the project item is a folder.

ItemType
See also

Declaration: ItemType as SPYProjectItemTypes

Description
This property is read-only.

Name
See also

Declaration: Name as String

Description
Name of the project item. This property is read-only.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1075

Open
See also

Declaration: Open as Document

Return Value
The project item opened as document.

Description
Opens the project item.

ParentItem
See also

Declaration: ParentItem as SpyProjectItem

Description
Parent item of the current project item. Can be NULL (Nothing) if the project item is a top-level
item.

Path
See also

Declaration: Path as String

Description
Path of project item. This property is read-only.

ValidateWith
See also

Declaration: ValidateWith as String

Description
Used to set the schema/DTD for validation.

XMLForXSLTransformation
See also

Declaration: XMLForXSLTransformation as String

Description
Used to set the XML for XSL transformation.

XSLForXMLTransformation
See also

Declaration: XSLForXMLTransformation as String

© 2010 Altova GmbH Programmers' Reference


1076 The XMLSpy API Interfaces

Description
Used to set the XSL for XML transformation.

XSLTransformationFileExtension
See also

Declaration: XSLTransformationFileExtension as String

Description
Used to set the file extension for XSL transformation output files.

XSLTransformationFolder
See also

Declaration: XSLTransformationFolder as String

Description
Used to set the destination folder for XSL transformation output files.

4.3.26 SpyProjectItems
See also

Methods
AddFile
AddFolder
AddURL
RemoveItem

Properties
Count
Item

Description
SpyProjectItem s Class

AddFile
See also

Declaration: AddFile (strPath as String)

Parameters

strPath
Full path with file name of new project item

Description
The method adds a new file to the collection of project items.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1077

AddFolder
See also

Declaration: AddFolder (strName as String)

Parameters

strNam e
Name of the new folder.

Description
The method AddFolder adds a folder with the name strNam e to the collection of project items.

AddURL
See also

Declaration: AddURL (strURL as String, nURLType as SPYURLTypes, strUser as String,


strPassword as String, bSave as Boolean)

Description

strURL
URL to open as document.

nU R LType
Type of document to open. Set to -1 for auto detection.

strUser
Name of the user if required. Can be empty.

strPassword
Password for authentification. Can be empty.

bSave
Save user and password information.

Description
The method adds an URL item to the project collection.

Count
See also

Declaration: Count as long

Description
This property gets the count of project items in the collection. The property is read-only.

Item
See also

Declaration: Item (n as long) as SpyProjectItem

© 2010 Altova GmbH Programmers' Reference


1078 The XMLSpy API Interfaces

Description
Retrieves the n-th element of the collection of project items. The first item has index 1.

RemoveItem
See also

Declaration: RemoveItem (pItem as SpyProjectItem)

Description
RemoveItem deletes the item pItem from the collection of project items.

4.3.27 TextImportExportSettings
See also

Properties for import only


ImportFile

Properties for export only


DestinationFolder
FileExtension
CommentIncluded
RemoveDelimiter
RemoveNewline

Properties for import and export


HeaderRow
FieldDelimiter
EnclosingCharacter
Encoding
EncodingByteOrder

Description
TextIm portExportSetti
ngs contains options common to text import and export functions.

CommentIncluded
See also

Property: CommentIncluded as Boolean

Description
This property tells whether additional comments are added to the generated text file. Default is
true. This property is used only when exporting to text files.

DestinationFolder
See also

Property: DestinationFolder as String

Description
The property DestinationFolder sets the folder where the created files are saved during
text export.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1079

EnclosingCharacter
See also

Property: EnclosingCharacter as SPYTextEnclosing

Description
This property defines the character that encloses all field values for import and export. Default
is spyNoEnclosing.

Encoding
See also

Property: Encoding as String

Description
The property Encoding sets the character encoding for the text files for importing and
exporting.

EncodingByteOrder
See also

Property: EncodingByteOrder as SPYEncodingByteOrder

Description
The property EncodingByteOrder sets the byte order for Unicode characters. Default is spyNONE.

FieldDelimiter
See also

Property: FieldDelimiter as SPYTextDelimiters

Description
The property FieldDelimiter defines the delimiter between the fields during import and
export. Default is spyTabulator.

FileExtension
See also

Property: FileExtension as String

Description
This property sets the file extension for files created on text export.

HeaderRow
See also

Property: HeaderRow as Boolean

© 2010 Altova GmbH Programmers' Reference


1080 The XMLSpy API Interfaces

Description
The property HeaderRow is used during import and export. Set HeaderRow true on import, if
the first line of the text file contains the names of the columns. Set HeaderRow true on export, if
the first line in the created text files should contain the name of the columns. Default value is
true.

ImportFile
See also

Property: ImportFile as String

Description
This property is used to set the text file for import. The string has to be a full qualified path. See
also Import and Export.

RemoveDelimiter
See also

Property: RemoveDelimiter as Boolean

Description
The property RemoveDelimiter defines whether characters in the text that are equal to the
delimiter character are removed. Default is false. This property is used only when exporting to
text files.

RemoveNewline
See also

Property: RemoveNewline as Boolean

Description
The property RemoveNewline defines whether newline characters in the text are removed.
Default is false. This property is used only when exporting to text files.

4.3.28 TextView
See also

Properties and Methods

Application
Parent

LineFromPosition
PositionFromLine
LineLength
SelText
GetRangeText
ReplaceText
MoveCaret

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1081

GoToLineChar
SelectText
SelectionStart
SelectionEnd
Text
LineCount
Length

Description

Events

OnBeforeShowSuggestions
See also

Event: OnBeforeShowSuggestions()asBoolean

Description
This event gets fired before a suggestion window is shown. The Document property
Suggestions contains a string array that is recommended to the user. It is possible to modify the
displayed recommendations during this event. Before doing so you have to assign an empty
array to the Suggestions property. The best location for this is the OnDocumentOpened event.
To prevent the suggestion window to show up return false and true to continue its display.

Examples
Given below are examples of how this event can be scripted.

XMLSpy scripting environment - VBScript:


Function On_BeforeShowSuggestions()
End Function

XMLSpy scripting environment - JScript:


on On_BeforeShowSuggestions()
functi
{
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (33, ...) //nEventId=33

OnChar
See also

Event: OnChar(nChar asLong, bExi


stSuggesti
on asBoolean)asBoolean

Description
This event gets fired on each key stroke. The parameter nChar is the key that was pressed and
bExistSuggestions tells whether a XMLSpy generated suggestions window is displayed after
this key. The Document property Suggestions contains a string array that is recommended to
the user. It is possible to modify the displayed recommendations during this event. Before doing
so you have to assign an empty array to the Suggestions property. The best location for this is
the OnDocumentOpened event. To prevent the suggestion window to show up return false and

© 2010 Altova GmbH Programmers' Reference


1082 The XMLSpy API Interfaces

true to continue its display.


It is also possible to create a new suggestions window when none is provided by XMLSpy. Set
the Document property Suggestions to a string array with your recommendations and return
true.
This event is fired before the OnBeforeShowSuggestions event. If you prevent to show the
suggestion window by returning false then OnBeforeShowSuggestions is not fired.

Examples
Given below are examples of how this event can be scripted.

XMLSpy scripting environment - VBScript:


Function On_Char(nChar,bExi stSuggesti
ons )
End Function

XMLSpy scripting environment - JScript:


on On_Char(nChar,bExi
functi stSuggesti
ons )
{
}

XMLSpy IDE Plugin:


IXMLSpyPlugIn.OnEvent (35, ...) //nEventId=35

Application
Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

GetRangeText
Method: GetRangeText(nStart as Long, nEnd as Long) as String

Description
Returns the text in the specified range.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

GoToLineChar
Method: GoToLineChar(nLine as Long, nChar as Long)

Description
Moves the caret to the specified line and character position.

Errors
3900 The object is no longer valid.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1083

3901 Invalid address for the return parameter was specified.

Length
Property: Length as Long

Description
Returns the character count of the document.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

LineCount
Property: LineCount as Long

Description
Returns the number of lines in the document.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

LineFromPosition
Method: LineFromPosition(nCharPos as Long) as Long

Description
Returns the line number of the character position.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

LineLength
Method: LineLength(nLine as Long) as Long

Description
Returns the length of the line.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

MoveCaret
Method: MoveCaret(nDiff as Long)

Description
Moves the caret nDiff characters.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

© 2010 Altova GmbH Programmers' Reference


1084 The XMLSpy API Interfaces

Parent
Property: Parent as Document (read-only)

Description
Access the parent of the object.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

PositionFromLine
Method: PositionFromLine(nLine as Long) as Long

Description
Returns the start position of the line.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

ReplaceText
Method: ReplaceText(nPosFrom as Long, nPosTill as Long, sText as String)

Description
Replaces the text in the specified range.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

SelectionEnd
Property: SelectionEnd as Long

Description
Returns/sets the text selection end position.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

SelectionStart
Property: SelectionStart as Long

Description
Returns/sets the text selection start position.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1085

SelectText
Method: SelectText(nPosFrom as Long, nPosTill as Long)

Description
Selects the text in the specified range.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

SelText
Property: SelText as String

Description
Returns/sets the selected text.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

Text
Property: Text as String

Description
Returns/sets the document text.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

4.3.29 WSDL20DocumentationDlg
See also

Properties and Methods

Standard automation properties


Application
Parent

Interaction and visibility properties


OptionsDialogAction
OutputFile
OutputFileDialogAction
ShowProgressBar
ShowResult

Document generation options and methods


OutputFormat
EmbedDiagrams
DiagramFormat
MultipleOutputFiles
EmbedCSSInHTML

© 2010 Altova GmbH Programmers' Reference


1086 The XMLSpy API Interfaces

CreateDiagramsFolder

IncludeAll
IncludeBinding
IncludeImportedWSDLFiles
IncludeInterface
IncludeOverview
IncludeService
IncludeTypes

AllDetails
ShowBindingDiagram
ShowExtensibility
ShowEndpoint
ShowFault
ShowInterfaceDiagram
ShowOperation
ShowServiceDiagram
ShowSourceCode
ShowTypesDiagram
ShowUsedBy

Description
This object combines all options for WSDL document generation as they are available through
user interface dialog boxes in XMLSpy. The document generation options are initialized with the
values used during the last generation of WSDL documentation. However, before using the
object you have to set the OutputFile property to a valid file path. Use
OptionsDialogAction, OutputFileDialogAction and ShowProgressBar to specify
the level of user interaction desired. You can use I
ncl
udeAl
l and AllDetails to set whole
option groups at once or the individual properties to operate on a finer granularity.

AllDetails
See also

Method: AllDetails (i_bDetailsOn as Boolean )

Description
Use this method to turn all details options on or off.

Errors
4300 The object is no longer valid.

Application
See also

Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1087

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

CreateDiagramsFolder
See also

Property: CreateDiagramsFolder as Boolean

Description
Set this property to t
rue , to create a directory for the created images. Otherwise the diagrams
will be created next to the documentation. This property is only available when the diagrams are
not embedded. The property is initialized with the value used during the last call to
Docum ent.G enerateW SD20LDocum entation . The default for the first run is false.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

DiagramFormat
See also

Property: DiagramFormat as SPYImageKind

Description
This property specifies the generated diagram image type. This property is not available for
HTML documentation. The property is initialized with the value used during the last call to
Docum ent.G enerateW SDL20Docum entation . The default for the first run is PNG.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

EmbedCSSInHTML
See also

Property: EmbedCSSInHTML as Boolean

Description
Set this property to true , to embed the CSS data in the generated HTML document. Otherwise a
separate file will be created and linked. This property is only available for HTML documentation.
The property is initialized with the value used during the last call to
Docum ent.G enerateW SDL20Docum entation . The default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

© 2010 Altova GmbH Programmers' Reference


1088 The XMLSpy API Interfaces

EmbedDiagrams
See also

Property: EmbedDiagrams as Boolean

Description
Set this property to t
rue , to embed the diagrams in the generated document. This property is not
available for HTML documentation. The property is initialized with the value used during the last
call to Docum ent.G enerateW SDL20Docum entation . The default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

IncludeAll
See also

Method: IncludeAll (i_bInclude as Boolean )

Description
Use this method to mark or unmark all include options.

Errors
4300 The object is no longer valid.

IncludeBinding
See also

Property: IncludeBinding as Boolean

Description
Set this property to true , to include bindings in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDL20Docum entation
. The default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

IncludeImportedWSDLFiles
See also

Property: IncludeImportedWSDLFiles as Boolean

Description
Set this property to t rue , to include imported WSDL finles in the WSDL documentation. The
property is initialized with the value used during the last call to
Docum ent.G enerateW SDL20Docum entation . The default for the first run is true.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1089

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

IncludeInterface
See also

Property: IncludeInterface as Boolean

Description
Set this property to true , to include interfaces in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDL20Docum entation
. The default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

IncludeOverview
See also

Property: IncludeOverview as Boolean

Description
Set this property to true , to include an overview in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDL20Docum entation
. The default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

IncludeService
See also

Property: IncludeService as Boolean

Description
Set this property to true , to include services in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDL20Docum entation
. The default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

IncludeTypes
See also

Property: IncludeTypes as Boolean

© 2010 Altova GmbH Programmers' Reference


1090 The XMLSpy API Interfaces

Description
Set this property to t rue , to include types in the WSDL documentation. The property is initialized
with the value used during the last call to Docum ent.G enerateW SDL20Docum entation . The
default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

MultipleOutputFiles
See also

Property: MultipleOutputFiles as Boolean

Description
Set this property to t
rue , to split the documentation files. The property is initialized with the value
used during the last call to Docum ent.G enerateW SDL20Docum entation . The default for the first
run is false.

Errors
4300 The object is no longer valid.
4301 Invalid value has been used to set the property.
Invalid address for the return parameter was specified.

OptionsDialogAction
See also

Property: OptionsDialogAction as SPYDialogAction

Description
To allow your script to fill in the default values and let the user see and react on the dialog, set
this property to the value spyDialogUserInput(2). If you want your script to define all the options
in the schema documentation dialog without any user interaction necessary, use
spyDialogOK(0). Default is spyDialogOK.

Errors
4300 The object is no longer valid.
4301 Invalid value has been used to set the property.
Invalid address for the return parameter was specified.

OutputFile
See also

Property: OutputFile as St
ri
ng

Description
Full path and name of the file that will contain the generated documentation. In case of HTML
output, additional '.png' files will be generated based on this filename. The default value for this
property is an empty string and needs to be replaced before using this object in a call to
Docum ent.G enerateW SDL20Docum entation .

Errors

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1091

4300 The object is no longer valid.


4301 Invalid address for the return parameter was specified.

OutputFileDialogAction
See also

Property: OutputFileDialogAction as SPYDialogAction

Description
To allow the user to select the output file with a file selection dialog, set this property to
spyDialogUserInput(2). If the value stored in OutputFile should be taken and no user interaction
should occur, use spyDialogOK(0). Default is spyDialogOK.

Errors
4300 The object is no longer valid.
4301 Invalid value has been used to set the property.
Invalid address for the return parameter was specified.

OutputFormat
See also

Property: OutputFormat as SPYSchem aDocum entationForm at

Description
Defines the kind of documentation that will be generated: HTML (value=0), MS-Word (value=1),
or RTF (value=2). The property gets initialized with the value used during the last call to
Docum ent.G enerateW SDL20Docum entation . The default for the first run is HTML.

Errors
4300 The object is no longer valid.
4301 Invalid value has been used to set the property.
Invalid address for the return parameter was specified.

Parent
See also

Property: Parent as Dialogs (read-only)

Description
Access the parent of the object.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

ShowBindingDiagram
See also

Property: ShowBindingDiagram as Boolean

© 2010 Altova GmbH Programmers' Reference


1092 The XMLSpy API Interfaces

Description
Set this property to true , to show binding diagrams in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDL20Docum entation
. The default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

ShowEndpoint
See also

Property: ShowEndpoint as Boolean

Description
Set this property to true , to show service endpoints in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDL20Docum entation
. The default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

ShowExtensibility
See also

Property: ShowExtensibility as Boolean

Description
Set this property to t
rue , to show service and binding extensibilities in the WSDL
documentation. The property is initialized with the value used during the last call to
Docum ent.G enerateW SDL20Docum entation . The default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

ShowFault
See also

Property: ShowFault as Boolean

Description
Set this property to t rue , to show faults in the WSDL documentation. The property is initialized
with the value used during the last call to Docum ent.G enerateW SDL20Docum entation . The
default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1093

ShowInterfaceDiagram
See also

Property: ShowInterfaceDiagram as Boolean

Description
Set this property to t rue , to show interface diagrams in the WSDL documentation. The property
is initialized with the value used during the last call to
Docum ent.G enerateW SDL20Docum entation . The default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

ShowOperation
See also

Property: ShowOperation as Boolean

Description
Set this property to true , to show interface and binding operations in the WSDL documentation.
The property is initialized with the value used during the last call to
Docum ent.G enerateW SDL20Docum entation . The default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

ShowProgressBar
See also

Property: ShowProgressBar as Boolean

Description
Set this property to t
rue , to make the window showing the document generation progress
visible. Use fse , to hide it. Default is f
al se .
al

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

ShowResult
See also

Property: ShowResult as Boolean

Description

© 2010 Altova GmbH Programmers' Reference


1094 The XMLSpy API Interfaces

Set this property to t


rue , to automatically open the resulting document when generation was
successful. HTML documentation will be opened in XMLSpy. To show Word documentation,
MS-Word will be started. The property gets initialized with the value used during the last call to
Docum ent.G enerateW SDL20Docum entation . The default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

ShowServiceDiagram
See also

Property: ShowServiceDiagram as Boolean

Description
Set this property to true , to show service diagrams in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDL20Docum entation
. The default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

ShowSourceCode
See also

Property: ShowSourceCode as Boolean

Description
Set this property to t rue , to show source code for the includes in the WSDL documentation. The
property is initialized with the value used during the last call to
Docum ent.G enerateW SDL20Docum entation . The default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

ShowTypesDiagram
See also

Property: ShowTypesDiagram as Boolean

Description
Set this property to true , to show type diagrams in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDL20Docum entation
. The default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1095

ShowUsedBy
See also

Property: ShowUsedBy as Boolean

Description
Set this property to t
rue , to show the used-by relation for types, bindings and messages
definitions in the WSDL documentation. The property is initialized with the value used during the
last call to Docum ent.G enerateW SDL20Docum entation . The default for the first run is true.

Errors
4300 The object is no longer valid.
4301 Invalid address for the return parameter was specified.

4.3.30 WSDLDocumentationDlg
See also

Properties and Methods

Standard automation properties


Application
Parent

Interaction and visibility properties


OptionsDialogAction
OutputFile
OutputFileDialogAction
ShowProgressBar
ShowResult

Document generation options and methods


OutputFormat
EmbedDiagrams
DiagramFormat
MultipleOutputFiles
EmbedCSSInHTML
CreateDiagramsFolder

IncludeAll
IncludeBinding
IncludeImportedWSDLFiles
IncludeMessages
IncludeOverview
IncludePortType
IncludeService
IncludeTypes

AllDetails
ShowBindingDiagram
ShowExtensibility
ShowMessageParts
ShowPort
ShowPortTypeDiagram
ShowPortTypeOperations

© 2010 Altova GmbH Programmers' Reference


1096 The XMLSpy API Interfaces

ShowServiceDiagram
ShowSourceCode
ShowTypesDiagram
ShowUsedBy

Description
This object combines all options for WSDL document generation as they are available through
user interface dialog boxes in XMLSpy. The document generation options are initialized with the
values used during the last generation of WSDL documentation. However, before using the
object you have to set the OutputFile property to a valid file path. Use
OptionsDialogAction, OutputFileDialogAction and ShowProgressBar to specify
the level of user interaction desired. You can use I
ncl
udeAl
l and AllDetails to set whole
option groups at once or the individual properties to operate on a finer granularity.

AllDetails
See also

Method: AllDetails (i_bDetailsOn as Boolean )

Description
Use this method to turn all details options on or off.

Errors
4300 The object is no longer valid.

Application
See also

Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

CreateDiagramsFolder
See also

Property: CreateDiagramsFolder as Boolean

Description
Set this property to t
rue , to create a directory for the created images. Otherwise the diagrams
will be created next to the documentation. This property is only available when the diagrams are
not embedded. The property is initialized with the value used during the last call to
Docum ent.G enerateW SDLDocum entation . The default for the first run is false.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1097

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

DiagramFormat
See also

Property: DiagramFormat as SPYImageKind

Description
This property specifies the generated diagram image type. This property is not available for
HTML documentation. The property is initialized with the value used during the last call to
Docum ent.G enerateW SDLDocum entation . The default for the first run is PNG.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

EmbedCSSInHTML
See also

Property: EmbedCSSInHTML as Boolean

Description
Set this property to true , to embed the CSS data in the generated HTML document. Otherwise a
separate file will be created and linked. This property is only available for HTML documentation.
The property is initialized with the value used during the last call to
Docum ent.G enerateW SDLDocum entation . The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

EmbedDiagrams
See also

Property: EmbedDiagrams as Boolean

Description
Set this property to t
rue , to embed the diagrams in the generated document. This property is not
available for HTML documentation. The property is initialized with the value used during the last
call to Docum ent.G enerateW SDLDocum entation . The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

© 2010 Altova GmbH Programmers' Reference


1098 The XMLSpy API Interfaces

IncludeAll
See also

Method: IncludeAll (i_bInclude as Boolean )

Description
Use this method to mark or unmark all include options.

Errors
4300 The object is no longer valid.

IncludeBinding
See also

Property: IncludeBinding as Boolean

Description
Set this property to true , to include bindings in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDLDocum entation .
The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

IncludeImportedWSDLFiles
See also

Property: IncludeImportedWSDLFiles as Boolean

Description
Set this property to t rue , to include imported WSDL finles in the WSDL documentation. The
property is initialized with the value used during the last call to
Docum ent.G enerateW SDLDocum entation . The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

IncludeMessages
See also

Property: IncludeMessages as Boolean

Description
Set this property to true , to include messages in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDLDocum entation .
The default for the first run is true.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1099

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

IncludeOverview
See also

Property: IncludeOverview as Boolean

Description
Set this property to true , to include an overview in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDLDocum entation .
The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

IncludePortType
See also

Property: IncludePortType as Boolean

Description
Set this property to true , to include port types in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDLDocum entation .
The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

IncludeService
See also

Property: IncludeService as Boolean

Description
Set this property to true , to include services in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDLDocum entation .
The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

IncludeTypes
See also

Property: IncludeTypes as Boolean

© 2010 Altova GmbH Programmers' Reference


1100 The XMLSpy API Interfaces

Description
Set this property to t rue , to include types in the WSDL documentation. The property is initialized
with the value used during the last call to Docum ent.G enerateW SDLDocum entation . The
default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

MultipleOutputFiles
See also

Property: MultipleOutputFiles as Boolean

Description
Set this property to t
rue , to split the documentation files. The property is initialized with the value
used during the last call to Docum ent.G enerateW SDLDocum entation . The default for the first
run is false.

Errors
3900 The object is no longer valid.
3901 Invalid value has been used to set the property.
Invalid address for the return parameter was specified.

OptionsDialogAction
See also

Property: OptionsDialogAction as SPYDialogAction

Description
To allow your script to fill in the default values and let the user see and react on the dialog, set
this property to the value spyDialogUserInput(2). If you want your script to define all the options
in the schema documentation dialog without any user interaction necessary, use
spyDialogOK(0). Default is spyDialogOK.

Errors
3900 The object is no longer valid.
3901 Invalid value has been used to set the property.
Invalid address for the return parameter was specified.

OutputFile
See also

Property: OutputFile as St
ri
ng

Description
Full path and name of the file that will contain the generated documentation. In case of HTML
output, additional '.png' files will be generated based on this filename. The default value for this
property is an empty string and needs to be replaced before using this object in a call to
Docum ent.G enerateW SDLDocum entation .

Errors
3900 The object is no longer valid.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1101

3901 Invalid address for the return parameter was specified.

OutputFileDialogAction
See also

Property: OutputFileDialogAction as SPYDialogAction

Description
To allow the user to select the output file with a file selection dialog, set this property to
spyDialogUserInput(2). If the value stored in OutputFile should be taken and no user interaction
should occur, use spyDialogOK(0). Default is spyDialogOK.

Errors
3900 The object is no longer valid.
3901 Invalid value has been used to set the property.
Invalid address for the return parameter was specified.

OutputFormat
See also

Property: OutputFormat as SPYSchem aDocum entationForm at

Description
Defines the kind of documentation that will be generated: HTML (value=0), MS-Word (value=1),
or RTF (value=2). The property gets initialized with the value used during the last call to
Docum ent.G enerateW SDLDocum entation . The default for the first run is HTML.

Errors
3900 The object is no longer valid.
3901 Invalid value has been used to set the property.
Invalid address for the return parameter was specified.

Parent
See also

Property: Parent as Dialogs (read-only)

Description
Access the parent of the object.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

ShowBindingDiagram
See also

Property: ShowBindingDiagram as Boolean

Description

© 2010 Altova GmbH Programmers' Reference


1102 The XMLSpy API Interfaces

Set this property to true , to show binding diagrams in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDLDocum entation .
The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

ShowExtensibility
See also

Property: ShowExtensibility as Boolean

Description
Set this property to t
rue , to show service and binding extensibilities in the WSDL
documentation. The property is initialized with the value used during the last call to
Docum ent.G enerateW SDLDocum entation . The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

ShowMessageParts
See also

Property: ShowMessageParts as Boolean

Description
Set this property to t rue , to show message parts of messges in the WSDL documentation. The
property is initialized with the value used during the last call to
Docum ent.G enerateW SDLDocum entation . The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

ShowPort
See also

Property: ShowPort as Boolean

Description
Set this property to true , to show service ports in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDLDocum entation .
The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1103

ShowPortTypeDiagram
See also

Property: ShowPortTypeDiagram as Boolean

Description
Set this property to t rue , to show port type diagrams in the WSDL documentation. The property
is initialized with the value used during the last call to Docum ent.G enerateW SDLDocum entation
. The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

ShowPortTypeOperations
See also

Property: ShowPortTypeOperations as Boolean

Description
Set this property to t rue , to show port type operations in the WSDL documentation. The property
is initialized with the value used during the last call to Docum ent.G enerateW SDLDocum entation
. The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

ShowProgressBar
See also

Property: ShowProgressBar as Boolean

Description
Set this property to t
rue , to make the window showing the document generation progress
visible. Use fse , to hide it. Default is f
al se .
al

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

ShowResult
See also

Property: ShowResult as Boolean

Description
Set this property to t
rue , to automatically open the resulting document when generation was
successful. HTML documentation will be opened in XMLSpy. To show Word documentation,

© 2010 Altova GmbH Programmers' Reference


1104 The XMLSpy API Interfaces

MS-Word will be started. The property gets initialized with the value used during the last call to
Docum ent.G enerateW SDLDocum entation . The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

ShowServiceDiagram
See also

Property: ShowServiceDiagram as Boolean

Description
Set this property to true , to show service diagrams in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDLDocum entation .
The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

ShowSourceCode
See also

Property: ShowSourceCode as Boolean

Description
Set this property to t rue , to show source code for the includes in the WSDL documentation. The
property is initialized with the value used during the last call to
Docum ent.G enerateW SDLDocum entation . The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

ShowTypesDiagram
See also

Property: ShowTypesDiagram as Boolean

Description
Set this property to true , to show type diagrams in the WSDL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateW SDLDocum entation .
The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1105

ShowUsedBy
See also

Property: ShowUsedBy as Boolean

Description
Set this property to t
rue , to show the used-by relation for types, bindings and messages
definitions in the WSDL documentation. The property is initialized with the value used during the
last call to Docum ent.G enerateW SDLDocum entation . The default for the first run is true.

Errors
3900 The object is no longer valid.
3901 Invalid address for the return parameter was specified.

4.3.31 XBRLDocumentationDlg
See also

Properties and Methods

Standard automation properties


Application
Parent

Interaction and visibility properties


OptionsDialogAction
OutputFile
OutputFileDialogAction
ShowProgressBar
ShowResult

Document generation options and methods


OutputFormat
EmbedDiagrams
DiagramFormat
EmbedCSSInHTML
CreateDiagramsFolder

IncludeAll
IncludeOverview
IncludeNamespacePrefixes
IncludeGlobalElements
IncludeDefinitionLinkroles
IncludePresentationLinkroles
IncludeCalculationLinkroles

AllDetails
ShowDiagram
ShowSubstitutiongroup
ShowItemtype
ShowBalance
ShowPeriod
ShowAbstract
ShowNillable
ShowLabels

© 2010 Altova GmbH Programmers' Reference


1106 The XMLSpy API Interfaces

ShowReferences
ShowLinkbaseReferences

ShortQualifiedName
ShowImportedElements

Description
This object combines all options for XBRL document generation as they are available through
user interface dialog boxes in XMLSpy. The document generation options are initialized with the
values used during the last generation of XBRL documentation. However, before using the
object you have to set the OutputFile property to a valid file path. Use
OptionsDialogAction, OutputFileDialogAction and ShowProgressBar to specify
the level of user interaction desired. You can use I
ncl
udeAl
l and All
Det
ai
l
s to set whole option
groups at once or the individual properties to operate on a finer granularity.

AllDetails
See also

Method: AllDetails (i_bDetailsOn as Boolean )

Description
Use this method to turn all details options on or off.

Errors
4400 The object is no longer valid.

Application
See also

Property: Application as Application (read-only)

Description
Access the XMLSpy application object.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

CreateDiagramsFolder
See also

Property: CreateDiagramsFolder as Boolean

Description
Set this property to t
rue , to create a directory for the created images. Otherwise the diagrams
will be created next to the documentation. This property is only available when the diagrams are
not embedded. The property is initialized with the value used during the last call to

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1107

Docum ent.G enerateXBRLDocum entation . The default for the first run is false.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

DiagramFormat
See also

Property: DiagramFormat as SPYImageKind

Description
This property specifies the generated diagram image type. This property is not available for
HTML documentation. The property is initialized with the value used during the last call to
Docum ent.G enerateXBRLDocum entation . The default for the first run is PNG.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

EmbedCSSInHTML
See also

Property: EmbedCSSInHTML as Boolean

Description
Set this property to true , to embed the CSS data in the generated HTML document. Otherwise a
separate file will be created and linked. This property is only available for HTML documentation.
The property is initialized with the value used during the last call to
Docum ent.G enerateXBRLDocum entation . The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

EmbedDiagrams
See also

Property: EmbedDiagrams as Boolean

Description
Set this property to true , to embed the diagrams in the generated document. This property is not
available for HTML documentation. The property is initialized with the value used during the last
call to Docum ent.G enerateXBRLDocum entation . The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

© 2010 Altova GmbH Programmers' Reference


1108 The XMLSpy API Interfaces

IncludeAll
See also

Method: IncludeAll (i_bInclude as Boolean )

Description
Use this method to mark or unmark all include options.

Errors
4400 The object is no longer valid.

IncludeCalculationLinkroles
See also

Property: IncludeCalculationLinkroles as Boolean

Description
Set this property to t rue , to include calculation linkroles in the XBRL documentation. The
property is initialized with the value used during the last call to
Docum ent.G enerateXBRLDocum entation . The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

IncludeDefinitionLinkroles
See also

Property: IncludeDefinitionLinkroles as Boolean

Description
Set this property to t rue , to include definition linkroles in the XBRL documentation. The property
is initialized with the value used during the last call to Docum ent.G enerateXBRLDocum entation .
The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

IncludeGlobalElements
See also

Property: IncludeGlobalElements as Boolean

Description
Set this property to true , to include global elements in the XBRL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateXBRLDocum entation .
The default for the first run is true.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1109

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

IncludeNamespacePrefixes
See also

Property: IncludeNamespacePrefixes as Boolean

Description
Set this property to t rue , to include namespace prefixes in the XBRL documentation. The
property is initialized with the value used during the last call to
Docum ent.G enerateXBRLDocum entation . The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

IncludeOverview
See also

Property: IncludeOverview as Boolean

Description
Set this property to true , to include an overview in the XBRL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateXBRLDocum entation .
The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

IncludePresentationLinkroles
See also

Property: IncludePresentationLinkroles as Boolean

Description
Set this property to t rue , to include presentation linkroles in the XBRL documentation. The
property is initialized with the value used during the last call to
Docum ent.G enerateXBRLDocum entation . The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

OptionsDialogAction
See also

Property: OptionsDialogAction as SPYDialogAction

© 2010 Altova GmbH Programmers' Reference


1110 The XMLSpy API Interfaces

Description
To allow your script to fill in the default values and let the user see and react on the dialog, set
this property to the value spyDialogUserInput(2). If you want your script to define all the options
in the schema documentation dialog without any user interaction necessary, use
spyDialogOK(0). Default is spyDialogOK.

Errors
4400 The object is no longer valid.
4401 Invalid value has been used to set the property.
Invalid address for the return parameter was specified.

OutputFile
See also

Property: OutputFile as St
ri
ng

Description
Full path and name of the file that will contain the generated documentation. In case of HTML
output, additional '.png' files will be generated based on this filename. The default value for this
property is an empty string and needs to be replaced before using this object in a call to
Docum ent.G enerateXBRLDocum entation .

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

OutputFileDialogAction
See also

Property: OutputFileDialogAction as SPYDialogAction

Description
To allow the user to select the output file with a file selection dialog, set this property to
spyDialogUserInput(2). If the value stored in OutputFile should be taken and no user interaction
should occur, use spyDialogOK(0). Default is spyDialogOK.

Errors
4400 The object is no longer valid.
4401 Invalid value has been used to set the property.
Invalid address for the return parameter was specified.

OutputFormat
See also

Property: OutputFormat as SPYSchem aDocum entationForm at

Description
Defines the kind of documentation that will be generated: HTML (value=0), MS-Word (value=1),
or RTF (value=2). The property gets initialized with the value used during the last call to
Docum ent.G enerateXBRLDocum entation . The default for the first run is HTML.

Errors

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1111

4400 The object is no longer valid.


4401 Invalid value has been used to set the property.
Invalid address for the return parameter was specified.

Parent
See also

Property: Parent as Dialogs (read-only)

Description
Access the parent of the object.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

ShortQualifiedName
See also

Property: ShortQualifiedName as Boolean

Description
Set this property to t rue , to use short qualified names in the XBRL documentation. The property
is initialized with the value used during the last call to Docum ent.G enerateXBRLDocum entation .
The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

ShowAbstract
See also

Property: ShowAbstract as Boolean

Description
Set this property to true , to show abstracts in the XBRL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateXBRLDocum entation .
The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

ShowBalance
See also

Property: ShowBalance as Boolean

© 2010 Altova GmbH Programmers' Reference


1112 The XMLSpy API Interfaces

Description
Set this property to true , to show balances in the XBRL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateXBRLDocum entation .
The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

ShowDiagram
See also

Property: ShowDiagram as Boolean

Description
Set this property to true , to show diagrams in the XBRL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateXBRLDocum entation .
The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

ShowImportedElements
See also

Property: ShowImportedElements as Boolean

Description
Set this property to t rue , to show imported elements in the XBRL documentation. The property
is initialized with the value used during the last call to Docum ent.G enerateXBRLDocum entation .
The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

ShowItemtype
See also

Property: ShowItemtype as Boolean

Description
Set this property to true , to show item types in the XBRL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateXBRLDocum entation .
The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1113

ShowLabels
See also

Property: ShowLabels as Boolean

Description
Set this property to t rue , to show labels in the XBRL documentation. The property is initialized
with the value used during the last call to Docum ent.G enerateXBRLDocum entation . The default
for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

ShowLinkbaseReferences
See also

Property: ShowLinkbaseReferences as Boolean

Description
Set this property to t rue , to show linkbase references in the XBRL documentation. The property
is initialized with the value used during the last call to Docum ent.G enerateXBRLDocum entation .
The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

ShowNillable
See also

Property: ShowNillable as Boolean

Description
Set this property to true , to show nillable properties in the XBRL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateXBRLDocum entation .
The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

ShowPeriod
See also

Property: ShowPeriod as Boolean

© 2010 Altova GmbH Programmers' Reference


1114 The XMLSpy API Interfaces

Description
Set this property to t rue , to show periods in the XBRL documentation. The property is initialized
with the value used during the last call to Docum ent.G enerateXBRLDocum entation . The default
for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

ShowProgressBar
See also

Property: ShowProgressBar as Boolean

Description
Set this property to t
rue , to make the window showing the document generation progress
visible. Use fse , to hide it. Default is f
al se .
al

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

ShowReferences
See also

Property: ShowReferences as Boolean

Description
Set this property to true , to show references in the XBRL documentation. The property is
initialized with the value used during the last call to Docum ent.G enerateXBRLDocum entation .
The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

ShowResult
See also

Property: ShowResult as Boolean

Description
Set this property to t
rue , to automatically open the resulting document when generation was
successful. HTML documentation will be opened in XMLSpy. To show Word documentation,
MS-Word will be started. The property gets initialized with the value used during the last call to
Docum ent.G enerateXBRLDocum entation . The default for the first run is true.

Errors
4400 The object is no longer valid.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1115

4401 Invalid address for the return parameter was specified.

ShowSubstitutiongroup
See also

Property: ShowSubstitutiongroup as Boolean

Description
Set this property to t rue , to show substitution groups in the XBRL documentation. The property
is initialized with the value used during the last call to Docum ent.G enerateXBRLDocum entation .
The default for the first run is true.

Errors
4400 The object is no longer valid.
4401 Invalid address for the return parameter was specified.

4.3.32 XMLData
See also

Properties
Kind
Name
TextValue

HasChildren
MayHaveChildren
Parent

Methods
GetFirstChild
GetNextChild
GetCurrentChild

InsertChild
AppendChild

EraseAllChildren
EraseCurrentChild

IsSameNode

CountChildren
CountChildrenKind

GetChild
GetChildKind

HasChildrenKind

Description
The XMLData interface provides direct XML-level access to a document. You can read and
directly modify the XML representation of the document. However, please, note the following
restrictions:

© 2010 Altova GmbH Programmers' Reference


1116 The XMLSpy API Interfaces

 The XMLData representation is only valid when the document is shown in grid view or
authentic view.
 When in authentic view, additional XMLData elements are automatically inserted as
parents of each visible document element. Typically this is an XMLData of kind
spyXM LDataElem ent with the Name property set to 'Text'.
 When you use the XMLData interface while in a different view mode you will not receive
errors, but changes are not reflected to the view and might get lost during the next view
switch.

Note also:
 Setting a new text value for an XML element is possible if the element does not have
non-text children. A text value can be set even if the element has attributes.
 When setting a new text value for an XML element which has more than one text child,
the latter will be deleted and replaced by one new text child.
 When reading the text value of an XML element which has more than one text child,
only the value of the first text child will be returned.

Objects of this class represent the different atomic parts of an XML document. See the
enumeration type SPYXM LD ataKind for the available part types. Each part knows its children,
thus forming a XMLData tree with Docum ent.RootElem ent at its top. To get the top element of
the document content - ignoring the XML header - use Docum ent.DataRoot . For examples on
how to traverse the XMLData tree see Using XM LData to m odifydocum entstructure and
GetNextChild .

AppendChild
See also

Declaration: AppendChild (pNewData as XMLData)

Description
AppendChild appends pNewD ata as last child to the XM LD ata object. See also Using XMLData.

Errors
1500 The XMLData object is no longer valid.
1505 Invalid XMLData kind was specified.
1506 Invalid address for the return parameter was specified.
1507 Element cannot have Children
1512 Cyclic insertion - new data element is already part of document
1514 Invalid XMLData kind was specified for this position.
1900 Document must not be modified

Example
Dim objCurrentParent As XMLData
Dim objNewChild As XMLData

Set objNewChild = objSpy.ActiveDocument.CreateChild(spyXMLDataElement)


Set objCurrentParent = objSpy.ActiveDocument.RootElement

objCurrentParent.AppendChild objNewChild

Set objNewChild = Nothing

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1117

CountChildren
See also

Declaration: CountChildren as long

Description
CountChi
l
dren gets the number of children.

Available with TypeLibrary version 1.5

Errors
1500 The XMLData object is no longer valid.

CountChildrenKind
See also

Declaration: CountChildrenKind (nKind as SPYXMLDataKind) as long

Description
CountChildrenKind gets the number of children of the specific kind.

Available with TypeLibrary version 1.5

Errors
1500 The XMLData object is no longer valid.

EraseAllChildren
See also

Declaration: EraseAllChildren

Description
EraseAl
l
Chi
l
dren deletes all associated children of the XM LD ata object.

Errors
1500 The XMLData object is no longer valid.
1900 Document must not be modified

Example
The sample erases all elements of the active document.

Dim objCurrentParent As XMLData

Set objCurrentParent = objSpy.ActiveDocument.RootElement


objCurrentParent.EraseAllChildren

© 2010 Altova GmbH Programmers' Reference


1118 The XMLSpy API Interfaces

EraseChild
Method: EraseChild (Child node and new node as XMLData)

Description
Deletes the given child node.

Errors
1500 Invalid object.
1506 Invalid input xml
1510 Invalid parameter.

EraseCurrentChild
See also

Declaration: EraseCurrentChild

Description
EraseCurrentChil
d deletes the current XM LD ata child object. Before you call EraseCurrentChi
l
d
you must initialize an internal iterator with XMLData.GetFirstChild. After deleting the
current child, EraseCurrentChil
d increments the internal iterator of the XMLData element. No
error is returned when the last child gets erased and the iterator is moved past the end of the
child list. The next call to EraseCurrentChi
l
d however, will return error 1503.

Errors
1500 The XMLData object is no longer valid.
1503 No iterator is initialized for this XMLData object, or the iterator points past
the last child.
1900 Document must not be modified

Examples
// ---------------------------------------
// XMLSpy scripting environment - JScript
// erase all children of XMLData
// ---------------------------------------
// let's get an XMLData element, we assume that the
// cursor selects the parent of a list in grid view
var objList = Application.ActiveDocument.GridView.CurrentFocus;

// the following line would be shorter, of course


//objList.EraseAllChildren ();

// but we want to demonstrate the usage of EraseCurrentChild


if ((objList != null) && (objList.HasChildren))
{
try
{
objEle = objList.GetFirstChild(-1);
while (objEle != null)
objList.EraseCurrentChild();
// no need to call GetNextChild
}
catch (err)
// 1503 - we reached end of child list
{ if ((err.number & 0xffff) != 1503) throw (err); }
}

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1119

GetChild
See also

Declaration: GetChild (position as long) as XMLData

Return Value
Returns an XML element as XM LD ata object.

Description
d() returns a reference to the child at the given index (zero-based).
GetChi
l

Available with TypeLibrary version 1.5

Errors
1500 The XMLData object is no longer valid.
1510 Invalid address for the return parameter was specified.

GetChildAttribute
Method: GetChildAttribute (Name as string) as XMLData object (NULL on error)

Description
Retrieves the attribute having the given name.

Errors
1500 Invalid object.
1510 Invalid parameter.

GetChildElement
Method: GetChildElement (Name as string, position as integer) as XMLData object (NULL
on error)

Description
Retrieves the Nth child element with the given name.

Errors
1500 Invalid object.
1510 Invalid parameter.

GetChildKind
See also

Declaration: GetChildKind (position as long, nKind as SPYXMLDataKind) as XMLData

Return Value
Returns an XML element as XM LD ata object.

© 2010 Altova GmbH Programmers' Reference


1120 The XMLSpy API Interfaces

Description
GetChil
dKi
nd() returns a reference to a child of this kind at the given index (zero-based). The
position parameter is relative to the number of children of the specified kind and not to all
children of the object.

Available with TypeLibrary version 1.5

Errors
1500 The XMLData object is no longer valid.
1510 Invalid address for the return parameter was specified.

GetCurrentChild
See also

Declaration: GetCurrentChild as XMLData

Return Value
Returns an XML element as XM LD ata object.

Description
GetCurrentChil
d gets the current child. Before you call GetCurrentChi
l
d you must initialize an
internal iterator with XMLData.GetFirstChild.

Errors
1500 The XMLData object is no longer valid.
1503 No iterator is initialized for this XMLData object.
1510 Invalid address for the return parameter was specified.

GetFirstChild
See also

Declaration: GetFirstChild (nKind as SPYXMLDataKind) as XMLData

Return Value
Returns an XML element as XM LD ata object.

Description
GetFi
rstChi
l
d initializes a new iterator and returns the first child. Set nKind = -1 to get an iterator
for all kinds of children.
REMARK: The iterator is stored inside the XMLData object and gets destroyed when the
XMLData object gets destroyed. Be sure to keep a reference to this object as long as you want
to use GetCurrentChi ld , GetNextChild or EraseCurrentChi
l
d .

Errors
1500 The XMLData object is no longer valid.
1501 Invalid XMLData kind was specified.
1504 Element has no children of specified kind.
1510 Invalid address for the return parameter was specified.

Example
See the example at XMLData.GetNextChild.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1121

GetNamespacePrefixForURI
Method: GetNamespacePrefixForURI (URI as string) Prefix as string

Description
Returns the namespace prefix of the supplied URI.

Errors
1500 Invalid object.
1510 Invalid parameter.

GetNextChild
See also

Declaration: GetNextChild as XMLData

Return Value
Returns an XML element as XM LD ata object.

Description
GetNextChild steps to the next child of this element. Before you call GetNextChild you must
initialize an internal iterator with XMLData.GetFirstChild.

Check for the last child of the element as shown in the sample below.

Errors
1500 The XMLData object is no longer valid.
1503 No iterator is initialized for this XMLData object.
1510 Invalid address for the return parameter was specified.

Examples
' ----------------------------------------------
' VBA code snippet - iterate XMLData children
' ----------------------------------------------
On Error Resume Next
Set objParent = objSpy.ActiveDocument.RootElement

'get elements of all kinds


Set objCurrentChild = objParent.GetFirstChild(-1)

Do
'do something useful with the child

'step to next child


Set objCurrentChild = objParent.GetNextChild
Loop Until (Err.Number - vbObjectError = 1503)

// ---------------------------------------
// XMLSpy scripting environment - JScript
// iterate through children of XMLData
// ---------------------------------------
try
{
var objXMLData = ... // initialize somehow
var objChild = objXMLData.GetFirstChild(-1);

© 2010 Altova GmbH Programmers' Reference


1122 The XMLSpy API Interfaces

while (true)
{
// do something usefull with objChild

objChild = objXMLData.GetNextChild();
}
}
catch (err)
{
if ((err.number & 0xffff) == 1504)
; // element has no children
else if ((err.number & 0xffff) == 1503)
;// last child reached
else
throw (err);
}

GetTextValueXMLDecoded
Method: GetTextValueXMLDecoded as string

Description
Gets the decoded text value of the XML.

Errors
1500 Invalid object.
1510 Invalid parameter.

HasChildren
See also

Declaration: HasChildren as Boolean

Description
The property is true if the object is the parent of other XM LD ata objects. This property is
read-only.

Errors
1500 The XMLData object is no longer valid.
1510 Invalid address for the return parameter was specified.

HasChildrenKind
See also

Declaration: HasChildrenKind (nKind as SPYXMLDataKind) as Boolean

Description
The method returns true if the object is the parent of other XM LD ata objects of the specific kind.

Available with TypeLibrary version 1.5

Errors

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1123

1500 The XMLData object is no longer valid.


1510 Invalid address for the return parameter was specified.

InsertChild
See also

Declaration: InsertChild (pNewData as XMLData)

Description
I
nsert
Chi
l
d inserts the new child before the current child (see also XMLData.GetFirstChild,
XMLData.GetNextChild to set the current child).

Errors
1500 The XMLData object is no longer valid.
1503 No iterator is initialized for this XMLData object.
1505 Invalid XMLData kind was specified.
1506 Invalid address for the return parameter was specified.
1507 Element cannot have Children
1512 Cyclic insertion - new data element is already part of document
1514 Invalid XMLData kind was specified for this position.
1900 Document must not be modified

Examples
See Using XM LData to m odifydocum entstructure .

InsertChildAfter
Method: InsertChildAfter (Child node and new node as XMLData)

Description
Inserts a new XML node after the given node.

Errors
1500 Invalid object.
1506 Invalid input xml
1507 No children allowed
1510 Invalid parameter.
1512 Child is already added
1514 Invalid kind at position

InsertChildBefore
Method: InsertChildBefore (Child node and new node as XMLData)

Description
Inserts a new XML node before the given node.

Errors
1500 Invalid object.
1506 Invalid input xml
1507 No children allowed
1510 Invalid parameter.

© 2010 Altova GmbH Programmers' Reference


1124 The XMLSpy API Interfaces

1512 Child is already added


1514 Invalid kind at position

IsSameNode
See also

Declaration: IsSameNode (pNodeToCompare as XMLData) as Boolean

Description

Returns true if pN odeToC om pare references the same node as the object itself.

Errors
1500 The XMLData object is no longer valid.
1506 Invalid address for the return parameter was specified.

Kind
See also

Declaration: Kind as SPYXMLDataKind

Description
Kind of this XM LD ata object. This property is read-only.

Errors
1500 The XMLData object is no longer valid.
1510 Invalid address for the return parameter was specified.

MayHaveChildren
See also

Declaration: MayHaveChildren as Boolean

Description
Indicates whether it is allowed to add children to this XM LD ata object.
This property is read-only.

Errors
1500 The XMLData object is no longer valid.
1510 Invalid address for the return parameter was specified.

Name
See also

Declaration: Name as String

Description
Used to modify and to get the name of the XM LD ata object.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces 1125

Errors
1500 The XMLData object is no longer valid.
1510 Invalid address for the return parameter was specified.

Parent
See also

Declaration: Parent as XMLData

Return value
Parent as XM LD ata object. Nothing (or NULL) if there is no parent element.

Description
Parent of this element. This property is read-only.

Errors
1500 The XMLData object is no longer valid.
1510 Invalid address for the return parameter was specified.

SetTextValueXMLDecoded
Method: SetTextValueXMLDecoded ( string value)

Description
Sets the encoded text value of the XML.

Errors
1500 Invalid object.
1513 Modification not allowed.

TextValue
See also

Declaration: TextValue as String

Description
Used to modify and to get the text value of this XM LD ata object.

Errors
1500 The XMLData object is no longer valid.
1510 Invalid address for the return parameter was specified.

Examples
See Using XM LData to m odifydocum entstructure .

© 2010 Altova GmbH Programmers' Reference


1126 The XMLSpy API Interfaces (obsolete)

4.4 Interfaces (obsolete)


Interfaces contained in this book are obsolete. It is recommended to migrate your applications
to the new interfaces. See the different properties and methods in this book for migration hints.

4.4.1 AuthenticEvent (obsolete)


Superseded by AuthenticView and AuthenticRange
The DocEditView object is renamed to OldAuthenticView.
DocEditSelection is renamed to AuthenticSelection.
DocEditEvent is renamed to AuthenticEvent.
DocEditDataTransfer is renamed to AuthenticDataTransfer.

Their usage - except for AuthenticDataTransfer - is no longer recommended. We will continue


to support existing functionality for a yet undefined period of time but no new features will be
added to these interface. All functionality available up to now in DocEditView,
DocEditSelection, DocEditEvent and DocEditDataTransfer is now available via AuthenticView,
AuthenticRange and AuthenticDataTransfer. Many new features have been added.

For examples on migrating from DocEdit to Authentic see the description of the different
methods and properties of the different DocEdit objects.

See also

Properties

altKey
altLeft
ctrlKey
ctrlLeft
shiftKey
shiftLeft

keyCode
repeat

button

clientX
clientY

dataTransfer

srcElement
fromElement

propertyName

cancelBubble
returnValue

type

Description
DocEditEvent interface.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1127

altKey (obsolete)

Superseded by parameters to
AuthenticView.OnKeyboardEvent (On_AuthenticView_KeyPressed)
AuthenticView.OnMouseEvent (On_AuthenticView_MouseEvent)
AuthenticView.OnDragOver (On_AuthenticView_DragOver)
The event object that holds the information of the last event is now replaced by parameters to
the different event handler functions to simplify data access. The event object will be
supported for a not yet defined period of time for compatibility reasons. No improvements are
planned. It is highly recommended to migrate to the new event handler functions.

// ----- XMLSpy scripting environment - javascript sample -----


// instead of:
// function On_DocEditKeyPressed ()
// {
// if (Application.ActiveDocument.DocEditView.event.altKey ||
// Application.ActiveDocument.DocEditView.event.altLeft)
// MsgBox ("alt key is down");
// }
// use now:
function On_AuthenticView_KeyPressed (SPYKeyEvent i_eKeyEvent, long
i_nKeyCode, SPYVirtualKeyMask i_nVirtualKeyStatus)
{
if (i_nVirtualKeyStatus & spyAltKeyMask)
MsgBox ("alt key is down");
}

See also

Declaration: altKey as Boolean

Description
True if the right ALT key is pressed.

© 2010 Altova GmbH Programmers' Reference


1128 The XMLSpy API Interfaces (obsolete)

altLeft (obsolete)

Superseded by parameters to
AuthenticView.OnKeyboardEvent (On_AuthenticView_KeyPressed)
AuthenticView.OnMouseEvent (On_AuthenticView_MouseEvent)
AuthenticView.OnDragOver (On_AuthenticView_DragOver)
The event object that holds the information of the last event is now replaced by parameters to
the different event handler functions to simplify data access. The event object will be
supported for a not yet defined period of time for compatibility reasons. No improvements are
planned. It is highly recommended to migrate to the new event handler functions.

// ----- XMLSpy scripting environment - javascript sample -----


// instead of:
// function On_DocEditKeyDown ()
// {
// if (Application.ActiveDocument.DocEditView.event.altKey ||
// Application.ActiveDocument.DocEditView.event.altLeft)
// MsgBox ("alt key is down");
// }
// use now:
function On_AuthenticView_KeyDown (SPYKeyEvent i_eKeyEvent, long i_nKeyCode,
SPYVirtualKeyMask i_nVirtualKeyStatus)
{
if (i_nVirtualKeyStatus & spyAltKeyMask)
MsgBox ("alt key is down");
}

See also

Declaration: altLeft as Boolean

Description
True if the left ALT key is pressed.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1129

button (obsolete)

Superseded by parameters to
AuthenticView.OnMouseEvent (On_AuthenticView_MouseEvent)
AuthenticView.OnDragOver (On_AuthenticView_DragOver)
The event object that holds the information of the last event is now replaced by parameters to
the different event handler functions to simplify data access. The event object will be
supported for a not yet defined period of time for compatibility reasons. No improvements are
planned. It is highly recommended to migrate to the new event handler functions.

// ----- XMLSpy scripting environment - javascript sample -----


// instead of:
// function On_DocEditButtonDown ()
// {
// if (Application.ActiveDocument.DocEditView.event.button == 1)
// MsgBox ("left mouse button down detected");
// }
// use now:
function On_AuthenticView_MouseEvent (long i_nXPos, long i_nYPos,
SPYMouseEvent i_eMouseEvent, IAuthenticRange *i_ipRange)
{
if (i_eMouseEvent & spyLeftButtonDownMask)
MsgBox ("left mouse button down detected");
}

See also

Declaration: button as long

Description
Specifies which mouse button is pressed:

0 No button is pressed.
1 Left button is pressed.
2 Right button is pressed.
3 Left and right buttons are both pressed.
4 Middle button is pressed.
5 Left and middle buttons both are pressed.
6 Right and middle buttons are both pressed.
7 All three buttons are pressed.

© 2010 Altova GmbH Programmers' Reference


1130 The XMLSpy API Interfaces (obsolete)

cancelBubble (obsolete)

Superseded by the boolean return value of following event handler


functions
AuthenticView.OnKeyboardEvent (On_AuthenticView_KeyPressed)
AuthenticView.OnMouseEvent (On_AuthenticView_MouseEvent)
AuthenticView.OnDragOver (On_AuthenticView_DragOver)
The event object that holds the information of the last event is now replaced by parameters to
the different event handler functions to simplify data access. The event object will be
supported for a not yet defined period of time for compatibility reasons. No improvements are
planned. It is highly recommended to migrate to the new event handler functions.

Returning true from an event handler function signals that the event has beend handled and
normal event handling should be aborted.

// ----- XMLSpy scripting environment - javascript sample -----


// instead of:
// function On_DocEditKeyPressed ()
// {
// if (Application.ActiveDocument.DocEditView.event.keyCode == 0x20)
// {
// // cancel key processing, swallow spaces :-)
// Application.ActiveDocument.DocEditView.event.cancelBubble = true;
// }
// }
// use now:
function On_AuthenticView_KeyPressed (SPYKeyEvent i_eKeyEvent, long
i_nKeyCode, SPYVirtualKeyMask i_nVirtualKeyStatus)
{
if (i_nKeyCode == 0x20)
return true; // cancel key processing, swallow spaces :-)
}

See also

Declaration: cancelBubble as Boolean

Description
Set cancelBubble to TRUE if the default event handler should not be called.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1131

clientX (obsolete)

Superseded by parameters to
AuthenticView.OnMouseEvent (On_AuthenticView_MouseEvent)
AuthenticView.OnBeforeDrop (On_AuthenticView_BeforeDrop)
AuthenticView.OnDragOver (On_AuthenticView_DragOver)
The event object that holds the information of the last event is now replaced by parameters to
the different event handler functions to simplify data access. The event object will be
supported for a not yet defined period of time for compatibility reasons. No improvements are
planned. It is highly recommended to migrate to the new event handler functions.

// ----- XMLSpy scripting environment - javascript sample -----


// instead of:
// function On_DocEditMouseMove ()
// {
// MsgBox ("moving over " +
Application.ActiveDocument.DocEditView.event.clientX +
// "/" + Application.ActiveDocument.DocEditView.event.clientY);
// }
// use now:
function On_AuthenticView_MouseEvent (long i_nXPos, long i_nYPos,
SPYMouseEvent i_eMouseEvent, IAuthenticRange *i_ipRange)
{
if (i_eMouseEvent & spyMouseMoveMask)
MsgBox ("moving over " + i_nXPos + "/" + i_nYPos);
}

See also

Declaration: clientX as long

Description
X value of the current mouse position in client coordinates.

© 2010 Altova GmbH Programmers' Reference


1132 The XMLSpy API Interfaces (obsolete)

clientY (obsolete)

Superseded by parameters to
AuthenticView.OnMouseEvent (On_AuthenticView_MouseEvent)
AuthenticView.OnBeforeDrop (On_AuthenticView_BeforeDrop)
AuthenticView.OnDragOver (On_AuthenticView_DragOver)
The event object that holds the information of the last event is now replaced by parameters to
the different event handler functions to simplify data access. The event object will be
supported for a not yet defined period of time for compatibility reasons. No improvements are
planned. It is highly recommended to migrate to the new event handler functions.

// ----- XMLSpy scripting environment - javascript sample -----


// instead of:
// function On_DocEditMouseMove ()
// {
// MsgBox ("moving over " +
Application.ActiveDocument.DocEditView.event.clientX +
// "/" + Application.ActiveDocument.DocEditView.event.clientY);
// }
// use now:
function On_AuthenticView_MouseEvent (long i_nXPos, long i_nYPos,
SPYMouseEvent i_eMouseEvent, IAuthenticRange *i_ipRange)
{
if (i_eMouseEvent & spyMouseMoveMask)
MsgBox ("moving over " + i_nXPos + "/" + i_nYPos);
}

See also

Declaration: clientY as long

Description
Y value of the current mouse position in client coordinates.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1133

ctrlKey (obsolete)

Superseded by parameters to
AuthenticView.OnKeyboardEvent (On_AuthenticView_KeyPressed)
AuthenticView.OnMouseEvent (On_AuthenticView_MouseEvent)
AuthenticView.OnDragOver (On_AuthenticView_DragOver)
The event object that holds the information of the last event is now replaced by parameters to
the different event handler functions to simplify data access. The event object will be
supported for a not yet defined period of time for compatibility reasons. No improvements are
planned. It is highly recommended to migrate to the new event handler functions.

// ----- XMLSpy scripting environment - javascript sample -----


// instead of:
// function On_DocEditMouseMove ()
// {
// if (Application.ActiveDocument.DocEditView.event.ctrlKey ||
// Application.ActiveDocument.DocEditView.event.altLeft)
// MsgBox ("control key is down");
// }
// use now:
function On_AuthenticView_MouseEvent (long i_nXPos, long i_nYPos,
SPYMouseEvent i_eMouseEvent, IAuthenticRange *i_ipRange)
{
if (i_eMouseEvent & spyCtrlKeyMask)
MsgBox ("control key is down");
}

See also

Declaration: ctrlKey as Boolean

Description
True if the right CTRL key is pressed.

© 2010 Altova GmbH Programmers' Reference


1134 The XMLSpy API Interfaces (obsolete)

ctrlLeft (obsolete)

Superseded by parameters to
AuthenticView.OnKeyboardEvent (On_AuthenticView_KeyPressed)
AuthenticView.OnMouseEvent (On_AuthenticView_MouseEvent)
AuthenticView.OnDragOver (On_AuthenticView_DragOver)
The event object that holds the information of the last event is now replaced by parameters to
the different event handler functions to simplify data access. The event object will be
supported for a not yet defined period of time for compatibility reasons. No improvements are
planned. It is highly recommended to migrate to the new event handler functions.

// ----- XMLSpy scripting environment - javascript sample -----


// instead of:
// function On_DocEditMouseMove ()
// {
// if (Application.ActiveDocument.DocEditView.event.ctrlKey ||
// Application.ActiveDocument.DocEditView.event.altLeft)
// MsgBox ("control key is down");
// }
// use now:
function On_AuthenticView_MouseEvent (long i_nXPos, long i_nYPos,
SPYMouseEvent i_eMouseEvent, IAuthenticRange *i_ipRange)
{
if (i_eMouseEvent & spyCtrlKeyMask)
MsgBox ("control key is down");
}

See also

Declaration: ctrlLeft as Boolean

Description
True if the left CTRL key is pressed.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1135

dataTransfer (obsolete)

Superseded by parameters to
AuthenticView.OnBeforeDrop (On_AuthenticView_BeforeDrop)
AuthenticView.OnDragOver (On_AuthenticView_DragOver)
The event object that holds the information of the last event is now replaced by parameters to
the different event handler functions to simplify data access. The event object will be
supported for a not yet defined period of time for compatibility reasons. No improvements are
planned. It is highly recommended to migrate to the new event handler functions.

// ----- XMLSpy scripting environment - javascript sample -----


// instead of:
// function On_DocEditDrop ()
// {
// if (Application.ActiveDocument.DocEditView.event.dataTransfer !=
null)
// if (!
Application.ActiveDocument.DocEditView.event.dataTransfer.ownDrag)
// {
// // cancel key processing, don't drop foreign objects :-)
// Application.ActiveDocument.DocEditView.event.cancelBubble =
true;
// }
// }
// use now:
function On_AuthenticView_BeforeDrop (long i_nXPos, long i_nYPos,
IAuthenticRange *i_ipRange,
IAuthenticDataTransfer *i_ipData)
{
if (i_ipRange != null)
if (! i_ipRange.ownDrag)
return true; // cancel key processing, don't drop foreign
objects :-)

return false;
}

See also

Declaration: dataTransfer as Variant

Description
Property dataTransfer.

© 2010 Altova GmbH Programmers' Reference


1136 The XMLSpy API Interfaces (obsolete)

fromElement (obsolete)

Not supported

See also

Declaration: fromElement as Variant (not supported)

Description
Currently no event sets this property.

keyCode (obsolete)

Superseded by a parameter to AuthenticView.OnKeyboardEvent


(On_AuthenticView_KeyPressed)
The event object that holds the information of the last event is now replaced by parameters to
the different event handler functions to simplify data access. The event object will be
supported for a not yet defined period of time for compatibility reasons. No improvements are
planned. It is highly recommended to migrate to the new event handler functions.

// ----- XMLSpy scripting environment - javascript sample -----


// instead of:
// function On_DocEditKeyPressed ()
// {
// if (Application.ActiveDocument.DocEditView.event.keyCode == 0x20)
// {
// // cancel key processing, swallow spaces :-)
// Application.ActiveDocument.DocEditView.event.cancelBubble = true;
// }
// }
// use now:
function On_AuthenticView_KeyPressed (SPYKeyEvent i_eKeyEvent, long
i_nKeyCode, SPYVirtualKeyMask i_nVirtualKeyStatus)
{
if (i_nKeyCode == 0x20)
return true; // cancel key processing, swallow spaces :-)
}

See also

Declaration: keyCode as long

Description
Keycode of the currently pressed key. This property is read-write.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1137

propertyName (obsolete)

Not supported

See also

Declaration: propertyName as String (not supported)

Description
Currently no event sets this property.

repeat (obsolete)

Not supported

See also

Declaration: repeat as Boolean (not supported)

Description
True if the onkeydown event is repeated.

returnValue (obsolete)

No longer supported

See also

Declaration: returnValue as Variant

Description
Use returnVal
ue to set a return value for your event handler.

© 2010 Altova GmbH Programmers' Reference


1138 The XMLSpy API Interfaces (obsolete)

shiftKey (obsolete)

Superseded by parameters to
AuthenticView.OnKeyboardEvent (On_AuthenticView_KeyPressed)
AuthenticView.OnMouseEvent (On_AuthenticView_MouseEvent)
AuthenticView.OnDragOver (On_AuthenticView_DragOver)
The event object that holds the information of the last event is now replaced by parameters to
the different event handler functions to simplify data access. The event object will be
supported for a not yet defined period of time for compatibility reasons. No improvements are
planned. It is highly recommended to migrate to the new event handler functions.

// ----- XMLSpy scripting environment - javascript sample -----


// instead of:
// function On_DocEditDragOver ()
// {
// if (Application.ActiveDocument.DocEditView.event.shiftKey ||
// Application.ActiveDocument.DocEditView.event.shiftLeft)
// MsgBox ("shift key is down");
// }
// use now:
function On_AuthenticView_DragOver (long i_nXPos, long i_nYPos,
SPYMouseEvent i_eMouseEvent,
IAuthenticRange *i_ipRange,
IAuthenticDataTransfer *i_ipData)
{
if (i_eMouseEvent & spyShiftKeyMask)
MsgBox ("shift key is down");
}

See also

Declaration: shiftKey as Boolean

Description
True if the right SHIFT key is pressed.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1139

shiftLeft (obsolete)

Superseded by parameters to
AuthenticView.OnKeyboardEvent (On_AuthenticView_KeyPressed)
AuthenticView.OnMouseEvent (On_AuthenticView_MouseEvent)
AuthenticView.OnDragOver (On_AuthenticView_DragOver)
The event object that holds the information of the last event is now replaced by parameters to
the different event handler functions to simplify data access. The event object will be
supported for a not yet defined period of time for compatibility reasons. No improvements are
planned. It is highly recommended to migrate to the new event handler functions.

// ----- XMLSpy scripting environment - javascript sample -----


// instead of:
// function On_DocEditDragOver ()
// {
// if (Application.ActiveDocument.DocEditView.event.shiftKey ||
// Application.ActiveDocument.DocEditView.event.shiftLeft)
// MsgBox ("shift key is down");
// }
// use now:
function On_AuthenticView_DragOver (long i_nXPos, long i_nYPos,
SPYMouseEvent i_eMouseEvent,
IAuthenticRange *i_ipRange,
IAuthenticDataTransfer *i_ipData)
{
if (i_eMouseEvent & spyShiftKeyMask)
MsgBox ("shift key is down");
}

See also

Declaration: shiftLeft as Boolean

Description
True if the left SHIFT key is pressed.

© 2010 Altova GmbH Programmers' Reference


1140 The XMLSpy API Interfaces (obsolete)

srcElement (obsolete)

Superseded by parameters to
AuthenticView.OnMouseEvent (On_AuthenticView_MouseEvent)
AuthenticView.OnBeforeDrop (On_AuthenticView_BeforeDrop)
AuthenticView.OnDragOver (On_AuthenticView_DragOver)
The event object that holds the information of the last event is now replaced by parameters to
the different event handler functions to simplify data access. The event object will be
supported for a not yet defined period of time for compatibility reasons. No improvements are
planned. It is highly recommended to migrate to the new event handler functions.

With the new event handler function, a range object selecting this element is provided instead
of the XMLData element currently below the mouse cursor.

// ----- XMLSpy scripting environment - javascript sample -----


// instead of:
// function On_DocEditMouseMove ()
// {
// var objEvent = Application.ActiveDocument.DocEditView.event;
// if (objEvent.srcElement != null)
// MsgBox ("moving over " + objEvent.srcElement.Parent.Name);
// }
// use now:
function On_AuthenticView_MouseEvent (long i_nXPos, long i_nYPos,
SPYMouseEvent i_eMouseEvent, IAuthenticRange *i_ipRange)
{
if ((i_eMouseEvent & spyMouseMoveMask) &&
(i_ipRange != null))
MsgBox ("moving over " + i_ipRange.FirstXMLData.Parent.Name);
}

See also

Declaration: srcElement as Variant

Description
Element which fires the current event. This is usually an XMLData object.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1141

type (obsolete)

Not supported

See also

Declaration: type as String (not supported)

Description
Currently no event sets this property.

© 2010 Altova GmbH Programmers' Reference


1142 The XMLSpy API Interfaces (obsolete)

4.4.2 AuthenticSelection (obsolete)


Superseded by AuthenticRange
The DocEditView object is renamed to OldAuthenticView.
DocEditSelection is renamed to AuthenticSelection.
DocEditEvent is renamed to AuthenticEvent.
DocEditDataTransfer is renamed to AuthenticDataTransfer.

Their usage - except for AuthenticDataTransfer - is no longer recommended. We will continue


to support existing functionality for a yet undefined period of time but no new features will be
added to these interface. All functionality available up to now in DocEditView,
DocEditSelection, DocEditEvent and DocEditDataTransfer is now available via AuthenticView,
AuthenticRange and AuthenticDataTransfer. Many new features have been added.

For examples on migrating from DocEdit to Authentic see the description of the different
methods and properties of the different DocEdit objects.

See also

Properties
Start
StartTextPosition
End
EndTextPosition

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1143

End (obsolete)

Superseded by AuthenticRange.LastXMLData
// ----- javascript sample -----
// instead of:
// var objXMLData =
Application.ActiveDocument.DocEditView.CurrentSelection.End;
// use now:
var objXMLData =
Application.ActiveDocument.AuthenticView.Selection.LastXMLData;

See also

Declaration: End as XMLData

Description
XML element where the current selection ends.

EndTextPosition (obsolete)

Superseded by AuthenticRange.LastXMLDataOffset
// ----- javascript sample -----
// instead of:
// var nOffset =
Application.ActiveDocument.DocEditView.CurrentSelection.EndTextPosition;
// use now:
var nOffset =
Application.ActiveDocument.AuthenticView.Selection.LastXMLDataOffset;

See also

Declaration: EndTextPosition as long

Description
Position in DocEditSelection.End.TextValue where the selection ends.

© 2010 Altova GmbH Programmers' Reference


1144 The XMLSpy API Interfaces (obsolete)

Start (obsolete)

Superseded by AuthenticRange.FirstXMLData
// ----- javascript sample -----
// instead of:
// var objXMLData =
Application.ActiveDocument.DocEditView.CurrentSelection.Start;
// use now:
var objXMLData =
Application.ActiveDocument.AuthenticView.Selection.FirstXMLData;

See also

Declaration: Start as XMLData

Description
XML element where the current selection starts.

StartTextPosition (obsolete)

Superseded by AuthenticRange.FirstXMLDataOffset
// ----- javascript sample -----
// instead of:
// var nOffset =
Application.ActiveDocument.DocEditView.CurrentSelection.StartTextPosition;
// use now:
var nOffset =
Application.ActiveDocument.AuthenticView.Selection.FirstXMLDataOffset;

See also

Declaration: StartTextPosition as long

Description
Position in DocEditSelection.Start.TextValue where the selection starts.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1145

4.4.3 OldAuthentictView (obsolete)


Superseded by AuthenticView and AuthenticRange
The DocEditView object is renamed to OldAuthenticView.
DocEditSelection is renamed to AuthenticSelection.
DocEditEvent is renamed to AuthenticEvent.
DocEditDataTransfer is renamed to AuthenticDataTransfer.

Their usage - except for AuthenticDataTransfer - is no longer recommended. We will continue


to support existing functionality for a yet undefined period of time but no new features will be
added to these interfaces. All functionality available up to now in DocEditView,
DocEditSelection, DocEditEvent and DocEditDataTransfer is now available via AuthenticView,
AuthenticRange and AuthenticDataTransfer. Many new features have been added.

For examples on migrating from DocEdit to Authentic see the description of the different
methods and properties of the different DocEdit objects.

See also

Methods

LoadXML
SaveXML

EditClear
EditCopy
EditCut
EditPaste
EditRedo
EditSelectAll
EditUndo

RowAppend
RowDelete
RowDuplicate
RowInsert
RowMoveDown
RowMoveUp

ApplyTextState
IsTextStateApplied
IsTextStateEnabled

MarkUpView

SelectionSet
SelectionMoveTabOrder

GetNextVisible
GetPreviousVisible

GetAllowedElements

© 2010 Altova GmbH Programmers' Reference


1146 The XMLSpy API Interfaces (obsolete)

Properties
CurrentSelection

event

XMLRoot

IsEditClearEnabled
IsEditCopyEnabled
IsEditCutEnabled
IsEditPasteEnabled
IsEditRedoEnabled
IsEditUndoEnabled

IsRowAppendEnabled
IsRowDeleteEnabled
IsRowDuplicateEnabled
IsRowInsertEnabled
IsRowMoveDownEnabled
IsRowMoveUpEnabled

Description
Interface for Authentic View.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1147

ApplyTextState (obsolete)

Superseded by AuthenticRange.PerformAction
Use spyAuthenticApply for the eAction parameter. The PerformAction method allows to apply
text state attributes to any range of the document, not only the current UI selection.

// ----- javascript sample -----


// instead of:
// Application.ActiveDocument.DocEditView.ApplyTextState ("bold");
// use now:
if (! Application.ActiveDocument.AuthenticView.Selection.PerformAction
(spyAuthenticApply, "bold"))
MsgBox ("Error: can't set current selection to bold");

See also

Declaration: ApplyTextState (elementName as String)

Description
Applies or removes the text state defined by the parameter elementName. Common examples
for the parameter elementName would be strong and italic.

In an XML document there are segments of data, which may contain sub-elements. For
example consider the following HTML:

<b>fragment</b>

The HTML tag <b> will cause the word fragment to be bold. However, this only happens
because the HTML parser knows that the tag <b> is bold. With XML there is much more
flexibility. It is possible to define any XML tag to do anything you desire. The point is that it is
possible to apply a Text state using XML. But the Text state that is applied must be part of the
schema. For example in the OrgChart.xml, OrgChart.sps, OrgChart.xsd example
the tag <strong> is the same as bold. And to apply bold the method ApplyTextState() is
called. But like the row and edit operations it is necessary to test if it is possible to apply the text
state.

See also IsTextStateEnabled and IsTextStateApplied.

© 2010 Altova GmbH Programmers' Reference


1148 The XMLSpy API Interfaces (obsolete)

CurrentSelection (obsolete)

Superseded by AuthenticView.Selection
The returned AuthenticRange object supports navigation via XMLData elements as well as
navigation by document elements (e.g. characters, words, tags) or text cursor positions.

// ----- javascript sample -----


// instead of:
// var objDocEditSel =
Application.ActiveDocument.DocEditView.CurrentSelection;
// use now:
var objRange = Application.ActiveDocument.AuthenticView.Selection;

See also

Declaration: CurrentSelection as DocEditSelection

Description
The property provides access to the current selection in the Authentic View.

EditClear (obsolete)

Superseded by AuthenticRange.Delete
The Delete method of AuthenticRange allows to delete any range of the document, not only
the current UI selection.

// ----- javascript sample -----


// instead of:
// Application.ActiveDocument.DocEditView.EditClear();
// use now:
if (! Application.ActiveDocument.AuthenticView.Selection.Delete())
MsgBox ("Error: can't delete current selection");

See also

Declaration: EditClear

Description
Deletes the current selection.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1149

EditCopy (obsolete)

Superseded by AuthenticRange.Copy
The Copy method of AuthenticRange allows to delete any range of the document, not only the
current UI selection.

// ----- javascript sample -----


// instead of:
// Application.ActiveDocument.DocEditView.EditCopy();
// use now:
if (! Application.ActiveDocument.AuthenticView.Selection.Copy())
MsgBox ("Error: can't copy current selection");

See also

Declaration: EditCopy

Description
Copies the current selection to the clipboard.

EditCut (obsolete)

Superseded by AuthenticRange.Cut
The Cut method of AuthenticRange allows to delete any range of the document, not only the
current UI selection.

// ----- javascript sample -----


// instead of:
// Application.ActiveDocument.DocEditView.EditCut();
// use now:
if (! Application.ActiveDocument.AuthenticView.Selection.Cut())
MsgBox ("Error: can't cut out current selection");

See also

Declaration: EditCut

Description
Cuts the current selection from the document and copies it to the clipboard.

© 2010 Altova GmbH Programmers' Reference


1150 The XMLSpy API Interfaces (obsolete)

EditPaste (obsolete)

Superseded by AuthenticRange.Paste
The Paste method of AuthenticRange allows to delete any range of the document, not only
the current UI selection.

// ----- javascript sample -----


// instead of:
// Application.ActiveDocument.DocEditView.EditPaste();
// use now:
if (! Application.ActiveDocument.AuthenticView.Selection.Paste())
MsgBox ("Error: can't paste to current selection");

See also

Declaration: EditPaste

Description
Pastes the content from the clipboard into the document.

EditRedo (obsolete)

Superseded by AuthenticView.Redo
// ----- javascript sample -----
// instead of:
// Application.ActiveDocument.DocEditView.EditRedo();
// use now:
if (! Application.ActiveDocument.AuthenticView.Redo())
MsgBox ("Error: no redo step available");

See also

Declaration: EditRedo

Description
Redo the last undo step.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1151

EditSelectAll (obsolete)

Superseded by AuthenticView.WholeDocument and


AuthenticRange.Select
// ----- javascript sample -----
// instead of:
// Application.ActiveDocument.DocEditView.EditSelectAll();
// use now:
Application.ActiveDocument.AuthenticView.WholeDocument.Select();

See also

Declaration: EditSelectAll

Description
The method selects the complete document.

EditUndo (obsolete)

Superseded by AuthenticView.Undo
// ----- javascript sample -----
// instead of:
// Application.ActiveDocument.DocEditView.EditUndo();
// use now:
if (! Application.ActiveDocument.AuthenticView.Undo())
MsgBox ("Error: no undo step available");

See also

Declaration: EditUndo

Description
Undo the last action.

© 2010 Altova GmbH Programmers' Reference


1152 The XMLSpy API Interfaces (obsolete)

event (obsolete)

Superseded by parameters to AuthenticView events.

See also

Declaration: event as DocEditEvent

Description
The event property holds a DocEditEvent object which contains information about the current
event.

GetAllowedElements (obsolete)

Superseded by AuthenticRange.CanPerformActionWith
AuthenticRange now supports all functionality of the 'elements' entry helper. Besides querying
the elements that can be inserted, appended, etc., you can invoke the action as well. See
AuthenticRange.PerformAction for more information.

// ----- javascript sample -----


// instead of:
// var arrElements = New Array();
// var objDocEditView = Application.ActiveDocument.DocEditView;
// var objStartElement = objDocEditView.CurrentSelection.Start;
// var objEndElement = objDocEditView.CurrentSelection.End;
// objDocEditView.GetAllowedElements(k_ActionInsertBefore, objStartElement,
objEndElement, arrElements);
// use now:
var arrElements = New Array();
Application.ActiveDocument.AuthenticView.Selection.CanPerformActionWith
(spyAuthenticInsertBefore, arrElements);

See also

Declaration: GetAllowedElements (nAction as SpyAuthenticElementActions,


pStartElement as XMLData, pEndElement as XMLData, pElements as Variant)

Description
GetAllowedElements() returns the allowed elements for the various actions specified by
nAction.

JavaScript example:

Function GetAllowed()
{
var objView = Application.ActiveDocument.DocEditView;

var arrElements = New Array(1);

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1153

var objStart = objView.CurrentSelection.Start;


var objEnd = objView.CurrentSelection.End;

var strText;
strText = "valid elements at current selection:\n\n";

For(var i = 1;i <= 4;i++) {


objPlugIn.GetAllowedElements(i,objStart,objEnd,arrElements);
strText = strText + ListArray(arrElements) + "------------------\n";
}

Return strText;
}

Function ListArray(arrIn)
{
var strText = "";

If(TypeOf(arrIn) == "object") {
For(var i = 0;i <= (arrIn.length - 1);i++)
strText = strText + arrIn[i] + "\n";
}

Return strText;
}

VBScript example:

Sub DisplayAllowed
Dim objView
Set objView = Application.ActiveDocument.DocEditView

Dim arrElements()

Dim objStart
Dim objEnd
Set objStart = objView.CurrentSelection.Start
Set objEnd = objView.CurrentSelection.End

Dim strText
strText = "valid elements at current selection:" & chr(13) & chr(13)

Dim i

For i = 1 To 4
objView.GetAllowedElements i,objStart,objEnd,arrElements
strText = strText & ListArray(arrElements) & "---------------" & chr(13)
Next

msgbox strText
End Sub

Function ListArray(arrIn)
Dim strText

If IsArray(arrIn) Then
Dim i

For i = 0 To UBound(arrIn)
strText = strText & arrIn(i) & chr(13)
Next
End If

ListArray = strText
End Function

© 2010 Altova GmbH Programmers' Reference


1154 The XMLSpy API Interfaces (obsolete)

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1155

GetNextVisible (obsolete)

Superseded by AuthenticRange.SelectNext
AuthenticRange now supports a wide range of element navigation methods based on
document elements like characters, words, tags and many more. Selecting the text passage
that represents the content of the next XML element is just one of them.

// ----- javascript sample -----


// instead of:
// var objCurrXMLData = ...
// var objXMLData =
Application.ActiveDocument.DocEditView.GetNextVisible(objCurrXMLData);
// Application.ActiveDocument.DocEditView.SelectionSet (objXMLData, 0,
objXMLData, -1);
// use now:
var objRange = ...
try
{ objRange.SelectNext (spyAuthenticTag).Select(); }
catch (err)
{
if ((err.number & 0xffff) == 2003)
MsgBox ("end of document reached");
else
throw (err);
}

See also

Declaration: GetNextVisible (pElement as XMLData) as XMLData

Description
The method gets the next visible XML element in the document.

© 2010 Altova GmbH Programmers' Reference


1156 The XMLSpy API Interfaces (obsolete)

GetPreviousVisible (obsolete)

Superseded by AuthenticRange.SelectPrevious
AuthenticRange now supports a wide range of element navigation methods based on
document elements like characters, words, tags and many more. Selecting the text passage
that represents the content of the previous XML element is just one of them.

// ----- javascript sample -----


// instead of:
// var objCurrXMLData = ...
// var objXMLData =
Application.ActiveDocument.DocEditView.GetPreviousVisible(objCurrXMLData);
// Application.ActiveDocument.DocEditView.SelectionSet (objXMLData, 0,
objXMLData, -1);
// use now:
var objRange = ...
try
{ objRange.SelectPrevious (spyAuthenticTag).Select(); }
catch (err)
{
if ((err.number & 0xffff) == 2004)
MsgBox ("begin of document reached");
else
throw (err);
}

See also

Declaration: GetPreviousVisible (pElement as XMLData) as XMLData

Description
The method gets the previous visible XML element in the document.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1157

IsEditClearEnabled (obsolete)

Superseded by AuthenticRange.IsDeleteEnabled
The IsDeleteEnabled property is now supported for any range of the document, not only the
current UI selection.

// ----- javascript sample -----


// instead of:
// if (Application.ActiveDocument.DocEditView.IsEditClearEnabled)
// Application.ActiveDocument.DocEditView.EditClear();
// use now:
var objCurrSelection = Application.ActiveDocument.AuthenticView.Selection;
if (objCurrSelection.IsDeleteEnabled)
objCurrSelection.Delete();

See also

Declaration: IsEditClearEnabled as Boolean

Description
True if EditClear is possible. See also Editing operations.

IsEditCopyEnabled (obsolete)

Superseded by AuthenticRange.IsCopyEnabled
The IsCopyEnabled property is now supported for any range of the document, not only the
current UI selection.

// ----- javascript sample -----


// instead of:
// if (Application.ActiveDocument.DocEditView.IsEditCopyEnabled)
// Application.ActiveDocument.DocEditView.EditCopy();
// use now:
var objCurrSelection = Application.ActiveDocument.AuthenticView.Selection;
if (objCurrSelection.IsCopyEnabled)
objCurrSelection.Copy();

See also

Declaration: IsEditCopyEnabled as Boolean

Description
True if copy to clipboard is possible. See also EditCopy and Editing operations.

© 2010 Altova GmbH Programmers' Reference


1158 The XMLSpy API Interfaces (obsolete)

IsEditCutEnabled (obsolete)

Superseded by AuthenticRange.IsCutEnabled
The IsCutEnabled property is now supported for any range of the document, not only the
current UI selection.

// ----- javascript sample -----


// instead of:
// if (Application.ActiveDocument.DocEditView.IsEditCutEnabled)
// Application.ActiveDocument.DocEditView.EditCut();
// use now:
var objCurrSelection = Application.ActiveDocument.AuthenticView.Selection;
if (objCurrSelection.IsCutEnabled)
objCurrSelection.Cut();

See also

Declaration: IsEditCutEnabled as Boolean

Description
True if EditCut is currently possible. See also Editing operations.

IsEditPasteEnabled (obsolete)

Superseded by AuthenticRange.IsPasteEnabled
The IsPasteEnabled property is now supported for any range of the document, not only the
current UI selection.

// ----- javascript sample -----


// instead of:
// if (Application.ActiveDocument.DocEditView.IsEditPasteEnabled)
// Application.ActiveDocument.DocEditView.EditPaste();
// use now:
var objCurrSelection = Application.ActiveDocument.AuthenticView.Selection;
if (objCurrSelection.IsPasteEnabled)
objCurrSelection.Paste();

See also

Declaration: IsEditPasteEnabled as Boolean

Description
True if EditPaste is possible. See also Editing operations.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1159

IsEditRedoEnabled (obsolete)

Superseded by AuthenticView.IsRedoEnabled
// ----- javascript sample -----
// instead of:
// if (Application.ActiveDocument.DocEditView.IsEditRedoEnabled)
// Application.ActiveDocument.DocEditView.EditRedo();
// use now:
if (Application.ActiveDocument.AuthenticView.IsRedoEnabled)
Application.ActiveDocument.AuthenticView.Redo();

See also

Declaration: IsEditRedoEnabled as Boolean

Description
True if EditRedo is currently possible. See also Editing operations.

IsEditUndoEnabled (obsolete)

Superseded by AuthenticView.IsUndoEnabled
// ----- javascript sample -----
// instead of:
// if (Application.ActiveDocument.DocEditView.IsEditUndoEnabled)
// Application.ActiveDocument.DocEditView.EditUndo();
// use now:
if (Application.ActiveDocument.AuthenticView.IsUndoEnabled)
Application.ActiveDocument.AuthenticView.Undo();

See also

Declaration: IsEditUndoEnabled as Boolean

Description
True if EditUndo is possible. See also Editing operations.

© 2010 Altova GmbH Programmers' Reference


1160 The XMLSpy API Interfaces (obsolete)

IsRowAppendEnabled (obsolete)

Superseded by AuthenticRange.IsInDynamicTable
The operations 'insert', 'append', 'delete' and 'duplicate' row are available whenever the
selection is inside a dynamic table.

// ----- javascript sample -----


// instead of:
// if (Application.ActiveDocument.DocEditView.IsRowAppendEnabled)
// Application.ActiveDocument.DocEditView.RowAppend();
// use now:
if (Application.ActiveDocument.AuthenticView.Selection.IsInDynamicTable())
Application.ActiveDocument.AuthenticView.Selection.AppendRow();

See also

Declaration: IsRowAppendEnabled as Boolean

Description
True if RowAppend is possible. See also Row operations.

IsRowDeleteEnabled (obsolete)

Superseded by AuthenticRange.IsInDynamicTable
The operations 'insert', 'append', 'delete' and 'duplicate' row are available whenever the
selection is inside a dynamic table.

// ----- javascript sample -----


// instead of:
// if (Application.ActiveDocument.DocEditView.IsRowDeleteEnabled)
// Application.ActiveDocument.DocEditView.Rowdelete();
// use now:
if (Application.ActiveDocument.AuthenticView.Selection.IsInDynamicTable())
Application.ActiveDocument.AuthenticView.Selection.DeleteRow();

See also

Declaration: IsRowDeleteEnabled as Boolean

Description
True if RowDelete is possible. See also Row operations.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1161

IsRowDuplicateEnabled (obsolete)

Superseded by AuthenticRange.IsInDynamicTable
The operations 'insert', 'append', 'delete' and 'duplicate' row are available whenever the
selection is inside a dynamic table.

// ----- javascript sample -----


// instead of:
// if (Application.ActiveDocument.DocEditView.IsRowDuplicateEnabled)
// Application.ActiveDocument.DocEditView.RowDuplicate();
// use now:
if (Application.ActiveDocument.AuthenticView.Selection.IsInDynamicTable())
Application.ActiveDocument.AuthenticView.Selection.DuplicateRow();

See also

Declaration: IsRowDuplicateEnabled as Boolean

Description
True if RowDuplicate is currently possible. See also Row operations.

IsRowInsertEnabled (obsolete)

Superseded by AuthenticRange.IsInDynamicTable
The operations 'insert', 'append', 'delete' and 'duplicate' row are available whenever the
selection is inside a dynamic table.

// ----- javascript sample -----


// instead of:
// if (Application.ActiveDocument.DocEditView.IsRowInsertEnabled)
// Application.ActiveDocument.DocEditView.RowInsert();
// use now:
if (Application.ActiveDocument.AuthenticView.Selection.IsInDynamicTable())
Application.ActiveDocument.AuthenticView.Selection.InsertRow();

See also

Declaration: IsRowInsertEnabled as Boolean

Description
True if RowInsert is possible. See also Row operations.

© 2010 Altova GmbH Programmers' Reference


1162 The XMLSpy API Interfaces (obsolete)

IsRowMoveDownEnabled (obsolete)

Superseded by AuthenticRange.IsLastRow

// ----- javascript sample -----


// instead of:
// if (Application.ActiveDocument.OldAuthenticView.IsRowMoveDownEnabled)
// Application.ActiveDocument.DocEditView.RowMoveDown();
// use now:
if (!Application.ActiveDocument.AuthenticView.Selection.IsLastRow)
Application.ActiveDocument.AuthenticView.Selection.MoveRowDown();

See also

Declaration: IsRowMoveDownEnabled as Boolean

Description
True if RowMoveDown is currently possible. See also Row operations.

IsRowMoveUpEnabled (obsolete)

Superseded by AuthenticRange.IsFirstRow

// ----- javascript sample -----


// instead of:
// if (Application.ActiveDocument.DocEditView.IsRowMoveUpEnabled)
// Application.ActiveDocument.DocEditView.RowMoveUp();
// use now:
if (!Application.ActiveDocument.AuthenticView.Selection.IsFirstRow)
Application.ActiveDocument.AuthenticView.Selection.MoveRowUp();

See also

Declaration: IsRowMoveUpEnabled as Boolean

Description
True if RowMoveUp is possible. See also Row operations.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1163

IsTextStateApplied (obsolete)

Superseded by AuthenticRange.IsTextStateApplied
// ----- javascript sample -----
// instead of:
// Application.ActiveDocument.DocEditView.IsTextStateApplied ("bold");
// use now:
if (Application.ActiveDocument.AuthenticView.Selection.IsTextStateApplied (
"bold"))
MsgBox ("bold on");
else
MsgBox ("bold off");

See also

Declaration: IsTextStateApplied (elementName as String) as Boolean

Description
Checks to see if the it the text state has already been applied. Common examples for the
parameter elementName would be strong and italic.

IsTextStateEnabled (obsolete)

Superseded by AuthenticRange.CanPerformAction
Use spyAuthenticApply for the eAction parameter. The CanPerformAction method allows to
operate on any range of the document, not only the current UI selection.

// ----- javascript sample -----


// instead of:
// Application.ActiveDocument.DocEditView.IsTextStateEnabled ("bold");
// use now:
if (Application.ActiveDocument.AuthenticView.Selection.CanPerformAction
(spyAuthenticApply, "bold"))
... // e.g. enable 'bold' button

See also

Declaration: IsTextStateEnabled (i_strElementName as String) as Boolean

Description
Checks to see if it is possible to apply a text state. Common examples for the parameter
elementName would be strong and italic.

© 2010 Altova GmbH Programmers' Reference


1164 The XMLSpy API Interfaces (obsolete)

LoadXML (obsolete)

Superseded by AuthenticView.AsXMLString
AuthenticView now supports the property AsXMLString that can be used to directly access
and replace the document content as an XMLString.

// ----- javascript sample -----


// instead of:
// Application.ActiveDocument.DocEditView.LoadXML (strDocAsXMLString);
// use now:
try
{ Application.ActiveDocument.AuthenticView.AsXMLString =
strDocAsXMLString; }
catch (err)
{ MsgBox ("Error: invalid XML string"); }

See also

Declaration: LoadXML (xmlString as String)

Description
Loads the current XML document with the XML string applied. The new content is displayed
immediately.
The xmlString parameter must begin with the XML declaration, e.g.,
objPlugIn.LoadXML("<?xml version='1.0' encoding='UTF-8'?><root></root>");

MarkUpView (obsolete)

Superseded by AuthenticView.MarkupVisibility
// ----- javascript sample -----
// instead of:
// Application.ActiveDocument.DocEditView.MarkuUpView = 2;
// use now:
Application.ActiveDocument.AuthenticView.MarkupVisibility =
spyAuthenticMarkupLarge;

See also

Declaration: MarkUpView (kind as long)

Description
By default the document displayed is using HTML techniques. But sometimes it is desirable to
show the editing tags. Using this method it is possible to display three different types of markup
tags:

0 hide the markup tags


2 show the large markup tags
3 show the mixed markup tags.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1165

© 2010 Altova GmbH Programmers' Reference


1166 The XMLSpy API Interfaces (obsolete)

RowAppend (obsolete)

Superseded by AuthenticRange.AppendRow
The table operations of AuthenticRange now allow to manipulate any table in the current
document independent of the current UI selection.

// ----- javascript sample -----


// instead of:
// Application.ActiveDocument.DocEditView.RowAppend();
// use now:
if (! Application.ActiveDocument.AuthenticView.Selection.AppendRow())
MsgBox ("Error: can't append row");

See also

Declaration: RowAppend

Description
Appends a row at the current position.

See also Row operations.

RowDelete (obsolete)

Superseded by AuthenticRange.DeleteRow
The table operations of AuthenticRange now allow to manipulate any table in the current
document independent of the current UI selection.

// ----- javascript sample -----


// instead of:
// Application.ActiveDocument.DocEditView.RowDelete();
// use now:
if (! Application.ActiveDocument.AuthenticView.Selection.DeleteRow())
MsgBox ("Error: can't delete row");

See also

Declaration: RowDelete

Description
Deletes the currently selected row(s).

See also Row operations.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1167

RowDuplicate (obsolete)

Superseded by AuthenticRange.DuplicateRow
The table operations of AuthenticRange now allow to manipulate any table in the current
document independent of the current UI selection.

// ----- javascript sample -----


// instead of:
// Application.ActiveDocument.DocEditView.RowDuplicate();
// use now:
if (! Application.ActiveDocument.AuthenticView.Selection.DuplicateRow())
MsgBox ("Error: can't duplicate row");

See also

Declaration: RowDuplicate

Description
The method duplicates the currently selected rows.

See also Row operations.

RowInsert (obsolete)

Superseded by AuthenticRange.InsertRow
The table operations of AuthenticRange now allow to manipulate any table in the current
document independent of the current UI selection.

// ----- javascript sample -----


// instead of:
// Application.ActiveDocument.DocEditView.RowInsert();
// use now:
if (! Application.ActiveDocument.AuthenticView.Selection.InsertRow())
MsgBox ("Error: can't insert row");

See also

Declaration: RowInsert

Description
Inserts a new row immediately above the current selection.

See also Row operations.

© 2010 Altova GmbH Programmers' Reference


1168 The XMLSpy API Interfaces (obsolete)

RowMoveDown (obsolete)

Superseded by AuthenticRange.MoveRowDown
The table operations of AuthenticRange now allow to manipulate any table in the current
document independent of the current UI selection.

// ----- javascript sample -----


// instead of:
// Application.ActiveDocument.DocEditView.RowMoveDown();
// use now:
if (! Application.ActiveDocument.AuthenticView.Selection.MoveRowDown())
MsgBox ("Error: can't move row down");

See also

Declaration: RowMoveDown

Description
Moves the current row one position down.

See also Row operations.

RowMoveUp (obsolete)

Superseded by AuthenticRange.MoveRowUp
The table operations of AuthenticRange now allow to manipulate any table in the current
document independent of the current UI selection.

// ----- javascript sample -----


// instead of:
// Application.ActiveDocument.DocEditView.RowAppend();
// use now:
if (! Application.ActiveDocument.AuthenticView.Selection.MoveRowUp())
MsgBox ("Error: can't move row up");

See also

Declaration: RowMoveUp

Description
Moves the current row one position up.

See also Row operations.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1169

SaveXML (obsolete)

Superseded by AuthenticView.AsXMLString
AuthenticView now supports the property XMLString that can be used to directly access and
replace the document content as an XMLString.

// ----- javascript sample -----


// instead of:
// var strDocAsXMLString = Application.ActiveDocument.DocEditView.SaveXML();
// use now:
try
{
var strDocAsXMLString =
Application.ActiveDocument.AuthenticView.AsXMLString;
... // do something here
}
catch (err)
{ MsgBox ("Error: invalid XML string"); }

See also

Declaration: SaveXML as String

Return Value
XML structure as string

Description
Saves the current XML data to a string that is returned to the caller.

© 2010 Altova GmbH Programmers' Reference


1170 The XMLSpy API Interfaces (obsolete)

SelectionMoveTabOrder (obsolete)

Superseded by AuthenticRange.SelectNext
AuthenticRange now supports a wide range of element navigation methods based on
document elements like characters, words, tags and many more. Selecting the next
paragraph is just one of them, and navigation is not necessarily bound to the current UI
selection.

// ----- javascript sample -----


// instead of:
// Application.ActiveDocument.DocEditView.SelectionMoveTabOrder(true, true);
// use now:
Application.ActiveDocument.AuthenticView.Selection.SelectNext
(spyAuthenticParagraph).Select();
// to append a row to a table use AuthenticRange.AppendRow

See also

Declaration: SelectionMoveTabOrder (bForward as Boolean, bTag as Boolean)

Description
SelectionMoveTabOrder() moves the current selection forwards or backwards.

If bTag is false and the current selection is at the last cell of a table a new line will be added.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1171

SelectionSet (obsolete)

Superseded by AuthenticRange.FirstXMLData and related properties


AuthenticRange supports navigation via XMLData elements as well as navigation by
document elements (e.g. characters, words, tags) or text cursor positions.

// ----- javascript sample -----


// instead of:
// if (! Application.ActiveDocument.DocEditView.SelectionSet(varXMLData1, 0,
varXMLData2, -1))
// MsgBox ("Error: invalid data position");
// use now:
try
{
var objSelection = Application.ActiveDocument.AuthenticView.Selection;
objSelection.FirstXMLData = varXMLData1;
objSelection.FirstXMLdataOffset = 0;
objSelection.LastXMLData = varXMLData2;
objSelection.LastXMLDataOffset = -1;
objSelection.Select();
}
catch (err)
{ MsgBox ("Error: invalid data position"); }
// to select all text between varXMLData1 and varXMLdata2, inclusive

See also

Declaration: SelectionSet (pStartElement as XMLData, nStartPos as long,


pEndElement as XMLData, nEndPos as long) as Boolean

Description
Use SelectionSet() to set a new selection in the Authentic View. Its possible to set
pEndElement to null (nothing) if the selection should be just over one (pStartElement) XML
element.

© 2010 Altova GmbH Programmers' Reference


1172 The XMLSpy API Interfaces (obsolete)

XMLRoot (obsolete)

Superseded by AuthenticView.XMLDataRoot
// ----- javascript sample -----
// instead of:
// var objXMLData = Application.ActiveDocument.DocEditView.XMLRoot;
// use now:
var objXMLData = Application.ActiveDocument.AuthenticView.XMLDataRoot;

See also

Declaration: XMLRoot as XMLData

Description
XMLRoot is the parent element of the currently displayed XML structure. Using the XMLData
interface you have full access to the complete content of the file.

See also Using XMLData for more information.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Interfaces (obsolete) 1173

© 2010 Altova GmbH Programmers' Reference


1174 The XMLSpy API Enumerations

4.5 Enumerations
This is a list of all enumerations used by the XMLSpy API. If your scripting environment does
not support enumerations use the number-values instead.

4.5.1 ENUMApplicationStatus
Description
Enumeration to specify the current Application status.

Possible values:

eApplicationRunning =0
eApplicationAfterLicenseCheck =1
eApplicationBeforeLicenseCheck =2
eApplicationConcurrentLicenseCheckFailed =3
eApplicationProcessingCommandLine =4

4.5.2 SPYAttributeTypeDefinition
Description
Attribute type definition that can be selected for generation of Sample XML.
This type is used with the method GenerateDTDOrSchema and GenerateDTDOrSchemaEx.

Possible values:
spyMergedGlobal =0
spyDistinctGlobal =1
spyLocal =2

4.5.3 SPYAuthenticActions
Description
Actions that can be performed on AuthenticRange objects.

Possible values:
spyAuthenticInsertAt =0
spyAuthenticApply =1
spyAuthenticClearSurr =2
spyAuthenticAppend =3
spyAuthenticInsertBefore =4
spyAuthenticRemove =5

4.5.4 SPYAuthenticDocumentPosition
Description
Relative and absolute positions used for navigating with AuthenticRange objects.

Possible values:
spyAuthenticDocumentBegin = 0
spyAuthenticDocumentEnd = 1
spyAuthenticRangeBegin =2
spyAuthenticRangeEnd =3

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Enumerations 1175

4.5.5 SPYAuthenticElementActions
Description
Actions that can be used with GetAllowedElements (superseded by
AuthenticRange.CanPerformActionWith).

Possible values:
k_ActionInsertAt =0
k_ActionApply =1
k_ActionClearSurr =2
k_ActionAppend =3
k_ActionInsertBefore =4
k_ActionRemove =5

4.5.6 SPYAuthenticElementKind
Description
Enumeration of the different kinds of elements used for navigation and selection within the
AuthenticRange and AuthenticView objects.

Possible values:
spyAuthenticChar =0
spyAuthenticWord =1
spyAuthenticLine =3
spyAuthenticParagraph =4
spyAuthenticTag =6
spyAuthenticDocument =8
spyAuthenticTable =9
spyAuthenticTableRow = 10
spyAuthenticTableColumn = 11

4.5.7 SPYAuthenticMarkupVisibility
Description
Enumeration values to customize the visibility of markup with MarkupVisibility.

Possible values:
spyAuthenticMarkupHidden =0
spyAuthenticMarkupSmall =1
spyAuthenticMarkupLarge =2
spyAuthenticMarkupMixed =3

4.5.8 SPYAuthenticToolbarButtonState
Description
Authentic toolbar button states are given by the following enumeration:

Possible values:
authenticToolbarButtonDefault =0
authenticToolbarButtonEnabled =1
authenticToolbarButtonDisabled =2

© 2010 Altova GmbH Programmers' Reference


1176 The XMLSpy API Enumerations

4.5.9 SPYDatabaseKind
Description
Values to select different kinds of databases for import. See
DatabaseConnection.DatabaseKind for its use.

Possible values:
spyDB_Access =0
spyDB_SQLServer =1
spyDB_Oracle =2
spyDB_Sybase =3
spyDB_MySQL =4
spyDB_DB2 =5
spyDB_Other =6
spyDB_Unspecified =7

4.5.10 SPYDialogAction
Description
Values to simulate different interactions on dialogs. See Dialogs for all dialogs available.

Possible values:
spyDialogOK =0 //si
m ul
atecl
i
ckonOK button
spyDialogCancel =1 //si
m ul
atecl
i
ckonCancelbutton
spyDialogUserInput =2 / show dial
ogandal
l
ow useri nteracti
on

4.5.11 SPYDOMType
Description
Enumeration values to parameterize generation of C++ code from schema definitions.

Possible values:
spyDOMType_msxml4 =0 Obsolete
spyDOMType_xerces =1
spyDOMType_xerces3 =2
spyDOMType_msxml6 =3

spyDOMType_xerces indicates Xerces 2.x usage; spyDOMType_xerces3 indicates Xerces 3.x


usage.

4.5.12 SPYDTDSchemaFormat
Description
Enumeration to identify the different schema formats.

Possible values:
spyDTD =0
spyW3C =1

4.5.13 SPYEncodingByteOrder
Description
Enumeration values to specify encoding byte ordering for text import and export.

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Enumerations 1177

Possible values:
spyNONE =0
spyLITTLE_ENDIAN =1
spyBIG_ENDIAN =2

4.5.14 SPYExportNamespace
Description
Enumeration type to configure handling of namespace identifiers during export.

Possible values:
spyNoNamespace =0
spyReplaceColonWithUnderscore = 1

4.5.15 SPYFindInFilesSearchLocation
Description
The different locations where a search can be performed. This type is used with the
FindInFilesDlg dialog.

Possible values:
spyFindInFiles_Documents =0
spyFindInFiles_Project =1
spyFindInFiles_Folder =2

4.5.16 SPYFrequentElements
Description
Enumeration value to parameterize schema generation.

Possible values:
spyGlobalElements =0
spyGlobalComplexType =1

4.5.17 SPYImageKind
Description
Enumeration values to parameterize image type of the generated documentation. These values
are used in Schem aDocum entationDialog.Diagram Form at and
W SDLDocum entationDlg.Diagram Form at .

Possible values:
spyImageType_PNG =0
spyImageType_EMF =1

4.5.18 SPYImportColumnsType
Description
Enumeration to specify different Import columns types.

Possible values:

spyImportColumns_Element =0
spyImportColumns_Attribute =1

© 2010 Altova GmbH Programmers' Reference


1178 The XMLSpy API Enumerations

4.5.19 SPYKeyEvent
Description
Enumeration type to identify the different key events. These events correspond with the equally
named windows messages.

Possible values:
spyKeyDown =0
spyKeyUp =1
spyKeyPressed =2

4.5.20 SPYKeyStatus
Description
Enumeration type to identify the key status.

Possible values:
spyLeftShiftKeyMask =1
spyRightShiftKeyMask =2
spyLeftCtrlKeyMask =4
spyRightCtrlKeyMask =8
spyLeftAltKeyMask = 16
spyRightAltKeyMask = 32

4.5.21 SPYLibType
Description
Enumeration values to parameterize generation of C++ code from schema definitions.

Possible values:
spyLibType_static =0
spyLibType_dll =1

4.5.22 SPYLoading
Description
Enumeration values to define loading behaviour of URL files.

Possible values:
spyUseCacheProxy =0
spyReload =1

4.5.23 SPYMouseEvent
Description
Enumeration type that defines the mouse status during a mouse event. Use the enumeration
values as bitmasks rather then directly comparing with them.

Examples

' to check for ctrl-leftbutton-down in VB


If (i_eMouseEvent = (XMLSpyLib.spyLeftButtonDownMask Or
XMLSpyLib.spyCtrlKeyDownMask)) Then
' react on ctrl-leftbutton-down
End If

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Enumerations 1179

' to check for double-click with any button in VBScript


If (((i_eMouseEvent And spyDoubleClickMask) <> 0) Then
' react on double-click
End If

Possible values:
spyNoButtonMask =0
spyMouseMoveMask =1
spyLeftButtonMask =2
spyMiddleButtonMask =4
spyRightButtonMask =8
spyButtonUpMask = 16
spyButtonDownMask = 32
spyDoubleClickMask = 64
spyShiftKeyDownMask = 128
spyCtrlKeyDownMask = 256
spyLeftButtonDownMask = 34 // spyLeftButtonMask | spyButtonDownMask
spyMiddleButtonDownMask = 36 // spyMiddleButtonMask | spyButtonDownMask
spyRightButtonDownMask = 40 // spyRightButtonMask | spyButtonDownMask
spyLeftButtonUpMask = 18 // spyLeftButtonMask | spyButtonUpMask
spyMiddleButtonUpMask = 20 // spyMiddleButtonMask | spyButtonUpMask
spyRightButtonUpMask = 24 // spyRightButtonMask | spyButtonUpMask
spyLeftDoubleClickMask = 66 // spyRightButtonMask | spyButtonUpMask
spyMiddleDoubleClickMask = 68 // spyMiddleButtonMask | spyDoubleClickMask
spyRightDoubleClickMask = 72 // spyRightButtonMask | spyDoubleClickMask

4.5.24 SPYNumberDateTimeFormat
Description
Enumeration value to configure database connections.

Possible values:
spySystemLocale =0
spySchemaCompatible = 1

4.5.25 SPYProgrammingLanguage
Description
Enumeration values to select the programming language for code generation from schema
definitions.

Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.

Possible values:
spyUndefinedLanguage = -1
spyJava =0
spyCpp =1
spyCSharp =2

4.5.26 SPYProjectItemTypes
Description
Enumeration values to identify the different elements in project item lists. See
SpyProjectItem.ItemType.

© 2010 Altova GmbH Programmers' Reference


1180 The XMLSpy API Enumerations

Possible values:
spyUnknownItem =0
spyFileItem =1
spyFolderItem =2
spyURLItem =3

4.5.27 SPYProjectType
Description
Enumeration values to parameterize generation of C# from schema definitions.

Possible values:
spyVisualStudioProject =0 Obsolete
spyVisualStudio2003Project =1 Obsolete
spyBorlandProject =2 Obsolete
spyMonoMakefile =3
spyVisualStudio2005Project =4 For C++ code also
spyVisualStudio2008Project =5 For C++ code also
spyVisualStudio2010Project =6 For C++ code also

4.5.28 SPYSampleXMLGenerationOptimization
Description
Specify the elements that will be generated in the Sample XML.
This enumeration is used in GenerateSampleXMLDlg.

Possible values:
spySampleXMLGen_Optimized =0
spySampleXMLGen_NonMandatoryElements = 1
spySampleXMLGen_Everything =2

4.5.29 SPYSampleXMLGenerationSchemaOrDTDAssignment
Description
Specifies what kind of reference to the schema/DTD should be added to the generated Sample
XML.
This enumeration is used in GenerateSampleXMLDlg.

Possible values:
spySampleXMLGen_AssignRelatively =0
spySampleXMLGen_AssignAbsolutely =1
spySampleXMLGen_DoNotAssign =2

4.5.30 SPYSchemaDefKind
Description
Enumeration type to select schema diagram types.

Possible values:
spyKindElement =0
spyKindComplexType =1
spyKindSimpleType =2
spyKindGroup =3
spyKindModel =4

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Enumerations 1181

spyKindAny =5
spyKindAttr =6
spyKindAttrGroup =7
spyKindAttrAny =8
spyKindIdentityUnique =9
spyKindIdentityKey = 10
spyKindIdentityKeyRef = 11
spyKindIdentitySelector = 12
spyKindIdentityField = 13
spyKindNotation = 14
spyKindInclude = 15
spyKindImport = 16
spyKindRedefine = 17
spyKindFacet = 18
spyKindSchema = 19
spyKindCount = 20

4.5.31 SPYSchemaDocumentationFormat
Description
Enumeration values to parameterize generation of schema documentation. These values are
used in Schem aDocum entationDialog.OutputForm at and
W SDLDocum entationDlg.O utputForm at .

Possible values:
spySchemaDoc_HTML =0
spySchemaDoc_MSWord =1
spySchemaDoc_RTF =2

4.5.32 SPYSchemaExtensionType
Description
Enumeration to specify different Schema Extension types.

Possible values:

spySchemaExtension_None =0
spySchemaExtension_SQL_XML =1
spySchemaExtension_MS_SQL_Server =2
spySchemaExtension_Oracle =3

4.5.33 SPYSchemaFormat
Description
Enumeration to specify different Schema Format types.

Possible values:

spySchemaFormat_Hierarchical =0
spySchemaFormat_Flat =1

4.5.34 SPYTextDelimiters
Description
Enumeration values to specify text delimiters for text export.

© 2010 Altova GmbH Programmers' Reference


1182 The XMLSpy API Enumerations

Possible values:
spyTabulator =0
spySemicolon =1
spyComma =2
spySpace =3

4.5.35 SPYTextEnclosing
Description
Enumeration value to specify text enclosing characters for text import and export.

Possible values:
spyNoEnclosing =0
spySingleQuote =1
spyDoubleQuote =2

4.5.36 SPYTypeDetection
Description
Enumeration to select how type detection works during GenerateDTDOrSchema and
GenerateDTDOrSchemaEx.

Possible values:
spyBestPossible =0
spyNumbersOnly =1
spyNoDetection =2

4.5.37 SPYURLTypes
Description
Enumeration to specify different URL types.

Possible values:
spyURLTypeAuto = -1
spyURLTypeXML = 0
spyURLTypeDTD = 1

4.5.38 SPYViewModes
Description
Enumeration values that define the different view modes for XML documents. The mode
spyViewAuthentic(4) identifies the mode that was intermediately called DocEdit mode and is
now called Authentic mode. The mode spyViewWSDL identifies a mode which is mapped to the
schema view on the GUI but distinguished internally.

Possible values:
spyViewGrid =0
spyViewText =1
spyViewBrowser =2
spyViewSchema =3
spyViewContent =4 // obsolete
spyViewAuthentic =4
spyViewWSDL =5
spyViewZIP =6
spyViewEditionInfo =7
spyViewXBRL =8

Altova XMLSpy 2011 © 2010 Altova GmbH


The XMLSpy API Enumerations 1183

4.5.39 SPYVirtualKeyMask
Description
Enumeration type for the most frequently used key masks that identify the status of the virtual
keys. Use these values as bitmasks rather then directly comparing with them. When necessary,
you can create further masks by using the 'logical or' operator.

Examples

' VBScript sample: check if ctrl-key is pressed


If ((i_nVirtualKeyStatus And spyCtrlKeyMask) <> 0)) Then
' ctrl-key is pressed
End If

' VBScript sample: check if ONLY ctrl-key is pressed


If (i_nVirtualKeyStatus == spyCtrlKeyMask) Then
' exactly ctrl-key is pressed
End If

// JScript sample: check if any of the right virtual keys is pressed


if ((i_nVirtualKeyStatus & (spyRightShiftKeyMask | spyRightCtrlKeyMask |
spyRightAltKeyMask)) != 0)
{
; ' right virtual key is pressed
}

Possible values:
spyNoVirtualKeyMask =0
spyLeftShiftKeyMask =1
spyRightShiftKeyMask =2
spyLeftCtrlKeyMask =4
spyRightCtrlKeyMask =8
spyLeftAltKeyMask = 16
spyRightAltKeyMask = 32
spyShiftKeyMask =3 // spyLeftShiftKeyMask | spyRightShiftKeyMask
spyCtrlKeyMask = 12 // spyLeftCtrlKeyMask | spyRightCtrlKeyMask
spyAltKeyMask = 48 // spyLeftAltKeyMask | spyRightAltKeyMask

4.5.40 SPYXMLDataKind
Description
The different types of XMLData elements available for XML documents.

Possible values:

spyXMLDataXMLDocStruct =0
spyXMLDataXMLEntityDocStruct =1
spyXMLDataDTDDocStruct =2
spyXMLDataXML =3
spyXMLDataElement =4
spyXMLDataAttr =5
spyXMLDataText =6
spyXMLDataCData =7
spyXMLDataComment =8
spyXMLDataPI =9
spyXMLDataDefDoctype = 10
spyXMLDataDefExternalID = 11
spyXMLDataDefElement = 12
spyXMLDataDefAttlist = 13

© 2010 Altova GmbH Programmers' Reference


1184 The XMLSpy API Enumerations

spyXMLDataDefEntity = 14
spyXMLDataDefNotation = 15
spyXMLDataKindsCount = 16

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java 1185

5 Using the XMLSpy API with Java


The XMLSpy API has an interface built up of Java classes, each of which corresponds to an
object in the XMLSpy API. Developers can use these Java classes to interact with the COM
API. These classes are listed below and described in subsequent sections. For a description of
the XMLSpy API objects themselves, see the XMLSpy API documentation. Bear in mind that
some API features are only available in scripting environments; these have therefore not been
ported to Java.

Java classes
SpyApplication
SpyProject
SpyProjectItems
SpyProjectItem
SpyDocuments
SpyDoc
SpyAuthenticView
SpyAuthenticRange
SpyDocEditView
SpyDocEditSelection
SpyGridView
SpyTextView
SpyXMLData
SpyDialogs
SpyCodeGeneratorDlg
SpyDTDSchemaGeneratorDlg
SpyFileSelectionDlg
SpyFindInFilesDlg
SpyGenerateSampleXMLDlg
SpySchemaDocumentationDlg
SpyWSDL20DocumentationDlg
SpyWSDLDocumentationDlg
SpyXBRLDocumentationDlg
SpyDatabaseConnection
SpyElementList
SpyElementListItem
SpyExportSettings
SpyFindInFilesResults
SpyFindInFilesResult
SpyFindInFilesMatch
SpyTextImportExportSettings

Implementation of COM properties in Java


Properties in Java have been defined to include both a set and get method (set if it is allowed
by the COM implementation). For example, the COM class Document contains the GridView
property. In Java the method is called SpyDoc and the property is defined as a GetGridView
method.

If you encounter compiling problems, please check the following points:


 The xmlspylib.dll must be available in ..\windows\system32.
 The XMLSpyInterface.jar file must be inserted in the ClassPath environment
variable.

Setting the ClassPath variable in Windows XP

© 2010 Altova GmbH Programmers' Reference


1186 Using the XMLSpy API with Java

1. Click Start | Settings | Control panel | System | Advanced | Environment Variables.


This opens the Environment Variables dialog box.
2. If a ClassPath entry already exists in the System variables group, select the
ClassPath entry, and click the Edit button. Edit the path to: "C:\Program
Files\Altova\xmlspy\XMLSpyInterface.jar".

If a ClassPath entry does not exist in the System variables group, click the New
button. The New System Variable dialog pops up. Enter CLASSPATH as the variable
name, and "C:\Program Files\Altova\xmlspy\XMLSpyInterface.jar" as
the ClassPath variable (alter the path to match your installation, if necessary).

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java Sample source code 1187

5.1 Sample source code


The "SpyDoc doc = app.GetDocuments().OpenFile(...)" command parameter must
be altered to suit your environment.

What the sample does:


 Starts a new XMLSPY instance
 Opens the Datasheet.xml file (alter the path here...)
 Switches to the Enhanced Grid view
 Appends a new child element called "NewChild" with the text value "NewValuE"
element to the root element
 Checks if the document is valid and outputs a message to the Java console
 Quits and releases the XMLSPY application

import XMLSpyInterface.*;

public class TestSpyInterface


{
public TestSpyInterface() {}

public static void main(String[] args)


{
SpyApplication app = null;
SpyDoc oDoc = null;
SpyXMLData oData = null;
SpyXMLData oNewChild = null;

try
{
app = new SpyApplication();
app.ShowApplication( true );

oDoc = app.GetDocuments().OpenFile("C:\\FilePath\\OrgChart.xml",
true );

// OrgChart.xml is in the folder C:\Documents and


Settings\<username>\My Documents\Altova\XMLSpy2011\. The filepath
should be in
// the form: C:\\Documents and
Settings\\Username\\Folder\\Filename.xml

if ( oDoc != null )
{
oDoc.SwitchViewMode(SPYViewModes.spyViewGrid);
oData = oDoc.GetRootElement();
oNewChild = oDoc.CreateChild(SPYXMLDataKind.spyXMLDataElement);

oNewChild.SetName( "NewChild" );
oNewChild.SetTextValue("newVaLuE");
oData.AppendChild(oNewChild);

if ( oDoc.IsValid() == false )
{
// is to be expected after above insertion
System.out.println( "!!!!!!validation error: " +
oDoc.GetErrorString() );
System.out.println( "!!!!!!validation error: " +
oDoc.GetErrorPos() );
System.out.println( "!!!!!!validation error: " +
oDoc.GetBadData() );
}

© 2010 Altova GmbH Programmers' Reference


1188 Using the XMLSpy API with Java Sample source code

app.Quit();
}
finally
{
// Free any allocated resources by calling ReleaseInstance().
if ( oNewChild != null )
oNewChild.ReleaseInstance();

if ( oData != null )
oData.ReleaseInstance();

if ( oDoc != null )
oDoc.ReleaseInstance();

if ( app != null )
app.ReleaseInstance();
}
}
}

If you have difficulties compiling this sample, please try the following commands on the (Start |
Run | cmd) command line. Please make sure you are currently in the folder that contains the
sample java file.

compilation
javac -classpath c:\yourpathhere\XMLSpyInterface.jar testspyinterface.java

Execution
java -classpath c:\yourpathhere\XMLSpyInterface.jar testspyinterface

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java SpyApplication 1189

5.2 SpyApplication
public class SpyApplication
{
public void ReleaseInstance();
public void ShowApplication( boolean bShow );
public void Quit();
public void AddMacroMenuItem( String sMacro, String sDisplayText );
public void ClearMacroMenu();
public SpyDoc GetActiveDocument();
public SpyProject GetCurrentProject();
public SpyDocuments GetDocuments();
public SpyElementList GetDatabaseImportElementList( SpyDatabaseConnection
oImportSettings );
public SpyDatabaseConnection GetDatabaseSettings();
public SpyElementList GetDatabaseTables( SpyDatabaseConnection
oImportSettings );
public SpyExportSettings GetExportSettings();
public SpyElementList GetTextImportElementList( SpyTextImportExportSettings
oImportSettings );
public SpyTextImportExportSettings GetTextImportExportSettings();
public SpyDoc ImportFromDatabase( SpyDatabaseConnection oImportSettings,
SpyElementList oElementList );
public SpyDoc ImportFromSchema( SpyDatabaseConnection oImportSettings,
String strTable, SpyDoc oSchemaDoc );
public SpyDoc ImportFromText( SpyTextImportExportSettings oImportSettings,
SpyElementList oElementList );
public SpyDoc ImportFromWord( String sFile );
public void NewProject( String sPath, boolean bDiscardCurrent );
public void OpenProject(String sPath , boolean bDiscardCurrent, boolean
bDialog );
public long ShowForm( String sName );
public void URLDelete( String sURL, String sUser, String sPassword );
public void URLMakeDirectory( String sURL, String sUser, String sPassword );

public int GetWarningNumber();


public String GetWarningText();

// since Version 2004R4


public SpyApplication GetApplication();
public SpyApplication GetParent();
public SpyDialogs GetDialogs();
public boolean GetVisible();
public void SetVisible( boolean i_bVisibility );
public long GetWindowHandle();

public void ReloadSettings();


public SpyFindInFilesResults FindInFiles( SpyFindInFilesDlg dlgSettings );
public boolean ShowFindInFiles( SpyFindInFilesDlg dlgSettings );
public void Selection( String sVal );

public long Status();


public int MajorVersion();
public int MinorVersion();
public String Edition();
public boolean IsAPISupported();
public long ServicePackVersion();
public void CreateXMLSchemaFromDBStructure( SpyDatabaseConnection
oConnection, SpyElementList oTables );
}

© 2010 Altova GmbH Programmers' Reference


1190 Using the XMLSpy API with Java SpyCodeGeneratorDlg

5.3 SpyCodeGeneratorDlg
Only available/enabled in the Enterprise edition. An error is returned, if accessed by any other
version.
// since version 2004R4
public class SpyCodeGeneratorDlg
{
public void ReleaseInstance();
public SpyApplication GetApplication();
public SpyDialogs GetParent();
public long GetProgrammingLanguage();
public void SetProgrammingLanguage( long i_eVal );
public String GetTemplateFileName();
public void SetTemplateFileName( String i_strVal );
public String GetOutputPath();
public void SetOutputPath( String i_strVal );
public long GetOutputPathDialogAction();
public void SetOutputPathDialogAction( long i_eVal );
public long GetPropertySheetDialogAction();
public void SetPropertySheetDialogAction( long i_eVal );
public long GetOutputResultDialogAction();
public void SetOutputResultDialogAction( long i_eVal );
public long GetCPPSettings_DOMType();
public void SetCPPSettings_DOMType( long i_eVal );
public long GetCPPSettings_LibraryType();
public void SetCPPSettings_LibraryType( long i_eVal );
public boolean GetCPPSettings_UseMFC();
public void SetCPPSettings_UseMFC( boolean i_bVal );
public long GetCSharpSettings_ProjectType();
public void SetCSharpSettings_ProjectType( long i_eVal );
}

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java SpyDatabaseConnection 1191

5.4 SpyDatabaseConnection
public class SpyDatabaseConnection
{
public void ReleaseInstance();
public String GetADOConnection();
public void SetADOConnection( String sValue );
public boolean GetAsAttributes();
public void SetAsAttributes( boolean bValue );
public boolean GetCreateMissingTables();
public void SetCreateMissingTables( boolean bValue );
public boolean GetCreateNew();
public void SetCreateNew( boolean bValue );
public boolean GetExcludeKeys();
public void SetExcludeKeys( boolean bValue );
public String GetFile();
public void SetFile( String sValue );
public boolean GetIncludeEmptyElements();
public void SetIncludeEmptyElements( boolean bValue );
public long GetNumberDateTimeFormat();
public void SetNumberDateTimeFormat( long nValue );
public String GetODBCConnection();
public void SetODBCConnection( String sValue );
public String GetSQLSelect();
public void SetSQLSelect( String sValue );
public long GetTextFieldLen();
public void SetTextFieldLen( long nValue );

// since version 2004R4


public long GetDatabaseKind();
public void SetDatabaseKind( long nValue );

// since version 2008R2


public boolean GetCommentIncluded();
public void SetCommentIncluded( boolean bValue );
public String GetNullReplacement();
public void SetNullReplacement( String sValue );
public String GetDatabaseSchema();
public void SetDatabaseSchema( String sValue );

// since version 2010r3


public boolean GetPrimaryKeys()
public void SetPrimaryKeys( boolean bValue )
public boolean GetForeignKeys()
public void SetForeignKeys( boolean bValue )
public boolean GetUniqueKeys()
public void SetUniqueKeys( boolean bValue )
public long GetSchemaExtensionType()
public void SetSchemaExtensionType( long nValue )
public long GetSchemaFormat()
public void SetSchemaFormat( long nValue )
public long GetImportColumnsType()
public void SetImportColumnsType( long nValue )
}

© 2010 Altova GmbH Programmers' Reference


1192 Using the XMLSpy API with Java SpyDialogs

5.5 SpyDialogs
// Since version 2004R4
public class SpyDialogs
{
public SpyApplication GetApplication();
public SpyApplication GetParent();
public SpyCodeGeneratorDlg GetCodeGeneratorDlg();
public SpyFileSelectionDlg GetFileSelectionDlg();
public SpySchemaDocumentationDlg GetSchemaDocumentationDlg();
public SpyGenerateSampleXMLDlg GetGenerateSampleXMLDlg();
public SpyDTDSchemaGeneratorDlg GetDTDSchemaGeneratorDlg();
public SpyFindInFilesDlg GetFindInFilesDlg();
public SpyWSDLDocumentationDlg GetWSDLDocumentationDlg();

// Since version 2010


public SpyWSDL20DocumentationDlg GetWSDL20DocumentationDlg();
public SpyXBRLDocumentationDlg GetXBRLDocumentationDlg();
}

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java SpyDoc 1193

5.6 SpyDoc
public class SpyDoc
{
public void ReleaseInstance();
public void SetEncoding( String strEncoding );
public void SetPathName( String strPath );
public String GetPathName();
public String GetTitle();
public boolean IsModified();
public void Save();
public void Close( boolean bDiscardChanges );
public void UpdateViews();
public long GetCurrentViewMode();
public boolean SwitchViewMode( long nMode );
public SpyGridView GetGridView();
public void SetActiveDocument();
public void StartChanges();
public void EndChanges();
public void TransformXSL();
public void AssignDTD( String sDTDFile, boolean bDialog );
public void AssignSchema( String sSchemaFile, boolean bDialog );
public void AssignXSL( String sXSLFile, boolean bDialog );
public void ConvertDTDOrSchema( long nFormat, long nFrequentElements );
public SpyXMLData CreateChild( long nKind );
public void CreateSchemaDiagram( long nKind, String sName, String sFile );
public SpyDocEditView GetDocEditView();
public void ExportToDatabase( SpyXMLData oFromChild, SpyExportSettings
oExportSettings, SpyDatabaseConnection oDatabaseConnection );
public void ExportToText( SpyXMLData oFromChild, SpyExportSettings
oExportSettings, SpyTextImportExportSettings oTextSettings );
public void GenerateDTDOrSchema( long nFormat, int nValuesList, long
nDetection, long nFrequentElements );
public SpyElementList GetExportElementList( SpyXMLData oFromChild,
SpyExportSettings oExportSettings );
public SpyXMLData GetRootElement();
public String SaveInString( SpyXMLData oData, boolean bMarked );
public void SaveToURL( String sUrl, String sUser, String sPassword );
public String GetErrorString(); // See IsValid() or IsWellFormed()
public int GetErrorPos(); // See IsValid() or IsWellFormed()
public SpyXMLData GetBadData(); // See IsValid() or IsWellFormed()
public boolean IsValid();
public boolean IsWellFormed( SpyXMLData oData, boolean bWithChildren );

// Since version 2004R3


public SpyAuthenticView GetAuthenticView()

// Since version 2004R4


public SpyApplication GetApplication();
public SpyDocuments GetParent();
public String GetFullName();
public void SetFullName( String i_strName );
public String GetName();
public String GetPath();
public boolean GetSaved();
public void SaveAs( String i_strFileNameOrPath );
public String GetEncoding();
public SpyXMLData GetDataRoot();
public void GenerateProgramCode( SpyCodeGeneratorDlg i_dlg );
public void AssignXSLFO( String i_strFile, boolean i_bUseDialog );
public void TransformXSLFO();

© 2010 Altova GmbH Programmers' Reference


1194 Using the XMLSpy API with Java SpyDoc

public void GenerateSchemaDocumentation( SpySchemaDocumentationDlg i_dlg );

public void ExecuteXQuery( String i_strXMLSourceFile );


public void SetExternalIsValid( boolean bIsValid );
public SpyDoc GenerateSampleXML( SpyGenerateSampleXMLDlg ipGenerateXMLDlg );
public boolean UpdateXMLData();
public String GetAsXMLString();
public void SetAsXMLString( String newVal );
public SpyDoc GenerateDTDOrSchemaEx( SpyDTDSchemaGeneratorDlg
ipDTDSchemaGeneratorDlg );
public SpyDoc ConvertDTDOrSchemaEx( long nFormat, long nFrequentElements,
String sOutputPath, long nOutputPathDialogAction );
public SpyTextView GetTextView();
public String[] GetSuggestions();
public void SetSuggestions( String[] aList );
public void SetSelection( String sVal );

// Since version 2009


public void GenerateWSDLDocumentation( SpyWSDLDocumentationDlg
ipWSDLDocumenationDlg );
public void TransformXSLEx( long nDialogAction );

// Since version 2010


public void GenerateWSDL20Documentation( SpyWSDL20DocumentationDlg
ipWSD20DocumenationDlg );
public void GenerateXBRLDocumentation( SpyXBRLDocumentationDlg
ipXBRLDocumentationDlg );
public SpyDoc ConvertToWSDL20( String sFilePath, boolean bShowDialogs );

// Since version 2010r3


public String CreateDBStructureFromXMLSchema( SpyDatabaseConnection
oConnection, SpyElementList oTables, boolean bDropTableWithExistingName );
public SpyElementList GetDBStructureList( SpyDatabaseConnection oConnection
);
}

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java SpyDocuments 1195

5.7 SpyDocuments
public class SpyDocuments
{
public void ReleaseInstance();
public long Count();
public SpyDoc GetItem( long nNo );
public SpyDoc NewFile( String strFile, String strType );
public SpyDoc NewFileFromText( String nSource, String strType );
public SpyDoc OpenFile( String sPath, boolean bDialog );
public SpyDoc OpenURL( String sUrl, long nURLType, long nLoading, String
sUser, String sPassword );
public SpyDoc OpenURLDialog(String sURL, long nURLType, long nLoading,
String sUser, String sPassword )
}

© 2010 Altova GmbH Programmers' Reference


1196 Using the XMLSpy API with Java SpyDTDSchemaGeneratorDlg

5.8 SpyDTDSchemaGeneratorDlg
public class SpyDTDSchemaGeneratorDlg
{
public void ReleaseInstance();
public SpyApplication GetApplication();
public long GetDTDSchemaFormat();
public void SetDTDSchemaFormat( long newVal );
public short GetValueList();
public void SetValueList( short newVal );
public long GetTypeDetection();
public void SetTypeDetection( long newVal );
public long GetFrequentElements();
public void SetFrequentElements( long newVal );
public boolean GetMergeAllEqualNamed();
public void SetMergeAllEqualNamed( boolean newVal );
public boolean GetResolveEntities();
public void SetResolveEntities( boolean newVal );
public long GetAttributeTypeDefinition();
public void SetAttributeTypeDefinition( long newVal );
public boolean GetGlobalAttributes();
public void SetGlobalAttributes( boolean newVal );
public boolean GetOnlyStringEnums();
public void SetOnlyStringEnums( boolean newVal );
public long GetMaxEnumLength();
public void SetMaxEnumLength( long newVal );
public String GetOutputPath();
public void SetOutputPath( String newVal );
public long GetOutputPathDialogAction();
public void SetOutputPathDialogAction( long newVal );
}

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java SpyElementList 1197

5.9 SpyElementList
public class SpyElementList
{
public void ReleaseInstance();
public long GetCount();
public SpyElementListItem GetItem( long nIndex );
public void RemoveElement( long nIndex );
}

© 2010 Altova GmbH Programmers' Reference


1198 Using the XMLSpy API with Java SpyElementListItem

5.10 SpyElementListItem
public class SpyElementListItem
{
public void ReleaseInstance();
public long GetElementKind();
public void SetElementKind( long nKind );
public long GetFieldCount();
public String GetName();
public long GetRecordCount();
}

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java SpyExportSettings 1199

5.11 SpyExportSettings
public class SpyExportSettings
{
public void ReleaseInstance();
public boolean GetCreateKeys();
public void SetCreateKeys( boolean bValue );
public SpyElementList GetElementList();
public void SetElementList( SpyElementList obj );
public boolean GetEntitiesToText ();
public void SetEntitiesToText( boolean bValue );
public boolean GetExportAllElements();
public void SetExportAllElements( boolean bValue );
public boolean GetFromAttributes();
public void SetFromAttributes( boolean bValue );
public boolean GetFromSingleSubElements();
public void SetFromSingleSubElements( boolean bValue );
public boolean GetFromTextValues();
public void SetFromTextValues( boolean bValue );
public boolean GetIndependentPrimaryKey();
public void SetIndependentPrimaryKey( boolean bValue );
public long GetNamespace();
public void SetNamespace( long nValue );
public int GetSubLevelLimit();
public void SetSubLevelLimit( int nValue );
}

© 2010 Altova GmbH Programmers' Reference


1200 Using the XMLSpy API with Java SpyFileSelectionDlg

5.12 SpyFileSelectionDlg
// Since version 2004R4
public class SpyFileSelectionDlg
{
public void ReleaseInstance();
public SpyApplication GetApplication();
public SpyDialogs GetParent();
public String GetFullName();
public void SetFullName( String i_strName );
public long GetDialogAction();
public void SetDialogAction( long i_eAction );
}

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java SpyFindInFilesDlg 1201

5.13 SpyFindInFilesDlg
public class SpyFindInFilesDlg
{
public void ReleaseInstance();
public SpyApplication GetApplication();
public String GetFind();
public void SetFind( String sNewVal );
public boolean GetRegularExpression();
public void SetRegularExpression( boolean bNewVal );
public String GetReplace();
public void SetReplace( String sNewVal );
public boolean GetReplaceOnDisk();
public void SetReplaceOnDisk( boolean bNewVal );
public boolean GetDoReplace();
public void SetDoReplace( boolean bNewVal );
public boolean GetMatchWholeWord();
public void SetMatchWholeWord( boolean bNewVal );
public boolean GetMatchCase();
public void SetMatchCase( boolean bNewVal );
public long GetSearchLocation();
public void SetSearchLocation( long nPosition );
public String GetStartFolder();
public void SetStartFolder( String sNewVal );
public boolean GetIncludeSubfolders();
public void SetIncludeSubfolders( boolean bNewVal );
public boolean GetSearchInProjectFilesDoExternal();
public void SetSearchInProjectFilesDoExternal( boolean bNewVal );
public String GetFileExtension();
public void SetFileExtension( String sNewVal );
public boolean GetAdvancedXMLSearch();
public void SetAdvancedXMLSearch( boolean bNewVal );
public boolean GetXMLElementNames();
public void SetXMLElementNames( boolean bNewVal );
public boolean GetXMLElementContents();
public void SetXMLElementContents( boolean bNewVal );
public boolean GetXMLAttributeNames();
public void SetXMLAttributeNames( boolean bNewVal );
public boolean GetXMLAttributeContents();
public void SetXMLAttributeContents( boolean bNewVal );
public boolean GetXMLComments();
public void SetXMLComments( boolean bNewVal );
public boolean GetXMLCData();
public void SetXMLCData( boolean bNewVal );
public boolean GetXMLPI();
public void SetXMLPI( boolean bNewVal );
public boolean GetXMLRest();
public void SetXMLRest( boolean bNewVal );
public boolean GetShowResult();
public void SetShowResult( boolean bNewVal );
}

© 2010 Altova GmbH Programmers' Reference


1202 Using the XMLSpy API with Java SpyFindInFilesMatch

5.14 SpyFindInFilesMatch
public class SpyFindInFilesMatch
{
public void ReleaseInstance();
public long Line();
public long Position();
public long Length();
public String LineText();
public boolean Replaced();
}

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java SpyFindInFilesResult 1203

5.15 SpyFindInFilesResult
public class SpyFindInFilesResult
{
public void ReleaseInstance();
public long Count();
public SpyFindInFilesMatch GetItem( long nNo );
public String GetPath();
public SpyDoc GetDocument();
}

© 2010 Altova GmbH Programmers' Reference


1204 Using the XMLSpy API with Java SpyFindInFilesResults

5.16 SpyFindInFilesResults
public class SpyFindInFilesResults
{
public void ReleaseInstance();
public long Count();
public SpyFindInFilesResult GetItem( long nNo );
}

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java SpyGenerateSampleXMLDlg 1205

5.17 SpyGenerateSampleXMLDlg
public class SpyGenerateSampleXMLDlg
{
public void ReleaseInstance();
public SpyApplication GetApplication();
public boolean GetNonMandatoryAttributes();
public void SetNonMandatoryAttributes( boolean newVal );
public boolean GetNonMandatoryElements();
public void SetNonMandatoryElements( boolean newVal );
public boolean GetTakeFirstChoice();
public void SetTakeFirstChoice( boolean newVal );
public long GetRepeatCount();
public void SetRepeatCount( long newVal );
public boolean GetFillWithSampleData();
public void SetFillWithSampleData( boolean newVal );
public boolean GetFillElementsWithSampleData();
public void SetFillElementsWithSampleData( boolean newVal );
public boolean GetFillAttributesWithSampleData();
public void SetFillAttributesWithSampleData( boolean newVal );
public boolean GetContentOfNillableElementsIsNonMandatory();
public void SetContentOfNillableElementsIsNonMandatory( boolean newVal );
public boolean GetTryToUseNonAbstractTypes();
public void SetTryToUseNonAbstractTypes( boolean newVal );
public long GetOptimization();
public void SetOptimization( long newVal );
public long GetSchemaOrDTDAssignment();
public void SetSchemaOrDTDAssignment( long newVal );
public String GetLocalNameOfRootElement();
public void SetLocalNameOfRootElement( String newVal );
public String GetNamespaceURIOfRootElement();
public void SetNamespaceURIOfRootElement( String newVal );
public long GetOptionsDialogAction();
public void SetOptionsDialogAction( long newVal );
}

© 2010 Altova GmbH Programmers' Reference


1206 Using the XMLSpy API with Java SpyGridView

5.18 SpyGridView
public class SpyGridView
{
public void ReleaseInstance();
public SpyXMLData GetCurrentFocus();
public void Deselect( SpyXMLData oData );
public boolean GetIsVisible();
public void Select( SpyXMLData oData );
public void SetFocus( SpyXMLData oData );
}

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java SpyProject 1207

5.19 SpyProject
public class SpyProject
{
public void ReleaseInstance();
public void CloseProject( boolean bDiscardChanges, boolean bCloseFiles,
boolean bDialog );
public String GetProjectFile();
public void SetProjectFile( String sFile );
public SpyProjectItems GetRootItems();
public void SaveProject();
public void SaveProjectAs( String sPath, boolean bDialog );
}

© 2010 Altova GmbH Programmers' Reference


1208 Using the XMLSpy API with Java SpyProjectItem

5.20 SpyProjectItem
public class SpyProjectItem
{
public void ReleaseInstance();
public SpyProjectItems GetChildItems();
public String GetFileExtensions();
public void SetFileExtensions( String sExtensions );
public long GetItemType();
public String GetName();
public SpyDoc Open();
public SpyProjectItem GetParentItem();
public String GetPath();
public String GetValidateWith();
public void SetValidateWith( String sVal );
public String GetXMLForXSLTransformation();
public void SetXMLForXSLTransformation( String sVal );
public String GetXSLForXMLTransformation();
public void SetXSLForXMLTransformation( String sVal );
public String GetXSLTransformationFileExtension();
public void SetXSLTransformationFileExtension( String sVal );
public String GetXSLTransformationFolder();
public void SetXSLTransformationFolder( String sVal );
}

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java SpyProjectItems 1209

5.21 SpyProjectItems
public class SpyProjectItems
{
public void ReleaseInstance();
public void AddFile( String sPath );
public void AddFolder( String sName );
public void AddURL( String sURL, long nURLType, String sUser, String
sPassword, boolean bSave );
public long Count();
public SpyProjectItem GetItem( long nNumber );
public void RemoveItem( SpyProjectItem oItemToRemove );
}

© 2010 Altova GmbH Programmers' Reference


1210 Using the XMLSpy API with Java SpySchemaDocumentationDlg

5.22 SpySchemaDocumentationDlg
// Since version 2004R4
public class SpySchemaDocumentationDlg
{
public void ReleaseInstance();
public SpyApplication GetApplication();
public SpyDialogs GetParent();

public String GetOutputFile();


public void SetOutputFile( String i_strVal );
public long GetOutputFormat();
public void SetOutputFormat( long i_eVal );

public boolean GetShowResult();


public void SetShowResult( boolean i_bVal );
public long GetOptionsDialogAction();
public void SetOptionsDialogAction( long i_eVal );
public long GetOutputFileDialogAction();
public void SetOutputFileDialogAction( long i_eVal );
public boolean GetShowProgressBar();
public void SetShowProgressBar( boolean i_bVal );

public void IncludeAll( boolean i_bInclude );


public boolean GetIncludeIndex();
public void SetIncludeIndex( boolean i_bVal );
public boolean GetIncludeGlobalElements();
public void SetIncludeGlobalElements( boolean i_bVal );
public boolean GetIncludeLocalElements();
public void SetIncludeLocalElements( boolean i_bVal );
public boolean GetIncludeGroups();
public void SetIncludeGroups( boolean i_bVal );
public boolean GetIncludeComplexTypes();
public void SetIncludeComplexTypes( boolean i_bVal );
public boolean GetIncludeSimpleTypes();
public void SetIncludeSimpleTypes( boolean i_bVal );
public boolean GetIncludeAttributeGroups();
public void SetIncludeAttributeGroups( boolean i_bVal );
public boolean GetIncludeRedefines();
public void SetIncludeRedefines( boolean i_bVal );

public void AllDetails( boolean i_bDetailsOn );


public boolean GetShowDiagram();
public void SetShowDiagram( boolean i_bVal );
public boolean GetShowNamespace();
public void SetShowNamespace( boolean i_bVal );
public boolean GetShowType();
public void SetShowType( boolean i_bVal );
public boolean GetShowChildren();
public void SetShowChildren( boolean i_bVal );
public boolean GetShowUsedBy();
public void SetShowUsedBy( boolean i_bVal );
public boolean GetShowProperties();
public void SetShowProperties( boolean i_bVal );
public boolean GetShowSingleFacets();
public void SetShowSingleFacets( boolean i_bVal );
public boolean GetShowPatterns();
public void SetShowPatterns( boolean i_bVal );
public boolean GetShowEnumerations();
public void SetShowEnumerations( boolean i_bVal );
public boolean GetShowAttributes();

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java SpySchemaDocumentationDlg 1211

public void SetShowAttributes( boolean i_bVal );


public boolean GetShowIdentityConstraints();
public void SetShowIdentityConstraints( boolean i_bVal );
public boolean GetShowAnnotations();
public void SetShowAnnotations( boolean i_bVal );
public boolean GetShowSourceCode();
public void SetShowSourceCode( boolean i_bVal );

// Since version 2009


public boolean GetEmbedDiagrams();
public void SetEmbedDiagrams( boolean i_bVal );
public long GetDiagramFormat();
public void SetDiagramFormat( long i_nVal );
public boolean GetIncludeGlobalAttributes();
public void SetIncludeGlobalAttributes( boolean i_bVal );
public boolean GetIncludeLocalAttributes();
public void SetIncludeLocalAttributes( boolean i_bVal );
public boolean GetIncludeReferencedSchemas();
public void SetIncludeReferencedSchemas( boolean i_bVal );
public boolean GetMultipleOutputFiles();
public void SetMultipleOutputFiles( boolean i_bVal );

// Since version 2010


public boolean GetEmbedCSSInHTML();
public void SetEmbedCSSInHTML( boolean i_bVal );
public boolean GetCreateDiagramsFolder();
public void SetCreateDiagramsFolder( boolean i_bVal );

// Since version 2010r3


public boolean GetGenerateRelativeLinks();
public void SetGenerateRelativeLinks( boolean i_bVal );
}

© 2010 Altova GmbH Programmers' Reference


1212 Using the XMLSpy API with Java SpyTextImportExportSettings

5.23 SpyTextImportExportSettings
public class SpyTextImportExportSettings
{
public void ReleaseInstance();
public String GetDestinationFolder();
public void SetDestinationFolder( String sVal );
public long GetEnclosingCharacter();
public void SetEnclosingCharacter( long nEnclosing );
public String GetEncoding();
public void SetEncoding( String sVal );
public long GetEncodingByteOrder();
public void SetEncodingByteOrder( long nByteOrder );
public long GetFieldDelimiter();
public void SetFieldDelimiter( long nDelimiter );
public String GetFileExtension ();
public void SetFileExtension( String sVal );
public boolean GetHeaderRow();
public void SetHeaderRow( boolean bVal );
public String GetImportFile();
public void SetImportFile( String sVal );
}

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java SpyTextView 1213

5.24 SpyTextView
public class SpyTextView
{
public void ReleaseInstance();
public SpyApplication GetApplication();
public SpyDoc GetParent();
public long LineFromPosition( long nCharPos );
public long PositionFromLine( long nLine );
public long LineLength( long nLine );
public String GetSelText();
public void SetSelText( String sText );
public String GetRangeText( long nPosFrom, long nPosTill );
public void ReplaceText( long nPosFrom, long nPosTill, String sText );
public void MoveCaret( long nDiff );
public void GoToLineChar( long nLine, long nChar );
public void SelectText( long nPosFrom, long nPosTill );
public long GetSelectionStart();
public void SetSelectionStart( long nNewVal );
public long GetSelectionEnd();
public void SetSelectionEnd( long nNewVal );
public String GetText();
public void SetText( String sText );
public long LineCount();
public long Length();
}

© 2010 Altova GmbH Programmers' Reference


1214 Using the XMLSpy API with Java SpyWSDL20DocumentationDlg

5.25 SpyWSDL20DocumentationDlg

// Since version 2010


public class SpyWSDL20DocumentationDlg
{
public void ReleaseInstance();
public SpyApplication GetApplication();

public long GetOptionsDialogAction();


public void SetOptionsDialogAction( long nNewVal );

public long GetOutputFileDialogAction();


public void SetOutputFileDialogAction( long nNewVal );

public boolean GetShowProgressBar();


public void SetShowProgressBar( boolean bNewVal );

public String GetOutputFile();


public void SetOutputFile( String sNewVal );

public long GetOutputFormat();


public void SetOutputFormat( long nNewVal );

public boolean GetMultipleOutputFiles();


public void SetMultipleOutputFiles( boolean bNewVal );

public boolean GetEmbedCSSInHTML();


public void SetEmbedCSSInHTML( boolean bNewVal );

public long GetDiagramFormat();


public void SetDiagramFormat( long nNewVal );

public boolean GetEmbedDiagrams();


public void SetEmbedDiagrams( boolean bNewVal );

public boolean GetCreateDiagramsFolder();


public void SetCreateDiagramsFolder( boolean bNewVal );

public boolean GetShowResult();


public void SetShowResult( boolean bNewVal );

public void IncludeAll( boolean bNewVal );


public void AllDetails( boolean bNewVal );

public boolean GetIncludeOverview();


public void SetIncludeOverview( boolean bNewVal );

public boolean GetIncludeService();


public void SetIncludeService( boolean bNewVal );

public boolean GetIncludeBinding();


public void SetIncludeBinding( boolean bNewVal );

public boolean GetIncludeInterface();


public void SetIncludeInterface( boolean bNewVal );

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java SpyWSDL20DocumentationDlg 1215

public boolean GetIncludeTypes();


public void SetIncludeTypes( boolean bNewVal );

public boolean GetIncludeImportedWSDLFiles();


public void SetIncludeImportedWSDLFiles( boolean bNewVal );

public boolean GetShowServiceDiagram();


public void SetShowServiceDiagram( boolean bNewVal );

public boolean GetShowBindingDiagram();


public void SetShowBindingDiagram( boolean bNewVal );

public boolean GetShowInterfaceDiagram();


public void SetShowInterfaceDiagram( boolean bNewVal );

public boolean GetShowTypesDiagram();


public void SetShowTypesDiagram( boolean bNewVal );

public boolean GetShowEndpoint();


public void SetShowEndpoint( boolean bNewVal );

public boolean GetShowSourceCode();


public void SetShowSourceCode( boolean bNewVal );

public boolean GetShowExtensibility();


public void SetShowExtensibility( boolean bNewVal );

public boolean GetShowUsedBy();


public void SetShowUsedBy( boolean bNewVal );

public boolean GetShowOperation();


public void SetShowOperation( boolean bNewVal );

public boolean GetShowFault();


public void SetShowFault( boolean bNewVal );
}

© 2010 Altova GmbH Programmers' Reference


1216 Using the XMLSpy API with Java SpyWSDLDocumentationDlg

5.26 SpyWSDLDocumentationDlg
// Since version 2008r2sp1
public class SpyWSDLDocumentationDlg
{
public void ReleaseInstance();
public SpyApplication GetApplication();

public String GetOutputFile();


public void SetOutputFile( String sNewVal );

public long GetOutputFileDialogAction();


public void SetOutputFileDialogAction( long nNewVal );

public long GetOptionsDialogAction();


public void SetOptionsDialogAction( long nNewVal );

public boolean GetShowProgressBar();


public void SetShowProgressBar( boolean bNewVal );

public boolean GetShowResult();


public void SetShowResult( boolean bNewVal );

public long GetOutputFormat();


public void SetOutputFormat( long nNewVal );

public boolean GetEmbedDiagrams();


public void SetEmbedDiagrams( boolean bNewVal );

public long GetDiagramFormat();


public void SetDiagramFormat( long nNewVal );

public boolean GetMultipleOutputFiles();


public void SetMultipleOutputFiles( boolean bNewVal );

public void IncludeAll( boolean bNewVal );

public boolean GetIncludeBinding();


public void SetIncludeBinding( boolean bNewVal );

public boolean GetIncludeImportedWSDLFiles();


public void SetIncludeImportedWSDLFiles( boolean bNewVal );

public boolean GetIncludeMessages();


public void SetIncludeMessages( boolean bNewVal );

public boolean GetIncludeOverview();


public void SetIncludeOverview( boolean bNewVal );

public boolean GetIncludePortType();


public void SetIncludePortType( boolean bNewVal );

public boolean GetIncludeService();


public void SetIncludeService( boolean bNewVal );

public boolean GetIncludeTypes();


public void SetIncludeTypes( boolean bNewVal );

public void AllDetails( boolean bNewVal );

public boolean GetShowBindingDiagram();


public void SetShowBindingDiagram( boolean bNewVal );

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java SpyWSDLDocumentationDlg 1217

public boolean GetShowExtensibility();


public void SetShowExtensibility( boolean bNewVal );

public boolean GetShowMessageParts();


public void SetShowMessageParts( boolean bNewVal );

public boolean GetShowPort();


public void SetShowPort( boolean bNewVal );

public boolean GetShowPortTypeDiagram();


public void SetShowPortTypeDiagram( boolean bNewVal );

public boolean GetShowPortTypeOperations();


public void SetShowPortTypeOperations( boolean bNewVal );

public boolean GetShowServiceDiagram();


public void SetShowServiceDiagram( boolean bNewVal );

public boolean GetShowSourceCode();


public void SetShowSourceCode( boolean bNewVal );

public boolean GetShowTypesDiagram();


public void SetShowTypesDiagram( boolean bNewVal );

public boolean GetShowUsedBy();


public void SetShowUsedBy( boolean bNewVal );

// Since version 2010


public boolean GetEmbedCSSInHTML();
public void SetEmbedCSSInHTML( boolean i_bVal );

public boolean GetCreateDiagramsFolder();


public void SetCreateDiagramsFolder( boolean i_bVal );
}

© 2010 Altova GmbH Programmers' Reference


1218 Using the XMLSpy API with Java SpyXBRLDocumentationDlg

5.27 SpyXBRLDocumentationDlg

// Since version 2010


public class SpyXBRLDocumentationDlg
{
public void ReleaseInstance();
public SpyApplication GetApplication();

public long GetOptionsDialogAction();


public void SetOptionsDialogAction( long nNewVal );

public long GetOutputDialogAction();


public void SetOutputDialogAction( long nNewVal );

public boolean GetShowProgressBar();


public void SetShowProgressBar( boolean bNewVal );

public String GetOutputFile();


public void SetOutputFile( String sNewVal );

public long GetOutputFormat();


public void SetOutputFormat( long nNewVal );

public boolean GetEmbedCSSInHTML();


public void SetEmbedCSSInHTML( boolean bNewVal );

public long GetDiagramFormat();


public void SetDiagramFormat( long nNewVal );

public boolean GetEmbedDiagrams();


public void SetEmbedDiagrams( boolean bNewVal );

public boolean GetCreateDiagramsFolder();


public void SetCreateDiagramsFolder( boolean bNewVal );

public boolean GetShowResult();


public void SetShowResult( boolean bNewVal );

public void IncludeAll( boolean bNewVal );


public void AllDetails( boolean bNewVal );

public boolean GetIncludeOverview();


public void SetIncludeOverview( boolean bNewVal );

public boolean GetIncludeNamespacePrefixes();


public void SetIncludeNamespacePrefixes( boolean bNewVal );

public boolean GetIncludeGlobalElements();


public void SetIncludeGlobalElements( boolean bNewVal );

public boolean GetIncludeDefinitionLinkroles();


public void SetIncludeDefinitionLinkroles( boolean bNewVal );

public boolean GetIncludePresentationLinkroles();


public void SetIncludePresentationLinkroles( boolean bNewVal );

public boolean GetIncludeCalculationLinkroles();

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java SpyXBRLDocumentationDlg 1219

public void SetIncludeCalculationLinkroles( boolean bNewVal );

public boolean GetShowDiagram();


public void SetShowDiagram( boolean bNewVal );

public boolean GetShowSubstitutiongroup();


public void SetShowSubstitutiongroup( boolean bNewVal );

public boolean GetShowItemtype();


public void SetShowItemtype( boolean bNewVal );

public boolean GetShowBalance();


public void SetShowBalance( boolean bNewVal );

public boolean GetShowPeriod();


public void SetShowPeriod( boolean bNewVal );

public boolean GetShowAbstract();


public void SetShowAbstract( boolean bNewVal );

public boolean GetShowNillable();


public void SetShowNillable( boolean bNewVal );

public boolean GetShowLabels();


public void SetShowLabels( boolean bNewVal );

public boolean GetShowReferences();


public void SetShowReferences( boolean bNewVal );

public boolean GetShowLinkbaseReferences();


public void SetShowLinkbaseReferences( boolean bNewVal );

public boolean GetShortQualifiedName();


public void SetShortQualifiedName( boolean bNewVal );

public boolean GetShowImportedElements();


public void SetShowImportedElements( boolean bNewVal );
};

© 2010 Altova GmbH Programmers' Reference


1220 Using the XMLSpy API with Java SpyXMLData

5.28 SpyXMLData
public class SpyXMLData
{
public void ReleaseInstance();
public void AppendChild( SpyXMLData oNewData );
public void EraseAllChildren();
public void EraseCurrentChild();
public SpyXMLData GetCurrentChild();
public SpyXMLData GetFirstChild( long nKind );
public SpyXMLData GetNextChild();
public boolean GetHasChildren();
public void InsertChild( SpyXMLData oNewData );
public boolean IsSameNode( SpyXMLData oToComp);
public long GetKind();
public boolean GetMayHaveChildren();
public String GetName();
public void SetName( String sValue );
public SpyXMLData GetParent();
public String GetTextValue();
public void SetTextValue( String sValue );
}

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java Authentic 1221

5.29 Authentic

5.29.1 SpyAuthenticRange

// Since version 2004R3


public class SpyAuthenticRange
{
public void ReleaseInstance();
public SpyApplication GetApplication();
public SpyAuthenticView GetParent();
public SpyAuthenticRange GotoNext( long eKind );
public SpyAuthenticRange GotoPrevious( long eKind );
public void Select();
public long GetFirstTextPosition();
public void SetFirstTextPosition( long nTextPosition );
public long GetLastTextPosition();
public void SetLastTextPosition( long nTextPosition );
public String GetText();
public void SetText( String strText );
public boolean PerformAction( long eAction, String strElementName );
public boolean CanPerformAction( long eAction, String strElementName );
public String[] CanPerformActionWith( long eAction );
public SpyAuthenticRange GoTo( long eKind, long nCount, long nFrom );
public SpyAuthenticRange SelectNext( long eKind );
public SpyAuthenticRange SelectPrevious( long eKind );
public SpyAuthenticRange MoveBegin( long eKind, long nCount );
public SpyAuthenticRange MoveEnd( long eKind, long nCount );
public SpyAuthenticRange ExpandTo( long eKind );
public SpyAuthenticRange CollapsToBegin();
public SpyAuthenticRange CollapsToEnd();
public SpyAuthenticRange GotoNextCursorPosition();
public SpyAuthenticRange GotoPreviousCursorPosition();
public boolean IsEmpty();
public boolean IsEqual( SpyAuthenticRange ipCmp );
public SpyAuthenticRange Clone();
public SpyAuthenticRange SetFromRange( SpyAuthenticRange ipSrc );
public boolean Delete();
public boolean Cut();
public boolean Copy();
public boolean Paste();
public SpyXMLData GetFirstXMLData();
public void SetFirstXMLData( SpyXMLData objXMLDataPtr );
public long GetFirstXMLDataOffset();
public void SetFirstXMLDataOffset( long nOffset );
public SpyXMLData GetLastXMLData();
public void SetLastXMLData( SpyXMLData objXMLDataPtr );
public long GetLastXMLDataOffset();
public void SetLastXMLDataOffset( long nOffset );
public String[] GetElementHierarchy();
public String[] GetElementAttributeNames( String strElementName );
public boolean HasElementAttribute( String strElementName, String
strAttributeName );
public String GetElementAttributeValue( String strElementName, String
strAttributeName );
public void SetElementAttributeValue( String strElementName, String
strAttributeName, String strNewValue );
public String[] GetEntityNames();
public void InsertEntity( String strEntityName );
public boolean IsInDynamicTable();
public boolean AppendRow();
public boolean InsertRow();

© 2010 Altova GmbH Programmers' Reference


1222 Using the XMLSpy API with Java Authentic

public boolean DuplicateRow();


public boolean DeleteRow();
public boolean MoveRowUp();
public boolean MoveRowDown();

// Since version 2004R4


public boolean IsCopyEnabled();
public boolean IsCutEnabled();
public boolean IsPasteEnabled();
public boolean IsDeleteEnabled();
public boolean IsTextStateApplied( String i_strElementName );
public boolean IsFirstRow();
public boolean IsLastRow();
}

5.29.2 SpyAuthenticView

// Since version 2004R3


public class SpyAuthenticView
{
public void ReleaseInstance();
public SpyApplication GetApplication();
public SpyDoc GetParent();
public SpyAuthenticRange GetSelection();
public void SetSelection( SpyAuthenticRange obj );
public SpyAuthenticRange GetDocumentBegin();
public SpyAuthenticRange GetDocumentEnd();
public SpyAuthenticRange GetWholeDocument();
public long GetMarkupVisibility();
public void SetMarkupVisibility( long eSpyAuthenticMarkupVisibility );
public SpyAuthenticRange GoTo( long eKind, long nCount, long nFrom );
public void Print( boolean bWithPreview, boolean bPromptUser );
public boolean Undo();
public boolean Redo();
public void UpdateXMLInstanceEntities();

// Since version 2004R4


public String GetAsXMLString();
public void SetAsXMLString( String i_strXML );
public SpyXMLData GetXMLDataRoot();
public boolean IsUndoEnabled();
public boolean IsRedoEnabled();
}

5.29.3 SpyDocEditSelection

public class SpyDocEditSelection


{
public void ReleaseInstance();
public SpyXMLData GetEnd();
public long GetEndTextPosition();
public SpyXMLData GetStart();
public long GetStartTextPosition();
}

5.29.4 SpyDocEditView

public class SpyDocEditView


{

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java Authentic 1223

public void ReleaseInstance();


public void ApplyTextState( String sElementName );
public SpyDocEditSelection GetCurrentSelection();
public void EditClear();
public void EditCopy();
public void EditCut();
public void EditPaste();
public void EditRedo();
public void EditSelectAll();
public void EditUndo();
public SpyXMLData GetNextVisible( SpyXMLData oElement );
public SpyXMLData GetPreviousVisible( SpyXMLData oElement );
public boolean GetIsEditClearEnabled();
public boolean GetIsEditCopyEnabled();
public boolean GetIsEditCutEnabled();
public boolean GetIsEditPasteEnabled();
public boolean GetIsEditRedoEnabled();
public boolean GetIsEditUndoEnabled();
public boolean GetIsRowAppendEnabled();
public boolean GetIsRowDeleteEnabled();
public boolean GetIsRowDuplicateEnabled();
public boolean GetIsRowInsertEnabled();
public boolean GetIsRowMoveDownEnabled();
public boolean GetIsRowMoveUpEnabled();
public boolean IsTextStateApplied( String sElementName );
public boolean IsTextStateEnabled( String sElementName );
public void LoadXML( String sXML );
public void MarkUpView( long nKind );
public void RowAppend();
public void RowDelete();
public void RowDuplicate();
public void RowInsert();
public void RowMoveDown();
public void RowMoveUp();
public String SaveXML();
public void SelectionMoveTabOrder( boolean bForward, boolean bTag );
public boolean SelectionSet( SpyXMLData oStart, long nStartPos, SpyXMLData
oEndElement, long nEndPos );
public SpyXMLData GetXMLRoot();
public String[] GetAllowedElements( long nAction, SpyXMLData oStartPtr,
SpyXMLData oEndPtr );
}

© 2010 Altova GmbH Programmers' Reference


1224 Using the XMLSpy API with Java Predefined constants

5.30 Predefined constants


This section lists all classes that define the predefined constants used by the Java interface.

5.30.1 SPYApplicationStatus
public class SPYApplicationStatus
{
public final static long spyApplicationStatus_Running = 0;
public final static long = 1;
spyApplicationStatus_AfterLicenseCheck
public final static long = 2;
spyApplicationStatus_BeforeLicenseCheck
public final static long = 3;
spyApplicationStatus_ConcurrentLicenseCheckFailed
public final static long = 4;
spyApplicationStatus_ProcessingCommandLine
}

5.30.2 SPYAttributeTypeDefinition

public class SPYAttributeTypeDefinition


{
public final static long = 0;
spyMergedGlobal
public final static long = 1;
spyDistinctGlobal
public final static long spyLocal = 2;
}

5.30.3 SPYAuthenticActions

public class SPYAuthenticActions


{
public final static long = 0;
spyAuthenticInsertAt
public final static long spyAuthenticApply= 1;
public final static long = 2;
spyAuthenticClearSurr
public final static long = 3;
spyAuthenticAppend
public final static long = 4;
spyAuthenticInsertBefore
public final static long = 5;
spyAuthenticRemove
}

5.30.4 SPYAuthenticDocumentPosition

public class SPYAuthenticDocumentPosition


{
public final static long = 0;
spyAuthenticDocumentBegin

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java Predefined constants 1225

public final static long = 1;


spyAuthenticDocumentEnd
public final static long = 2;
spyAuthenticRangeBegin
public final static long = 3;
spyAuthenticRangeEnd
}

5.30.5 SPYAuthenticElementKind

public class SPYAuthenticElementKind


{
public final static long = 0;
spyAuthenticChar
public final static long = 1;
spyAuthenticWord
public final static long = 3;
spyAuthenticLine
public final static long = 4;
spyAuthenticParagraph
public final static long = 6;
spyAuthenticTag
public final static long = 8;
spyAuthenticDocument
public final static long = 9;
spyAuthenticTable
public final static long = 10;
spyAuthenticTableRow
public final static long = 11;
spyAuthenticTableColumn
}

5.30.6 SPYAuthenticMarkupVisibility

public class SPYAuthenticMarkupVisibility


{
public final static long = 0;
spyAuthenticMarkupHidden
public final static long = 1;
spyAuthenticMarkupSmall
public final static long = 2;
spyAuthenticMarkupLarge
public final static long = 3;
spyAuthenticMarkupMixed
}

5.30.7 SPYDatabaseKind
public class SPYLoading
{
public final static long = 0;
spyDB_Access
public final static long = 1;
spyDB_SQLServer

© 2010 Altova GmbH Programmers' Reference


1226 Using the XMLSpy API with Java Predefined constants

public final static long = 2;


spyDB_Oracle
public final static long = 3;
spyDB_Sybase
public final static long = 4;
spyDB_MySQL
public final static long spyDB_DB2 = 5;
public final static long = 6;
spyDB_Other
public final static long = 7;
spyDB_Unspecified
}

5.30.8 SPYDialogAction
public class SPYDialogAction
{
public final static long = 0;
spyDialogOK
public final static long = 1;
spyDialogCancel
public final static long = 2;
spyDialogUserInput
}

5.30.9 SPYDOMType
public class SPYDOMType
{
public final static long = 0;
spyDOMType_msxml4
public final static long = 1;
spyDOMType_xerces
}

5.30.10 SPYDTDSchemaFormat

public class SPYDTDSchemaFormat


{
public final static long spyDTD = 0;
public final static long spyDCD = 1;
public final static long spyXMLData = 2;
public final static long spyBizTalk = 3;
public final static long spyW3C = 4;
}

5.30.11 SPYEncodingByteOrder

public class SPYEncodingByteOrder


{
public final static long spyNONE = 0;
public final static long = 1;
spyLITTLE_ENDIAN

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java Predefined constants 1227

public final static long = 2;


spyBIG_ENDIAN
}

5.30.12 SPYExportNamespace

public class SPYExportNamespace


{
public final static long spyNoNamespace = 0;
public final static long spyReplaceColonWithUnderscore = 1;
}

5.30.13 SPYFindInFilesSearchLocation

public class SPYFindInFilesSearchLocation


{
public final static long = 0;
spyFindInFiles_Documents
public final static long = 1;
spyFindInFiles_Project
public final static long = 2;
spyFindInFiles_Folder
}

5.30.14 SPYFrequentElements

public class SPYFrequentElements


{
public final static long = 0;
spyGlobalElements
public final static long = 1;
spyGlobalComplexType
}

5.30.15 SPYImageKind
public class SPYImageKind
{
public final static long = 0;
spyImageType_PNG
public final static long = 1;
spyImageType_EMF
}

5.30.16 SPYImportColumnsType
Enter topic text here.

5.30.17 SPYLibType
public class SPYLibType
{
public final static long = 0;
spyLibType_static

© 2010 Altova GmbH Programmers' Reference


1228 Using the XMLSpy API with Java Predefined constants

public final static long = 1;


spyLibType_dll
}

5.30.18 SPYLoading

public class SPYLoading


{
public final static long = 0;
spyUseCacheProxy
public final static long = 1;
spyReload
}

5.30.19 SPYNumberDateTimeFormat

public class SPYNumberDateTimeFormat


{
public final static long = 0;
spySystemLocale
public final static long = 1;
spySchemaCompatible
}

5.30.20 SPYProgrammingLanguage
public class SPYLoading
{
public final static long spyUndefinedLanguage = -1;
public final static long spyJava = 0;
public final static long spyCpp = 1;
public final static long spyCSharp = 2;
}

5.30.21 SPYProjectItemTypes

public class SPYProjectItemTypes


{
public final static long = 0;
spyUnknownItem
public final static long = 1;
spyFileItem
public final static long = 2;
spyFolderItem
public final static long = 3;
spyURLItem
}

5.30.22 SPYProjectType
public class SPYProjectType
{
public final static long = 0;
spyVisualStudioProject

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java Predefined constants 1229

public final static long = 1;


spyVisualStudio2003Project
public final static long = 2;
spyBorlandProject
public final static long = 3;
spyMonoMakefile
}

5.30.23 SPYSampleXMLGenerationOptimization

public class SPYSampleXMLGenerationOptimization


{
public final static long = 0;
spySampleXMLGen_Optimized
public final static long = 1;
spySampleXMLGen_NonMandatoryElements
public final static long = 2;
spySampleXMLGen_Everything
}

5.30.24 SPYSampleXMLGenerationSchemaOrDTDAssignment

public class SPYSampleXMLGenerationOptimization


{
public final static long = 0;
spySampleXMLGen_AssignRelatively
public final static long = 1;
spySampleXMLGen_AssignAbsolutely
public final static long = 2;
spySampleXMLGen_DoNotAssign
}

5.30.25 SPYSchemaDefKind

public class SPYSchemaDefKind


{
public final static long spyKindElement = 0;
public final static long = 1;
spyKindComplexType
public final static long = 2;
spyKindSimpleType
public final static long spyKindGroup = 3;
public final static long spyKindModel = 4;
public final static long spyKindAny = 5;
public final static long spyKindAttr = 6;
public final static long = 7;
spyKindAttrGroup
public final static long spyKindAttrAny = 8;
public final static long = 9;
spyKindIdentityUnique
public final static long = 10;
spyKindIdentityKey
public final static long = 11;
spyKindIdentityKeyRef

© 2010 Altova GmbH Programmers' Reference


1230 Using the XMLSpy API with Java Predefined constants

public final static long = 12;


spyKindIdentitySelector
public final static long = 13;
spyKindIdentityField
public final static long spyKindNotation = 14;
public final static long spyKindInclude = 15;
public final static long spyKindImport = 16;
public final static long spyKindRedefine = 17;
public final static long spyKindFacet = 18;
public final static long spyKindSchema = 19;
public final static long spyKindCount = 20;
}

5.30.26 SPYSchemaDocumentationFormat
public class SPYSchemaDocumentationFormat
{
public final static long = 0;
spySchemaDoc_HTML
public final static long = 1;
spySchemaDoc_MSWord
public final static long = 2;
spySchemaDoc_RTF
}

5.30.27 SPYSchemaExtensionType
public class SPYSchemaExtensionType
{
public final static long = 0;
spySchemaExtension_None
public final static long = 1;
spySchemaExtension_SQL_XML
public final static long = 2;
spySchemaExtension_MS_SQL_Server
public final static long = 3;
spySchemaExtension_Oracle
}

5.30.28 SPYSchemaFormat
public class SPYSchemaFormat
{
public final static long = 0;
spySchemaFormat_Hierarchical
public final static long = 1;
spySchemaFormat_Flat
}

5.30.29 SPYTextDelimiters

public class SPYTextDelimiters


{

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java Predefined constants 1231

public final static long = 0;


spyTabulator
public final static long = 1;
spySemicolon
public final static long spyComma = 2;
public final static long spySpace = 3;
}

5.30.30 SPYTextEnclosing

public class SPYTextEnclosing


{
public final static long = 0;
spyNoEnclosing
public final static long = 1;
spySingleQuote
public final static long = 2;
spyDoubleQuote
}

5.30.31 SPYTypeDetection

public class SPYTypeDetection


{
public final static long = 0;
spyBestPossible
public final static long = 1;
spyNumbersOnly
public final static long = 2;
spyNoDetection
}

5.30.32 SPYURLTypes

public class SPYURLTypes


{
public final static long = (-1);
spyURLTypeAuto
public final static long = 0;
spyURLTypeXML
public final static long = 1;
spyURLTypeDTD
}

5.30.33 SpyViewModes

public class SPYViewModes


{
public final static long = 0;
spyViewGrid
public final static long = 1;
spyViewText
public final static long = 2;
spyViewBrowser

© 2010 Altova GmbH Programmers' Reference


1232 Using the XMLSpy API with Java Predefined constants

public final static long = 3;


spyViewSchema
public final static long = 4;
spyViewContent
public final static long = 4;
spyViewAuthentic
public final static long = 5;
spyViewWSDL
public final static long spyViewZIP = 6;
public final static long = 7;
spyViewEditionInfo
}

5.30.34 SPYWhitespaceComparison
public class SPYWhitespaceComparison
{
public final static long = 0;
spyCompareAsIs
public final static long = 1;
spyCompareNormalized
public final static long = 2;
spyStripAll
}

5.30.35 SPYXMLDataKind

public class SPYXMLDataKind


{
public final static long = 0;
spyXMLDataXMLDocStruct
public final static long = 1;
spyXMLDataXMLEntityDocStruct
public final static long = 2;
spyXMLDataDTDDocStruct
public final static long = 3;
spyXMLDataXML
public final static long = 4;
spyXMLDataElement
public final static long = 5;
spyXMLDataAttr
public final static long = 6;
spyXMLDataText
public final static long = 7;
spyXMLDataCData
public final static long = 8;
spyXMLDataComment
public final static long = 9;
spyXMLDataPI
public final static long = 10;
spyXMLDataDefDoctype
public final static long = 11;
spyXMLDataDefExternalID
public final static long = 12;
spyXMLDataDefElement
public final static long = 13;
spyXMLDataDefAttlist

Altova XMLSpy 2011 © 2010 Altova GmbH


Using the XMLSpy API with Java Predefined constants 1233

public final static long = 14;


spyXMLDataDefEntity
public final static long = 15;
spyXMLDataDefNotation
public final static long = 16;
spyXMLDataKindsCount
}

© 2010 Altova GmbH Programmers' Reference


1234 XMLSpy Integration

6 XMLSpy Integration
XMLSpyControl is a control that provides a means of integration of the XMLSpy user interface
and the functionality described in this section into most kinds of applications. ActiveX technology
was chosen so as to allow integration using any of a wide variety of languages; this enables
C++, C#, VisualBasic, or HTML to be used for integration. ActiveX components officially only
work with Microsoft Internet Explorer. All components are full OLE Controls, which makes
integration as simple as possible. Two different levels of integration are provided, thus enabling
the integration to be adapted to a wide range of needs.

To integrate XMLSpy you must install the XMLSpy Integration Package. Ensure that you install
XMLSpy first, and then the XMLSpy Integration Package.

For a successful integration you have to consider the following main design factors:
 What technology or programming language can the hosting application use to integrate
the XMLSpyControl?
 Should the integrated UI look exactly like XMLSpy with all its menus, toolbars, and
windows, or will a subset of these elements—like allowing only one document and a
restricted set of commands—be more effective?
 How deep will the integration be? Should the XMLSpy user interface be used as is? Are
user interface extensions and/or restrictions required? Can some frequently used tasks
be automated?

The sections, Integration at the Application Level and Integration at Document Level, both of
which have examples in various programming languages, will help you to make the right
decisions quickly. The section, Object Reference, describes all COM objects that can be used
for integration, together with their properties and methods.

For automation tasks, the XMLSpy Automation Interface is accessible from the XMLSpyControl
as well.

For information about how to integrate XMLSpy into Microsoft Visual Studio see the section,
XMLSpy in Visual Studio.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Integration at Application Level 1235

6.1 Integration at Application Level


Integration at application level is simple and straightforward. It allows you to embed the
complete interface of XMLSpy into a window of your application. Since you get the whole user
interface of XMLSpy, you get all menus, toolbars, the status bar, document windows, and helper
windows. Customization of the application's user interface is restricted to what XMLSpy
provides. This includes rearrangement and resizing of helper windows and customization of
menus and toolbars.

The only ActiveX control you need to integrate is XMLSpyControl. Its property
IntegrationLevel defaults to application-level. You may use Appearance and
BorderStyle to configure the appearance of the control's wrapper window. Do not instantiate
or access XMLSpyControlDocument or XMLSpyControlPlaceHolder ActiveX controls
when integrating at application-level.

If you have any initialization to do or if you want to automate some behaviour of XMLSpy, use
the properties, methods, and events described for XMLSpyControl. Consider using
XMLSpyControl.Application for more complex access to XMLSpy functionality.

In this section is an example (Example: HTML) showing how the XMLSpy application can be
embedded in an HTML page. For usage with other programming languages, or more
sophisticated access, see the Examples of integration at document-level.

6.1.1 Example: HTML


This example shows a simple integration of the XMLSpy control at application-level into a HTML
page. The integration is described in the following sections:
 Instantiate a XMLSpyControl in HTML code.
 Implement buttons to load documents and automate code-generation tasks.
 Define actions for some application events.

The code for this example is available at the following location in your XMLSpy installation:
Examples\ActiveX\HTML\XMLSpyActiveX_ApplicationLevel.htm.

Note: This example works only in Internet Explorer.

Instantiate the Control


The HTML Object tag is used to create an instance of the XMLSpyControl. The Classid is
that of XMLSpyControl. Width and height specify the window size. No additional parameters are
necessary, since application-level is the default.

<OBJECT id="objXMLSpyControl"
Classid="clsid:a258bba2-3835-4c16-8590-72b44f52c471"
width="1000"
height="700"
VIEWASTEXT>
</OBJECT>

Add Button to Open Default Document


As a simple example of how to automate some tasks, we add a button to the page:
<input type="button" value="Open Marketing Expenses"

© 2010 Altova GmbH Programmers' Reference


1236 XMLSpy Integration Integration at Application Level

onclick="BtnOpenMEFile()">

When clicked, a predefined document will be opened in the XMLSpyControl. We use a method
to locate the file relative to the XMLSpyControl so the example can run on different installations.

<SCRIPT ID=Javahandlers LANGUAGE=javascript>


// ---------------------------------
// open a pre-defined document
function BtnOpenMEFile()
{

objXMLSpyControl.Open("C:\Documents and Settings\username\My


Documents\Altova\XMLSpy2010\Examples/OrgChart.xml");

}
</SCRIPT>

Add Buttons for Code Generation


For direct access, we want to have a button that will validate the current document. The method
is similar to that used in the previous section.

First comes the button:


<input type="button" value="Validate" onclick="BtnValidate()">

Then we provide the script that will validate the current document.

<SCRIPT ID=Javahandlers LANGUAGE=javascript>


// ----------------------------------------------------------------------
// check validity of current document.
// if validation fails, show validation result in alert box .
function BtnValidate()
{
// get top-level object of automation interface
var objApp = objXMLSpyControl.Application;

// get the active document


var objDocument = objApp.ActiveDocument;

if ( objDocument == null )
alert( "no active document found" );
else
{
// define as arrays to support their usage as return parameters
var errorText = new Array(1);
var errorPos = new Array(1);
var badData = new Array(1);

var valid = objDocument.IsValid(errorText, errorPos, badData);

if (! valid)
{
// compose the error description
var text = errorText;

// access that XMLData object only if filled in


if (badData[0] != null)
text += "(" + badData[0].Name + "/" +
badData[0].TextValue + ")";

alert("Validation error[" + errorPos + "]: " + text);

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Integration at Application Level 1237

}
else
alert("Docuent is valid"); }
}
</SCRIPT>

Connect to Custom Events


The example implements two event callbacks for XMLSpyControl custom events to show the
principle:

<!-- ----------------------------------------------------------- -->


<!-- custom event 'OnDocumentOpened" of XMLSpyControl object -->
<SCRIPT FOR="objXMLSpyControl" event="OnDocumentOpened( objDocument )"
LANGUAGE="javascript">
// alert("Document '" + objDocument.Name + "' opened!");
</SCRIPT>

<!-- ----------------------------------------------------------- -->


<!-- custom event 'OnDocumentClosed" of XMLSpyControl object -->
<SCRIPT FOR="objXMLSpyControl" event="OnDocumentClosed( objDocument )"
LANGUAGE="javascript">
// alert("Document '" + objDocument.Name + "' closed!");
</SCRIPT>

© 2010 Altova GmbH Programmers' Reference


1238 XMLSpy Integration Integration at Document Level

6.2 Integration at Document Level


Integration at document level gives you freedom over instantiation and placement of the
following parts of the XMLSpy user interface:
 Editing windows for XMLSpy
 XMLSpy entry helper windows
 XMLSpy validator output window
 XMLSpy project window
 XMLSpy XPath profiler window
 XMLSpy XPath dialog window
 XMLSpy XSLT/XQuery debugger windows
 XMLSpy SOAP debugger window

If necessary, a replacement for the menus and toolbars of XMLSpy must be provided by your
application.

You will need to instantiate and access multiple ActiveX controls, depending on which user
interface parts you want to re-use. All these controls are contained in the XMLSpyControl OCX.
 Use XMLSpyControl to set the integration level and access application wide
functionality.
 Use XMLSpyControlDocument to create any number of editor windows. It may be
sufficient to create only one window and re-use it, depending on your needs.
 Optionally Use XMLSpyControlPlaceholder to embed XMLSpy entry helper windows,
validator output or other windows mentioned above.
 Access run-time information about commands, menus, and toolbars available in
XMLSpyControl to seamlessly integrate these commands into your application's menus
and toolbars. See Query XMLSpy Commands for more information.

If you want to automate some behaviour of XMLSpy use the properties, methods, and events
described for the XMLSpyControl, XMLSpyControlDocument and XMLSpyControlPlaceHolder.
Consider using XMLSpyControl.Application, XMLSpyControlDocument.Document and
XMLSpyControlPlaceHolder.Project for more complex access to XMLSpy functionality.
However, to open a document always use XMLSpyControlDocument.Open or
XMLSpyControlDocument.New on the appropriate document control. To open a project always
use XMLSpyControlPlaceHolder.OpenProject on a placeholder control embedding a XMLSpy
project window.

See Examples on how to instantiate and access the necessary controls in different
programming environments.

6.2.1 Use XMLSpyControl


To integrate at document level, instantiate a XMLSpyControl first. Set the property
IntegrationLevel to ICActiveXIntegrationOnDocum entLevel(= 1) . Set the window size of the
embedding window to 0x0 to hide any user interface behind the control. You may use
Appearance and BorderStyle to configure the appearance of the control's wrapper window.

Avoid using the method Open since this might lead to unexpected results. Use the
corresponding open methods of XMLSpyControlDocument and
XMLSpyControlPlaceHolder, instead.

See Query XMLSpy Commands for a description of how to integrate XMLSpy commands into
your application. Send commands to XMLSpy via the method Exec. Query if a command is
currently enabled or disabled using the method QueryStatus.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Integration at Document Level 1239

6.2.2 Use XMLSpyControlDocument


An instance of the XMLSpyControlDocument ActiveX control allows you to embed one
XMLSpy document editing window into your application. You can use any number of instances
you need.

Use the method Open to load any other existing file.

The control does not supports a read-only mode. The value of the property ReadOnly is
ignored.

Use Path and Save or methods and properties accessible via the property Document to
access document functionality.

6.2.3 Use XMLSpyControlPlaceHolder


Instances of XMLSpyControlPlaceHolder ActiveX controls allow you to selectively embed the
additional helper windows of XMLSpy into your application. The property
PlaceholderWindowID selects the XMLSpy helper window to be embedded. Use only one
XMLSpyControlPlaceHolder for each window identifier. See
Enumerations.XMLSpyControlPlaceholderWindow for valid window identifiers.

For placeholder controls that select the XMLSpy project window, additional methods are
available. Use OpenProject to load a XMLSpy project. Use the property Project and the
methods and properties from the XMLSpy automation interface to perform any other project
related operations.

6.2.4 Query XMLSpy Commands


When integrating at document-level, no menu or toolbar from XMLSpy is available to your
application. Instead, you can query all the commands and the structure of the application menu
at runtime. Professional applications will need to integrate this menu in a sophisticated manner
into their own menu structure. Your installation of XMLSpy even provides you with command
label images used within XMLSpy. See the folder Examples\ActiveX\Images of your
XMLSpy installation for icons in GIF format. The file names correspond to the labels of
commands.

6.2.5 Examples
This section contains examples of XMLSpy document-level integration using different container
environments and programming languages. Source code for all examples is available in the
folder Examples\ActiveX of your XMLSpy installation.

C#
The C# example shows how to integrate the XMLSpyControl in a common desktop application
created with C# using Visual Studio 2008. The following topics are covered:
 Integration of a XMLSpyControl Document control to embed a XMLSpy document editing
window.
 Usage of a XMLSpyControlPlaceholder controls to embed the XMLSpy XPath dialog
window.

© 2010 Altova GmbH Programmers' Reference


1240 XMLSpy Integration Integration at Document Level

 Opening and closing of XMLSpy documents via the main menu.


Please note that the example application is already complete. There is no need to change
anything if you want to run and see it working. The following steps describe what general
actions and considerations must be taken in order to create a project such as this.

Introduction
Adding the XMLSpy components to the Toolbox
Before you take a look at the sample project please add the assemblies to the .NET IDE
Toolbox. The XMLSpy Installer will have already installed the assemblies in the .NET Global
Assembly Cache (GAC). If you open the Toolbox dialog under Tools | Add/Remove Toolbox
Items the controls will appear as AxXMLSpyControl, AxXMLSpyControlDocument and
AxXMLSpyControlPlaceholder on the .NET Framework Components tab. Check all to
make them available to the IDE.

Now you can open the XPathDialog.sln file in the ActiveX\C#\XPathDialog folder to
load the project.

Placing the XMLSpyControl


It is necessary to have one XMLSpyControl instance to set the integration level and to manage
the Document and Placeholder controls of the XMLSpy library. The control is accessible via the
General section of the Toolbox helper window in the IDE. To add it you need to select the
component in the Toolbox window and drag a rectangle wherever you want to have it in the
destination window. If you have an application which does not open a window on startup you
can use a simple invisible Form with the control on it which is created manually in the code.

The example project adds this instance to the main MdiContainer MDIMain. If you open
MDIMain in the Design View from the Solution Explorer you will see a light blue rectangle at the
top-left side in the client area of the Frame window. Selecting this rectangle will show you the
properties of the XMLSpyControl. It is important to set the IntegrationLevel property to
ICActiveXIntegrationOnDocumentLevel in order to turn on the Document and
Placeholder support of the XMLSpy library. You can set the Visible flag to False to avoid any
confusion about the control for the user.

Adding the Document Control


Document editing window on the MDI Frame
The example project uses one Document control show and edit one XMLSpy document in the
main MDI Frame. It is added via the Toolbox window by dragging a rectangle on the destination
Form.The Document control also has the Anchor and Dock properties set in order to react on
resizing of the Frame window.

Adding the Placeholder Control


Placeholders on the MDI Frame
The example project uses one Placeholder control to embed the XPath Dialog window into the
main MDI Frame. It is added via the Toolbox window by dragging a rectangle on the destination
Form. To set the type of the Placeholder which should be displayed one has to set the
PlaceholderWindowID property. This property can also be changed during runtime in the
code of the application. The Placeholder control would change its content immediately. The
Placeholder also has the Anchor properties set in order to react on resizing of the Frame

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Integration at Document Level 1241

window.

Retrieving Command Information


The XMLSpyControl gives access to all commands of XMLSpy through its Com m andsStructure
property. The example project uses the XMLSpyCommands and XMLSpyCommand interfaces to
dynamically build a menu in the MDI Frame window.

The code to add the commands will be placed in the MDIMain method of the
XMLSpyApplication class in the file MDIMain.cs:

public MDIMain()
{
.
.
.
XMLSpyControlLib.XMLSpyCommands objCommands;
objCommands = axXMLSpyControl.CommandsStructure;

long nCount = objCommands.Count;

for(long idx = 0;idx < nCount;idx++)


{
XMLSpyControlLib.XMLSpyCommand objCommand;
objCommand = objCommands[(int)idx];

// We are looking for the Menu with the name IDR_XMLSPY. This menu
contains
// the complete main menu of XMLSpy.

if(objCommand.Label == "IDR_XMLSPY")
{
InsertMenuStructure(mainMenu.MenuItems, 1, objCommand, 0, 0,
false);
}
}
.
.
.
}

mainMenu is the name of the menu object of the MDI Frame window created in the Visual
Studio IDE. InsertMenuStructure takes the XMLSpy menu from the IDR_XMLSPY command
object and adds the XMLSpy menu structure to the already existing menu of the sample project.
No commands from the File, Project, or Window menu are added.

The new commands are instances of the class CustomMenuItem, which is defined in
CustomMenuItem.cs. This class has an additional member to save the XMLSpy command
ID, which is taken to execute the command using Exec on selecting the menu item. This code
from InsertMenuStructure creates the new command:

CustomMenuItem newMenuItem = new CustomMenuItem();

if(objCommand.IsSeparator)
newMenuItem.Text = "-";
else
{
newMenuItem.Text = strLabel;
newMenuItem.m_XMLSpyCmdID = (int)objCommand.ID;
newMenuItem.Click += new EventHandler(AltovaMenuItem_Click);

© 2010 Altova GmbH Programmers' Reference


1242 XMLSpy Integration Integration at Document Level

You can see that all commands get the same event handler AltovaMenuItem_Click which
does the processing of the command:

private void AltovaMenuItem_Click(object sender, EventArgs e)


{
if(sender.GetType() == System.Type.GetType("XMLSpy
Application.CustomMenuItem"))
{
CustomMenuItem customItem = (CustomMenuItem)sender;

ProcessCommand(customItem.m_XMLSpyCmdID);
}
}

private void ProcessCommand(int nID)


{
XMLSpyDoc docXMLSpy = GetCurrentXMLSpyDoc();

if(docXMLSpy != null)
docXMLSpy.axXMLSpyControlDoc.Exec(nID);
else
axXMLSpyControl.Exec(nID);
}

ProcessCommand delegates the execution either to the XMLSpyControl itself or to any active
XMLSpy document loaded in a XMLSpyControlDocument control. This is necessary because
the XMLSpyControl has no way to know which document is currently active in the hosting
application.

Handling Events
Because all events in the XMLSpy library are based on connection points, you can use the C#
delegate mechanism to provide the custom event handlers. You will always find a complete list
of events on the property page of each control of the XMLSpy library. The picture below shows
the events of the main XMLSpyControl:

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Integration at Document Level 1243

As you can see, the example project only overrides the OnFileExternalChange event. The
creation of the C# delegate is done for you by the C# Framework. All you need to do is to fill the
empty event handler. The handler implementation turns off any file reloading and displays a
message box to inform the user that a file loaded by the XMLSpyControl has been changed
from outside:

private void axMapForceControl_OnFileExternalChange(object sender,


AxMapForceControlLib._DMapForceControlEvents_OnFileExternalChangeEvent e)
{
MessageBox.Show("Attention: The file " + e.strPath + " has been changed
from outside\nbut reloading is turned off in the sample application!");

// This turns off any file reloading:


e.varRet = false;
}

Testing the Example


After adding the assemblies to the Toolbox (see Introduction), you can run the sample project
with F5 without the need to change anything in the code. The main MDI Frame window is
created and contains an editing window with an empty XML document and a XPath Dialog
window of XMLSpy at the bottom. Use File | Open to open the file OrgChart.xml, which is in
the XMLSpy examples folder. The file is loaded and displayed.

After you load the document, you can try using the XPath dialog.

© 2010 Altova GmbH Programmers' Reference


1244 XMLSpy Integration Integration at Document Level

HTML
This example shows an integration of the XMLSpy control at document-level into a HTML page.
The following topics are covered:
 Instantiate a XMLSpyControl ActiveX control object in HTML code
 Instantiate a XMLSpyControlDocument ActiveX control to allow editing a XMLSpy file
 Instantiate one XMLSpyControlPlaceHolder for a XMLSpyControl project window
 Instantiate one XMLSpyControlPlaceHolder to alternatively host one of the XMLSpy
helper windows
 Instantiate one XMLSpyControlPlaceHolder ActiveX control to show the XMLSpy
validation output window
 Create a simple customer toolbar for some heavy-used XMLSpy commands
 Add some more buttons that use the COM automation interface of XMLSpy
 Use event handlers to update command buttons

This example is available in its entirety in the file XMLSpyActiveX_ApplicationLevel.htm


within the C:\Program Files\Altova\XMLSpy2011\Examples\ActiveX\HTML\ folder of your
XMLSpy installation.

Note: This example works only in Internet Explorer.

Instantiate the XMLSpyControl


XMLSpyControlThe HTML OBJECT tag is used to create an instance of the XMLSpyControl.
The Classid is that of XMLSpyControl. Width and height are set to 0 since we use this control
as manager control without use for its user interface. The integration level is specified as a
parameter within the OBJECT tag.

<OBJECT id="objXMLSpyXXMLSpyControl"
Classid="clsid:a258bba2-3835-4c16-8590-72b44f52c471"
width="0"
height="0"
VIEWASTEXT>
<PARAM NAME="IntegrationLevel" VALUE="1">
</OBJECT>

Create Editor Window


The HTML OBJECT tag is used to embed an editing window.

<OBJECT id="objDoc1"
Classid="clsid:DFBB0871-DAFE-4502-BB66-08CEB7DF5255"
width="600"
height="500"
VIEWASTEXT>
</OBJECT>

Create Project Window


The HTML OBJECT tag is used to create a XMLSpyControlPlaceHolder window. The first
additional custom parameter defines the placeholder to show the XMLSpy project window. The
second parameter loads one of the example projects delivered with your XMLSpy installation

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Integration at Document Level 1245

(located in the <yourusername>/MyDocuments folder).

<OBJECT id="objProjectWindow"
Classid="clsid:FDEC3B04-05F2-427d-988C-F03A85DE53C2"
width="200"
height="200"
VIEWASTEXT>
<PARAM name="PlaceholderWindowID" value="3">
<PARAM name="FileName" value="Examples/Examples.spp">
</OBJECT>

Create Placeholder for Helper Windows


The HTML OBJECT tag is used to instantiate a XMLSpyControlPlaceHolder ActiveX control that
can host the different XMLSpy helper windows. Initially, no helper window is shown. See the
example file.

<OBJECT id="objEHWindow"
Classid="clsid:135DEEF4-6DF0-47c2-8F8C-F145F5F3F672"
width="200"
height="200"
VIEWASTEXT>
<PARAM name="PlaceholderWindowID" value="0">
</OBJECT>

Three buttons allow us to switch the actual window that will be shown. The JavaScript execute
on-button-click sets the property PlaceHolderWindowID to the corresponding value defined in
XMLSpyControlPlaceholderWindow.

<input type="button" value="EH - Elements" onclick="BtnHelperWindow(0)">


<input type="button" value="EH - Attributes" onclick="BtnHelperWindow(1)">
<input type="button" value="EH - Entities" onclick="BtnHelperWindow(2)">

<SCRIPT ID="Javahandlers" LANGUAGE="javascript">


//
------------------------------------------------------------------------------
// specify which of the windows shall be shown in the placeholder control.
function BtnHelperWindow(i_ePlaceholderWindowID)
{
objEHWindow.PlaceholderWindowID = i_ePlaceholderWindowID;
}
</SCRIPT>

Create a Custom Toolbar


The custom toolbar consists of buttons with images of XMLSpy commands. The command ID
numbers can be found in Command Table.

<button id="btnWellFormed" title="Check Well-formedness"


onclick="BtnDoCommand(34049)">
<img src="..\Images\IDC_CHECK_WELL_FORM.gif" width="16" height="16" />
</button>
<button id="btnValidate" title="Validate" onclick="BtnDoCommand(34174)">
<img src="..\Images\IDC_VALIDATE.gif" width="16" height="16" />
</button>

On clicking one of these buttons the corresponding command ID is sent to the manager control.

© 2010 Altova GmbH Programmers' Reference


1246 XMLSpy Integration Integration at Document Level

<SCRIPT ID="Javahandlers" LANGUAGE="javascript">


// ---------------------------------------------------------------
// perform any command specified by cmdID.
// command routing includes application, active document and view.
function BtnDoCommand(cmdID)
{
objXMLSpyX.Exec( cmdID );
msgtext.innerText = "Command " + cmdID + " performed.";
}
</SCRIPT>

Create More Buttons


In the example, we add some more buttons to show some automation code.
<p>
<input type="button" value="New File" onclick="BtnNewFile(objDoc1)">
<input type="button" value="Save File" onclick="BtnSaveFile(objDoc1)">
<input type="text" title="Path" id="strPath" width="150">
<input type="button" value="Open OrgChart.xml"
onclick="BtnOpenFile(objDoc1, 'OrgChart.xml')">
<input type="button" value="Open OrgChart.xsd"
onclick="BtnOpenFile(objDoc1, 'OrgChart.xsd')">
<p>

The corresponding JavaScript looks like this:

<SCRIPT ID="Javahandlers" LANGUAGE="javascript">


// ---------------------------------------------------------
// open a document in the specified document control window.
function BtnOpenFile(objDocCtrl, strFileName)
{
// do not use XMLSpyX.Application.OpenDocument(...) to open a document,
// since then XMLSpyControl wouldn't know a control window to show
// the document in. Instead:

objDocCtrl.Open("C:\Documents and Settings\username\My


Documents\Altova\XMLSpy2010\Examples/" + strFileName);
objDocCtrl.setActive();

// -------------------------------------------------------------------
// open a new empty document in the specified document control window.
function BtnNewFile(objDocCtrl)
{
objDocCtrl.Open("");
objDocCtrl.setActive();
}

// -------------------------------------------------------------------
// Saves the current file in the specified document control window.
function BtnSaveFile(objDocCtrl)
{
if(objDocCtrl.Path.length > 0)
objDocCtrl.SaveDocument();
else
{
if(strPath.value.length > 0)
{
objDocCtrl.Path = strPath.value;
objDocCtrl.Save();
}
else

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Integration at Document Level 1247

{
alert("Please set path for the document first!");
strPath.focus();
}
}

objDocCtrl.setActive();
}

// ----------------------------------------------------------------------
// check validity of current document.
// if validation fails, show validation result in alert box .
function BtnValidate()
{
// get top-level object of automation interface
var objApp = objXMLSpyControl.Application;

// get the active document


var objDocument = objApp.ActiveDocument;

if ( objDocument == null )
alert( "no active document found" );
else
{
// define as arrays to support their usage as return parameters
var errorText = new Array(1);
var errorPos = new Array(1);
var badData = new Array(1);

var valid = objDocument.IsValid(errorText, errorPos, badData);

if (! valid)
{
// compose the error description
var text = errorText;

// access that XMLData object only if filled in


if (badData[0] != null)
text += "(" + badData[0].Name + "/" +
badData[0].TextValue + ")";

alert("Validation error[" + errorPos + "]: " + text);


}
else
alert("Docuent is valid");
}
}
</SCRIPT>

Create Event Handler to Update Button Status


Availability of a command may vary with every mouseclick or keystroke. The custom event
OnUpdateCmdUI of XMLSpyControl gives us an opportunity to update the enabled/disabled
state of buttons associated with XMLSpy commands. The method
XMLSpyControl.QueryStatus is used to query whether a command is enabled or not.

<SCRIPT FOR="objXMLSpyX" event="OnUpdateCmdUI()" LANGUAGE="javascript">


if ( document.readyState == "complete" ) // 'complete'
{
// update status of buttons
btnWellFormed.disabled = ! (objDoc1.QueryStatus(34049) & 0x02);
// not enabled

© 2010 Altova GmbH Programmers' Reference


1248 XMLSpy Integration Integration at Document Level

btnValidate.disabled = ! (objDoc1.QueryStatus(34174) & 0x02);


// not enabled
}

// set activity status of simulated toolbar


</SCRIPT>

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Command Table for XMLSpy 1249

6.3 Command Table for XMLSpy


Tables in this section list the names and identifiers of all commands that are available within
XMLSpy. Every sub-section lists the commands from the corresponding top-level menu of
XMLSpy. The left-most column shows the command's menu text to make it easier for you to
identify the functionality behind the command. The last sub-section is a collection of those
commands that are not accessible via the main menu.

Depending on the edition of XMLSpy you have installed, some of these commands might not be
supported. See Query XMLSpy Commands on how to query the current resource structure and
command availability.

Use the command identifiers with XMLSpyControl.QueryStatus or


XMLSpyControlDocument.QueryStatus to check the current status of a command. Use
XMLSpyControl.Exec or XMLSpyControlDocument.Exec to execute a command.

File Menu
Edit Menu
Project Menu
XML menu
DTD/Schema Menu
Schema Design Menu
XSL/XQuery Menu
Authentic Menu
Convert Menu
View Menu
Browser Menu
WSDL Menu
SOAPMenu
Tools Menu
Window Menu
Help Menu

6.3.1 File Menu


Commands from the File menu:

Menu Text Command Name ID


New... ID_FILE_NEW 57600
Open... ID_FILE_OPEN 57601
Reload IDC_FILE_RELOAD 34065
Encoding... IDC_ENCODING 34061
Close ID_FILE_CLOSE 57602
Close All IDC_CLOSE_ALL 34050
Save ID_FILE_SAVE 57603
Save As... ID_FILE_SAVE_AS 57604
Save to URL... ID_FILE_SAVE_TO_URL 34209
Save All ID_FILE_SAVE_ALL 34208
Send by Mail... ID_FILE_SEND_MAIL 57612
Print... IDC_PRINT 34103
Print Preview IDC_PRINT_PREVIEW 34104
Print Setup... ID_FILE_PRINT_SETUP 57606

© 2010 Altova GmbH Programmers' Reference


1250 XMLSpy Integration Command Table for XMLSpy

Recent File ID_FILE_MRU_FILE1 57616


Exit ID_APP_EXIT 57665

6.3.2 Edit Menu


Commands from the Edit menu:

Menu Text Command Name ID


Undo ID_EDIT_UNDO 57643
Redo ID_EDIT_REDO 57644
Cut ID_EDIT_CUT 57635
Copy ID_EDIT_COPY 57634
Paste ID_EDIT_PASTE 57637
Delete ID_EDIT_CLEAR 57632
Copy as XML-Text IDC_COPY_AS_XML_TEXT 33443
Copy as Structured text IDC_COPY_AS_STRUCTURED_TEXT 33442
Copy XPath IDC_COPY_XPATH 33444
Pretty-Print XML Text IDC_PRETTY_PRINT 34101
Select All ID_EDIT_SELECT_ALL 57642
Find... ID_EDIT_FIND 57636
Find next ID_EDIT_REPEAT 57640
Replace... ID_EDIT_REPLACE 57641
Find in files... IDC_FIND_IN_FILES 34000
Insert/Remove Bookmark IDC_TOGGLE_BOOKMARK 34162
Remove All Bookmarks IDC_REMOVEALLBOOKMARKS 34132
Goto Next Bookmark IDC_GOTONEXTBOOKMARK 34070
Goto Previous Bookmark IDC_GOTOPREVBOOKMARK 34071

6.3.3 Project Menu


Commands from the Project menu:

Menu Text Command Name ID


New Project IDC_PROJECT_NEW 34122
Open Project... IDC_PROJECT_OPEN 34123
Reload Project IDC_PROJECT_RELOAD 34126
Close Project IDC_PROJECT_CLOSE 34113
Save Project IDC_PROJECT_SAVE 34127
Source Control/Open Project... IDC_SCC_OPEN_PROJECT 34140
Source Control/Enable Source Code Control IDC_SCC_ENABLE 34137

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Command Table for XMLSpy 1251

Source Control/Get latest version... IDC_SCC_GET 34138


Source Control/Check Out... IDC_SCC_CHECK_OUT 34135
Source Control/Check In... IDC_SCC_CHECK_IN 34134
Source Control/Undo Check Out... IDC_SCC_UNDO_CHECK_OUT 34145
Source Control/Add to Source Control... IDC_SCC_ADD 34133
Source Control/Remove from Source Control... IDC_SCC_REMOVE 34143
Source Control/Show History... IDC_SCC_HISTORY 34139
Source Control/Show Differences... IDC_SCC_DIFF 34136
Source Control/Properties... IDC_SCC_PROPERTIES 34141
Source Control/Refresh Status... IDC_SCC_REFRESH 34142
Source Control/Run Native Interface... IDC_SCC_RUN 34144
Add Files to Project... IDC_PROJECT_ADD_FILES 34109
Add URL to Project... IDC_PROJECT_ADD_URL 34112
Add Active File to Project IDC_PROJECT_ADD_ACTIVE 34106
Add Active and Related Files to Project IDC_PROJECT_ADD_RELATED 34111
Add Project Folder to Project... IDC_PROJECT_ADD_FOLDER 34110
Add External Folder to Project... IDC_PROJECT_ADD_EXT_FOLDER 34107
Add External Web Folder to Project... IDC_PROJECT_ADD_EXT_URL_FOLDER 34108
Project Properties... IDC_PROJECT_PROPERTIES 34124
Recent Project IDC_RECENT_PROJECT_ID 34265

6.3.4 XML menu


Commands from the XML menu:

Menu Text Command Name ID


Insert/Attribute IDC_INSERT_ATTRIBUTE 33449
Insert/Element IDC_INSERT_STRUCT 33459
Insert/Text IDC_INSERT_TEXT 33460
Insert/CData IDC_INSERT_CDATA 33450
Insert/Comment IDC_INSERT_COMMENT 33451
Insert/XML IDC_INSERT_XML 33461
Insert/Processing Instruction IDC_INSERT_PI 33458
Insert/XInclude IDC_INSERT_XINCLUDE 34019
Insert/DOCTYPE IDC_INSERT_DEF_DOCTYPE 33453
Insert/ExternalID IDC_INSERT_DEF_EXTERNAL_ID 33456
Insert/ELEMENT IDC_INSERT_DEF_ELEMENT 33454
Insert/ATTLIST IDC_INSERT_DEF_ATTLIST 33452
Insert/ENTITY IDC_INSERT_DEF_ENTITY 33455
Insert/NOTATION IDC_INSERT_DEF_NOTATION 33457
Append/Attribute IDC_APPEND_ATTRIBUTE 33415

© 2010 Altova GmbH Programmers' Reference


1252 XMLSpy Integration Command Table for XMLSpy

Append/Element IDC_APPEND_STRUCT 33425


Append/Text IDC_APPEND_TEXT 33426
Append/CData IDC_APPEND_CDATA 33416
Append/Comment IDC_APPEND_COMMENT 33417
Append/XML IDC_APPEND_XML 33427
Append/Processing Instruction IDC_APPEND_PI 33424
Append/XInclude IDC_APPEND_XINCLUDE 34026
Append/DOCTYPE IDC_APPEND_DEF_DOCTYPE 33419
Append/ExternalID IDC_APPEND_DEF_EXTERNAL_ID 33422
Append/ELEMENT IDC_APPEND_DEF_ELEMENT 33420
Append/ATTLIST IDC_APPEND_DEF_ATTLIST 33418
Append/ENTITY IDC_APPEND_DEF_ENTITY 33421
Append/NOTATION IDC_APPEND_DEF_NOTATION 33423
Add child/Attribute IDC_ADD_CHILD_ATTRIBUTE 33402
Add child/Element IDC_ADD_CHILD_STRUCT 33412
Add child/Text IDC_ADD_CHILD_TEXT 33413
Add child/CData IDC_ADD_CHILD_CDATA 33403
Add child/Comment IDC_ADD_CHILD_COMMENT 33404
Add child/XML IDC_ADD_CHILD_XML 33414
Add child/Processing Instruction IDC_ADD_CHILD_PI 33411
Add child/XInclude IDC_ADD_CHILD_XINCLUDE 34027
Add child/DOCTYPE IDC_ADD_CHILD_DEF_DOCTYPE 33406
Add child/ExternalID IDC_ADD_CHILD_DEF_EXTERNAL_ID 33409
Add child/ELEMENT IDC_ADD_CHILD_DEF_ELEMENT 33407
Add child/ATTLIST IDC_ADD_CHILD_DEF_ATTLIST 33405
Add child/ENTITY IDC_ADD_CHILD_DEF_ENTITY 33408
Add child/NOTATION IDC_ADD_CHILD_DEF_NOTATION 33410
Convert to/Attribute IDC_CONVERT_TO_ATTRIBUTE 33429
Convert to/Element IDC_CONVERT_TO_STRUCT 33439
Convert to/Text IDC_CONVERT_TO_TEXT 33440
Convert to/CData IDC_CONVERT_TO_CDATA 33430
Convert to/Comment IDC_CONVERT_TO_COMMENT 33431
Convert to/XML IDC_CONVERT_TO_XML 33441
Convert to/Processing Instruction IDC_CONVERT_TO_PI 33438
Convert to/DOCTYPE IDC_CONVERT_TO_DEF_DOCTYPE 33433
Convert to/ExternalID IDC_CONVERT_TO_DEF_EXTERNAL_ID 33436
Convert to/ELEMENT IDC_CONVERT_TO_DEF_ELEMENT 33434
Convert to/ATTLIST IDC_CONVERT_TO_DEF_ATTLIST 33432
Convert to/ENTITY IDC_CONVERT_TO_DEF_ENTITY 33435
Convert to/NOTATION IDC_CONVERT_TO_DEF_NOTATION 33437

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Command Table for XMLSpy 1253

Table/Display as Table IDC_GRID_VIEW_AS_TABLE 34075


Table/Insert Row IDC_TABLE_INSERT_ROW 34158
Table/Append Row IDC_TABLE_APPEND_ROW 34157
Table/Ascending Sort IDC_TABLE_SORT_ASC 33464
Table/Descending Sort IDC_TABLE_SORT_DESC 33465
Move left IDC_MOVE_LEFT 34091
Move right IDC_MOVE_RIGHT 34092
Enclose in Element IDC_ENCLOSE_IN_ELEMENT 33446
Evaluate XPath... IDC_EVALUATE_XPATH 34007
Check well-formedness IDC_CHECK_WELL_FORM 34049
Validate IDC_VALIDATE 34174
Update Entry Helpers IDC_UPDATE_ELEMENT_CHOICE 34173
Namespace prefix... IDC_NAMESPACE 33462

6.3.5 DTD/Schema Menu


Commands from the DTD/Schema menu:

Menu Text Command Name ID


Assign DTD... IDC_ASSIGN_DTD 34032
Assign Schema... IDC_ASSIGN_SCHEMA 34033
Include another DTD... IDC_INCLUDE_DTD 34084
Go to DTD IDC_GOTO_DTD 34072
Go to Schema IDC_GOTO_SCHEMA 34074
Go to Definition IDC_GOTO_DEFINITION 33447
Generate DTD/Schema... IDC_GENERATE_DTD_SCHEMA 34068
Convert DTD/Schema... IDC_CONVERT_DTD_SCHEMA 34052
Convert to UML... IDC_CONVERT_SCHEMA_TO_UML 34008
Generate XML from DB, Excel, EDI IDC_DTD_OPENIN_MAPFORCE 34056
with MapForce
Design HTML/PDF Output in IDC_DTD_OPENIN_STYLEVISION 34057
StyleVision...
Generate Sample XML File... IDC_GENERATE_XML_FROM_SCHEMA 34069
Generate Program Code... IDC_GENERATE_CODE_FROM_SCHEMA 34067
Flush memory cache IDC_FLUSH_CACHED_FILES 34066

6.3.6 Schema Design Menu


Commands from the Schema Design menu:

Menu Text Command Name ID


Schema Settings IDC_SCHEMA_NAMESPACES 3357
1
Save Diagram... IDC_SCHEMA_SAVE_DIAGRAM 3358
1

© 2010 Altova GmbH Programmers' Reference


1254 XMLSpy Integration Command Table for XMLSpy

Generate Documentation IDC_SCHEMA_DOCUMENTATION 3414


6
Configure view IDC_SCHEMA_VIEW_CONFIG 3359
3
Zoom IDC_SCHEMA_ZOOM 3415
0
Display All Globals IDC_SCHEMA_MODE_GLOBALS 3414
7
Display Diagram IDC_SCHEMA_MODE_DIAGRAM 3357
0
Enable Oracle Schema Extensions IDC_SCHEMA_ORACLE_EXTENSIONS 3357
7
Oracle Schema Settings... IDC_SCHEMA_ORACLE_SCHEMA_SETTING 3357
S 8
Enable Microsoft SQL Server Schema IDC_SCHEMA_SQLSERVER_EXTENSIONS 3358
Extensions 8
Named Schema Relationships... IDC_SCHEMA_SQLSERVER_GLOBAL_RELA 3358
TIONSHIPS 9
Unnamed Element Relationships... IDC_SCHEMA_SQLSERVER_LOCAL_RELATI 3359
ONSHIPS 0
Connect to SchemaAgent Server... IDC_SCHEMA_SCHEMAAGENT_SERVER_C 3358
ONNECT 2
Disconnect from SchemaAgent Server IDC_SCHEMA_SCHEMAAGENT_SERVER_DI 3358
SCONNECT 3
Show in SchemaAgent/Schema only IDC_SCHEMAAGENT_SHOW 3350
4
Show in SchemaAgent/Schema and all directly IDC_SCHEMAAGENT_SHOW_RELATED 3350
referenced 7
Show in SchemaAgent/Schema and all IDC_SCHEMAAGENT_SHOW_ALL 3350
referenced 5
Show in SchemaAgent/Schema and all linked IDC_SCHEMAAGENT_SHOW_ALL_REACHA 3350
BLE 6
Extended Validation IDC_SCHEMA_EXTVALID_MENU 3353
9

6.3.7 XSL/XQuery Menu


Commands from the XSL/XQuery menu:

Menu Text Command Name ID


XSL Transformation IDC_TRANSFORM_XSL 3300
6
XSL:FO Transformation IDC_TRANSFORM_XSLFO 3300
7
XSL Parameters/XQuery IDC_TRANSFORM_XSL_PARAMS 3300
Variables... 8
XQuery Execution IDC_TRANSFORM_XQUERY 3417
0
Enable XSLT 2 / XQuery IDC_PROFILING_OPTIONS 3410
profiling.... 5
Assign XSL... IDC_ASSIGN_XSL 3300
1
Assign XSL:FO... IDC_ASSIGN_XSLFO 3300
2

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Command Table for XMLSpy 1255

Assign sample XML file... IDC_ASSIGN_SAMPLE_XML 3300


0
Go to XSL IDC_GOTO_XSL 3300
4
Start Debugger/Go ID_PROCESS_XSL 3421
2
Stop Debugger ID_XSLT_DEBUGGER_STOP 3301
7
Restart Debugger ID_XSLT_DEBUGGER_RESTART 3301
3
End Debugger Session ID_XSLT_DEBUGGER_END_SESSION 3301
1
Step Into ID_XSLT_DEBUGGER_STEP 3301
4
Step Out ID_XSLT_DEBUGGER_STEP_OUT 3301
5
Step Over ID_XSLT_DEBUGGER_STEP_OVER 3301
6
Show Current Execution Node ID_XSLT_DEBUGGER_GO_TO_CURRENT_EXECUTION_ 3301
NODES 2
Insert/Remove Breakpoint IDC_TOGGLE_BREAKPOINT 3424
6
Insert/Remove Tracepoint IDC_TOGGLE_TRACEPOINT 3424
8
Enable/Disable Breakpoint IDC_ENABLE_BREAKPOINT 3424
5
Enable/Disable Tracepoint IDC_ENABLE_TRACEPOINT 3424
7
Breakpoints/Tracepoints... ID_XSLTDEBUGGER_BREAKPOINTS 3300
9
Debug Windows/Call Stack ID_XSL_DEBUGWINDOWS_CALLSTACK 3423
8
Debug Windows/XPath-Watch ID_XSL_DEBUGWINDOWS_WATCH 3424
4
Debug Windows/Context ID_XSL_DEBUGWINDOWS_CONTEXT 3423
9
Debug Windows/Variables ID_XSL_DEBUGWINDOWS_VARIABLE 3424
3
Debug Windows/Messages ID_XSL_DEBUGWINDOWS_MESSAGES 3424
0
Debug Windows/Templates ID_XSL_DEBUGWINDOWS_TEMPLATES 3424
1
Debug Windows/Info ID_XSLXQUERY_DEBUGWINDOWS_INFO 3423
7
Debug Windows/Trace ID_XSL_DEBUGWINDOWS_TRACES 3424
2
XSLT/XQuery Settings... ID_XSLTDEBUGGER_SETTINGS 3301
0

6.3.8 Authentic Menu


Commands from the Authentic menu:

Menu Text Command Name ID

© 2010 Altova GmbH Programmers' Reference


1256 XMLSpy Integration Command Table for XMLSpy

New Document... IDC_AUTHENTIC_NEW_FILE 34036


Edit Database Data... IDC_AUTHENTIC_EDIT_DB 34035
Assign a StyleVision Stylesheet... IDC_ASSIGN_SPS 34034
Edit StyleVision Stylesheet IDC_EDIT_SPS 34060
Define XML Entities... IDC_DEFINE_ENTITIES 32805
Hide markup IDC_MARKUP_HIDE 34087
Show Small markup IDC_MARKUP_SMALL 34090
Show Large markup IDC_MARKUP_LARGE 34088
Show Mixed markup IDC_MARKUP_MIX 34089
Append row IDC_ROW_APPEND 32806
Insert row IDC_ROW_INSERT 32809
Duplicate row IDC_ROW_DUPLICATE 32808
Move row Up IDC_ROW_MOVE_UP 32811
Move row Down IDC_ROW_MOVE_DOWN 32810
Delete row IDC_ROW_DELETE 32807

6.3.9 Convert Menu


Commands from the Convert menu:

Menu Text Command Name ID


Import Text file... IDC_IMPORT_TEXT 34082
Import Database data... IDC_IMPORT_DATABASE 34080
Import Microsoft Word document... IDC_IMPORT_WORD 34083
Create XML Schema from DB Structure IDC_CREATE_DB_SCHEMA 34054
DB Import based on XML Schema IDC_IMPORT_DB_SCHEMA 34081
Create DB Structure from XML Schema IDC_CREATE_DB_BASED_ON_SCHEMA 34053
Export to Text files... IDC_EXPORT_TEXTFILE 34064
Export to a Database... IDC_EXPORT_DB 34003
Oracle XML DB/Search... ID_CONVERT_ORACLEXMLDB_QUERY 34207
Oracle XML DB/List Schemas... ID_ORACLEXMLDB_LISTSCHEMAS 34211
Oracle XML DB/Add Schema... ID_CONVERT_ORACLEXMLDB_ADDSCHE 34204
MA
Oracle XML DB/Browse Oracle XML ID_CONVERT_ORACLEXMLDB_BROWSE 34205
Documents...
Oracle XML DB/Properties... ID_CONVERT_ORACLEXMLDB_PROPERTI 34206
ES

6.3.10 View Menu


Commands from the View menu:

Menu Text Command Name ID


Text view IDC_VIEW_TEXT 34180
Enhanced Grid view IDC_VIEW_GRID 34178

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Command Table for XMLSpy 1257

Schema/WSDL Design view IDC_VIEW_SCHEMA 34179


Authentic view IDC_VIEW_CONTENT 34177
Browser view IDC_VIEW_BROWSER 34176
Expand + IDC_SEL_EXPAND 34152
Collapse - IDC_SEL_COLLAPSE 34151
Expand fully IDC_SEL_EXPAND_ALL 33463
Collapse unselected IDC_COLLAPSE_UNSELECTED 33428
Optimal widths IDC_OPTIMAL_WIDTHS 34099
Word Wrap IDC_WORD_WRAP 34181
Go to line/char IDC_GOTO_LINE 34073
Go to File IDC_GOTO_FILE 33448
Line Numbers Margin IDC_TOGGLE_NUMLINEMARGIN 34168
Bookmarks Margin IDC_TOGGLE_BOOKMARKMARGIN 34163
Source Folding Margin IDC_TOGGLE_FOLDINGMARGIN 34166
Indentation Guides IDC_TOGGLE_INDENTGUIDES 34167

6.3.11 Browser Menu


Commands from the Browser menu:

Menu Text Command Name ID


Back IDC_BROWSER_BACK 34039
Forward IDC_BROWSER_FORWARD 34045
Stop IDC_BROWSER_STOP 34047
Refresh IDC_BROWSER_REFRESH 34046
Fonts/Largest IDC_BROWSER_FONT_LARGEST 34041
Fonts/Larger IDC_BROWSER_FONT_LARGE 34040
Fonts/Medium IDC_BROWSER_FONT_MEDIUM 34042
Fonts/Smaller IDC_BROWSER_FONT_SMALL 34043
Fonts/Smallest IDC_BROWSER_FONT_SMALLEST 34044
Separate window IDC_BROWSER_USE_OWN_FRAME 34048

6.3.12 WSDL Menu


Commands from the WSDL menu:

Menu Text Command Name ID


Messages/Insert message ID_WSDL_MESSAGES_ADDNEWMESSAGE 3371
5
Messages/Delete message ID_WSDL_MESSAGES_DELETESELECTEDMESSAGE 3371
7
Messages/Add message part ID_WSDL_MESSAGES_ADDMESSAGEPART 3371
(parameter) 4
Messages/Delete message part ID_WSDL_MESSAGES_DELETEMESSAGEPART 3371
(parameter) 6

© 2010 Altova GmbH Programmers' Reference


1258 XMLSpy Integration Command Table for XMLSpy

Operations/Insert Operation ID_WSDL_OPERATIONS_INSERTOPERATION 3372


5
Operations/Delete operation ID_WSDL_OPERATIONS_DELETEOPERATION 3372
4
Operations/Add input element ID_WSDL_OPERATIONS_ADDINPUTFUNCTION 3371
9
Operations/Add output element ID_WSDL_OPERATIONS_ADDOUTPUTFUNCTION 3372
1
Operations/Add fault element ID_WSDL_OPERATIONS_ADDFAULTFUNCTION 3371
8
Operations/Delete input/output/fault ID_WSDL_OPERATIONS_DELETEINPUTOUTPUTFUNC 3372
element TION 3
Operations/Add new message to ID_WSDL_OPERATIONS_ADDNEWMESSAGETOTHISE 3372
intput/output/fault element LEMENT 0
Operations/empty operation ID_WSDL_OPERATIONS_APPENDAOPERATIONTOTHI 3372
SPORTTYPE 2
PortType/Insert portType ID_WSDL_PORTTYPE_INSERTAPORTTYPE 3372
7
PortType/Delete PortType ID_WSDL_PORTTYPE_DELETETHISPORTTYPE 3372
6
Binding/Insert binding ID_WSDL_BINDING_NEWBINDING 3371
3
Binding/Delete binding ID_WSDL_BINDING_DELETEBINDING 3371
1
Binding/Append Child/soap:body ID_WSDL_BINDING_APPENDEXTENSIBILITY_SOAPBO 3370
DY 6
Binding/Append Child/soap:header ID_WSDL_BINDING_APPENDEXTENSIBILITY_SOAPHE 3370
ADER 8
Binding/Append ID_WSDL_BINDING_APPENDEXTENSIBILITY_SOAPHE 3370
Child/soap:headerfault ADERFAULT 9
Binding/Append Child/soap:fault ID_WSDL_BINDING_APPENDEXTENSIBILITY_SOAPFA 3370
ULT 7
Binding/Append Child/mime:content ID_WSDL_BINDING_APPENDEXTENSIBILITY_MIMECO 3370
NTENT 2
Binding/Append ID_WSDL_BINDING_APPENDEXTENSIBILITY_MIMEMUL 3370
Child/mime:multipartrelated TIPARTRELATED 4
Binding/Append Child/mime:part ID_WSDL_BINDING_APPENDEXTENSIBILITY_MIMEPAR 3370
T 5
Binding/Append ID_WSDL_BINDING_APPENDEXTENSIBILITY_MIMEMIM 3370
Child/mime:mimeXml EXML 3
Binding/Append ID_WSDL_BINDING_APPENDEXTENSIBILITY_HTTPURL 3370
Child/http:urlencoded ENCODED 0
Binding/Append ID_WSDL_BINDING_APPENDEXTENSIBILITY_HTTPURL 3370
Child/http:urlreplacement REPLACEMENT 1
Binding/Delete extensibility element ID_WSDL_BINDING_DELETEEXTESIBILITY 3371
2
Service/Insert service ID_WSDL_SERVICE_INSERTSERVICE 3373
1
Service/Delete service ID_WSDL_SERVICE_DELETETHISSERVICE 3372
9
Service/Insert port ID_WSDL_SERVICE_INSERTNEWPORT 3373
0
Service/Delete port ID_WSDL_SERVICE_DELETETHISPORT 3372
8

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Command Table for XMLSpy 1259

Types/New schema ID_WSDL_TYPES_NEWSCHEMA 3373


3
Types/Edit schema(s) in Schema ID_WSDL_TYPES_EDITTHISSCHEMA 3373
View 2
Save Diagram... IDC_WSDL_SAVE_DIAGRAM 3400
1
Generate Documentation... ID_WSDL_GENERATEDOCUMENTATION 3423
3
Reparse WSDL document IDC_WSDL_REPARSE 3377
4

6.3.13 SOAPMenu
Commands from the SOAP menu:

Menu Text Command Name ID


Create new SOAP request ID_SOAP_GENERATESOAPMESSAGE 34224
Send request to server ID_SOAP_SENDREQUESTTOSERVER 34225
Change SOAP request parameters ID_SOAP_SOAPREQUESTSETTINGS 34227
Soap Debugger Session ID_SOAP_SOAPDEBUGGER 34226
Go ID_SOAPDEBUGGER_BUTTONPLAY 34221
Single Step ID_SOAPDEBUGGER_SINGLESTEP 34222
Break on next Request ID_SOAPDEBUGGER_BREAKONNEXTREQUEST 34219
Break on next Response ID_SOAPDEBUGGER_BREAKONNEXTRESPONSE 34220
Stop the proxy server ID_SOAPDEBUGGER_STOPSERVER 34223
Soap Debugger Options ID_SOAPDEBUGGEROPTIONS 34218

6.3.14 Tools Menu


Commands from the Tools menu:

Menu Text Command Name ID


Spelling... IDC_SPELL_CHECK 34154
Spelling options... IDC_SPELL_OPTIONS 34155
Switch to Scripting environment... ID_WINDOW_SWITCHTOVBA 34231
Show macros... ID_WINDOW_VBAMACROS 34232
Project/Assign Scripts to Project ID_SCRIPTINGPRJ_ASSIGN 34214
Project/Unassign Scripts from Project ID_SCRIPTINGPRJ_UNASSIGN 34215
Project/Project Scripts active ID_SCRIPTINGPRJ_ACTIVE 34213
Compare open file with... ID_XMLDIFF_CHOOSE_FILES 34235
Compare directories... ID_XMLDIFF_CHOOSE_DIRECTORIES 34234
Compare options... ID_XMLDIFF_SETTINGS 34236
Customize... IDC_CUSTOMIZE 34055
Options... IDC_SETTINGS 33300
<placeholder> ID_SCRIPTING_MACROITEMS 34249

© 2010 Altova GmbH Programmers' Reference


1260 XMLSpy Integration Command Table for XMLSpy

6.3.15 Window Menu


Commands from the Window menu:

Menu Text Command Name ID


Cascade ID_WINDOW_CASCADE 57650
Tile horizontally ID_WINDOW_TILE_HORZ 57651
Tile vertically ID_WINDOW_TILE_VERT 57652
Project window IDC_PROJECT_WINDOW 34128
Info window IDC_INFO_WINDOW 34085
Entry Helpers IDC_ENTRY_HELPERS 34062
Output windows IDC_OUTPUT_DIALOGBARS 34004
Project and Entry Helpers IDC_PROJECT_ENTRYHELPERS 34006
All on/off IDC_ALL_BARS 34031

6.3.16 Help Menu


Commands from the Help menu:

Menu Text Command Name ID


Table of Contents... IDC_HELP_CONTENTS 34076
Index... IDC_HELP_INDEX 34077
Search... IDC_HELP_SEARCH 34079
Keyboard Map... IDC_HELP_KEYMAPDLG 34078
Software Activation... IDC_ACTIVATION 34005
Order Form... IDC_OPEN_ORDER_PAGE 34094
Registration... IDC_REGISTRATION 34131
Check for Updates... IDC_CHECK_FOR_UPDATES 34275
Support Center... IDC_OPEN_SUPPORT_PAGE 34096
FAQ on the Web... IDC_SHOW_FAQ 34153
Download Components and Free IDC_OPEN_COMPONENTS_PAGE 34093
Tools...
XMLSpy on the Internet.. IDC_OPEN_XML_SPY_HOME 34098
XMLSpy Training... ID_HELP_XMLSPYTRAINING 34210
About XMLSpy... ID_APP_ABOUT 57664

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Accessing XMLSpyAPI 1261

6.4 Accessing XMLSpyAPI


The focus of this documentation is the ActiveX controls and interfaces required to integrate the
XMLSpy user interface into your application. To allow you to automate or control the
functionality of the integrated components, the following properties give you access to the
XMLSpy automation interface (XMLSpyAPI):
XMLSpyControl.Application
XMLSpyControlDocument.Document
XMLSpyControlPlaceHolder.Project

Some restrictions apply to the usage of the XMLSpy automation interface when integrating
XMLSpyControl at document-level. See Integration at document level for details.

© 2010 Altova GmbH Programmers' Reference


1262 XMLSpy Integration Object Reference

6.5 Object Reference


Objects:
XMLSpyCommand
XMLSpyCommands
XMLSpyControl
XMLSpyControlDocument
XMLSpyControlPlaceHolder

To give access to standard XMLSpy functionality, objects of the XMLSpy automation interface
can be accessed as well. See XMLSpyControl.Application,
XMLSpyControlDocument.Document and XMLSpyControlPlaceHolder.Project for more
information.

6.5.1 XMLSpyCommand
Properties:
ID
Label
IsSeparator
ToolTip
StatusText
Accelerator
SubCommands

Description:
Each Command object can be one of three possible types:

 Command: ID is set to a value greater 0 and Label is set to the command name.
IsSeparator is false and the SubCommands collection is empty.
 Separator: IsSeparator is true. ID is 0 and Label is not set. The SubCommands
collection is empty.
 (Sub) Menu: The SubCommands collection contains Command objects and Label is
the name of the menu. ID is set to 0 and IsSeparator is false.

Accelerator
Property: Label as string

Description:
For command objects that are children of the ALL_COMMANDS collection, this is the
accelerator key defined for the command. If the command has no accelerator key assigned, this
property returns the empty string.

The string representation of the accelerator key has the following format:
[ALT+][CTRL+][SHIFT+]key
Where key is converted using the Windows Platform SDK function GetKeyNameText.

ID
Property: ID as long

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Object Reference 1263

Description:
ID is 0 for separators and menus.
For commands, this is the ID which can be used with Exec and QueryStatus.

IsSeparator
Property: IsSeparator as boolean

Description:
True if the command is a separator.

Label
Property: Label as string

Description:
Label is empty for separators.
For command objects that are children of the ALL_COMMANDS collection, this is a unique
name. Command icons are stored in files with this name. See Query Commands for more
information.

For command objects that are children of menus, the label property holds the command's menu
text.
For sub-menus, this property holds the menu text.

StatusText
Property: Label as string

Description:
For command objects that are children of the ALL_COMMANDS collection, this is the text
shown in the status bar when the command is selected.

SubCommands
Property: SubCommands as Commands

Description:
The SubCommands collection holds any sub-commands if this command is actually a menu or
submenu.

ToolTip
Property: ToolTip as string

Description:
For command objects that are children of the ALL_COMMANDS collection, this is the text
shown as tool-tip.

6.5.2 XMLSpyCommands
Properties:
Count

© 2010 Altova GmbH Programmers' Reference


1264 XMLSpy Integration Object Reference

Item

Description:
Collection of Command objects to get access to command labels and IDs of the XMLSpyControl.
Those commands can be executed with the Exec method and their status can be queried with
QueryStatus.

Count
Property: Count as long

Description:
Number of Command objects on this level of the collection.

Item
Property: Item (n as long) as Command

Description:
Gets the command with the index n in this collection. Index is 1-based.

6.5.3 XMLSpyControl
Properties:
IntegrationLevel
Appearance
Application
BorderStyle
CommandsList
CommandsStructure (deprecated)
EnableUserPrompts
MainMenu
Toolbars

Methods:
Open
Exec
QueryStatus

Events:
OnUpdateCmdUI
OnOpenedOrFocused
OnCloseEditingWindow
OnFileChangedAlert
OnContextChanged
OnDocumentOpened
OnValidationWindowUpdated

This object is a complete ActiveX control and should only be visible if the XMLSpy library is
used in the Application Level mode.

CLSID: a258bba2-3835-4c16-8590-72b44f52c471
ProgID: Altova.XMLSpyControl

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Object Reference 1265

Properties
The following properties are defined:
IntegrationLevel
EnableUserPrompts
Appearance
BorderStyle

Command related properties:


CommandsList
MainMenu
Toolbars
CommandsStructure (deprecated)

Access to XMLSpyAPI:
Application

Appearance
Property: Appearance as short

Dispatch Id: -520

Description:
A value not equal to 0 displays a client edge around the control. Default value is 0.

Application
Property: Application as Application

Dispatch Id: 1

Description:
The Application property gives access to the Application object of the complete XMLSpy
automation server API. The property is read-only.

BorderStyle
Property: BorderStyle as short

Dispatch Id: -504

Description:
A value of 1 displays the control with a thin border. Default value is 0.

CommandsList
Property: CommandList as Commands (read-only)

Dispatch Id: 1004

Description:

© 2010 Altova GmbH Programmers' Reference


1266 XMLSpy Integration Object Reference

This property returns a flat list of all commands defined available with XMLSpyControl. For more
information see C# Sample.

EnableUserPrompts
Property: EnableUserPrompts as boolean

Dispatch Id: 1006

Description:
Setting this property to false, disables user prompts in the control. The default value is true.

IntegrationLevel
Property: IntegrationLevel as ICActiveXIntegrationLevel

Dispatch Id: 1000

Description:
The IntegrationLevel property determines the operation mode of the control. See also
Integration at the application level and Integration at document level for more information.

Note: It is important to set this property immediately after the creation of the XMLSpyControl
object.

MainMenu
Property: MainMenu as C om m and(read-only)

Dispatch Id: 1003

Description:
This property gives access to the description of the XMLSpyControl main menu. For more
information see C# Sample.

Toolbars
Property: Toolbars as C om m ands(read-only)

Dispatch Id: 1005

Description:
This property returns a list of all toolbar descriptions that describe all toolbars available with
XMLSpyControl. For more information see C# Sample.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Object Reference 1267

Methods
The following methods are defined:
Open
Exec
QueryStatus

Exec
Method: Exec (nCmdID as long) as boolean

Dispatch Id: 6

Description:
Exec calls the XMLSpy command with the ID nCmdID. If the command can be executed, the
method returns true. See also CommandsStructure to get a list of all available commands
and QueryStatus to retrieve the status of any command.

Open
Method: Open (strFilePath as string) as boolean

Dispatch Id: 5

Description:
The result of the method depends on the extension passed in the argument strFilePath. If
the file extension is .sps, a new document is opened. If the file extension is .svp, the
corresponding project is opened. If a different file extension is passed into the method, the
control tries to load the file as a new component into the active document.

Do not use this method to load documents or projects when using the control in document-level
integration mode. Instead, use XMLSpyControlDocument.Open and
XMLSpyControlPlaceHolder.OpenProject.

QueryStatus
Method: QueryStatus (nCmdID as long) as long

Dispatch Id: 7

Description:
QueryStatus returns the enabled/disabled and checked/unchecked status of the command
specified by nCmdID. The status is returned as a bit mask.

Bit Value Name Meaning

-----------------------------------------------------------------------------------------------------------------------
0 1 Supported Set if the command is supported.
1 2 Enabled Set if the command is enabled (can be
executed).
2 4 Checked Set if the command is checked.

This means that if QueryStatus returns 0 the command ID is not recognized as a valid
XMLSpy command. If QueryStatus returns a value of 1 or 5, the command is disabled.

© 2010 Altova GmbH Programmers' Reference


1268 XMLSpy Integration Object Reference

Events
The XMLSpyControl ActiveX control provides the following connection point events:
OnUpdateCmdUI
OnOpenedOrFocused
OnCloseEditingWindow
OnFileChangedAlert
OnContextChanged

OnDocumentOpened
OnValidationWindowUpdated

OnCloseEditingWindow
Event: OnCloseEditingWindow (i_strFilePath as String) as boolean

Dispatch Id: 1002

Description:
This event is triggered when XMLSpy needs to close an already open document. As an answer
to this event, clients should close the editor window associated with i_strFilePath. Returning true
from this event indicates that the client has closed the document. Clients can return false if no
specific handling is required and XMLSpyControl should try to close the editor and destroy the
associated document control.

OnContextChanged
Event: OnContextChanged (i_strContextName as String, i_bActive as bool) as bool

Dispatch Id: 1004

Description:
This event is triggered when XMLSpy activates or de-actives one of the following operational
contexts:
 XSLT Profiling - "XSLTProfiling" is passed as the context name
 XSLT / XQuery debugging - "DebuggingXSLT" is passed as the context name
 SOAP debugging - "DebuggingSOAP" is passed as the context name

OnDocumentOpened
Event: OnDocumentOpened (objDocument as Document)

Dispatch Id: 1

Description:
This event is triggered whenever a document is opened. The argument objDocument is a
Document object from the XMLSpy automation interface and can be used to query for more
details about the document, or perform additional operations. When integrating on
document-level, it is often better to use the event
XMLSpyControlDocument.OnDocumentOpened instead.

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Object Reference 1269

OnFileChangedAlert
Event: OnFileChangedAlert (i_strFilePath as String) as bool

Dispatch Id: 1001

Description:
This event is triggered when a file loaded with XMLSpyControl, is changed on the harddisk by
another application. Clients should return true, if they handled the event, or false, if XMLSpy
should handle it in its customary way, i.e. prompting the user for reload.

OnLicenseProblem
Event: OnLicenseProblem (i_strLicenseProblemText as String)

Dispatch Id: 1005

Description:
This event is triggered when XMLSpyControl detects that no valid license is available for this
control. In case of restricted user licenses this can happen some time after the control has been
initialized. Integrators should use this event to disable access to this control's functionality. After
returning from this event, the control will block access to its functionality (e.g. show empty
windows in its controls and return errors on requests).

OnOpenedOrFocused
Event: OnOpenedOrFocused (i_strFilePath as String, i_bOpenWithThisControl as
bool)

Dispatch Id: 1000

Description:
When integrating at application level, this event informs clients that a document has been
opened, or made active by XMLSpy.
When integrating at document level, this event instructs the client to open the file
i_strFilePath in a document window. If the file is already open, the corresponding
document window should be made the active window.

if i_bOpenWithThisControl is true, the document must be opened with XMLSpyControl,


since internal access is required. Otherwise, the file can be opened with different editors.

OnToolWindowUpdated
Event: OnToolWindowUpdated(pToolWnd as long )

Dispatch Id: 1006

Description:
This event is triggered when the tool window is updated.

© 2010 Altova GmbH Programmers' Reference


1270 XMLSpy Integration Object Reference

OnUpdateCmdUI
Event: OnUpdateCmdUI ()

Dispatch Id: 1003

Description:
Called frequently to give integrators a good opportunity to check status of XMLSpy commands
using XMLSpyControl.QueryStatus. Do not perform long operations in this callback.

OnValidationWindowUpdated
Event: OnValidationWindowUpdated ()

Dispatch Id: 3

Description:
This event is triggered whenever the validation output window, is updated with new information.

6.5.4 XMLSpyControlDocument
Properties:
Appearance
BorderStyle
Document
IsModified
Path
ReadOnly

Methods:
Exec
New
Open
QueryStatus
Reload
Save
SaveAs

Events:
OnDocumentOpened
OnDocumentClosed
OnModifiedFlagChanged
OnContextChanged
OnFileChangedAlert
OnActivate

If the XMLSpyControl is integrated in the Document Level mode each document is displayed in
an own object of type XMLSpyControlDocument. The XMLSpyControlDocument contains
only one document at the time but can be reused to display different files one after another.

This object is a complete ActiveX control.

CLSID: 52A552E6-2AB8-4e3e-B545-BE998233DDA0
ProgID: Altova.XMLSpyControlDocument

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Object Reference 1271

Properties
The following properties are defined:
ReadOnly
IsModified
Path
Appearance
BorderStyle

Access to XMLSpyAPI:
Document

Appearance
Property: Appearance as short

Dispatch Id: -520

Description:
A value not equal to 0 displays a client edge around the document control. Default value is 0.

BorderStyle
Property: BorderStyle as short

Dispatch Id: -504

Description:
A value of 1 displays the control with a thin border. Default value is 0.

Document
Property: Document as Document

Dispatch Id: 1

Description:
The Document property gives access to the Document object of the XMLSpy automation
server API. This interface provides additional functionalities which can be used with the
document loaded in the control. The property is read-only.

IsModified
Property: IsModified as boolean (read-only)

Dispatch Id: 1006

Description:
IsModified is true if the document content has changed since the last open, reload or save
operation. It is false, otherwise.

© 2010 Altova GmbH Programmers' Reference


1272 XMLSpy Integration Object Reference

Path
Property: Path as string

Dispatch Id: 1005

Description:
Sets or gets the full path name of the document loaded into the control.

ReadOnly
Property: ReadOnly as boolean

Dispatch Id: 1007

Description:
Using this property you can turn on and off the read-only mode of the document. If ReadOnly
is true it is not possible to do any modifications.

Methods
The following methods are defined:
Document handling:
New
Open
Reload
Save
SaveAs

Command Handling:
Exec
QueryStatus

Exec
Method: Exec (nCmdID as long) as boolean

Dispatch Id: 8

Description:
Exec calls the XMLSpy command with the ID nCmdID. If the command can be executed, the
method returns true. The client should call the Exec method of the document control if there is
currently an active document available in the application.

See also CommandsStructure to get a list of all available commands and QueryStatus to
retrieve the status of any command.

New
Method: New () as boolean

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Object Reference 1273

Dispatch Id: 1000

Description:
This method initializes a new document inside the control..

Open
Method: Open (strFileName as string) as boolean

Dispatch Id: 1001

Description:
Open loads the file strFileName as the new document into the control.

QueryStatus
Method: QueryStatus (nCmdID as long) as long

Dispatch Id: 9

Description:
QueryStatus returns the enabled/disabled and checked/unchecked status of the command
specified by nCmdID. The status is returned as a bit mask.

Bit Value Name Meaning

-----------------------------------------------------------------------------------------------------------------------
0 1 Supported Set if the command is supported.
1 2 Enabled Set if the command is enabled (can be
executed).
2 4 Checked Set if the command is checked.

This means that if QueryStatus returns 0 the command ID is not recognized as a valid
XMLSpy command. If QueryStatus returns a value of 1 or 5 the command is disabled. The
client should call the QueryStatus method of the document control if there is currently an
active document available in the application.

Reload
Method: Reload () as boolean

Dispatch Id: 1002

Description:
Reload updates the document content from the file system.

Save
Method: Save () as boolean

Dispatch Id: 1003

© 2010 Altova GmbH Programmers' Reference


1274 XMLSpy Integration Object Reference

Description:
Save saves the current document at the location Path.

SaveAs
Method: OpenDocument (strFileName as string) as boolean

Dispatch Id: 1004

Description:
SaveAs sets Path to strFileName and then saves the document to this location.

Events
The XMLSpyControlDocument ActiveX control provides following connection point events:
OnDocumentOpened
OnDocumentClosed
OnModifiedFlagChanged
OnContextChanged
OnFileChangedAlert
OnActivate
OnSetEditorTitle

OnActivate
Event: OnActivate ()

Dispatch Id: 1005

Description:
This event is triggered when the document control is activated, has the focus, and is ready for
user input.

OnContextChanged
Event: OnContextChanged (i_strContextName as String, i_bActive as bool) as bool

Dispatch Id: 1004

Description:
This event is triggered when this document is shown in a different XMLSpy view. The following
values are passed:
 Grid view - "View_0" is passed as the context name
 Text view - "View_1" is passed as the context name
 Browser view - "View_2" is passed as the context name
 Schema view - "View_3" is passed as the context name
 Authentic view - "View_4" is passed as the context name
 WSDL view - "View_5" is passed as the context name

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Object Reference 1275

OnDocumentClosed
Event: OnDocumentClosed (objDocument as Document)

Dispatch Id: 1001

Description:
This event is triggered whenever the document loaded into this control is closed. The argument
objDocument is a Document object from the XMLSpy automation interface and should be
used with care.

OnDocumentOpened
Event: OnDocumentOpened (objDocument as Document)

Dispatch Id: 1000

Description:
This event is triggered whenever a document is opened in this control. The argument
objDocument is a Document object from the XMLSpy automation interface, and can be used
to query for more details about the document, or perform additional operations.

OnDocumentSaveAs
Event: OnContextDocumentSaveAs (i_strFileName as String)

Dispatch Id: 1007

Description:
This event is triggered when this document gets internally saved under a new name.

OnFileChangedAlert
Event: OnFileChangedAlert () as bool

Dispatch Id: 1003

Description:
This event is triggered when the file loaded into this document control, is changed on the
harddisk by another application. Clients should return true, if they handled the event, or false, if
XMLSpy should handle it in its customary way, i.e. prompting the user for reload.

OnModifiedFlagChanged
Event: OnModifiedFlagChanged (i_bIsModified as boolean)

Dispatch Id: 1002

Description:
This event gets triggered whenever the document changes between modified and unmodified
state. The parameter i_bIsModifed is true if the document contents differs from the original
content, and false, otherwise.

© 2010 Altova GmbH Programmers' Reference


1276 XMLSpy Integration Object Reference

OnSetEditorTitle
Event: OnSetEditorTitle ()

Dispatch Id: 1006

Description:
This event is being raised when the contained document is being internally renamed.

6.5.5 XMLSpyControlPlaceHolder
Properties available for all kinds of placeholder windows:
PlaceholderWindowID

Properties for project placeholder window:


Project

Methods for project placeholder window:


OpenProject
CloseProject

The XMLSpyControlPlaceHolder control is used to show the additional XMLSpy windows


like Overview, Library or Project window. It is used like any other ActiveX control and can be
placed anywhere in the client application.

CLSID: 135DEEF4-6DF0-47c2-8F8C-F145F5F3F672
ProgID: Altova.XMLSpyControlPlaceHolder

Properties
The following properties are defined:
PlaceholderWindowID

Access to XMLSpyAPI:
Project

Label
Property: Label as String (read-only)

Dispatch Id: 1001

Description:
This property gives access to the title of the placeholder. The property is read-only.

PlaceholderWindowID
Property: PlaceholderWindowID as XMLSpyControlPlaceholderWindow

Dispatch Id: 1

Description:

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Object Reference 1277

Using this property the object knows which XMLSpy window should be displayed in the client
area of the control. The PlaceholderWindowID can be set at any time to any valid value of
the XMLSpyControlPlaceholderWindow enumeration. The control changes its state
immediately and shows the new XMLSpy window.

Project
Property: Project as Project (read-only)

Dispatch Id: 2

Description:
The Project property gives access to the Project object of the XMLSpy automation server
API. This interface provides additional functionalities which can be used with the project loaded
into the control. The property will return a valid project interface only if the placeholder window
has PlaceholderWindowID with a value of XMLSpyXProjectWindow (=3). The property
is read-only.

Methods
The following method is defined:
OpenProject
CloseProject

OpenProject
Method: OpenProject (strFileName as string) as boolean

Dispatch Id: 3

Description:
OpenProject loads the file strFileName as the new project into the control. The method will
fail if the placeholder window has a PlaceholderWindowID different to
XMLSpyXProjectWindow (=3).

CloseProject
Method: CloseProject ()

Dispatch Id: 4

Description:
CloseProject closes the project loaded the control. The method will fail if the placeholder
window has a PlaceholderWindowID different to XMLSpyXProjectWindow (=3).

Events
The XMLSpyControlPlaceholder ActiveX control provides following connection point events:
OnModifiedFlagChanged

© 2010 Altova GmbH Programmers' Reference


1278 XMLSpy Integration Object Reference

OnModifiedFlagChanged
Event: OnModifiedFlagChanged (i_bIsModified as boolean)

Dispatch Id: 1

Description:
This event gets triggered only for placeholder controls with a PlaceholderWindowID of
XMLSpyXProjectWindow (=3). The event is fired whenever the project content changes
between modified and unmodified state. The parameter i_bIsModifed is true if the project
contents differs from the original content, and false, otherwise.

OnSetLabel
Event: OnSetLabel(i_strNewLabel as string)

Dispatch Id: 1000

Description:
Raised when the title of the placeholder window is changed.

6.5.6 Enumerations
The following enumerations are defined:
ICActiveXIntegrationLevel
XMLSpyControlPlaceholderWindow

ICActiveXIntegrationLevel
Possible values for the IntegrationLevel property of the XMLSpyControl.

ICActiveXIntegrationOnApplicationLevel = 0
ICActiveXIntegrationOnDocumentLevel = 1

XMLSpyControlPlaceholderWindow
This enumeration contains the list of the supported additional XMLSpy windows.

XMLSpyControlNoToolWnd = -1
XMLSpyControlEntryHelperTopToolWnd = 0
XMLSpyControlEntryHelperMiddleToolWnd = 1
XMLSpyControlEntryHelperBottomToolWnd = 2
XMLSpyControlValidatorOutputToolWnd = 3
XMLSpyControlProjectWindowToolWnd = 4
XMLSpyControlXSLTDebuggerContextToolWnd = 5
XMLSpyControlXSLTDebuggerCallstackToolWnd = 6
XMLSpyControlXSLTDebuggerVariableToolWnd = 7
XMLSpyControlXSLTDebuggerWatchToolWnd = 8
XMLSpyControlXSLTDebuggerTemplateToolWnd = 9
XMLSpyControlXSLTDebuggerInfoToolWnd = 10
XMLSpyControlXSLTDebuggerMessageToolWnd = 11
XMLSpyControlXSLTDebuggerTraceToolWnd = 12

Altova XMLSpy 2011 © 2010 Altova GmbH


XMLSpy Integration Object Reference 1279

XMLSpyControlSOAPDebuggerToolWnd = 13
XMLSpyControlXPathProfilerListToolWnd = 14
XMLSpyControlXPathProfilerTreeToolWnd = 15
XMLSpyControlXPathDialogToolWnd = 16
XMLSpyControlDBQueryManagerToolWnd = 17
XMLSpyControlInfoToolWnd = 18
XMLSpyControlXSLOutlineToolWnd = 19
XMLSpyControlSchemaFindToolWnd = 20

© 2010 Altova GmbH Programmers' Reference


Altova XMLSpy 2011

Appendices
1282

Appendices

These appendices contain technical information about XMLSpy and important licensing
information. Each appendix contains sub-sections as given below:

Engine Information
 Altova XSLT 1.0 Engine
 Altova XSLT 2.0 Engine
 Altova XQuery 1.0 Engine
 XPath 2.0 and XQuery 1.0 Functions
 Extensions

Datatype Conversions between DBs and XML Schemas


 DBs to XML Schemas
 XML Schemas to DBs

Technical Data
 OS and memory requirements
 Altova XML Parser
 Altova XSLT and XQuery Engines
 Unicode support
 Internet usage

License Information
 Electronic software distribution
 Software activation and license metering
 Copyrights
 End User License Agreement

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information 1283

1 Engine Information
This section contains information about implementation-specific features of the Altova XSLT 1.0
Engine, Altova XSLT 2.0 Engine, and Altova XQuery 1.0 Engine.

© 2010 Altova GmbH Appendices


1284 Engine Information XSLT 1.0 Engine: Implementation Information

1.1 XSLT 1.0 Engine: Implementation Information


The Altova XSLT 1.0 Engine is built into Altova's XMLSpy, StyleVision, Authentic, and
MapForce XML products. It is also available in the free AltovaXML package. The Altova XSLT
1.0 Engine implements and conforms to the World Wide Web Consortium's XSLT 1.0
Recommendation of 16 November 1999 and XPath 1.0 Recommendation of 16 November 1999
. Limitations and implementation-specific behavior are listed below.

Limitations
 The xsl:preserve-space and xsl:strip-space elements are not supported.
 When the method attribute of xsl:output is set to HTML, or if HTML output is
selected by default, then special characters in the XML or XSLT file are inserted in the
HTML document directly as special characters; they are not inserted as HTML
character references in the output. For instance, the character &#160; (the decimal
character reference for a non-breaking space) is not inserted as &nbsp; in the HTML
code, but directly as a non-breaking space.

Implementation's handling of whitespace-only nodes in source XML document


The XML data (and, consequently, the XML Infoset) that is passed to the Altova XSLT 1.0
Engine is stripped of boundary-whitespace-only text nodes. (A boundary-whitespace-only text
node is a whitespace-only text node that occurs between two elements within an element of
mixed content.) This stripping may have an effect on the value returned by the
fn:position(), fn:last(), and fn:count() functions.

For any node selection that selects text nodes also, boundary-whitespace-only text nodes would
typically also be included in the selection. However, since the XML Infoset used by the Altova
engines has boundary-whitespace-only text nodes stripped from it, these nodes are not present
in the XML Infoset. As a result, the size of the selection and the numbering of nodes in the
selection will be different than that for a selection which included these text nodes. The
fn:position(), fn:last(), and fn:count() functions, therefore, could produce results
that are different from those produced by some other processors.

A situation in which boundary-whitespace-only text nodes are evaluated as siblings of other


elements arises most commonly when xsl:apply-templates is used to apply templates.
When the fn:position(), fn:last(), and fn:count() functions are used in patterns with
a name test (for example, para[3], which is short for para[position()=3]),
boundary-whitespace-only nodes are irrelevant since only the named elements (para in the
above example) are selected. (Note, however, that boundary-whitespace-only nodes are
relevant in patterns that use the wildcard, for example, *[10].)

Note: If a boundary-whitespace-only text node is required in the output, then insert the required
whitespace within one of the two adjoining child elements. For example, the XML fragment:
<para>This is <b>bold</b> <i>italic</>.</para>

when processed with the XSLT template


<xsl:template match="para">
<xsl:apply-templates/>
</xsl:template>

will produce:
This is bolditalic.

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information XSLT 1.0 Engine: Implementation Information 1285

To get a space between bold and italic in the output, insert a space character within either
the <b> or <i> elements in the XML source. For example:
<para>This is <b>bold</b> <i> italic</i>.</para> or
<para>This is <b>bold&#x20;</b> <i>italic</i>.</para> or
<para>This is <b>bold</b><i>&#x20;italic</i>.</para>

When any of the para elements above is processed with the same XSLT template given
above, it will produce:
This is bold italic.

© 2010 Altova GmbH Appendices


1286 Engine Information XSLT 2.0 Engine: Implementation Information

1.2 XSLT 2.0 Engine: Implementation Information


The Altova XSLT 2.0 Engine is built into Altova's XMLSpy, StyleVision, Authentic, and
MapForce XML products. It is also available in the free AltovaXML package. This section
describes the engine's implementation-specific aspects of behavior. It starts with a section
giving general information about the engine, and then goes on to list the implementation-specific
behavior of XSLT 2.0 functions.

For information about implementation-specific behavior of XPath 2.0 functions, see the section,
XPath 2.0 and XQuery 1.0 Functions.

1.2.1 General Information


The Altova XSLT 2.0 Engine conforms to the World Wide Web Consortium's (W3C's) XSLT
2.0 Recommendation of 23 January 2007. Note the following general information about the
engine.

Backwards Compatibility
The Altova XSLT 2.0 Engine is backwards compatible. The only time the backwards
compatibility of the XSLT 2.0 Engine comes into play is when using the XSLT 2.0 Engine of
Altova XML to process an XSLT 1.0 stylesheet. Note that there could be differences in the
outputs produced by the XSLT 1.0 Engine and the backwards-compatible XSLT 2.0 Engine.

In all other Altova products, the backwards-compatibility issue never arises. This is because
these products automatically select the appropriate engine for the transformation. For example,
consider that in XMLSpy you specify that a certain XML document be processed with an XSLT
1.0 stylesheet. When the transformation command is invoked, XMLSpy automatically selects
the XSLT 1.0 Engine of XMLSpy to carry out the transformation.

Note: The stylesheet version is specified in the version attribute of the stylesheet or
transform element of the stylesheet.

Namespaces
Your XSLT 2.0 stylesheet should declare the following namespaces in order for you to be able
to use the type constructors and functions available in XSLT 2.0. The prefixes given below are
conventionally used; you could use alternative prefixes if you wish.

Namespace Name Prefix Namespace URI


XML Schema types xs: http://www.w3.org/2001/XMLSchema
XPath 2.0 functions fn: http://www.w3.org/2005/xpath-functions

Typically, these namespaces will be declared on the xsl:stylesheet or xsl:transform


element, as shown in the following listing:
<xsl:stylesheet version="2.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:fn="http://www.w3.org/2005/xpath-functions"
...
</xsl:stylesheet>

The following points should be noted:

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information XSLT 2.0 Engine: Implementation Information 1287

 The Altova XSLT 2.0 Engine uses the XPath 2.0 and XQuery 1.0 Functions namespace
(listed in the table above) as its default functions namespace. So you can use XPath
2.0 and XSLT 2.0 functions in your stylesheet without any prefix. If you declare the
XPath 2.0 Functions namespace in your stylesheet with a prefix, then you can
additionally use the prefix assigned in the declaration.
 When using type constructors and types from the XML Schema namespace, the prefix
used in the namespace declaration must be used when calling the type constructor (for
example, xs:date).
 With the CRs of 23 January 2007, the untypedAtomic and duration datatypes (
dayTimeDuration and yearMonthDuration), which were formerly in the XPath
Datatypes namespace (typically prefixed xdt:) have been moved to the XML Schema
namespace.
 Some XPath 2.0 functions have the same name as XML Schema datatypes. For
example, for the XPath functions fn:string and fn:boolean there exist XML
Schema datatypes with the same local names: xs:string and xs:boolean. So if
you were to use the XPath expression string('Hello'), the expression evaluates
as fn:string('Hello')—not as xs:string('Hello').

Schema-awareness
The Altova XSLT 2.0 Engine is schema-aware.

Whitespace in XML document


By default, the Altova XSLT 2.0 Engine strips all boundary whitespace from
boundary-whitespace-only nodes in the source XML document. The removal of this whitespace
affects the values that the fn:position(), fn:last(), fn:count(), and
fn:deep-equal() functions return. For more details, see Whitespace-only Nodes in XML
Document in the XPath 2.0 and XQuery 1.0 Functions section.

Note: If a boundary-whitespace-only text node is required in the output, then insert the required
whitespace within one of the two adjoining child elements. For example, the XML fragment:
<para>This is <b>bold</b> <i>italic</>.</para>

when processed with the XSLT template


<xsl:template match="para">
<xsl:apply-templates/>
</xsl:template>

will produce:
This is bolditalic.

To get a space between bold and italic in the output, insert a space character within either
the <b> or <i> elements in the XML source. For example:
<para>This is <b>bold</b> <i> italic</>.</para> or
<para>This is <b>bold&#x20;</b> <i>italic</>.</para> or
<para>This is <b>bold</b><i>&#x20;italic</>.</para>

When such an XML fragment is processed with the same XSLT template given above, it will
produce:
This is bold italic.

XSLT 2.0 elements and functions

© 2010 Altova GmbH Appendices


1288 Engine Information XSLT 2.0 Engine: Implementation Information

Limitations and implementation-specific behavior of XSLT 2.0 elements and functions are listed
in the section XSLT 2.0 Elements and Functions.

XPath 2.0 functions


Implementation-specific behavior of XPath 2.0 functions is listed in the section XPath 2.0 and
XQuery 1.0 Functions.

1.2.2 XSLT 2.0 Elements and Functions


Limitations
The xsl:preserve-space and xsl:strip-space elements are not supported.

Implementation-specific behavior
Given below is a description of how the Altova XSLT 2.0 Engine handles
implementation-specific aspects of the behavior of certain XSLT 2.0 functions.

xsl:result-document
Additionally supported encodings are: base16tobinary and base64tobinary.

function-available
The function tests for the availability of in-scope functions (XSLT 2.0, XPath 2.0, and extension
functions).

unparsed-text
The href attribute accepts (i) relative paths for files in the base-uri folder, and (ii) absolute
paths with or without the file:// protocol. Additionally supported encodings are:
binarytobase16 and binarytobase64.

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information XQuery 1.0 Engine: Implementation Information 1289

1.3 XQuery 1.0 Engine: Implementation Information


The Altova XQuery 1.0 Engine is built into Altova's XMLSpy and MapForce XML products. It is
also available in the free AltovaXML package. This section provides information about
implementation-defined aspects of behavior.

Standards conformance
The Altova XQuery 1.0 Engine conforms to the World Wide Web Consortium's (W3C's) XQuery
1.0 Recommendation of 23 January 2007. The XQuery standard gives implementations
discretion about how to implement many features. Given below is a list explaining how the
Altova XQuery 1.0 Engine implements these features.

Schema awareness
The Altova XQuery 1.0 Engine is schema-aware.

Encoding
The UTF-8 and UTF-16 character encodings are supported.

Namespaces
The following namespace URIs and their associated bindings are pre-defined.

Namespace Name Prefix Namespace URI


XML Schema types xs: http://www.w3.org/2001/XMLSchema
Schema instance xsi: http://www.w3.org/2001/XMLSchema-instance
Built-in functions fn: http://www.w3.org/2005/xpath-functions
Local functions local: http://www.w3.org/2005/xquery-local-functions

The following points should be noted:


 The Altova XQuery 1.0 Engine recognizes the prefixes listed above as being bound to
the corresponding namespaces.
 Since the built-in functions namespace listed above is the default functions namespace
in XQuery, the fn: prefix does not need to be used when built-in functions are invoked
(for example, string("Hello") will call the fn:string function). However, the
prefix fn: can be used to call a built-in function without having to declare the
namespace in the query prolog (for example: fn:string("Hello")).
 You can change the default functions namespace by declaring the default
function namespace expression in the query prolog.
 When using types from the XML Schema namespace, the prefix xs: may be used
without having to explicitly declare the namespaces and bind these prefixes to them in
the query prolog. (Example: xs:date and xs:yearMonthDuration.) If you wish to
use some other prefix for the XML Schema namespace, this must be explicitly declared
in the query prolog. (Example: declare namespace alt =
"http://www.w3.org/2001/XMLSchema"; alt:date("2004-10-04").)
 Note that the untypedAtomic, dayTimeDuration, and yearMonthDuration datatypes
have been moved, with the CRs of 23 January 2007, from the XPath Datatypes
namespace to the XML Schema namespace, so: xs:yearMonthDuration.

If namespaces for functions, type constructors, node tests, etc are wrongly assigned, an error is

© 2010 Altova GmbH Appendices


1290 Engine Information XQuery 1.0 Engine: Implementation Information

reported. Note, however, that some functions have the same name as schema datatypes, e.g.
fn:string and fn:boolean. (Both xs:string and xs:boolean are defined.) The
namespace prefix determines whether the function or type constructor is used.

XML source document and validation


XML documents used in executing an XQuery document with the Altova XQuery 1.0 Engine
must be well-formed. However, they do not need to be valid according to an XML Schema. If
the file is not valid, the invalid file is loaded without schema information. If the XML file is
associated with an external schema and is valid according to it, then post-schema validation
information is generated for the XML data and will be used for query evaluation.

Static and dynamic type checking


The static analysis phase checks aspects of the query such as syntax, whether external
references (e.g. for modules) exist, whether invoked functions and variables are defined, and so
on. No type checking is done in the static analysis phase. If an error is detected in the static
analysis phase, it is reported and the execution is stopped.

Dynamic type checking is carried out at run-time, when the query is actually executed. If a type
is incompatible with the requirement of an operation, an error is reported. For example, the
expression xs:string("1") + 1 returns an error because the addition operation cannot be
carried out on an operand of type xs:string.

Library Modules
Library modules store functions and variables so they can be reused. The Altova XQuery 1.0
Engine supports modules that are stored in a single external XQuery file. Such a module file
must contain a module declaration in its prolog, which associates a target namespace. Here is
an example module:
module namespace libns="urn:module-library";
declare variable $libns:company := "Altova";
declare function libns:webaddress() { "http://www.altova.com" };

All functions and variables declared in the module belong to the namespace associated with the
module. The module is used by importing it into an XQuery file with the import module
statement in the query prolog. The import module statement only imports functions and
variables declared directly in the library module file. As follows:
import module namespace modlib = "urn:module-library" at
"modulefilename.xq";
if ($modlib:company = "Altova")
then modlib:webaddress()
else error("No match found.")

External functions
External functions are not supported, i.e. in those expressions using the external keyword, as
in:
declare function hoo($param as xs:integer) as xs:string external;

Collations
The default collation is the Unicode codepoint collation. No other collation is currently
supported. Comparisons, including the fn:max function, are based on this collation.

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information XQuery 1.0 Engine: Implementation Information 1291

Character normalization
No character normalization form is supported.

Precision of numeric types


 The xs:integer datatype is arbitrary-precision, i.e. it can represent any number of
digits.
 The xs:decimal datatype has a limit of 20 digits after the decimal point.
 The xs:float and xs:double datatypes have limited-precision of 15 digits.

XQuery Instructions Support


The Pragma instruction is not supported. If encountered, it is ignored and the fallback
expression is evaluated.

XQuery Functions Support


For information about implementation-specific behavior of XQuery 1.0 functions, see the
section, XPath 2.0 and XQuery 1.0 Functions.

© 2010 Altova GmbH Appendices


1292 Engine Information XPath 2.0 and XQuery 1.0 Functions

1.4 XPath 2.0 and XQuery 1.0 Functions


XPath 2.0 and XQuery 1.0 functions are evaluated by:
 the Altova XPath 2.0 Engine, which (i) is a component of the Altova XSLT 2.0 Engine,
and (ii) is used in the XPath Evaluator of Altova's XMLSpy product to evaluate XPath
expressions with respect to the XML document that is active in the XMLSpy interface.
 the Altova XQuery 1.0 Engine.

This section describes how XPath 2.0 and XQuery 1.0 functions are handled by the Altova
XPath 2.0 Engine and Altova XQuery 1.0 Engine. Only those functions are listed, for which the
behavior is implementation-specific, or where the behavior of an individual function is different in
any of the three environments in which these functions are used (that is, in XSLT 2.0, in XQuery
1.0, and in the XPath Evaluator of XMLSpy). Note that this section does not describe how to use
these functions. For more information about the usage of functions, see the World Wide Web
Consortium's (W3C's) XQuery 1.0 and XPath 2.0 Functions and Operators Recommendation
of 23 January 2007.

1.4.1 General Information


Standards conformance
 The Altova XPath 2.0 Engine implements the World Wide Web Consortium's (W3C's)
XPath 2.0 Recommendation of 23 January 2007. The Altova XQuery 1.0 Engine
implements the World Wide Web Consortium's (W3C's) XQuery 1.0 Recommendation
of 23 January 2007. The XPath 2.0 and XQuery 1.0 functions support in these two
engines is compliant with the XQuery 1.0 and XPath 2.0 Functions and Operators
Recommendation of 23 January 2007.
 The Altova XPath 2.0 Engine conforms to the rules of XML 1.0 (Fourth Edition) and
XML Namespaces (1.0).

Default functions namespace


The default functions namespace has been set to comply with that specified in the standard.
Functions can therefore be called without a prefix.

Boundary-whitespace-only nodes in source XML document


The XML data (and, consequently, the XML Infoset) that is passed to the Altova XPath 2.0
Engine and Altova XQuery 1.0 Engine is stripped of boundary-whitespace-only text nodes. (A
boundary-whitespace-only text node is a child whitespace-only text node that occurs between
two elements within an element of mixed content.) This stripping has an effect on the value
returned by the fn:position(), fn:last(), fn:count(), and fn:deep-equal()
functions.

For any node selection that selects text nodes also, boundary-whitespace-only text nodes would
typically also be included in the selection. However, since the XML Infoset used by the Altova
engines has boundary-whitespace-only text nodes stripped from it, these nodes are not present
in the XML Infoset. As a result, the size of the selection and the numbering of nodes in the
selection will be different than that for a selection which included these text nodes. The
fn:position(), fn:last(), fn:count(), and fn:deep-equal() functions, therefore,
could produce results that are different from those produced by some other processors.

A situation in which boundary-whitespace-only text nodes are evaluated as siblings of other


elements arises most commonly when xsl:apply-templates is used to apply templates.
When the fn:position(), fn:last(), and fn:count() functions are used in patterns with

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information XPath 2.0 and XQuery 1.0 Functions 1293

a name test (for example, para[3], which is short for para[position()=3]),


boundary-whitespace-only nodes are irrelevant since only the named elements (para in the
above example) are selected. (Note, however, that boundary-whitespace-only nodes are
relevant in patterns that use the wildcard, for example, *[10].)

Numeric notation
On output, when an xs:double is converted to a string, scientific notation (for example,
1.0E12) is used when the absolute value is less than 0.000001 or greater than 1,000,000.
Otherwise decimal or integer notation is used.

Precision of xs:decimal
The precision refers to the number of digits in the number, and a minimum of 18 digits is
required by the specification. For division operations that produce a result of type xs:decimal,
the precision is 19 digits after the decimal point with no rounding.

Implicit timezone
When two date, time, or dateTime values need to be compared, the timezone of the values
being compared need to be known. When the timezone is not explicitly given in such a value,
the implicit timezone is used. The implicit timezone is taken from the system clock, and its value
can be checked with the fn:implicit-timezone() function.

Collations
Only the Unicode codepoint collation is supported. No other collations can be used. String
comparisons, including for the fn:max and fn:min functions, are based on this collation.

Namespace axis
The namespace axis is deprecated in XPath 2.0. Use of the namespace axis is, however,
supported. To access namespace information with XPath 2.0 mechanisms, use the
fn:in-scope-prefixes(), fn:namespace-uri() and
fn:namespace-uri-for-prefix() functions.

Static typing extensions


The optional static type checking feature is not supported.

1.4.2 Functions Support


The table below lists (in alphabetical order) the implementation-specific behavior of certain
functions. The following general points should be noted:
 In general, when a function expects a sequence of one item as an argument, and a
sequence of more than one item is submitted, then an error is returned.
 All string comparisons are done using the Unicode codepoint collation.
 Results that are QNames are serialized in the form [prefix:]localname.

Function Name Notes

© 2010 Altova GmbH Appendices


1294 Engine Information XPath 2.0 and XQuery 1.0 Functions

base-uri  If external entities are used in the source XML document and if
a node in the external entity is specified as the input node
argument of the base-uri() function, it is still the base URI of
the including XML document that is used—not the base URI of
the external entity.
 The base URI of a node in the XML document can be modified
using the xml:base attribute.

collection  The argument is a relative URI that is resolved against the


current base URI.
 If the resolved URI identifies an XML file, then this XML file is
treated as a catalog which references a collection of files. This
file must have the form:
<collection>
<doc href="uri-1" />
<doc href="uri-2" />
<doc href="uri-3" />
</collection>
The files referenced by the href attributes are loaded, and their
document nodes are returned as a sequence.
 If the resolved URI does not identify an XML file with the catalog
structure described above, then the argument string (in which
wildcards such as ? and * are allowed) is used as a search
string. XML files with names that match the search expression
are loaded, and their document nodes are returned as a
sequence. See examples below.
 XSLT example: The expression
collection("c:\MyDocs\*.xml")//Title returns a
sequence of all DocTitle elements in the .xml files in the
MyDocs folder.
 XQuery example: The expression {for $i in
collection(c:\MyDocs\*.xml) return element
doc{base-uri($i)}} returns the base URIs of all the .xml files
in the MyDocs folder, each URI being within a doc element.
 The default collection is empty.

Function Name Notes

count  See note on whitespace in the General Information section.

current-date,  The current date and time is taken from the system clock.
current-dateTi  The timezone is taken from the implicit timezone provided by
me, the evaluation context; the implicit timezone is taken from the
current-time system clock.
 The timezone is always specified in the result.

deep-equal  See note on whitespace in the General Information section.

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information XPath 2.0 and XQuery 1.0 Functions 1295

doc  An error is raised only if no XML file is available at the specified


location or if the file is not well-formed. The file is validated if a
schema is available. If the file is not valid, the invalid file is
loaded without schema information.

id  In a well-formed but invalid document that contains two or more


elements having the same ID value, the first element in
document order is returned.

in-scope-prefi  Only default namespaces may be undeclared in the XML


xes document. However, even when a default namespace is
undeclared on an element node, the prefix for the default
namespace, which is the zero-length string, is returned for that
node.

last  See note on whitespace in the General Information section.

lower-case  The Unicode character set is supported.

normalize-unic  The normalization forms NFC, NFD, NFKC, and NFKD are
ode supported.

Function Name Notes

position  See note on whitespace in the General Information section.

resolve-uri  If the second, optional argument is omitted, the URI to be


resolved (the first argument) is resolved against the base URI
from the static context, which is the URI of the XSLT stylesheet
or the base URI given in the prolog of the XQuery document.
 The relative URI (the first argument) is appended after the last
"/" in the path notation of the base URI notation.
 If the value of the first argument is the zero-length string, the
base URI from the static context is returned, and this URI
includes the file name of the document from which the base URI
of the static context is derived (e.g. the XSLT or XML file).

static-base-ur  The base URI from the static context is the base URI of the
i XSLT stylesheet or the base URI specified in the prolog of the
XQuery document.
 When using XPath Evaluator in the XMLSpy IDE, the base URI
from the static context is the URI of the active XML document.

upper-case  The Unicode character set is supported.

© 2010 Altova GmbH Appendices


1296 Engine Information Extensions

1.5 Extensions
There are several ready-made functions in programming languages such as Java and C# that
are not available as XPath 2.0 / XQuery 1.0 functions or as XSLT 2.0 functions. A good
example of such functions are the math functions available in Java, such as sin() and cos().
If these functions were available to the designers of XSLT stylesheets and XQuery queries, it
would increase the application area of stylesheets and queries and greatly simplify the tasks of
stylesheet creators.

Altova Engines (XSLT 1.0, XSLT 2.0, and XQuery 1.0), which are used in a number of Altova
products, support the use of extension functions in Java and .NET. The Altova XSLT Engines
additionally support MSXSL scripts for XSLT 1.0 and 2.0 and Altova's own extension functions.

You should note that extension functions are always called from XPath expressions. This
section describes how to use extension functions and MSXSL scripts in your XSLT stylesheets
and XQuery queries. These descriptions are organized into the following sections:
 Java Extension Functions
 .NET Extension Functions
 MSXSL Scripts for XSLT
 Altova Extension Functions

The two main issues considered in the descriptions are: (i) how functions in the respective
libraries are called; and (ii) what rules are followed for converting arguments in a function call to
the required input format of the function, and what rules are followed for the return conversion
(function result to XSLT/XQuery data object).

Requirements
For extension functions support, a Java Runtime Environment (for access to Java functions)
and .NET Framework 2.0 (minimum, for access to .NET functions) must be installed on the
machine running the XSLT transformation or XQuery execution, or must be accessible for the
transformations.

1.5.1 Java Extension Functions


A Java extension function can be used within an XPath or XQuery expression to invoke a Java
constructor or call a Java method (static or instance).

A field in a Java class is considered to be a method without any argument. A field can be static
or instance. How to access fields is described in the respective sub-sections, static and
instance.

This section is organized into the following sub-sections:


 Java: Constructors
 Java: Static Methods and Static Fields
 Java: Instance Methods and Instance Fields
 Datatypes: XSLT/XQuery to Java
 Datatypes: Java to XSLT/XQuery

Form of the extension function


The extension function in the XPath/XQuery expression must have the form prefix:fname().
 The prefix: part identifies the extension function as a Java function. It does so by

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information Extensions 1297

associating the extension function with an in-scope namespace declaration, the URI of
which must begin with java: (see below for examples). The namespace declaration
should identify a Java class, for example: xmlns:myns="java:java.lang.Math".
However, it could also simply be: xmlns:myns="java" (without a colon), with the
identification of the Java class being left to the fname() part of the extension function.
 The fname() part identifies the Java method being called, and supplies the arguments
for the method (see below for examples). However, if the namespace URI identified by
the prefix: part does not identify a Java class (see preceding point), then the Java
class should be identified in the fname() part, before the class and separated from the
class by a period (see the second XSLT example below).

Note: The class being called must be on the classpath of the machine.

XSLT example
Here are two examples of how a static method can be called. In the first example, the class
name (java.lang.Math) is included in the namespace URI and, therefore, must not be in the
fname() part. In the second example, the prefix: part supplies the prefix java: while the
fname() part identifies the class as well as the method.
<xsl:value-of xmlns:jMath="java:java.lang.Math"
select="jMath:cos(3.14)" />

<xsl:value-of xmlns:jmath="java"
select="jmath:java.lang.Math.cos(3.14)" />

The method named in the extension function (cos() in the example above) must match the
name of a public static method in the named Java class (java.lang.Math in the example
above).

XQuery example
Here is an XQuery example similar to the XSLT example above:
<cosine xmlns:jMath="java:java.lang.Math">
{jMath:cos(3.14)}
</cosine>

User-defined Java classes


If you have created your own Java classes, methods in these classes are called differently
according to: (i) whether the classes are accessed via a JAR file or a class file, and (ii) whether
these files (JAR or class) are located in the current directory (the same directory as the XSLT or
XQuery document) or not. How to locate these files is described in the sections User-Defined
Class Files and User-Defined Jar Files. Note that paths to class files not in the current directory
and to all JAR files must be specified.

User-Defined Class Files


If access is via a class file, then there are two possibilities:

 The class file is in a package. The XSLT or XQuery file is in the same folder as the
Java package.
 The class file is not packaged. The XSLT or XQuery file is in the same folder as the
class file.
 The class file is in a package. The XSLT or XQuery file is at some random location.
 The class file is not packaged. The XSLT or XQuery file is at some random location.

© 2010 Altova GmbH Appendices


1298 Engine Information Extensions

Consider the case where the class file is not packaged and is in the same folder as the XSLT or
XQuery document. In this case, since all classes in the folder are found, the file location does
not need to be specified. The syntax to identify a class is:
java:classname
where
java: indicates that a user-defined Java function is being called; (Java classes in the
current directory will be loaded by default)
classname is the name of the required method's class

The class is identified in a namespace URI, and the namespace is used to prefix a
method call.

Class file packaged, XSLT/XQuery file in same folder as Java package


The example below calls the getVehicleType()method of the Car class of the
com.altova.extfunc package. The com.altova.extfunc package is in the folder
JavaProject. The XSLT file is also in the folder JavaProject.

<xsl:stylesheet version="2.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:fn="http://www.w3.org/2005/xpath-functions"
xmlns:car="java:com.altova.extfunc.Car" >
<xsl:output exclude-result-prefixes="fn car xsl fo xs"/>

<xsl:template match="/">
<a>
<xsl:value-of select="car:getVehicleType()"/>
</a>
</xsl:template>

</xsl:stylesheet>

Class file not packaged, XSLT/XQuery file in same folder as class file
The example below calls the getVehicleType()method of the Car class of the
com.altova.extfunc package. The Car class file is in the following folder location:
JavaProject/com/altova/extfunc. The XSLT file is also in the folder
JavaProject/com/altova/extfunc.

<xsl:stylesheet version="2.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:fn="http://www.w3.org/2005/xpath-functions"
xmlns:car="java:Car" >
<xsl:output exclude-result-prefixes="fn car xsl fo xs"/>

<xsl:template match="/">
<a>
<xsl:value-of select="car:getVehicleType()"/>
</a>
</xsl:template>

</xsl:stylesheet>

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information Extensions 1299

Class file packaged, XSLT/XQuery file at any location


The example below calls the getCarColor()method of the Car class of the
com.altova.extfunc package. The com.altova.extfunc package is in the folder
JavaProject. The XSLT file is at any location. In this case, the location of the package must be
specified within the URI as a query string. The syntax is:

java:classname[?path=uri-of-package]

where

java: indicates that a user-defined Java function is being called


uri-of-package is the URI of the Java package
classname is the name of the required method's class

The class is identified in a namespace URI, and the namespace is used to prefix a
method call. The example below shows how to access a class file that is located in
another directory than the current directory.

<xsl:stylesheet version="2.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:fn="http://www.w3.org/2005/xpath-functions"
xmlns:car="
java:com.altova.extfunc.Car?path=file:///C:/JavaProject/" >

<xsl:output exclude-result-prefixes="fn car xsl xs"/>

<xsl:template match="/">
<xsl:variable name="myCar" select="car:new('red')" />
<a><xsl:value-of select="car:getCarColor($myCar)"/></a>
</xsl:template>

</xsl:stylesheet>

Class file not packaged, XSLT/XQuery file at any location


The example below calls the getCarColor()method of the Car class of the
com.altova.extfunc package. The com.altova.extfunc package is in the folder
JavaProject. The XSLT file is at any location. The location of the class file is specified within
the namespace URI as a query string. The syntax is:

java:classname[?path=uri-of-classfile]

where

java: indicates that a user-defined Java function is being called


uri-of-classfile is the URI of the folder containing the class file
classname is the name of the required method's class

The class is identified in a namespace URI, and the namespace is used to prefix a
method call. The example below shows how to access a class file that is located in
another directory than the current directory.

<xsl:stylesheet version="2.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:fn="http://www.w3.org/2005/xpath-functions"
xmlns:car="
java:Car?path=file:///C:/JavaProject/com/altova/extfunc/" >

© 2010 Altova GmbH Appendices


1300 Engine Information Extensions

<xsl:output exclude-result-prefixes="fn car xsl xs"/>

<xsl:template match="/">
<xsl:variable name="myCar" select="car:new('red')" />
<a><xsl:value-of select="car:getCarColor($myCar)"/></a>
</xsl:template>

</xsl:stylesheet>

Note: When a path is supplied via the extension function, the path is added to the
ClassLoader.

User-Defined Jar Files


If access is via a JAR file, the URI of the JAR file must be specified using the following syntax:

xmlns:classNS="java:classname?path=jar:uri-of-jarfile!/"

The method is then called by using the prefix of the namespace URI that identifies the
class: classNS:method()

In the above:

java: indicates that a Java function is being called


classname is the name of the user-defined class
? is the separator between the classname and the path
path=jar: indicates that a path to a JAR file is being given
uri-of-jarfile is the URI of the jar file
!/ is the end delimiter of the path
classNS:method() is the call to the method

Alternatively, the classname can be given with the method call. Here are two examples of the
syntax:

xmlns:ns1="java:docx.layout.pages?path=jar:file:///c:/projects/docs/docx.jar!/
"
ns1:main()

xmlns:ns2="java?path=jar:file:///c:/projects/docs/docx.jar!/"
ns2:docx.layout.pages.main()

Here is a complete XSLT example that uses a JAR file to call a Java extension function:

<xsl:stylesheet version="2.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:fn="http://www.w3.org/2005/xpath-functions"
xmlns:car="java?path=jar:file:///C:/test/Car1.jar!/" >
<xsl:output exclude-result-prefixes="fn car xsl xs"/>

<xsl:template match="/">
<xsl:variable name="myCar" select="car:Car1.new('red')" />
<a><xsl:value-of select="car:Car1.getCarColor($myCar)"/></a>
</xsl:template>

<xsl:template match="car"/>

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information Extensions 1301

</xsl:stylesheet>

Note: When a path is supplied via the extension function, the path is added to the
ClassLoader.

Java: Constructors
An extension function can be used to call a Java constructor. All constructors are called with the
pseudo-function new().

If the result of a Java constructor call can be implicitly converted to XPath/XQuery datatypes,
then the Java extension function will return a sequence that is an XPath/XQuery datatype. If the
result of a Java constructor call cannot be converted to a suitable XPath/XQuery datatype, then
the constructor creates a wrapped Java object with a type that is the name of the class returning
that Java object. For example, if a constructor for the class java.util.Date is called (
java.util.Date.new()), then an object having a type java.util.Date is returned. The lexical
format of the returned object may not match the lexical format of an XPath datatype and the
value would therefore need to be converted to the lexical format of the required XPath datatype
and then to the required XPath datatype.

There are two things that can be done with a Java object created by a constructor:
 It can be assigned to a variable:
<xsl:variable name="currentdate" select="date:new()" xmlns:date="
java:java.util.Date" />
 It can be passed to an extension function (see Instance Method and Instance Fields):
<xsl:value-of select="date:toString(date:new())" xmlns:date="
java:java.util.Date" />

Java: Static Methods and Static Fields


A static method is called directly by its Java name and by supplying the arguments for the
method. Static fields (methods that take no arguments), such as the constant-value fields E
and PI, are accessed without specifying any argument.

XSLT examples
Here are some examples of how static methods and fields can be called:
<xsl:value-of xmlns:jMath="java:java.lang.Math"
select="jMath:cos(3.14)" />

<xsl:value-of xmlns:jMath="java:java.lang.Math"
select="jMath:cos( jMath:PI() )" />

<xsl:value-of xmlns:jMath="java:java.lang.Math"
select="jMath:E() * jMath:cos(3.14)" />

Notice that the extension functions above have the form prefix:fname(). The prefix in all three
cases is jMath:, which is associated with the namespace URI java:java.lang.Math. (The
namespace URI must begin with java:. In the examples above it is extended to contain the
class name (java.lang.Math).) The fname() part of the extension functions must match the
name of a public class (e.g. java.lang.Math) followed by the name of a public static method
with its argument/s (such as cos(3.14)) or a public static field (such as PI()).

In the examples above, the class name has been included in the namespace URI. If it were not

© 2010 Altova GmbH Appendices


1302 Engine Information Extensions

contained in the namespace URI, then it would have to be included in the fname() part of the
extension function. For example:
<xsl:value-of xmlns:java="java:"
select="java:java.lang.Math.cos(3.14)" />

XQuery example
A similar example in XQuery would be:
<cosine xmlns:jMath="java:java.lang.Math">
{jMath:cos(3.14)}
</cosine>

Java: Instance Methods and Instance Fields


An instance method has a Java object passed to it as the first argument of the method call.
Such a Java object typically would be created by using an extension function (for example a
constructor call) or a stylesheet parameter/variable. An XSLT example of this kind would be:

<xsl:stylesheet version="1.0" exclude-result-prefixes="date"


xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:date="java:java.util.Date"
xmlns:jlang="java:java.lang">
<xsl:param name="CurrentDate" select="date:new()"/>
<xsl:template match="/">
<enrollment institution-id="Altova School"
date="{date:toString($CurrentDate)}"
type="{jlang:Object.toString(jlang:Object.getClass( date:new()
))}">
</enrollment>
</xsl:template>
</xsl:stylesheet>

In the example above, the value of the node enrollment/@type is created as follows:
1. An object is created with a constructor for the class java.util.Date (with the
date:new() constructor).
2. This Java object is passed as the argument of the jlang.Object.getClass method.
3. The object obtained by the getClass method is passed as the argument to the
jlang.Object.toString method.

The result (the value of @type) will be a string having the value: java.util.Date.

An instance field is theoretically different from an instance method in that it is not a Java object
per se that is passed as an argument to the instance field. Instead, a parameter or variable is
passed as the argument. However, the parameter/variable may itself contain the value returned
by a Java object. For example, the parameter CurrentDate takes the value returned by a
constructor for the class java.util.Date. This value is then passed as an argument to the
instance method date:toString in order to supply the value of /enrollment/@date.

Datatypes: XPath/XQuery to Java


When a Java function is called from within an XPath/XQuery expression, the datatype of the
function's arguments is important in determining which of multiple Java classes having the
same name is called.

In Java, the following rules are followed:

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information Extensions 1303

 If there is more than one Java method with the same name, but each has a different
number of arguments than the other/s, then the Java method that best matches the
number of arguments in the function call is selected.
 The XPath/XQuery string, number, and boolean datatypes (see list below) are implicitly
converted to a corresponding Java datatype. If the supplied XPath/XQuery type can be
converted to more than one Java type (for example, xs:integer), then that Java type
is selected which is declared for the selected method. For example, if the Java method
being called is fx(decimal) and the supplied XPath/XQuery datatype is xs:integer,
then xs:integer will be converted to Java's decimal datatype.

The table below lists the implicit conversions of XPath/XQuery string, number, and boolean
types to Java datatypes.

xs:string java.lang.String
xs:boolean boolean (primitive), java.lang.Boolean

xs:integer int, long, short, byte, float, double, and the


wrapper classes of these, such as java.lang.
Integer
xs:float float (primitive), java.lang.Float, double
(primitive)
xs:double double (primitive), java.lang.Double
xs:decimal float (primitive), java.lang.Float, double
(primitive), java.lang.Double

Subtypes of the XML Schema datatypes listed above (and which are used in XPath and
XQuery) will also be converted to the Java type/s corresponding to that subtype's ancestor type.

In some cases, it might not be possible to select the correct Java method based on the supplied
information. For example, consider the following case.
 The supplied argument is an xs:untypedAtomic value of 10 and it is intended for the
method mymethod(float).
 However, there is another method in the class which takes an argument of another
datatype: mymethod(double).
 Since the method names are the same and the supplied type (xs:untypedAtomic)
could be converted correctly to either float or double, it is possible that xs:
untypedAtomic is converted to double instead of float.
 Consequently the method selected will not be the required method and might not
produce the expected result. To work around this, you can create a user-defined
method with a different name and use this method.

Types that are not covered in the list above (for example xs:date) will not be converted and will
generate an error. However, note that in some cases, it might be possible to create the required
Java type by using a Java constructor.

Datatypes: Java to XPath/XQuery


When a Java method returns a value, the datatype of the value is a string, numeric or boolean
type, then it is converted to the corresponding XPath/XQuery type. For example, Java's java.
lang.Boolean and boolean datatypes are converted to xsd:boolean.

© 2010 Altova GmbH Appendices


1304 Engine Information Extensions

One-dimensional arrays returned by functions are expanded to a sequence. Multi-dimensional


arrays will not be converted, and should therefore be wrapped.

When a wrapped Java object or a datatype other than string, numeric or boolean is returned,
you can ensure conversion to the required XPath/XQuery type by first using a Java method (e.g
toString) to convert the Java object to a string. In XPath/XQuery, the string can be modified to
fit the lexical representation of the required type and then converted to the required type (for
example, by using the cast as expression).

1.5.2 .NET Extension Functions


If you are working on the .NET platform, you can use extension functions written in any of the
.NET languages (for example, C#). A .NET extension function can be used within an XPath or
XQuery expression to invoke a constructor, property, or method (static or instance) within a
.NET class.

A property of a .NET class is called using the syntax get_PropertyName().

This section is organized into the following sub-sections:


 .NET: Constructors
 .NET: Static Methods and Static Fields
 .NET: Instance Methods and Instance Fields
 Datatypes: XSLT/XQuery to .NET
 Datatypes: .NET to XSLT/XQuery

Form of the extension function


The extension function in the XPath/XQuery expression must have the form prefix:fname().
 The prefix: part is associated with a URI that identifies the .NET class being
addressed.
 The fname() part identifies the constructor, property, or method (static or instance)
within the .NET class, and supplies any argument/s, if required.
 The URI must begin with clitype: (which identifies the function as being a .NET
extension function).
 The prefix:fname() form of the extension function can be used with system classes
and with classes in a loaded assembly. However, if a class needs to be loaded,
additional parameters containing the required information will have to be supplied.

Parameters
To load an assembly, the following parameters are used:

asm The name of the assembly to be loaded.


ver The version number (maximum of four integers separated by periods).
sn The key token of the assembly's strong name (16 hex digits).
from A URI that gives the location of the assembly (DLL) to be loaded. If the
URI is relative, it is relative to the XSLT or XQuery document. If this
parameter is present, any other parameter is ignored.
partialname The partial name of the assembly. It is supplied to
Assembly.LoadWith.PartialName(), which will attempt to load the
assembly. If partialname is present, any other parameter is ignored.

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information Extensions 1305

loc The locale, for example, en-US. The default is neutral.

If the assembly is to be loaded from a DLL, use the from parameter and omit the sn parameter.
If the assembly is to be loaded from the Global Assembly Cache (GAC), use the sn parameter
and omit the from parameter.

A question mark must be inserted before the first parameter, and parameters must be
separated by a semi-colon. The parameter name gives its value with an equals sign (see
example below).

Examples of namespace declarations


An example of a namespace declaration in XSLT that identifies the system class
System.Environment:
xmlns:myns="clitype:System.Environment"

An example of a namespace declaration in XSLT that identifies the class to be loaded as


Trade.Forward.Scrip:
xmlns:myns="clitype:Trade.Forward.Scrip?asm=forward;version=10.6.2.1"

An example of a namespace declaration in XQuery that identifies the system class


MyManagedDLL.testClass:. Two cases are distinguished:
1. When the assembly is loaded from the GAC:
declare namespace cs="clitype:MyManagedDLL.testClass?asm=MyManagedDLL;
ver=1.2.3.4;loc=neutral;sn=b9f091b72dccfba8";

2. When the assembly is loaded from the DLL (complete and partial references below):
declare namespace
cs="clitype:MyManagedDLL.testClass?from=file:///C:/Altova
Projects/extFunctions/MyManagedDLL.dll;
declare namespace
cs="clitype:MyManagedDLL.testClass?from=MyManagedDLL.dll;

XSLT example
Here is a complete XSLT example that calls functions in system class System.Math:
<xsl:stylesheet version="2.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:fn="http://www.w3.org/2005/xpath-functions">
<xsl:output method="xml" omit-xml-declaration="yes" />
<xsl:template match="/">
<math xmlns:math="clitype:System.Math">
<sqrt><xsl:value-of select="math:Sqrt(9)"/></sqrt>
<pi><xsl:value-of select="math:PI()"/></pi>
<e><xsl:value-of select="math:E()"/></e>
<pow><xsl:value-of select="math:Pow(math:PI(), math:E())"/></pow>
</math>
</xsl:template>
</xsl:stylesheet>

The namespace declaration on the element math associates the prefix math: with the URI
clitype:System.Math. The clitype: beginning of the URI indicates that what follows
identifies either a system class or a loaded class. The math: prefix in the XPath expressions
associates the extension functions with the URI (and, by extension, the class) System.Math.
The extension functions identify methods in the class System.Math and supply arguments

© 2010 Altova GmbH Appendices


1306 Engine Information Extensions

where required.

XQuery example
Here is an XQuery example fragment similar to the XSLT example above:
<math xmlns:math="clitype:System.Math">
{math:Sqrt(9)}
</math>

As with the XSLT example above, the namespace declaration identifies the .NET class, in this
case a system class. The XQuery expression identifies the method to be called and supplies
the argument.

.NET: Constructors
An extension function can be used to call a .NET constructor. All constructors are called with
the pseudo-function new(). If there is more than one constructor for a class, then the
constructor that most closely matches the number of arguments supplied is selected. If no
constructor is deemed to match the supplied argument/s, then a 'No constructor found'
error is returned.

Constructors that return XPath/XQuery datatypes


If the result of a .NET constructor call can be implicitly converted to XPath/XQuery datatypes,
then the .NET extension function will return a sequence that is an XPath/XQuery datatype.

Constructors that return .NET objects


If the result of a .NET constructor call cannot be converted to a suitable XPath/XQuery
datatype, then the constructor creates a wrapped .NET object with a type that is the name of the
class returning that object. For example, if a constructor for the class System.DateTime is
called (withSystem.DateTime.new()), then an object having a type System.DateTime is
returned.

The lexical format of the returned object may not match the lexical format of a required XPath
datatype. In such cases, the returned value would need to be: (i) converted to the lexical format
of the required XPath datatype; and (ii) cast to the required XPath datatype.

There are three things that can be done with a .NET object created by a constructor:
 It can be used within a variable:
<xsl:variable name="currentdate" select="date:new(2008, 4, 29)"
xmlns:date="clitype:System.DateTime" />
 It can be passed to an extension function (see Instance Method and Instance Fields):
<xsl:value-of select="date:ToString(date:new(2008, 4, 29))" xmlns:date
="clitype:System.DateTime" />
 It can be converted to a string, number, or boolean:
 <xsl:value-of select="xs:integer(data:get_Month(date:new(2008, 4, 29)))
" xmlns:date="clitype:System.DateTime" />

.NET: Static Methods and Static Fields


A static method is called directly by its name and by supplying the arguments for the method.
The name used in the call must exactly match a public static method in the class specified. If

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information Extensions 1307

the method name and the number of arguments that were given in the function call matches
more than one method in a class, then the types of the supplied arguments are evaluated for
the best match. If a match cannot be found unambiguously, an error is reported.

Note: A field in a .NET class is considered to be a method without any argument. A property
is called using the syntax get_PropertyName().

Examples
An XSLT example showing a call to a method with one argument (System.Math.Sin(arg)):
<xsl:value-of select="math:Sin(30)" xmlns:math="clitype:System.Math"/>

An XSLT example showing a call to a field (considered a method with no argument) (


System.Double.MaxValue()):
<xsl:value-of select="double:MaxValue()" xmlns:double="
clitype:System.Double"/>

An XSLT example showing a call to a property (syntax is get_PropertyName()) (


System.String()):
<xsl:value-of select="string:get_Length('my string')" xmlns:string="
clitype:System.String"/>

An XQuery example showing a call to a method with one argument (System.Math.Sin(arg)):


<sin xmlns:math="clitype:System.Math">
{ math:Sin(30) }
</sin>

.NET: Instance Methods and Instance Fields


An instance method has a .NET object passed to it as the first argument of the method call.
This .NET object typically would be created by using an extension function (for example a
constructor call) or a stylesheet parameter/variable. An XSLT example of this kind would be:

<xsl:stylesheet version="2.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:fn="http://www.w3.org/2005/xpath-functions">
<xsl:output method="xml" omit-xml-declaration="yes"/>
<xsl:template match="/">
<xsl:variable name="releasedate"
select="date:new(2008, 4, 29)"
xmlns:date="clitype:System.DateTime"/>
<doc>
<date>
<xsl:value-of select="date:ToString(date:new(2008, 4, 29))"
xmlns:date="clitype:System.DateTime"/>
</date>
<date>
<xsl:value-of select="date:ToString($releasedate)"
xmlns:date="clitype:System.DateTime"/>
</date>
</doc>
</xsl:template>
</xsl:stylesheet>

© 2010 Altova GmbH Appendices


1308 Engine Information Extensions

In the example above, a System.DateTime constructor (new(2008, 4, 29)) is used to create a


.NET object of type System.DateTime. This object is created twice, once as the value of the
variable releasedate, a second time as the first and only argument of the
System.DateTime.ToString() method. The instance method System.DateTime.ToString()
is called twice, both times with the System.DateTime constructor (new(2008, 4, 29)) as its
first and only argument. In one of these instances, the variable releasedate is used to get the
.NET object.

Instance methods and instance fields


The difference between an instance method and an instance field is theoretical. In an instance
method, a .NET object is directly passed as an argument; in an instance field, a parameter or
variable is passed instead—though the parameter or variable may itself contain a .NET object.
For example, in the example above, the variable releasedate contains a .NET object, and it is
this variable that is passed as the argument of ToString() in the second date element
constructor. Therefore, the ToString() instance in the first date element is an instance method
while the second is considered to be an instance field. The result produced in both instances,
however, is the same.

Datatypes: XPath/XQuery to .NET


When a .NET extension function is used within an XPath/XQuery expression, the datatypes of
the function's arguments are important for determining which one of multiple .NET methods
having the same name is called.

In .NET, the following rules are followed:


 If there is more than one method with the same name in a class, then the methods
available for selection are reduced to those that have the same number of arguments
as the function call.
 The XPath/XQuery string, number, and boolean datatypes (see list below) are implicitly
converted to a corresponding .NET datatype. If the supplied XPath/XQuery type can be
converted to more than one .NET type (for example, xs:integer), then that .NET type
is selected which is declared for the selected method. For example, if the .NET method
being called is fx(double) and the supplied XPath/XQuery datatype is xs:integer,
then xs:integer will be converted to .NET's double datatype.

The table below lists the implicit conversions of XPath/XQuery string, number, and boolean
types to .NET datatypes.

xs:string StringValue, string


xs:boolean BooleanValue, bool
xs:integer IntegerValue, decimal, long, integer,
short, byte, double, float
xs:float FloatValue, float, double
xs:double DoubleValue, double
xs:decimal DecimalValue, decimal, double, float

Subtypes of the XML Schema datatypes listed above (and which are used in XPath and
XQuery) will also be converted to the .NET type/s corresponding to that subtype's ancestor type.

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information Extensions 1309

In some cases, it might not be possible to select the correct .NET method based on the
supplied information. For example, consider the following case.
 The supplied argument is an xs:untypedAtomic value of 10 and it is intended for the
method mymethod(float).
 However, there is another method in the class which takes an argument of another
datatype: mymethod(double).
 Since the method names are the same and the supplied type (xs:untypedAtomic)
could be converted correctly to either float or double, it is possible that xs:
untypedAtomic is converted to double instead of float.
 Consequently the method selected will not be the required method and might not
produce the expected result. To work around this, you can create a user-defined
method with a different name and use this method.

Types that are not covered in the list above (for example xs:date) will not be converted and will
generate an error.

Datatypes: .NET to XPath/XQuery


When a .NET method returns a value and the datatype of the value is a string, numeric or
boolean type, then it is converted to the corresponding XPath/XQuery type. For example, .
NET's decimal datatype is converted to xsd:decimal.

When a .NET object or a datatype other than string, numeric or boolean is returned, you can
ensure conversion to the required XPath/XQuery type by first using a .NET method (for
example System.DateTime.ToString()) to convert the .NET object to a string. In XPath/
XQuery, the string can be modified to fit the lexical representation of the required type and then
converted to the required type (for example, by using the cast as expression).

1.5.3 MSXSL Scripts for XSLT


The <msxsl:script> element contains user-defined functions and variables that can be called
from within XPath expressions in the XSLT stylesheet. The <msxsl:script> is a top-level
element, that is, it must be a child element of <xsl:stylesheet> or <xsl:transform>.

The <msxsl:script> element must be in the namespace urn:schemas-microsoft-com:xslt


(see example below).

Scripting language and namespace


The scripting language used within the block is specified in the <msxsl:script> element's
language attribute and the namespace to be used for function calls from XPath expressions is
identified with the implements-prefix attribute (see below).

<msxsl:script language="scripting-language" implements-prefix="user-namespace-


prefix">

function-1 or variable-1
...
function-n or variable-n

</msxsl:script>

The <msxsl:script> element interacts with the Windows Scripting Runtime, so only languages
that are installed on your machine may be used within the <msxsl:script> element. The .NET

© 2010 Altova GmbH Appendices


1310 Engine Information Extensions

Framework 2.0 platform or higher must be installed for MSXSL scripts to be used.
Consequently, the .NET scripting languages can be used within the <msxsl:script> element.

The language attribute accepts the same values as the language attribute on the HTML
<script> element. If the language attribute is not specified, then Microsoft JScript is assumed
as the default.

The implements-prefix attribute takes a value that is a prefix of a declared in-scope namespace.
This namespace typically will be a user namespace that has been reserved for a function
library. All functions and variables defined within the <msxsl:script> element will be in the
namespace identified by the prefix specified in the implements-prefix attribute. When a
function is called from within an XPath expression, the fully qualified function name must be in
the same namespace as the function definition.

Example
Here is an example of a complete XSLT stylesheet that uses a function defined within a
<msxsl:script> element.

<?xml version="1.0" encoding="UTF-8"?>


<xsl:stylesheet version="2.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:fn="http://www.w3.org/2005/xpath-functions"
xmlns:msxsl="urn:schemas-microsoft-com:xslt"
xmlns:user="http://mycompany.com/mynamespace">

<msxsl:script language="VBScript" implements-prefix="user">


<![CDATA[
' Input: A currency value: the wholesale price
' Returns: The retail price: the input value plus 20% margin,
' rounded to the nearest cent
dim a as integer = 13
Function AddMargin(WholesalePrice) as integer
AddMargin = WholesalePrice * 1.2 + a
End Function
]]>
</msxsl:script>

<xsl:template match="/">
<html>
<body>
<p>
<b>Total Retail Price =
$<xsl:value-of select="user:AddMargin(50)"/>
</b>
<br/>
<b>Total Wholesale Price =
$<xsl:value-of select="50"/>
</b>
</p>
</body>
</html>
</xsl:template>
</xsl:stylesheet>

Datatypes
The values of parameters passed into and out of the script block are limited to XPath datatypes.
This restriction does not apply to data passed among functions and variables within the script
block.

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information Extensions 1311

Assemblies
An assembly can be imported into the script by using the msxsl:assembly element. The
assembly is identified via a name or a URI. The assembly is imported when the stylesheet is
compiled. Here is a simple representation of how the msxsl:assembly element is to be used.

<msxsl:script>
<msxsl:assembly name="myAssembly.assemblyName" />
<msxsl:assembly href="pathToAssembly" />

...

</msxsl:script>

The assembly name can be a full name, such as:


"system.Math, Version=3.1.4500.1 Culture=neutral
PublicKeyToken=a46b3f648229c514"
or a short name, such as "myAssembly.Draw".

Namespaces
Namespaces can be declared with the msxsl:using element. This enables assembly classes
to be written in the script without their namespaces, thus saving you some tedious typing. Here
is how the msxsl:using element is used so as to declare namespaces.

<msxsl:script>
<msxsl:using namespace="myAssemblyNS.NamespaceName" />

...

</msxsl:script>

The value of the namespace attribute is the name of the namespace.

1.5.4 Altova Extension Functions


Altova extension functions are in the namespace http://www.altova.com/xslt-extensions
and are indicated in this section with the prefix altova:, which is assumed to be bound to the
namespace given above.

The following extension functions are supported in the current version of your Altova product in
the manner described below. However, note that in future versions of your product, support for
one or more of these functions might be discontinued or the behavior of individual functions
might change. Consult the documentation of future releases for information about support for
Altova extension functions in that release.

General functions
 altova:evaluate()
 altova:distinct-nodes()
 altova:encode-for-rtf()
 altova:xbrl-labels()
 altova:xbrl-footnotes()
 altova:generate-auto-number()
 altova:reset-auto-number()

© 2010 Altova GmbH Appendices


1312 Engine Information Extensions

 altova:get-temp-folder()

Chart functions (Enterprise and Reporting Editions only)


Altova extension functions for charts are supported only in the Enterprise and Reporting
Editions of Altova products and enable charts to be generated from XML data. The chart
functions have been organized into two groups:

 Functions to generate and save charts


 Functions to create charts

A third section gives a listing of the chart data XML structure, from which charts can be
generated. Finally, an example XSLT document shows how chart functions can be used to
generate charts from XML data.

General Functions
The following extension functions are supported in the current version of your Altova product in
the manner described below. However, note that in future versions of your product, support for
one or more of these functions might be discontinued or the behavior of individual functions
might change. Consult the documentation of future releases for information about support for
Altova extension functions in that release.
 altova:evaluate()
 altova:distinct-nodes()
 altova:encode-for-rtf()
 altova:xbrl-labels()
 altova:xbrl-footnotes()
 altova:generate-auto-number()
 altova:reset-auto-number()
 altova:get-temp-folder()

altova:evaluate()
The altova:evaluate() function takes an XPath expression, passed as a string, as its
mandatory argument. It returns the output of the evaluated expression.

altova:evaluate(XPathExp as xs:string)

For example:

altova:evaluate('//Name[1]')

In the example above, note that the expression //Name[1] is passed as a string by enclosing it
in single quotes. The altova:evaluate function returns the contents of the first Name element
in the document.

The altova:evaluate function can take additional (optional) arguments. These arguments are,
respectively, the values of variables with the names p1, p2, p3... pN that can be used in the
XPath expression.

altova:evaluate(XPathExp as xs:string [, p1value ... pNvalue])

where

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information Extensions 1313

 the variable names must be of the form pX, X being an integer


 the sequence of the function's arguments, from the second argument onwards
corresponds to the sequence of variables named p1 to pN. So the second argument
will be the value of the variable p1, the third argument that of the variable p2, and so
on.
 The variable values must be of type item*

For example:
<xsl:variable name="xpath" select="'$p3, $p2, $p1'" />
<xsl:value-of select="altova:evaluate( $xpath, 10, 20, 'hi' )" />
Outputs "hi 20 10"

In the above listing, notice the following:


 The second argument of the altova:evaluate expression is the value assigned to the
variable $p1, the third argument that assigned to the variable $p2, and so on.
 Notice that the fourth argument of the function is a string value, indicated by its being
enclosed in quotes.
 The select attribute of the xs:variable element supplies the XPath expression. Since
this expression must be of type xs:string, it is enclosed in single quotes.

The following examples further illustrate usage:


<xsl:variable name="xpath" select="'$p1'" />
<xsl:value-of select="altova:evaluate( $xpath, //Name[1] )" />
Outputs value of the first Name element.
<xsl:variable name="xpath" select="'$p1'" />
<xsl:value-of select="altova:evaluate( $xpath, '//Name[1]' )" />
Outputs "//Name[1]"

The altova:evaluate() extension function is useful in situations where an XPath expression


in the XSLT stylesheet contains one or more parts that must be evaluated dynamically. For
example, consider a situation in which a user enters his request for the sorting criterion and this
criterion is stored in the attribute UserReq/@sortkey. In the stylesheet, you could then have the
expression :
<xsl:sort select="altova:evaluate(../UserReq/@sortkey)" order="ascending"/
>
The altova:evaluate() function reads the sortkey attribute of the UserReq child element of
the parent of the context node. Say the value of the sortkey attribute is Price, then Price is
returned by the altova:evaluate() function and becomes the value of the select attribute:
<xsl:sort select="Price" order="ascending"/>

If this sort instruction occurs within the context of an element called Order, then the Order
elements will be sorted according to the values of their Price children. Alternatively, if the value
of @sortkey were, say, Date, then the Order elements would be sorted according to the values
of their Date children. So the sort criterion for Order is selected from the sortkey attribute at
runtime. This could not have been achieved with an expression like:
<xsl:sort select="../UserReq/@sortkey" order="ascending"/>
In the case shown above, the sort criterion would be the sortkey attribute itself, not Price or
Date (or any other current content of sortkey).

Variables can be used in the altova:evaluate() extension function as shown in the examples
below:

© 2010 Altova GmbH Appendices


1314 Engine Information Extensions

 Static variables: <xsl:value-of select="$i3, $i2, $i1" />


Outputs the values of three variables.

 Dynamic XPath expression with dynamic variables:


<xsl:variable name="xpath" select="'$p3, $p2, $p1'" />
<xsl:value-of select="altova:evaluate( $xpath, 10, 20, 30 )" />
Outputs "30 20 10"

 Dynamic XPath expression with no dynamic variable:


<xsl:variable name="xpath" select="'$p3, $p2, $p1'" />
<xsl:value-of select="altova:evaluate( $xpath )" />
Outputs error: No variable defined for $p3.

Note: The static context includes namespaces, types, and functions—but not variables—from
the calling environment. The base URI and default namespace are inherited.

altova:distinct-nodes()
The altova:distinct-nodes() function takes a set of one or more nodes as its input and
returns the same set minus nodes with duplicate values. The comparison is done using the
XPath/XQuery function fn:deep-equal.
altova:distinct-nodes( $arg as node()* )  as node()*

altova:encode-for-rtf()
The altova:encode-for-rtf() function converts the input string into code for RTF.
altova:encode-for-rtf( $inputstr as xs:string?,
$preserveallwhitespace as xs:boolean,
$preservenewlines as xs:boolean) as xs:string

Whitespace and new lines will be preserved according to the boolean value specified for their
respective parameters.

altova:xbrl-labels()
The altova:xbrl-labels() function takes two input arguments: a node name and the
taxonomy file location containing the node. The function returns the XBRL labels associated
with the input node.
altova:xbrl-labels( $name as xs:QName, $file as xs:string )  as node()*

altova:xbrl-footnotes()
The altova:footnotes() function takes a node as its input argument and returns the set of
XBRL footnote nodes referenced by the input node.
altova:footnotes( $arg as node() )  as node()*

altova:generate-auto-number(id as xs:string, start-with as xs:integer,


increment as xs:integer, reset-on-change as xs:string)

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information Extensions 1315

Generates a series of numbers having the specified ID. The start integer and the increment is
specified.

altova:reset-auto-number(id as xs:string)
This function resets the auto-numbering of the auto-numbering series specified with the ID
argument. The series is reset to the start integer of the series (see
altova:generate-auto-number above).

altova:get-temp-folder as xs:string
Gets the temporary folder.

Chart Functions
The chart functions listed below enable you to create, generate, and save charts as images.
They are supported in the current version of your Altova product in the manner described below.
However, note that in future versions of your product, support for one or more of these functions
might be discontinued or the behavior of individual functions might change. Consult the
documentation of future releases for information about support for Altova extension functions in
that release.

The chart functions are organized into two groups:


 Functions for generating and saving charts
 Functions for creating charts

Note: Chart functions are supported only in the Enterprise and Reporting Editions of Altova
products.

Functions for generating and saving charts


These functions take the chart object (obtained with the chart creation functions) and either
generate an image or save an image to file

altova:generate-chart-image ($chart, $width, $height, $encoding) as atomic

where
 $chart is the chart extension item obtained with the altova:create-chart function
 $width and $height must be specified with a length unit
 $encoding may be binarytobase64 or binarytobase16

The function returns the chart image in the specified encoding.

altova:generate-chart-image ($chart, $width, $height, $encoding, $imagetype)


as atomic

where
 $chart is the chart extension item obtained with the altova:create-chart function
 $width and $height must be specified with a length unit
 $encoding may be base64Binary or hexBinary

© 2010 Altova GmbH Appendices


1316 Engine Information Extensions

 $imagetype may be one of the following image formats: png, gif, bmp, jpg, jpeg

The function returns the chart image in the specified encoding and image format.

altova:save-chart-image ($chart, $filename, $width, $height) as empty()

where
 $chart is the chart extension item obtained with the altova:create-chart function
 $filename is the path to and name of the file to which the chart image is to be saved
 $width and $height must be specified with a length unit

The function saves the chart image to the file specified in $filename.

altova:save-chart-image ($chart, $filename, $width, $height, $imagetype) as


empty()

where
 $chart is the chart extension item obtained with the altova:create-chart function
 $filename is the path to and name of the file to which the chart image is to be saved
 $width and $height must be specified with a length unit
 $imagetype may be one of the following image formats: png, gif, bmp, jpg, jpeg

The function saves the chart image to the file specified in $filename in the image format
specified.

Functions for creating charts


The following functions are used to create charts.

altova:create-chart($chart-config, $chart-data-series*) as chart extension


item

where
 $chart-config is the chart-config extension item obtained with the
altova:create-chart-config function or or via the
altova:create-chart-config-from-xml function
 $chart-data-series is the chart-data-series extension item obtained with the
altova:create-chart-data-series function or
altova:create-chart-data-series-from-rows function

The function returns a chart extension item, which is created from the data supplied via the
arguments.

altova:create-chart-config($type-name, $title) as chart-config extension item

where
 $type-name specifies the type of chart to be created: Pie, Pie3d, BarChart,
BarChart3d, BarChart3dGrouped, LineChart, ValueLineChart, RoundGauge,
BarGauge
 $title is the name of the chart

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information Extensions 1317

The function returns a chart-config extension item containing the configuration information
of the chart.

altova:create-chart-config-from-xml($xml-struct) as chart-config extension


item

where
 $xml-struct is the XML structure containing the configuration information of the
chart

The function returns a chart-config extension item containing the configuration information
of the chart. This information is supplied in an XML data fragment.

altova:create-chart-data-series($series-name?, $x-values*, $y-values*) as


chart-data-series extension item

where
 $series-name specifies the name of the series
 $x-values gives the list of X-Axis values
 $y-values gives the list of Y-Axis values

The function returns a chart-data-series extension item containing the data for building the
chart: that is, the names of the series and the Axes data.

create-chart-data-row(x, y1, y2, y3, ...) as chart-data-x-Ny-row extension


item

where
 x is the value of the X-Axis column of the chart data row
 yN are the values of the Y-Axis columns

The function returns a chart-data-x-Ny-row extension item, which contains the data for the
X-Axis column and Y-Axis columns of a single series.

create-chart-data-series-from-rows($series-names as xs:string*, $row*) as


chart-data-series extension item

where
 $series-name is the name of the series to be created
 $row is the chart-data-x-Ny-row extension item that is to be created as a series

The function returns a chart-data-series extension item, which contains the data for the
X-Axis and Y-Axes of the series.

Chart Data XML Structure


Given below is the XML structure of chart data. This chart data can be transformed using Altova
extension functions for charts.

© 2010 Altova GmbH Appendices


1318 Engine Information Extensions

Note: Chart functions are supported only in the Enterprise and Reporting
Editions of Altova products.

<?xml version="1.0" encoding="UTF-8"?>


<ChartSettings>

<General
SettingsVersion="1" must be provided
ChartKind="BarChart" Pie, Pie3d, BarChart, BarChart3d, BarChart3dGrouped,
LineChart, ValueLineChart, RoundGauge, BarGauge
BKColor="#ffffff" Color
ShowBorder="1" Bool
PlotBorderColor="#000000" Color
PlotBKColor="#ffffff" Color
Title="" String
ShowLegend="1" Bool
OutsideMargin="3.%" PercentOrPixel
TitleToPlotMargin="3.%"   PercentOrPixel
LegendToPlotMargin="3.%" PercentOrPixel
Orientation="vert" Enumeration: possible values are: vert, horz
>
<TitleFont
Color="#000000" Color
Name="Tahoma" String
Bold="1"  Bool
Italic="0" Bool
Underline="0" Bool
MinFontHeight="10.pt" FontSize (only pt values)
Size="8.%" FontSize />
<LegendFont
Color="#000000"
Name="Tahoma"
Bold="0"
Italic="0"
Underline="0"
MinFontHeight="10.pt"
Size="3.5%" />
<AxisLabelFont
Color="#000000"
Name="Tahoma"
Bold="1"
Italic="0"
Underline="0"
MinFontHeight="10.pt"
Size="5.%" />
</General>
               
<Line
ConnectionShapeSize="1.%" PercentOrPixel
DrawFilledConnectionShapes="1" Bool
DrawOutlineConnectionShapes="0" Bool
DrawSlashConnectionShapes="0" Bool
DrawBackslashConnectionShapes="0" Bool
/>

<Bar
ShowShadow="1" Bool
ShadowColor="#a0a0a0" Color
OutlineColor="#000000" Color

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information Extensions 1319

ShowOutline="1" Bool
/>

<Colors User-defined color scheme: By default this element is empty except for the style
and has no Color attributes
Style="User" Possible values are: "Default", "Grayscale", "Colorful", "Pastel", "User"
Colors="#52aca0" Color: only added for user defined color set
Colors1="#d3c15d" Color: only added for user defined color set
Colors2="#8971d8" Color: only added for user defined color set
...
ColorsN="" Up to ten colors are allowed in a set: from Colors to Colors9
</Colors>

<Pie
ShowLabels="1" Bool
OutlineColor="#404040" Color
ShowOutline="1" Bool
StartAngle="0." Double
Clockwise="1" Bool
Draw2dHighlights="1" Bool
Transparency="0" Int (0 to 255: 0 is opaque, 255 is fully transparent)
DropShadowColor="#c0c0c0" Color
DropShadowSize="5.%" PercentOrPixel
PieHeight="10.%" PercentOrPixel. Pixel values might be different in the result
because of 3d tilting
Tilt="40.0" Double (10 to 90: The 3d tilt in degrees of a 3d pie)
ShowDropShadow="1" Bool
ChartToLabelMargin="10.%" PercentOrPixel
AddValueToLabel="0" Bool
AddPercentToLabel="0" Bool
AddPercentToLabels_DecimalDigits="0" UINT ( 0 – 2 )
>          
<LabelFont
Color="#000000"
Name="Arial"
Bold="0"
Italic="0"
Underline="0"
MinFontHeight="10.pt"
Size="4.%" />
</Pie>

<XY>
<XAxis Axis
AutoRange="1" Bool
AutoRangeIncludesZero="1" Bool
RangeFrom="0." Double: manual range
RangeTill="1." Double : manual range
LabelToAxisMargin="3.%" PercentOrPixel
AxisLabel="" String
AxisColor="#000000" Color
AxisGridColor="#e6e6e6" Color
ShowGrid="1" Bool
UseAutoTick="1" Bool
ManualTickInterval="1." Double
AxisToChartMargin="0.px" PercentOrPixel
TickSize="3.px" PercentOrPixel
>

© 2010 Altova GmbH Appendices


1320 Engine Information Extensions

<ValueFont
Color="#000000"
Name="Tahoma"
Bold="0"
Italic="0"
Underline="0"
MinFontHeight="10.pt"
Size="3.%" />
</XAxis>
<YAxis Axis (same as for XAxis)
AutoRange="1"
AutoRangeIncludesZero="1"
RangeFrom="0."
RangeTill="1."
LabelToAxisMargin="3.%"
AxisLabel=""
AxisColor="#000000"
AxisGridColor="#e6e6e6"
ShowGrid="1"
UseAutoTick="1"
ManualTickInterval="1."
AxisToChartMargin="0.px"
TickSize="3.px">
<ValueFont
Color="#000000"
Name="Tahoma"
Bold="0"
Italic="0"
Underline="0"
MinFontHeight="10.pt"
Size="3.%"/>
</YAxis>
</XY>

<XY3d
AxisAutoSize="1" Bool: If false, XSize and YSize define the aspect ration of x and y
axis. If true, aspect ratio is equal to chart window
XSize="100.%" PercentOrPixel. Pixel values might be different in the result because
of 3d tilting and zooming to fit chart
YSize="100.%" PercentOrPixel. Pixel values might be different in the result because
of 3d tilting and zooming to fit chart
SeriesMargin="30.%" PercentOrPixel. Pixel values might be different in the result
because of 3d tilting and zooming to fit chart
Tilt="20." Double. -90 to +90 degrees
Rot="20." Double. -359 to +359 degrees
FoV="50."> Double. Field of view: 1-120 degree
>
<ZAxis
AutoRange="1"
AutoRangeIncludesZero="1"
RangeFrom="0."
RangeTill="1."
LabelToAxisMargin="3.%"
AxisLabel=""
AxisColor="#000000"
AxisGridColor="#e6e6e6"
ShowGrid="1"
UseAutoTick="1"
ManualTickInterval="1."
AxisToChartMargin="0.px"
TickSize="3.px" >
<ValueFont
Color="#000000"
Name="Tahoma"

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information Extensions 1321

Bold="0"
Italic="0"
Underline="0"
MinFontHeight="10.pt"
Size="3.%"/>
</ZAxis>
</XY3d>

<Gauge
MinVal="0." Double
MaxVal="100." Double
MinAngle="225" UINT: -359-359
SweepAngle="270" UINT: 1-359
BorderToTick="1.%" PercentOrPixel
MajorTickWidth="3.px" PercentOrPixel
MajorTickLength="4.%" PercentOrPixel
MinorTickWidth="1.px" PercentOrPixel
MinorTickLength="3.%" PercentOrPixel
BorderColor="#a0a0a0" Color
FillColor="#303535" Color
MajorTickColor="#a0c0b0" Color
MinorTickColor="#a0c0b0" Color
BorderWidth="2.%" PercentOrPixel
NeedleBaseWidth="1.5%" PercentOrPixel
NeedleBaseRadius="5.%" PercentOrPixel
NeedleColor="#f00000" Color
NeedleBaseColor="#141414" Color
TickToTickValueMargin="5.%" PercentOrPixel
MajorTickStep="10." Double
MinorTickStep="5." Double
RoundGaugeBorderToColorRange="0.%" PercentOrPixel
RoundGaugeColorRangeWidth ="6.%" PercentOrPixel
BarGaugeRadius="5.%" PercentOrPixel
BarGaugeMaxHeight="20.%" PercentOrPixel
RoundGaugeNeedleLength="45.%" PercentOrPixel
BarGaugeNeedleLength="3.%" PercentOrPixel
>
<TicksFont
Color="#a0c0b0"
Name="Tahoma"
Bold="0"
Italic="0"
Underline="0"
MinFontHeight="10.pt"
Size="4.%"
/>
<ColorRanges> User-defined color ranges. By default empty with no child element
entries
<Entry
From="50. " Double
FillWithColor="1" Bool
Color="#00ff00" Color
/>                                   
<Entry
From="50.0"
FillWithColor="1"
Color="#ff0000"
/>                                  
...
</ColorRanges>

© 2010 Altova GmbH Appendices


1322 Engine Information Extensions

</Gauge>

</ChartSettings>

Example: Chart Functions


The example XSLT document below shows how Altova extension functions for charts can be
used. Given further below are an XML document and a screenshot of the output image
generated when the XML document is processed with the XSLT document using the Altova
XSLT 2.0 Engine.

Note: Chart functions are supported only in the Enterprise and Reporting Editions of Altova
products.

Note: For more information about how chart data tables are created, see the documentation
of Altova's XMLSpy and StyleVision products.

XSLT document
This XSLT document (listing below) uses Altova chart extension functions to generate a pie
chart. It can be used to process the XML document listed further below.

<?xml version="1.0" encoding="UTF-8"?>


<xsl:stylesheet version="2.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:altovaext="http://www.altova.com/xslt-extensions"
exclude-result-prefixes="#all">
<xsl:output version="4.0" method="html" indent="yes" encoding="UTF-8"/>
<xsl:template match="/">
<html>
<head>
<title>
<xsl:text>HTML Page with Embedded Chart</xsl:text>
</title>
</head>
<body>
<xsl:for-each select="/Data/Region[1]">
<xsl:variable name="extChartConfig" as="item()*">
<xsl:variable name="ext-chart-settings" as="item()*">
<chart-config>
<General
SettingsVersion="1"
ChartKind="Pie3d"
BKColor="#ffffff"
ShowBorder="1"
PlotBorderColor="#000000"
PlotBKColor="#ffffff"
Title="{@id}"
ShowLegend="1"
OutsideMargin="3.2%"
TitleToPlotMargin="3.%"
LegendToPlotMargin="6.%"
>
<TitleFont
Color="#023d7d"
Name="Tahoma"
Bold="1"
Italic="0"
Underline="0"
MinFontHeight="10.pt"
Size="8.%" />

Altova XMLSpy 2011 © 2010 Altova GmbH


Engine Information Extensions 1323

</General>
</chart-config>
</xsl:variable>
<xsl:sequence select="
altovaext:create-chart-config-from-xml( $ext-chart-settings )"/>
</xsl:variable>
<xsl:variable name="chartDataSeries" as="item()*">
<xsl:variable name="chartDataRows" as="item()*">
<xsl:for-each select="(Year)">
<xsl:sequence select="
altovaext:create-chart-data-row( (@id), ( .) )"/>
</xsl:for-each>
</xsl:variable>
<xsl:variable name="chartDataSeriesNames" as="xs:string*"
select=" ( (&quot;Series 1&quot;), &apos;&apos; )[1]"/>
<xsl:sequence
select="altovaext:create-chart-data-series-from-rows(
$chartDataSeriesNames, $chartDataRows)"/>
</xsl:variable>
<xsl:variable name="ChartObj" select="altovaext:create-chart(
$extChartConfig, ( $chartDataSeries), false() )"/>
<xsl:variable name="sChartFileName" select="'mychart1.png'"/>
<img src="{$sChartFileName, altovaext:save-chart-image(
$ChartObj, $sChartFileName, 400, 400 ) }"/>
</xsl:for-each>
</body>
</html>
</xsl:template>
</xsl:stylesheet>

XML document
This XML document can be processed with the XSLT document above. Data in the XML
document is used to generate the pie chart shown in the screenshot below.

<?xml version="1.0" encoding="UTF-8"?>


<Data xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="YearlySales.xsd">
<ChartType>Pie Chart 2D</ChartType>
<Region id="Americas">
<Year id="2005">30000</Year>
<Year id="2006">90000</Year>
<Year id="2007">120000</Year>
<Year id="2008">180000</Year>
<Year id="2009">140000</Year>
<Year id="2010">100000</Year>
</Region>
<Region id="Europe">
<Year id="2005">50000</Year>
<Year id="2006">60000</Year>
<Year id="2007">80000</Year>
<Year id="2008">100000</Year>
<Year id="2009">95000</Year>
<Year id="2010">80000</Year>
</Region>
<Region id="Asia">
<Year id="2005">10000</Year>
<Year id="2006">25000</Year>
<Year id="2007">70000</Year>
<Year id="2008">110000</Year>
<Year id="2009">125000</Year>
<Year id="2010">150000</Year>
</Region>
</Data>

© 2010 Altova GmbH Appendices


1324 Engine Information Extensions

Output image
The pie chart show below is generated when the XML document listed above is processed with
the XSLT document.

Altova XMLSpy 2011 © 2010 Altova GmbH


Datatypes in DB-Generated XML Schemas 1325

2 Datatypes in DB-Generated XML Schemas


When an XML Schema is generated from a database (DB), the datatypes specific to that DB
are converted to XML Schema datatypes. The mappings of DB datatypes to XML Schema
datatypes for commonly used DBs are given in this Appendix. Select from the list below.
 MS Access
 MS SQL Server
 MySQL
 Oracle
 ODBC
 ADO
 Sybase

© 2010 Altova GmbH Appendices


1326 Datatypes in DB-Generated XML Schemas MS Access

2.1 MS Access
When an XML Schema is generated from an MS Access database (DB), the MS Access DB
datatypes are converted to XML Schema datatypes as listed in the table below.

MS Access Datatype XML Schema Datatype


G U ID xs:
I
D
char xs:
st
ri
ng
varchar xs:
st
ri
ng
m em o xs:
st
ri
ng
bi
t xs:bool
ean
Num ber(si
ngl
e) xs:
f
l
oat
Num ber(double) xs:doubl
e
Decim al xs:deci
m al
Currency xs:deci
m al
Date/Tim e xs:dateTim e
Num ber(Long Integer) xs:
i
nt
eger
Num ber(Integer) xs:
short
Num ber(Byte) xs:
byte
O LE O bject xs:base64Binary

Altova XMLSpy 2011 © 2010 Altova GmbH


Datatypes in DB-Generated XML Schemas MS SQL Server 1327

2.2 MS SQL Server


When an XML Schema is generated from an MS SQL Server database (DB), the MS SQL
Server DB datatypes are converted to XML Schema datatypes as listed in the table below.

MS SQL Server Datatype XML Schema Datatype


uni
quei
dent
i
f
i
er xs:
I
D
char xs:
st
ri
ng
nchar xs:
st
ri
ng
varchar xs:
st
ri
ng
nvarchar xs:
st
ri
ng
t
ext xs:
st
ri
ng
nt
ext xs:
st
ri
ng
sysnam e xs:
st
ri
ng
bi
t xs:bool
ean
real xs:
f
l
oat
f
l
oat xs:doubl
e
deci
m al xs:deci
m al
m oney xs:deci
m al
sm allm oney xs:deci
m al
dateti
me xs:dateTim e
sm al
l
dateti
me xs:dateTim e
bi
nary xs:base64Binary
varbi
nary xs:base64Binary
im age xs:base64Binary
i
nt
eger xs:
i
nt
eger
smal
i
nt xs:
short
bi
gi
nt xs:l
ong
t
i
nyi
nt xs:
byte

© 2010 Altova GmbH Appendices


1328 Datatypes in DB-Generated XML Schemas MySQL

2.3 MySQL
When an XML Schema is generated from a MySQL database (DB), the MySQL DB datatypes
are converted to XML Schema datatypes as listed in the table below.

My SQL Datatype XML Schema Datatype


char xs:
st
ri
ng
varchar xs:
st
ri
ng
t
ext xs:
st
ri
ng
t
i
nyt
ext xs:
st
ri
ng
m edium text xs:
st
ri
ng
l
ongt
ext xs:
st
ri
ng
t
i
nyi
nt
(1) xs:bool
ean
f
l
oat xs:
f
l
oat
doubl
e xs:doubl
e
deci
m al xs:deci
m al
dateti
me xs:dateTim e
bl
ob xs:base64Binary
t
i
nybl
ob xs:base64Binary
m edium blob xs:base64Binary
l
ongbl
ob xs:base64Binary
smal
i
nt xs:
short
bi
gi
nt xs:l
ong
t
i
nyi
nt xs:
byte

Altova XMLSpy 2011 © 2010 Altova GmbH


Datatypes in DB-Generated XML Schemas Oracle 1329

2.4 Oracle
When an XML Schema is generated from an Oracle database (DB), the Oracle DB datatypes
are converted to XML Schema datatypes as listed in the table below.

Oracle Datatype XML Schema Datatype


R O W ID xs:
I
D
CHAR xs:
st
ri
ng
NCHAR xs:
st
ri
ng
VAR C H AR 2 xs:
st
ri
ng
N VAR C H AR 2 xs:
st
ri
ng
C LO B xs:
st
ri
ng
N C LO B xs:
st
ri
ng
NUM BER (with checkconstraint xs:bool
ean
appl
i
ed)*
NUM BER xs:deci
m al
FLO A T xs:doubl
e
D A TE xs:dateTim e
IN TER VAL YEAR TO M O N TH xs:gYearM onth
B LO B xs:base64Binary

* If a check constraint is applied to a column of datatype NUMBER, and the check


constraint checks for the values 0 or 1, then the NUMBER datatype for this column will be
converted to an XML Schema datatype of xs:boolean. This mechanism is useful for
generating an xs:boolean datatype in the generated XML Schema.

© 2010 Altova GmbH Appendices


1330 Datatypes in DB-Generated XML Schemas ODBC

2.5 ODBC
When an XML Schema is generated from an ODBC database (DB), the ODBC DB datatypes
are converted to XML Schema datatypes as listed in the table below.

ODBC Datatype XML Schema Datatype


SQ L_G U ID xs:
I
D
S Q L_C H A R xs:
st
ri
ng
S Q L_V A R C H A R xs:
st
ri
ng
S Q L_LO N G V A R C H A R xs:
st
ri
ng
SQ L_BIT xs:bool
ean
S Q L_R E A L xs:
f
l
oat
S Q L_D O U B LE xs:doubl
e
S Q L_D E C IM A L xs:deci
m al
S Q L_TIM E S TA M P xs:dateTim e
S Q L_D A TE xs:date
SQ L_BIN AR Y xs:base64Binary
S Q L_V A R B IN A R Y xs:base64Binary
S Q L_LO N G V A R B IN A R Y xs:base64Binary
S Q L_IN TE G E R xs:
i
nt
eger
SQ L_SM ALLIN T xs:
short
SQ L_BIG IN T xs:l
ong
SQ L_TIN YIN T xs:
byte

Altova XMLSpy 2011 © 2010 Altova GmbH


Datatypes in DB-Generated XML Schemas ADO 1331

2.6 ADO
When an XML Schema is generated from an ADO database (DB), the ADO DB datatypes are
converted to XML Schema datatypes as listed in the table below.

ADO Datatype XML Schema Datatype


adG U ID xs:
I
D
adChar xs:
st
ri
ng
adW C har xs:
st
ri
ng
adVarChar xs:
st
ri
ng
adW VarC har xs:
st
ri
ng
adLongVarChar xs:
st
ri
ng
adW LongVarChar xs:
st
ri
ng
adVarW C har xs:
st
ri
ng
adBoolean xs:bool
ean
adSi
ngl
e xs:
f
l
oat
adDouble xs:doubl
e
adNum eric xs:deci
m al
adCurrency xs:deci
m al
adD BTim eStam p xs:dateTim e
adDate xs:date
adBi
nary xs:base64Binary
adVarBinary xs:base64Binary
adLongVarBinary xs:base64Binary
adInteger xs:
I
nteger
adUnsignedInt xs:unsi
gnedInt
adSm al
l
Int xs:
short
adUnsignedSm allInt xs:unsi
gnedShort
adBi
gInt xs:l
ong
adUnsignedBigInt xs:unsignedLong
adTi
nyInt xs:
byte
adUnsi
gnedTi
nyInt xs:unsi
gnedByte

© 2010 Altova GmbH Appendices


1332 Datatypes in DB-Generated XML Schemas Sybase

2.7 Sybase
When an XML Schema is generated from a Sybase database (DB), the Sybase DB datatypes
are converted to XML Schema datatypes as listed in the table below.

Sybase Datatype XML Schema Datatype


char xs:
st
ri
ng
nchar xs:
st
ri
ng
varchar xs:
st
ri
ng
nvarchar xs:
st
ri
ng
t
ext xs:
st
ri
ng
sysnam e-varchar(30) xs:
st
ri
ng
bi
t xs:bool
ean
real xs:
f
l
oat
f
l
oat xs:
f
l
oat
doubl
e xs:doubl
e
deci
m al xs:deci
m al
m oney xs:deci
m al
sm allm oney xs:deci
m al
dateti
me xs:dateTim e
sm al
l
dateti
me xs:dateTim e
tim estam p xs:dateTim e
binary<=255 xs:base64Binary
varbinary<=255 xs:base64Binary
im age xs:base64Binary
i
nt
eger xs:
i
nt
eger
smal
i
nt xs:
short
t
i
nyi
nt xs:
byte

Altova XMLSpy 2011 © 2010 Altova GmbH


Datatypes in DBs Generated from XML Schemas 1333

3 Datatypes in DBs Generated from XML Schemas


When a DB structure is created from an XML Schema, the datatypes specific to that DB are
generated from XML Schema datatypes. The mappings of XML Schema datatypes to DB
datatypes for commonly used DBs are given in this Appendix. Select from the list below.
 MS Access
 MS SQL Server
 MySQL
 Oracle

© 2010 Altova GmbH Appendices


1334 Datatypes in DBs Generated from XML Schemas MS Access

3.1 MS Access
When an MS Access database (DB) is created from an XML Schema, the XML Schema
datatypes are converted to MS Access datatypes as listed in the table below.

XML Schema Datatype MS Access Datatype


xs:
I
D G U ID
xs:
st
ri
ng Ifnofacetsvarchar(255)
Si
ze=ei
therl
engthorm axLength
IfSi
ze<=255varchar(n)
else m em o
xs:norm al
i
zedStri
ng Same as xs:
st
ri
ng
xs:token Same as xs:
st
ri
ng
xs:Nam e Same as xs:
st
ri
ng
xs:N C N am e Same as xs:
st
ri
ng
xs:anyURI Same as xs:
st
ri
ng
xs:Q N am e Same as xs:
st
ri
ng
xs:N O TATIO N Same as xs:
st
ri
ng
xs:bool
ean bi
t
xs:
f
l
oat Num ber(single)
xs:doubl
e Num ber(double)
xs:deci
m al Decim al
xs:durati
on Date/Tim e
xs:dateTim e Date/Tim e
xs:ti
me Date/Tim e
xs:date Date/Tim e
xs:gYearM onth Date/Tim e
xs:gYear Date/Tim e
xs:gM onthDay Date/Tim e
xs:gDay Date/Tim e
xs:gM onth Date/Tim e
xs:hexBi
nary Ifnofacetsvarbi
nary(255)
Si
ze=ei
therl
engthorm axLength
IfSi
ze<=8000varbi
nary

Altova XMLSpy 2011 © 2010 Altova GmbH


Datatypes in DBs Generated from XML Schemas MS Access 1335

else im age (OLE Object)


xs:base64Binary Same as xs:hexBi
nary
xs:
i
nt
eger Num ber(Long Integer)
xs:
i
nt Num ber(Long Integer)
xs:negati
veInteger Num ber(LongInteger);val
ueconstrai
nt
xs:
posi
t
i
veI
nt
eger Num ber(LongInteger);val
ueconstrai
nt
xs:nonNegati
veInteger Num ber(LongInteger);val
ueconstrai
nt
xs:nonPosi
ti
veInteger Num ber(LongInteger);val
ueconstrai
nt
xs:unsi
gnedInt Num ber(Long Integer)
xs:
short --noequi
val
ent--
xs:unsi
gnedShort --noequi
val
ent--
xs:l
ong --noequi
val
ent--
xs:unsignedLong --noequi
val
ent--
xs:
byte Num ber(Byte)
xs:unsi
gnedByte Num ber(Byte)

© 2010 Altova GmbH Appendices


1336 Datatypes in DBs Generated from XML Schemas MS SQL Server

3.2 MS SQL Server


When an XML Schema is generated from an MS SQL Server database (DB), the MS SQL
Server DB datatypes are converted to XML Schema datatypes as listed in the table below.

XML Schema Datatype MS SQL Server Datatype


I
D uni
quei
dent
i
f
i
er
xs:
st
ri
ng Ifnofacets
{ifUNICODE nvarchar(255)
el
sevarchar(255)}
el
se
{ifUNICO DE
(Si
ze=ei
therl
engthorm axLength)
IfSi
ze<=4000
i
fFacetLengthIsSetthennChar
else nVarChar
ifSize<= 1073741823thennText}
el
se
{ifNO N-UNICO DE
(Si
ze=ei
therl
engthorm axLength)
IfSi
ze<=8000
i
fFacetLengthIsSetthenchar
el
sevarchar
i
fSi
ze<=2147483647thentext}
xs:norm al
i
zedStri
ng Same as xs:
st
ri
ng
xs:token Same as xs:
st
ri
ng
xs:Nam e Same as xs:
st
ri
ng
xs:N C N am e Same as xs:
st
ri
ng
xs:anyURi Same as xs:
st
ri
ng
xs:Q N am e Same as xs:
st
ri
ng
xs:N O TATIO N Same as xs:
st
ri
ng
xs:bool
ean bi
t
xs:
f
l
oat real
xs:doubl
e f
l
oat

Altova XMLSpy 2011 © 2010 Altova GmbH


Datatypes in DBs Generated from XML Schemas MS SQL Server 1337

xs:deci
m al deci
m al
xs:durati
on dateti
me
xs:dateTim e dateti
me
xs:ti
me dateti
me
xs:date dateti
me
xs:gYearM onth dateti
me
xs:gYear dateti
me
xs:gM onthDay dateti
me
xs:gDay dateti
me
xs:gM onth dateti
me
xs:hexBi
nary Ifnofacetsvarbi
nary(255)
(Si
ze=ei
therl
engthorm axLength
IfSize<= 8000
i
fFacetLengthIsSetthenbi
nary
el
sevarbi
nary
ifSize <= 2147483647 then im age
xs:base64Binary Same as xs:hexBi
nary
xs:
i
nt
eger i
nt
xs:
i
nt i
nt
xs:negati
veInteger I
nt(const
rai
nedt
o{..
,
-2,
-1})
xs:
posi
t
i
veI
nt
eger I
nt(const
rai
nedt
o{1,
2,
..
})
xs:nonNegati
veInteger i
nt(const
rai
nedt
o{0,
1,
2,
..
})
xs:nonPosi
ti
veInteger i
nt(const
rai
nedt
o{..
,
-2,
-1,
0})
xs:unsi
gnedInt i
nt(addi
t
i
onalconst
rai
nt
s)
xs:
short smal
i
nt
xs:unsi
gnedShort smal
i
nt(addi
ti
onalconstrai
nts)
xs:l
ong bi
gi
nt
xs:unsignedLong bi
gi
nt(addi
t
i
onalconst
rai
nt
s)
xs:
byte t
i
nyi
nt
xs:unsi
gnedByte t
i
nyi
nt(addi
t
i
onalconst
rai
nt
s)

© 2010 Altova GmbH Appendices


1338 Datatypes in DBs Generated from XML Schemas MySQL

3.3 MySQL
When an XML Schema is generated from a MySQL database (DB), the MySQL DB datatypes
are converted to XML Schema datatypes as listed in the table below.

XML Schema Datatype MySQL Datatype


xs:
I
D varchar(255)
xs:
st
ri
ng Ifnofacetsthenvarchar(255)
elsei
ffacetl
engthi
ssetand<=255
thenchar
elseiffacetm axLengthsetand<= 255
thenvarchar
elseifm axLengthissetand<= 65545
thentext
elseifm axlengthissetand<= 16777215
then m edium text
elseifm axlengthissetand<= 429496295
thenl
ongtext
xs:norm al
i
zedStri
ng Same as xs:
st
ri
ng
xs:token Same as xs:
st
ri
ng
xs:Nam e Same as xs:
st
ri
ng
xs:N C N am e Same as xs:
st
ri
ng
xs:anyURI Same as xs:
st
ri
ng
xs:Q N am e Same as xs:
st
ri
ng
xs:N O TATIO N Same as xs:
st
ri
ng
xs:bool
ean t
i
nyi
nt
(1)
xs:
f
l
oat f
l
oat
xs:doubl
e doubl
e
xs:deci
m al deci
m al
xs:durati
on tim estam p
xs:dateTim e dateti
me
xs:ti
me ti
me
xs:date date
xs:gYearM onth ti
m estam p(4)
xs:gYear year(4)
xs:gM onthDay ti
m estam p(8);constrai
ntstocheckm onth,day

Altova XMLSpy 2011 © 2010 Altova GmbH


Datatypes in DBs Generated from XML Schemas MySQL 1339

xs:gDay ti
m estam p(8);constrai
ntstocheckday
xs:gM onth ti
m estam p(8);constrai
ntstocheckm onth
xs:hexBi
nary Ifnofacetsthenbl
ob(255)
elsei
ffacetl
engthi
ssetand<=255
thenbl ob
elseiffacetm axLengthi
ssetand<=255
thenti
nyblob
elsei
fm axl
engthi
ssetand<=65545
thenbl
ob
elseifm axlengthissetand<= 16777215
then m edium blob
elseifm axlengthissetand<= 429496295
thenlongblob
xs:base64Binary Same as xs:hexBi
nary
xs:
i
nt
eger Integer
xs:
i
nt i
nt
xs:negati
veInteger I
nt
eger(const
rai
nedt
o{..
,
-2,
-1})
xs:
posi
t
i
veI
nt
eger I
nt
eger(const
rai
nedt
o{1,
2,
..
})
xs:nonNegati
veInteger I
nt
eger(const
rai
nedt
o{0,
1,
2,
..
})
xs:nonPosi
ti
veInteger I
nt
eger(const
rai
nedt
o{..
,
-2,
-1,
0})
xs:unsi
gnedInt I
nt(addi
t
i
onalconst
rai
nt
s)
xs:
short Smal
i
nt
xs:unsi
gnedShort Smal
i
nt(addi
ti
onalconstrai
nts)
xs:l
ong Bi
gi
nt
xs:unsignedLong Bi
gi
nt(addi
t
i
onalconst
rai
nt
s)
xs:
byte Ti
nyi
nt
xs:unsi
gnedByte Ti
nyi
nt(addi
t
i
onalconst
rai
nt
s)

© 2010 Altova GmbH Appendices


1340 Datatypes in DBs Generated from XML Schemas Oracle

3.4 Oracle
When an XML Schema is generated from an Oracle database (DB), the Oracle DB datatypes
are converted to XML Schema datatypes as listed in the table below.

XML Schema Datatype Oracle Datatype


xs:
I
D R O W ID
xs:
st
ri
ng Ifnofacets
ifUNICO DE then NVARCHAR2 (255)
else VARCHAR2 (255)
else ifUNICO DE
(Si
ze=ei
therl
engthorm axLength)
IfSize <= 2000 then NCHAR
ifSize <= 4000 then NVARHCAR2
ifSize <= 4 Gigabytesthen NCLOB
else ifNO N-UNICO DE
(Si
ze=ei
therl
engthorm axLength)
IfSize <= 2000 then CHAR
ifSize <= 4000 then VARCHAR2
ifSize <= 4 Gigabytesthen CLOB
xs:norm al
i
zedStri
ng Same as xs:
st
ri
ng
xs:token Same as xs:
st
ri
ng
xs:Nam e Same as xs:
st
ri
ng
xs:N C N am e Same as xs:
st
ri
ng
xs:anyURI Same as xs:
st
ri
ng
xs:Q N am e Same as xs:
st
ri
ng
xs:N O TATIO N Same as xs:
st
ri
ng
xs:bool
ean NUM BER with constraintBoolean
xs:
f
l
oat FLO A T
xs:doubl
e FLO A T
xs:deci
m al N U M BER
xs:durati
on TIM E S TA M P
xs:dateTim e TIM E S TA M P
xs:ti
me D A TE

Altova XMLSpy 2011 © 2010 Altova GmbH


Datatypes in DBs Generated from XML Schemas Oracle 1341

xs:date D A TE
xs:gYearM onth IN TER VAL YEAR TO M O N TH
xs:gYear D A TE
xs:gM onthDay D A TE
xs:gDay D A TE
xs:gM onth D A TE
xs:hexBi
nary ifnofacetsthenRAW (255)
(Si
ze=ei
therl
engthorm axLength)
IfSize <= 2000 then RAW (X)
else Size <= 2 G igabytes then LO NG RAW (X)
ifSize<= 4GigabytesthenBLOB (X)
xs:base64Binary B LO B
xs:
i
nt
eger N U M BER
xs:
i
nt N U M BER
xs:negati
veInteger NUMBER (constrai
nedto{...,-2,-1})
xs:
posi
t
i
veI
nt
eger NUM BER (constrai
nedto{1,2,...})
xs:nonNegati
veInteger NUMBER (constrai
nedto{0,1,2,...})
xs:nonPosi
ti
veInteger NUMBER (constrai
nedto{...,-2,-1,0})
xs:unsi
gnedInt NUM BER (additionalconstraints)
xs:
short N U M BER
xs:unsi
gnedShort NUM BER (additionalconstraints)
xs:l
ong N U M BER
xs:unsignedLong NUM BER (additionalconstraints)
xs:
byte B LO B
xs:unsi
gnedByte BLOB (addi
ti
onalconstrai
nts)

© 2010 Altova GmbH Appendices


1342 Technical Data

4 Technical Data
This section contains useful background information on the technical aspects of your software.
It is organized into the following sections:
 OS and Memory Requirements
 Altova XML Parser
 Altova XSLT and XQuery Engines
 Unicode Support
 Internet Usage

Altova XMLSpy 2011 © 2010 Altova GmbH


Technical Data OS and Memory Requirements 1343

4.1 OS and Memory Requirements


Operating System
This software application is a 32-bit Windows application that runs on Windows XP, Windows
Server 2003 and 2008, Windows Vista, and Windows 7.

Memory
Since the software is written in C++ it does not require the overhead of a Java Runtime
Environment and typically requires less memory than comparable Java-based applications.
However, each document is loaded fully into memory so as to parse it completely and to
improve viewing and editing speed. The memory requirement increases with the size of the
document.

Memory requirements are also influenced by the unlimited Undo history. When repeatedly
cutting and pasting large selections in large documents, available memory can rapidly be
depleted.

© 2010 Altova GmbH Appendices


1344 Technical Data Altova XML Parser

4.2 Altova XML Parser


When opening any XML document, the application uses its built-in validating parser (the Altova
XML Parser) to check for well-formedness, validate the document against a schema (if
specified), and build trees and Infosets. The Altova XML Parser is also used to provide
intelligent editing help while you edit documents and to dynamically display any validation error
that may occur.

The built-in Altova XML Parser implements the Final Recommendation of the W3C's XML
Schema specification. New developments recommended by the W3C's XML Schema Working
Group are continuously being incorporated in the Altova Parser, so that Altova products give
you a state-of-the-art development environment.

Altova XMLSpy 2011 © 2010 Altova GmbH


Technical Data Altova XSLT and XQuery Engines 1345

4.3 Altova XSLT and XQuery Engines


Altova products use the Altova XSLT 1.0 Engine, Altova XSLT 2.0 Engine, and Altova XQuery
1.0 Engines. Documentation about implementation-specific behavior for each engine is in the
section Engine Information, in Appendix 1 of the product documentation, should that engine be
used in the product.

These three engines are also available in the AltovaXML package, which can be downloaded
from the Altova website free of charge. Documentation for using the engines is available with
the AltovaXML package.

© 2010 Altova GmbH Appendices


1346 Technical Data Unicode Support

4.4 Unicode Support


Unicode is the new 16-bit character-set standard defined by the Unicode Consortium that
provides a unique number for every character,

 no matter what the platform,


 no matter what the program,
 no matter what the language.

Fundamentally, computers just deal with numbers. They store letters and other characters by
assigning a number for each one. Before Unicode was invented, there were hundreds of
different encoding systems for assigning these numbers. No single encoding could contain
enough characters: for example, the European Union alone requires several different encodings
to cover all its languages. Even for a single language like English, no single encoding was
adequate for all the letters, punctuation, and technical symbols in common use.

These encoding systems used to conflict with one another. That is, two encodings used the
same number for two different characters, or different numbers for the same character. Any
given computer (especially servers) needs to support many different encodings; yet whenever
data is passed between different encodings or platforms, that data always runs the risk of
corruption.

Unicode is changing all that!


Unicode provides a unique number for every character, no matter what the platform, no matter
what the program, and no matter what the language. The Unicode Standard has been adopted
by such industry leaders as Apple, HP, IBM, JustSystem, Microsoft, Oracle, SAP, Sun, Base
and many others.

Unicode is required by modern standards such as XML, Java, ECMAScript (JavaScript), LDAP,
CORBA 3.0, WML, etc., and is the official way to implement ISO/IEC 10646. It is supported in
many operating systems, all modern browsers, and many other products. The emergence of the
Unicode Standard, and the availability of tools supporting it, are among the most significant
recent global software technology trends.

Incorporating Unicode into client-server or multi-tiered applications and web sites offers
significant cost savings over the use of legacy character sets. Unicode enables a single
software product or a single web site to be targeted across multiple platforms, languages and
countries without re-engineering. It allows data to be transported through many different
systems without corruption.

4.4.1 Windows XP
Altova's XML products provide full Unicode support. To edit an XML document, you will also
need a font that supports the Unicode characters being used by that document.

Please note that most fonts only contain a very specific subset of the entire Unicode range and
are therefore typically targeted at the corresponding writing system. Consequently you may
encounter XML documents that contain "unprintable" characters, because the font you have
selected does not contain the required glyphs. Therefore it can sometimes be very useful to
have a font that covers the entire Unicode range - especially when editing XML documents from
all over the world.

The most universal font we have encountered is a typeface called Arial Unicode MS that has
been created by Agfa Monotype for Microsoft. This font contains over 50,000 glyphs and covers
the entire set of characters specified by the Unicode 2.1 standard. It needs 23MB and is
included with Microsoft Office 2000.

Altova XMLSpy 2011 © 2010 Altova GmbH


Technical Data Unicode Support 1347

We highly recommend that you install this font on your system and use it with the application if
you are often editing documents in different writing systems. This font is not installed with the
"Typical" setting of the Microsoft Office setup program, but you can choose the Custom Setup
option to install this font.

In the /Examples folder in your application folder you will also find a new XHTML file called
Unicode-UTF8.html that contains the sentence "When the world wants to talk, it speaks
Unicode" in many different languages ("Wenn die Welt miteinander spricht, spricht sie
Unicode") and writing-systems ( ) - this line has been
adopted from the 10th Unicode conference in 1997 and is a beautiful illustration of the
importance of Unicode for the XML standard. Opening this file will give you a quick impression
on what is possible with Unicode and what writing systems are supported by the fonts available
on your PC installation.

4.4.2 Right-to-Left Writing Systems


Please note that even under Windows NT 4.0 any text from a right-to-left writing-system (such
as Hebrew or Arabic) is not rendered correctly except in those countries that actually use
right-to-left writing-systems. This is due to the fact that only the Hebrew and Arabic versions of
Windows NT contains support for rendering and editing right-to-left text on the operating system
layer.

© 2010 Altova GmbH Appendices


1348 Technical Data Internet Usage

4.5 Internet Usage


Altova applications will initiate Internet connections on your behalf in the following situations:

 If you click the "Request evaluation key-code" in the Registration dialog (Help |
Software Activation), the three fields in the registration dialog box are transferred to
our web server by means of a regular http (port 80) connection and the free evaluation
key-code is sent back to the customer via regular SMTP e-mail.
 If you use the URL mode of the Open dialog box to open a document directly from a
URL (File | Open | Switch to URL), that document is retrieved through a http (port 80)
connection. (This functionality is available in XMLSpy and Authentic Desktop.)
 If you open an XML document that refers to an XML Schema or DTD and the document
is specified through a URL, it is also retrieved through a http (port 80) connection once
you validate the XML document. This may also happen automatically upon opening a
document if you have instructed the application to automatically validate files upon
opening in the File tab of the Options dialog (Tools | Options). (This functionality is
available in XMLSpy and Authentic Desktop.)
 If you are using the Send by Mail... command (File | Send by Mail) in XMLSpy, the
current selection or file is sent by means of any MAPI-compliant mail program installed
on the user's PC.
 As part of Software Activation and LiveUpdate as further described in this manual and
the Altova Software License Agreement.

Altova XMLSpy 2011 © 2010 Altova GmbH


License Information 1349

5 License Information
This section contains:
 Information about the distribution of this software product
 Information about the intellectual property rights related to this software product
 The End User License Agreement governing the use of this software product

Please read this information carefully. It is binding upon you since you agreed to these terms
when you installed this software product.

© 2010 Altova GmbH Appendices


1350 License Information Electronic Software Distribution

5.1 Electronic Software Distribution


This product is available through electronic software distribution, a distribution method that
provides the following unique benefits:
 You can evaluate the software free-of-charge before making a purchasing decision.
 Once you decide to buy the software, you can place your order online at the Altova
website and immediately get a fully licensed product within minutes.
 When you place an online order, you always get the latest version of our software.
 The product package includes a comprehensive integrated onscreen help system. The
latest version of the user manual is available at www.altova.com (i) in HTML format for
online browsing, and (ii) in PDF format for download (and to print if you prefer to have
the documentation on paper).

30-day evaluation period


After downloading this product, you can evaluate it for a period of up to 30 days free of charge.
About 20 days into this evaluation period, the software will start to remind you that it has not yet
been licensed. The reminder message will be displayed once each time you start the
application. If you would like to continue using the program after the 30-day evaluation period,
you have to purchase an Altova Software License Agreement, which is delivered in the form of
a key-code that you enter into the Software Activation dialog to unlock the product. You can
purchase your license at the online shop at the Altova website.

Helping Others within Your Organization to Evaluate the Software


If you wish to distribute the evaluation version within your company network, or if you plan to use
it on a PC that is not connected to the Internet, you may only distribute the Setup programs,
provided that they are not modified in any way. Any person that accesses the software installer
that you have provided, must request their own 30-day evaluation license key code and after
expiration of their evaluation period, must also purchase a license in order to be able to
continue using the product.

For further details, please refer to the Altova Software License Agreement at the end of this
section.

Altova XMLSpy 2011 © 2010 Altova GmbH


License Information Software Activation and License Metering 1351

5.2 Software Activation and License Metering


As part of Altova’s Software Activation, the software may use your internal network and Internet
connection for the purpose of transmitting license-related data at the time of installation,
registration, use, or update to an Altova-operated license server and validating the authenticity
of the license-related data in order to protect Altova against unlicensed or illegal use of the
software and to improve customer service. Activation is based on the exchange of license
related data such as operating system, IP address, date/time, software version, and computer
name, along with other information between your computer and an Altova license server.

Your Altova product has a built-in license metering module that further helps you avoid any
unintentional violation of the End User License Agreement. Your product is licensed either as a
single-user or multi-user installation, and the license-metering module makes sure that no more
than the licensed number of users use the application concurrently.

This license-metering technology uses your local area network (LAN) to communicate between
instances of the application running on different computers.

Single license
When the application starts up, as part of the license metering process, the software sends a
short broadcast datagram to find any other instance of the product running on another computer
in the same network segment. If it doesn't get any response, it will open a port for listening to
other instances of the application.

Multi license
If more than one instance of the application is used within the same LAN, these instances will
briefly communicate with each other on startup. These instances exchange key-codes in order
to help you to better determine that the number of concurrent licenses purchased is not
accidentally violated. This is the same kind of license metering technology that is common in the
Unix world and with a number of database development tools. It allows Altova customers to
purchase reasonably-priced concurrent-use multi-user licenses.

We have also designed the applications so that they send few and small network packets so as
to not put a burden on your network. The TCP/IP ports (2799) used by your Altova product are
officially registered with the IANA (see
http://www.isi.edu/in-notes/iana/assignments/port-numbers for details) and our license-metering
module is tested and proven technology.

If you are using a firewall, you may notice communications on port 2799 between the computers
that are running Altova products. You are, of course, free to block such traffic between different
groups in your organization, as long as you can ensure by other means, that your license
agreement is not violated.

You will also notice that, if you are online, your Altova product contains many useful functions;
these are unrelated to the license-metering technology.

© 2010 Altova GmbH Appendices


1352 License Information Intellectual Property Rights

5.3 Intellectual Property Rights


The Altova Software and any copies that you are authorized by Altova to make are the
intellectual property of and are owned by Altova and its suppliers. The structure, organization
and code of the Software are the valuable trade secrets and confidential information of Altova
and its suppliers. The Software is protected by copyright, including without limitation by United
States Copyright Law, international treaty provisions and applicable laws in the country in which
it is being used. Altova retains the ownership of all patents, copyrights, trade secrets,
trademarks and other intellectual property rights pertaining to the Software, and that Altova’s
ownership rights extend to any images, photographs, animations, videos, audio, music, text and
"applets" incorporated into the Software and all accompanying printed materials. Notifications of
claimed copyright infringement should be sent to Altova’s copyright agent as further provided on
the Altova Web Site.

Altova software contains certain Third Party Software that is also protected by intellectual
property laws, including without limitation applicable copyright laws as described in detail at
http://www.altova.com/legal_3rdparty.html.

All other names or trademarks are the property of their respective owners.

Altova XMLSpy 2011 © 2010 Altova GmbH


License Information Altova End User License Agreement 1353

5.4 Altova End User License Agreement


THIS IS A LEGAL DOCUMENT -- RETAIN FOR YOUR RECORDS

ALTOVA® END USER LICENSE AGREEMENT

Licensor:

Altova GmbH
Rudolfsplatz 13a/9
A-1010 Wien
Austria

Important - Read Carefully. Notice to User:


This End User License Agreement (“Software License Agreement”) is a legal
document between you and Altova GmbH (“Altova”). It is important that you read this
document before using the Altova-provided software (“Software”) and any
accompanying documentation, including, without limitation printed materials, ‘online’
files, or electronic documentation (“Documentation”). By clicking the “I accept” and
“Next” buttons below, or by installing, or otherwise using the Software, you agree to be
bound by the terms of this Software License Agreement as well as the Altova Privacy
Policy (“Privacy Policy”) including, without limitation, the warranty disclaimers,
limitation of liability, data use and termination provisions below, whether or not you
decide to purchase the Software. You agree that this agreement is enforceable like any
written agreement negotiated and signed by you. If you do not agree, you are not licensed
to use the Software, and you must destroy any downloaded copies of the Software in your
possession or control. You may print a copy of this Software License Agreement as part of the
installation process at the time of acceptance. Alternatively, please go to our Web site at
http://www.altova.com/eula to download and print a copy of this Software License Agreement for
your files and http://www.altova.com/privacy to review the privacy policy.

1. SOFTWARE LICENSE
(a) License Grant.
(i) Upon your acceptance of this Software License Agreement Altova grants you a
non-exclusive, non-transferable (except as provided below), limited license, without the right to
grant sublicenses, to install and use a copy of the Software on one compatible personal
computer or workstation up to the Permitted Number of computers. Subject to the limitations set

© 2010 Altova GmbH Appendices


1354 License Information Altova End User License Agreement

forth in Section 1(c), you may install and use a copy of the Software on more than one of your
compatible personal computers or workstations if you have purchased a Named User license.
The Permitted Number of computers and/or users shall be determined and specified at such
time as you elect to purchase the Software. During the evaluation period, hereinafter defined,
only a single user may install and use the software on one personal computer or workstation. If
you have licensed the Software as part of a suite of Altova software products (collectively, the
“Suite”) and have not installed each product individually, then the Software License Agreement
governs your use of all of the software included in the Suite.
(ii) If you have licensed SchemaAgent, then the terms and conditions of this Software
License Agreement apply to your use of the SchemaAgent server software (“SchemaAgent
Server”) included therein, as applicable, and you are licensed to use SchemaAgent Server
solely in connection with your use of Altova Software and solely for the purposes described in
the accompanying documentation.
(iii) If you have licensed Altova Software that enables users to generate source code,
your license to install and use a copy of the Software as provided herein permits you to
generate source code based on (i) Altova Library modules that are included in the Software
(such generated code hereinafter referred to as the “Restricted Source Code”) and (ii) schemas
or mappings that you create or provide (such code as may be generated from your schema or
mapping source materials hereinafter referred to as the “Unrestricted Source Code”). In
addition to the rights granted herein, Altova grants you a non-exclusive, non-transferable, limited
license to compile the complete generated code (comprised of the combination of the
Restricted Source Code and the Unrestricted Source Code) into executable object code form,
and to use, copy, distribute or license that executable. You may not distribute or redistribute,
sublicense, sell, or transfer the Restricted Source Code to a third party, unless said third party
already has a license to the Restricted Source Code through their separate license agreement
with Altova or other agreement with Altova. Notwithstanding anything to the contrary herein, you
may not distribute, incorporate or combine with other software, or otherwise use the Altova
Library modules or Restricted Source Code, (or any Altova intellectual property embodied in or
associated with the Altova Library modules or Restricted Source Code) in any manner that
would subject the Restricted Source Code to the terms of a copyleft, free software or open
source license that would require the Restricted Source Code or Altova Library modules source
code to be disclosed in source code form. Altova reserves all other rights in and to the Software.
With respect to the feature(s) of UModel that permit reverse-engineering of your own source
code or other source code that you have lawfully obtained, such use by you does not constitute
a violation of this Agreement. Except as otherwise expressly permitted in Section 1(i) reverse
engineering of the Software is strictly prohibited as further detailed therein.
(b) Server Use. You may install one copy of the Software on a computer file server
within your internal network solely for the purpose of downloading and installing the Software

Altova XMLSpy 2011 © 2010 Altova GmbH


License Information Altova End User License Agreement 1355

onto other computers within your internal network up to the Permitted Number of computers in a
commercial environment only. If you have licensed SchemaAgent, then you may install
SchemaAgent Server on any server computer or workstation and use it in connection with your
Software. No other network use is permitted, including without limitation using the Software
either directly or through commands, data or instructions from or to a computer not part of your
internal network, for Internet or Web-hosting services or by any user not licensed to use this
copy of the Software through a valid license from Altova. If you have purchased Concurrent
User Licenses as defined in Section 1(d), and subject to limits set forth therein, you may install
a copy of the Software on a terminal server (Microsoft Terminal Server, Citrix Metaframe, etc.),
application virtualization server (Microsoft App-V, Citrix XenApp, VMWare ThinApp, etc.) or
virtual machine environment within your internal network for the sole and exclusive purpose of
permitting individual users within your organization to access and use the Software through a
terminal server, application virtualization session, or virtual machine environment from another
computer on the same physical network provided that the total number of users that access or
use the Software on such network, virtual machine or terminal server does not exceed the
Permitted Number. Altova makes no warranties or representations about the performance of
Altova software in a terminal server or virtual machine environment and the foregoing are
expressly excluded from the limited warranty in Section 5 hereof and technical support is not
available with respect to issues arising from use in such environments.
(c) Named Use. If you have licensed the “Named User” version of the software,
you may install the Software on up to 5 compatible personal computers or workstations of which
you are the primary user thereby allowing you to switch from one computer to the other as
necessary provided that only one instance of the Software will be used by you as the Named
User at any given time. If you have purchased multiple Named User licenses, each individual
Named User will receive a separate license key code.
(d) Concurrent Use. If you have licensed a “Concurrent-User” version of the
Software, you may install the Software on any compatible computers in a commercial
environment only, up to ten (10) times the Permitted Number of users, provided that only the
Permitted Number of users actually use the Software at the same time and further provided that
the computers on which the Software is installed are on the same physical computer network.
The Permitted Number of concurrent users shall be delineated at such time as you elect to
purchase the Software licenses. Each separate physical network or office location requires its
own set of separate Concurrent User Licenses for those wishing to use the Concurrent-User
versions of the Software in more than one location or on more than one network, all subject to
the above Permitted Number limitations and based on the number of users using or needing
access to the Software. If a computer is not on the same physical network, then a locally
installed user license is required. Home User restrictions and limitations with respect to the
Concurrent-User licenses used on home computers are set forth in Section 1(f).

© 2010 Altova GmbH Appendices


1356 License Information Altova End User License Agreement

(e) Backup and Archival Copies. You may make one backup and one archival
copy of the Software, provided your backup and archival copies are not installed or used on any
computer and further provided that all such copies shall bear the original and unmodified
copyright, patent and other intellectual property markings that appear on or in the Software. You
may not transfer the rights to a backup or archival copy unless you transfer all rights in the
Software as provided under Section 3.
(f) Home Use (Personal and Non-Commercial). In order to further familiarize
yourself with the Software and allow you to explore its features and functions, you, as the
primary user of the computer on which the Software is installed for commercial purposes, may
also install one copy of the Software on only one home personal home computer (such as your
laptop or desktop) solely for your own personal and non-commercial (HPNC”) use. This HPNC
copy may not be used in any commercial or revenue-generating business activities, including
without limitation, work-from-home, teleworking, telecommuting, or other work-related use of the
Software. The HPNC copy of the Software may not be used at the same time on a personal
home computer as the Software is being used on the primary computer.
(g) Key Codes, Upgrades and Updates. Prior to your purchase and as part of the
registration for the thirty (30) -day evaluation period, as applicable, you will receive an evaluation
key code. You will receive a purchase key code when you elect to purchase the Software from
either Altova GmbH or an authorized reseller. The purchase key code will enable you to activate
the Software beyond the initial evaluation period. You may not re-license, reproduce or
distribute any key code except with the express written permission of Altova. If the Software that
you have licensed is an upgrade or an update, then the latest update or upgrade that you
download and install terminates the previously licensed copy of the Software to the extent it is
being replaced. The update or upgrade and the associated license keys does not constitute the
granting of a second license to the Software in that you may not use the upgrade or updated
copy in addition to the copy of the Software that it is replacing and whose license has
terminated.
(h) Title. Title to the Software is not transferred to you. Ownership of all copies of
the Software and of copies made by you is vested in Altova, subject to the rights of use granted
to you in this Software License Agreement. As between you and Altova, documents, files,
stylesheets, generated program code (including the Unrestricted Source Code) and schemas
that are authored or created by you via your utilization of the Software, in accordance with its
Documentation and the terms of this Software License Agreement, are your property unless
they are created using Evaluation Software, as defined in Section 4 of this Agreement, in which
case you have only a limited license to use any output that contains generated program code
(including Unrestricted Source Code) such as Java, C++, C# , VB.NET or XSLT and
associated project files and build scripts, as well as generated XML, XML Schemas,
documentation, UML diagrams, and database structures only for the thirty (30) day evaluation

Altova XMLSpy 2011 © 2010 Altova GmbH


License Information Altova End User License Agreement 1357

period.
(i) Reverse Engineering. Except and to the limited extent as may be otherwise
specifically provided by applicable law in the European Union, you may not reverse engineer,
decompile, disassemble or otherwise attempt to discover the source code, underlying ideas,
underlying user interface techniques or algorithms of the Software by any means whatsoever,
directly or indirectly, or disclose any of the foregoing, except to the extent you may be expressly
permitted to decompile under applicable law in the European Union, if it is essential to do so in
order to achieve operability of the Software with another software program, and you have first
requested Altova to provide the information necessary to achieve such operability and Altova
has not made such information available. Altova has the right to impose reasonable conditions
and to request a reasonable fee before providing such information. Any information supplied by
Altova or obtained by you, as permitted hereunder, may only be used by you for the purpose
described herein and may not be disclosed to any third party or used to create any software
which is substantially similar to the expression of the Software. Requests for information from
users in the European Union with respect to the above should be directed to the Altova
Customer Support Department.
(j) Other Restrictions. You may not loan, rent, lease, sublicense, distribute or
otherwise transfer all or any portion of the Software to third parties except to the limited extent
set forth in Section 3 or as otherwise expressly provided. You may not copy the Software except
as expressly set forth above, and any copies that you are permitted to make pursuant to this
Software License Agreement must contain the same copyright, patent and other intellectual
property markings that appear on or in the Software. You may not modify, adapt or translate the
Software. You may not, directly or indirectly, encumber or suffer to exist any lien or security
interest on the Software; knowingly take any action that would cause the Software to be placed
in the public domain; or use the Software in any computer environment not specified in this
Software License Agreement.
You will comply with applicable law and Altova’s instructions regarding the use of the
Software. You agree to notify your employees and agents who may have access to the Software
of the restrictions contained in this Software License Agreement and to ensure their compliance
with these restrictions.
(k) THE SOFTWARE IS NEITHER GUARANTEED NOR WARRANTED TO BE
ERROR-FREE NOR SHALL ANY LIABILITY BE ASSUMED BY ALTOVA IN THIS RESPECT.
NOTWITHSTANDING ANY SUPPORT FOR ANY TECHNICAL STANDARD, THE
SOFTWARE IS NOT INTENDED FOR USE IN OR IN CONNECTION WITH, WITHOUT
LIMITATION, THE OPERATION OF NUCLEAR FACILITIES, AIRCRAFT NAVIGATION,
COMMUNICATION SYSTEMS, AIR TRAFFIC CONTROL EQUIPMENT, MEDICAL DEVICES
OR LIFE SUPPORT SYSTEMS, MEDICAL OR HEALTH CARE APPLICATIONS, OR OTHER
APPLICATIONS WHERE THE FAILURE OF THE SOFTWARE OR ERRORS IN DATA

© 2010 Altova GmbH Appendices


1358 License Information Altova End User License Agreement

PROCESSING COULD LEAD TO DEATH, PERSONAL INJURY OR SEVERE PHYSICAL OR


ENVIRONMENTAL DAMAGE. YOU AGREE THAT YOU ARE SOLELY RESPONSIBLE FOR
THE ACCURACY AND ADEQUACY OF THE SOFTWARE AND ANY DATA GENERATED OR
PROCESSED BY THE SOFTWARE FOR YOUR INTENDED USE AND YOU WILL DEFEND,
INDEMNIFY AND HOLD ALTOVA, ITS OFFICERS AND EMPLOYEES HARMLESS FROM
ANY 3RD PARTY CLAIMS, DEMANDS, OR SUITS THAT ARE BASED UPON THE
ACCURACY AND ADEQUACY OF THE SOFTWARE IN YOUR USE OR ANY DATA
GENERATED BY THE SOFTWARE IN YOUR USE.

2. INTELLECTUAL PROPERTY RIGHTS


Acknowledgement of Altova's Rights. You acknowledge that the Software and any
copies that you are authorized by Altova to make are the intellectual property of and are owned
by Altova and its suppliers. The structure, organization and code of the Software are the
valuable trade secrets and confidential information of Altova and its suppliers. The Software is
protected by copyright, including without limitation by United States Copyright Law, international
treaty provisions and applicable laws in the country in which it is being used. You acknowledge
that Altova retains the ownership of all patents, copyrights, trade secrets, trademarks and other
intellectual property rights pertaining to the Software, and that Altova’s ownership rights extend
to any images, photographs, animations, videos, audio, music, text and “applets” incorporated
into the Software and all accompanying printed materials. You will take no actions which
adversely affect Altova’s intellectual property rights in the Software. Trademarks shall be used
in accordance with accepted trademark practice, including identification of trademark owners’
names. Trademarks may only be used to identify printed output produced by the Software, and
such use of any trademark does not give you any right of ownership in that trademark. XMLSpy,
Authentic, StyleVision, MapForce, UModel, DatabaseSpy, DiffDog, SchemaAgent,
SemanticWorks, MissionKit, Markup Your Mind, Axad, Nanonull, and Altova are trademarks of
Altova GmbH (registered in numerous countries). Unicode and the Unicode Logo are
trademarks of Unicode, Inc. Windows, Windows XP, Windows Vista, and Windows 7 are
trademarks of Microsoft. W3C, CSS, DOM, MathML, RDF, XHTML, XML and XSL are
trademarks (registered in numerous countries) of the World Wide Web Consortium (W3C);
marks of the W3C are registered and held by its host institutions, MIT, INRIA and Keio. Except
as expressly stated above, this Software License Agreement does not grant you any intellectual
property rights in the Software. Notifications of claimed copyright infringement should be sent to
Altova’s copyright agent as further provided on the Altova Web Site.

3. LIMITED TRANSFER RIGHTS


Notwithstanding the foregoing, you may transfer all your rights to use the Software to
another person or legal entity provided that: (a) you also transfer each of this Software License

Altova XMLSpy 2011 © 2010 Altova GmbH


License Information Altova End User License Agreement 1359

Agreement, the Software and all other software or hardware bundled or pre-installed with the
Software, including all copies, updates and prior versions, and all copies of font software
converted into other formats, to such person or entity; (b) you retain no copies, including
backups and copies stored on a computer; (c) the receiving party secures a personalized key
code from Altova; and (d) the receiving party accepts the terms and conditions of this Software
License Agreement and any other terms and conditions upon which you legally purchased a
license to the Software. Notwithstanding the foregoing, you may not transfer education,
pre-release, or not-for-resale copies of the Software.

4. PRE-RELEASE AND EVALUATION PRODUCT ADDITIONAL TERMS


If the product you have received with this license is pre-commercial release or beta
Software (“Pre-release Software”), then this Section applies. In addition, this section applies to
all evaluation and/or demonstration copies of Altova software (“Evaluation Software”) and
continues in effect until you purchase a license. To the extent that any provision in this section is
in conflict with any other term or condition in this Software License Agreement, this section shall
supersede such other term(s) and condition(s) with respect to the Pre-release and/or Evaluation
Software, but only to the extent necessary to resolve the conflict. You acknowledge that the
Pre-release Software is a pre-release version, does not represent final product from Altova, and
may contain bugs, errors and other problems that could cause system or other failures and data
loss. CONSEQUENTLY, THE PRE-RELEASE AND/OR EVALUATION SOFTWARE IS
PROVIDED TO YOU “AS-IS” WITH NO WARRANTIES FOR USE OR PERFORMANCE, AND
ALTOVA DISCLAIMS ANY WARRANTY OR LIABILITY OBLIGATIONS TO YOU OF ANY
KIND, WHETHER EXPRESS OR IMPLIED. WHERE LEGALLY LIABILITY CANNOT BE
EXCLUDED FOR PRE-RELEASE AND/OR EVALUATION SOFTWARE, BUT IT MAY BE
LIMITED, ALTOVA’S LIABILITY AND THAT OF ITS SUPPLIERS SHALL BE LIMITED TO THE
SUM OF FIFTY DOLLARS (USD $50) IN TOTAL. If the Evaluation Software has a time-out
feature, then the software will cease operation after the conclusion of the designated evaluation
period. Upon such expiration date, your license will expire unless otherwise extended. Your
license to use any output created with the Evaluation Software that contains generated program
code (including Unrestricted Source Code) such as Java, C++, C, VB.NET or XSLT and
associated project files and build scripts as well as generated XML, XML Schemas,
documentation, UML diagrams, and database structures terminates automatically upon the
expiration of the designated evaluation period but the license to use such output is revived upon
your purchase of a license for the Software that you evaluated and used to create such output.
Access to any files created with the Evaluation Software is entirely at your risk. You
acknowledge that Altova has not promised or guaranteed to you that Pre-release Software will
be announced or made available to anyone in the future that Altova has no express or implied
obligation to you to announce or introduce the Pre-release Software, and that Altova may not

© 2010 Altova GmbH Appendices


1360 License Information Altova End User License Agreement

introduce a product similar to or compatible with the Pre-release Software. Accordingly, you
acknowledge that any research or development that you perform regarding the Pre-release
Software or any product associated with the Pre-release Software is done entirely at your own
risk. During the term of this Software License Agreement, if requested by Altova, you will
provide feedback to Altova regarding testing and use of the Pre-release Software, including
error or bug reports. If you have been provided the Pre-release Software pursuant to a separate
written agreement, your use of the Software is governed by such agreement. You may not
sublicense, lease, loan, rent, distribute or otherwise transfer the Pre-release Software. Upon
receipt of a later unreleased version of the Pre-release Software or release by Altova of a
publicly released commercial version of the Software, whether as a stand-alone product or as
part of a larger product, you agree to return or destroy all earlier Pre-release Software received
from Altova and to abide by the terms of the license agreement for any such later versions of
the Pre-release Software.

5. LIMITED WARRANTY AND LIMITATION OF LIABILITY


(a) Limited Warranty and Customer Remedies. Altova warrants to the person or
entity that first purchases a license for use of the Software pursuant to the terms of this
Software License Agreement that (i) the Software will perform substantially in accordance with
any accompanying Documentation for a period of ninety (90) days from the date of receipt, and
(ii) any support services provided by Altova shall be substantially as described in Section 6 of
this agreement. Some states and jurisdictions do not allow limitations on duration of an implied
warranty, so the above limitation may not apply to you. To the extent allowed by applicable law,
implied warranties on the Software, if any, are limited to ninety (90) days. Altova’s and its
suppliers’ entire liability and your exclusive remedy shall be, at Altova’s option, either (i) return of
the price paid, if any, or (ii) repair or replacement of the Software that does not meet Altova’s
Limited Warranty and which is returned to Altova with a copy of your receipt. This Limited
Warranty is void if failure of the Software has resulted from accident, abuse, misapplication,
abnormal use, Trojan horse, virus, or any other malicious external code. Any replacement
Software will be warranted for the remainder of the original warranty period or thirty (30) days,
whichever is longer. This limited warranty does not apply to Evaluation and/or Pre-release
Software.

(b) No Other Warranties and Disclaimer. THE FOREGOING LIMITED


WARRANTY AND REMEDIES STATE THE SOLE AND EXCLUSIVE REMEDIES FOR
ALTOVA OR ITS SUPPLIER’S BREACH OF WARRANTY. ALTOVA AND ITS SUPPLIERS DO
NOT AND CANNOT WARRANT THE PERFORMANCE OR RESULTS YOU MAY OBTAIN BY
USING THE SOFTWARE. EXCEPT FOR THE FOREGOING LIMITED WARRANTY, AND
FOR ANY WARRANTY, CONDITION, REPRESENTATION OR TERM TO THE EXTENT
WHICH THE SAME CANNOT OR MAY NOT BE EXCLUDED OR LIMITED BY LAW

Altova XMLSpy 2011 © 2010 Altova GmbH


License Information Altova End User License Agreement 1361

APPLICABLE TO YOU IN YOUR JURISDICTION, ALTOVA AND ITS SUPPLIERS MAKE NO


WARRANTIES, CONDITIONS, REPRESENTATIONS OR TERMS, EXPRESS OR IMPLIED,
WHETHER BY STATUTE, COMMON LAW, CUSTOM, USAGE OR OTHERWISE AS TO ANY
OTHER MATTERS. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
ALTOVA AND ITS SUPPLIERS DISCLAIM ALL OTHER WARRANTIES AND CONDITIONS,
EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, IMPLIED
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
SATISFACTORY QUALITY, INFORMATIONAL CONTENT OR ACCURACY, QUIET
ENJOYMENT, TITLE AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE,
AND THE PROVISION OF OR FAILURE TO PROVIDE SUPPORT SERVICES. THIS LIMITED
WARRANTY GIVES YOU SPECIFIC LEGAL RIGHTS. YOU MAY HAVE OTHERS, WHICH
VARY FROM STATE/JURISDICTION TO STATE/JURISDICTION.
(c) Limitation of Liability. TO THE MAXIMUM EXTENT PERMITTED BY
APPLICABLE LAW EVEN IF A REMEDY FAILS ITS ESSENTIAL PURPOSE, IN NO EVENT
SHALL ALTOVA OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL, DIRECT,
INDIRECT OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT
LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION,
LOSS OF BUSINESS INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT
OF THE USE OF OR INABILITY TO USE THE SOFTWARE OR THE PROVISION OF OR
FAILURE TO PROVIDE SUPPORT SERVICES, EVEN IF ALTOVA HAS BEEN ADVISED OF
THE POSSIBILITY OF SUCH DAMAGES. IN ANY CASE, ALTOVA’S ENTIRE LIABILITY
UNDER ANY PROVISION OF THIS SOFTWARE LICENSE AGREEMENT SHALL BE LIMITED
TO THE AMOUNT ACTUALLY PAID BY YOU FOR THE SOFTWARE PRODUCT. Because
some states and jurisdictions do not allow the exclusion or limitation of liability, the above
limitation may not apply to you. In such states and jurisdictions, Altova’s liability shall be limited
to the greatest extent permitted by law and the limitations or exclusions of warranties and
liability contained herein do not prejudice applicable statutory consumer rights of person
acquiring goods otherwise than in the course of business. The disclaimer and limited liability
above are fundamental to this Software License Agreement between Altova and you.
(d) Infringement Claims. Altova will indemnify and hold you harmless and will
defend or settle any claim, suit or proceeding brought against you by a third party that is based
upon a claim that the content contained in the Software infringes a copyright or violates an
intellectual or proprietary right protected by United States or European Union law (“Claim”), but
only to the extent the Claim arises directly out of the use of the Software and subject to the
limitations set forth in Section 5 of this Agreement except as otherwise expressly provided. You
must notify Altova in writing of any Claim within ten (10) business days after you first receive
notice of the Claim, and you shall provide to Altova at no cost such assistance and cooperation
as Altova may reasonably request from time to time in connection with the defense of the Claim.

© 2010 Altova GmbH Appendices


1362 License Information Altova End User License Agreement

Altova shall have sole control over any Claim (including, without limitation, the selection of
counsel and the right to settle on your behalf on any terms Altova deems desirable in the sole
exercise of its discretion). You may, at your sole cost, retain separate counsel and participate in
the defense or settlement negotiations. Altova shall pay actual damages, costs, and attorney
fees awarded against you (or payable by you pursuant to a settlement agreement) in connection
with a Claim to the extent such direct damages and costs are not reimbursed to you by
insurance or a third party, to an aggregate maximum equal to the purchase price of the
Software. If the Software or its use becomes the subject of a Claim or its use is enjoined, or if in
the opinion of Altova’s legal counsel the Software is likely to become the subject of a Claim,
Altova shall attempt to resolve the Claim by using commercially reasonable efforts to modify the
Software or obtain a license to continue using the Software. If in the opinion of Altova’s legal
counsel the Claim, the injunction or potential Claim cannot be resolved through reasonable
modification or licensing, Altova, at its own election, may terminate this Software License
Agreement without penalty, and will refund to you on a pro rata basis any fees paid in advance
by you to Altova. THE FOREGOING CONSTITUTES ALTOVA’S SOLE AND EXCLUSIVE
LIABILITY FOR INTELLECTUAL PROPERTY INFRINGEMENT. This indemnity does not apply
to infringements that would not be such, except for customer-supplied elements.

6. SUPPORT AND MAINTENANCE


Altova offers multiple optional “Support & Maintenance Package(s)” (“SMP”) for the
version of Software product edition that you have licensed, which you may elect to purchase in
addition to your Software license. The Support Period, hereinafter defined, covered by such
SMP shall be delineated at such time as you elect to purchase a SMP. Your rights with respect
to support and maintenance as well as your upgrade eligibility depend on your decision to
purchase SMP and the level of SMP that you have purchased:
(a) If you have not purchased SMP, you will receive the Software AS IS and will not
receive any maintenance releases or updates. However, Altova, at its option and in its sole
discretion on a case by case basis, may decide to offer maintenance releases to you as a
courtesy, but these maintenance releases will not include any new features in excess of the
feature set at the time of your purchase of the Software. In addition, Altova will provide free
technical support to you for thirty (30) days after the date of your purchase (the “Support Period”
for the purposes of this paragraph a), and Altova, in its sole discretion on a case by case basis,
may also provide free courtesy technical support during your thirty (30)-day evaluation period.
Technical support is provided via a Web-based support form only, and there is no guaranteed
response time.
(b) If you have purchased SMP, then solely for the duration of its delineated
Support Period, you are eligible to receive the version of the Software edition that you have
licensed and all maintenance releases and updates for that edition that are released during your

Altova XMLSpy 2011 © 2010 Altova GmbH


License Information Altova End User License Agreement 1363

Support Period. For the duration of your SMP’s Support Period, you will also be eligible to
receive upgrades to the comparable edition of the next version of the Software that succeeds
the Software edition that you have licensed for applicable upgrades released during your
Support Period. The specific upgrade edition that you are eligible to receive based on your
Support Period is further detailed in the SMP that you have purchased. Software that is
introduced as separate product is not included in SMP. Maintenance releases, updates and
upgrades may or may not include additional features. In addition, Altova will provide Priority
Technical Support to you for the duration of the Support Period. Priority Technical Support is
provided via a Web-based support form only and Altova will make commercially reasonable
efforts to respond via e-mail to all requests within forty-eight (48) hours during Altova’s business
hours (MO-FR, 8am UTC – 10pm UTC, Austrian and US holidays excluded) and to make
reasonable efforts to provide work-arounds to errors reported in the Software.
During the Support Period you may also report any Software problem or error to Altova.
If Altova determines that a reported reproducible material error in the Software exists and
significantly impairs the usability and utility of the Software, Altova agrees to use reasonable
commercial efforts to correct or provide a usable work-around solution in an upcoming
maintenance release or update, which is made available at certain times at Altova’s sole
discretion.
If Altova, in its discretion, requests written verification of an error or malfunction
discovered by you or requests supporting example files that exhibit the Software problem, you
shall promptly provide such verification or files, by email, telecopy, or overnight mail, setting
forth in reasonable detail the respects in which the Software fails to perform. You shall use
reasonable efforts to cooperate in diagnosis or study of errors. Altova may include error
corrections in maintenance releases, updates, or new major releases of the Software. Altova is
not obligated to fix errors that are immaterial. Immaterial errors are those that do not
significantly impact use of the Software. Whether or not you have purchased the Support &
Maintenance Package, technical support only covers issues or questions resulting directly out of
the operation of the Software and Altova will not provide you with generic consultation,
assistance, or advice under any circumstances.
Updating Software may require the updating of software not covered by this Software
License Agreement before installation. Updates of the operating system and application
software not specifically covered by this Software License Agreement are your responsibility
and will not be provided by Altova under this Software License Agreement. Altova’s obligations
under this Section 6 are contingent upon your proper use of the Software and your compliance
with the terms and conditions of this Software License Agreement at all times. Altova shall be
under no obligation to provide the above technical support if, in Altova’s opinion, the Software
has failed due to the following conditions: (i) damage caused by the relocation of the software to
another location or CPU; (ii) alterations, modifications or attempts to change the Software

© 2010 Altova GmbH Appendices


1364 License Information Altova End User License Agreement

without Altova’s written approval; (iii) causes external to the Software, such as natural disasters,
the failure or fluctuation of electrical power, or computer equipment failure; (iv) your failure to
maintain the Software at Altova’s specified release level; or (v) use of the Software with other
software without Altova’s prior written approval. It will be your sole responsibility to: (i) comply
with all Altova-specified operating and troubleshooting procedures and then notify Altova
immediately of Software malfunction and provide Altova with complete information thereof; (ii)
provide for the security of your confidential information; (iii) establish and maintain backup
systems and procedures necessary to reconstruct lost or altered files, data or programs.

7. SOFTWARE ACTIVATION, UPDATES AND LICENSE METERING


(a) License Metering. Altova has a built-in license metering module that helps you
to avoid any unintentional violation of this Software License Agreement. Altova may use your
internal network for license metering between installed versions of the Software.
(b) Software Activation. Altova’s Software may use your internal network
and Internet connection for the purpose of transmitting license-related data at the time of
installation, registration, use, or update to an Altova-operated license server and
validating the authenticity of the license-related data in order to protect Altova against
unlicensed or illegal use of the Software and to improve customer service. Activation is
based on the exchange of license related data between your computer and the Altova
license server. You agree that Altova may use these measures and you agree to follow
any applicable requirements. You further agree that use of license key codes that are not
or were not generated by Altova and lawfully obtained from Altova, or an authorized
reseller as part of an effort to activate or use the Software violates Altova’s intellectual
property rights as well as the terms of this Software License Agreement. You agree that
efforts to circumvent or disable Altova’s copyright protection mechanisms or license
management mechanism violate Altova’s intellectual property rights as well as the terms
of this Software License Agreement. Altova expressly reserves the rights to seek all
available legal and equitable remedies to prevent such actions and to recover lost
profits, damages and costs.
(c) LiveUpdate. Altova provides a new LiveUpdate notification service to you,
which is free of charge. Altova may use your internal network and Internet connection for the
purpose of transmitting license-related data to an Altova-operated LiveUpdate server to validate
your license at appropriate intervals and determine if there is any update available for you.
(d) Use of Data. The terms and conditions of the Privacy Policy are set out in full
at http://www.altova.com/privacy and are incorporated by reference into this Software License
Agreement. By your acceptance of the terms of this Software License Agreement or use of the
Software, you authorize the collection, use and disclosure of information collected by Altova for
the purposes provided for in this Software License Agreement and/or the Privacy Policy as

Altova XMLSpy 2011 © 2010 Altova GmbH


License Information Altova End User License Agreement 1365

revised from time to time. European users understand and consent to the processing of
personal information in the United States for the purposes described herein. Altova has the right
in its sole discretion to amend this provision of the Software License Agreement and/or Privacy
Policy at any time. You are encouraged to review the terms of the Privacy Policy as posted on
the Altova Web site from time to time.

8. TERM AND TERMINATION


This Software License Agreement may be terminated (a) by your giving Altova written
notice of termination; (b) by Altova, at its option, giving you written notice of termination if you
commit a breach of this Software License Agreement and fail to cure such breach within ten
(10) days after notice from Altova; or (c) at the request of an authorized Altova reseller in the
event that you fail to make your license payment or other monies due and payable. In addition
the Software License Agreement governing your use of a previous version that you have
upgraded or updated of the Software is terminated upon your acceptance of the terms and
conditions of the Software License Agreement accompanying such upgrade or update. Upon
any termination of the Software License Agreement, you must cease all use of the Software that
it governs, destroy all copies then in your possession or control and take such other actions as
Altova may reasonably request to ensure that no copies of the Software remain in your
possession or control. The terms and conditions set forth in Sections 1(h), 1(i), 1(j), 1(k), 2, 5(b),
5(c), 5(d), 7(d) 9, 10 and 11 survive termination as applicable.

9. RESTRICTED RIGHTS NOTICE AND EXPORT RESTRICTIONS


The Software was developed entirely at private expense and is commercial computer
software provided with RESTRICTED RIGHTS. Use, duplication or disclosure by the U.S.
Government or a U.S. Government contractor or subcontractor is subject to the restrictions set
forth in this Agreement and as provided in FAR 12.211 and 12.212 (48 C.F.R. §12.211 and
12.212) or DFARS 227. 7202 (48 C.F.R. §227-7202) as applicable. Consistent with the above
as applicable, Commercial Computer Software and Commercial Computer Documentation
licensed to U.S. government end users only as commercial items and only with those rights as
are granted to all other end users under the terms and conditions set forth in this Software
License Agreement. Manufacturer is Altova GmbH, Rudolfsplatz, 13a/9, A-1010 Vienna,
Austria/EU. You may not use or otherwise export or re-export the Software or Documentation
except as authorized by United States law and the laws of the jurisdiction in which the Software
was obtained. In particular, but without limitation, the Software or Documentation may not be
exported or re-exported (i) into (or to a national or resident of) any U.S. embargoed country or
(ii) to anyone on the U.S. Treasury Department's list of Specially Designated Nationals or the
U.S. Department of Commerce's Table of Denial Orders. By using the Software, you represent
and warrant that you are not located in, under control of, or a national or resident of any such

© 2010 Altova GmbH Appendices


1366 License Information Altova End User License Agreement

country or on any such list.

10. THIRD PARTY SOFTWARE


The Software may contain third party software which requires notices and/or additional
terms and conditions. Such required third party software notices and/or additional terms and
conditions are located at our Website at http://www.altova.com/legal_3rdparty.html and are
made a part of and incorporated by reference into this Agreement. By accepting this
Agreement, you are also accepting the additional terms and conditions, if any, set forth therein.

11. GENERAL PROVISIONS


If you are located in the European Union and are using the Software in the European
Union and not in the United States, then this Software License Agreement will be governed by
and construed in accordance with the laws of the Republic of Austria (excluding its conflict of
laws principles and the U.N. Convention on Contracts for the International Sale of Goods) and
you expressly agree that exclusive jurisdiction for any claim or dispute with Altova or relating in
any way to your use of the Software resides in the Handelsgericht, Wien (Commercial Court,
Vienna) and you further agree and expressly consent to the exercise of personal jurisdiction in
the Handelsgericht, Wien (Commercial Court, Vienna) in connection with any such dispute or
claim.
If you are located in the United States or are using the Software in the United States
then this Software License Agreement will be governed by and construed in accordance with
the laws of the Commonwealth of Massachusetts, USA (excluding its conflict of laws principles
and the U.N. Convention on Contracts for the International Sale of Goods) and you expressly
agree that exclusive jurisdiction for any claim or dispute with Altova or relating in any way to
your use of the Software resides in the federal or state courts of Massachusetts and you further
agree and expressly consent to the exercise of personal jurisdiction in the federal or state
courts of Massachusetts in connection with any such dispute or claim.
If you are located outside of the European Union or the United States and are not using
the Software in the United States, then this Software License Agreement will be governed by
and construed in accordance with the laws of the Republic of Austria (excluding its conflict of
laws principles and the U.N. Convention on Contracts for the International Sale of Goods) and
you expressly agree that exclusive jurisdiction for any claim or dispute with Altova or relating in
any way to your use of the Software resides in the Handelsgericht, Wien (Commercial Court,
Vienna) and you further agree and expressly consent to the exercise of personal jurisdiction in
the Handelsgericht Wien (Commercial Court, Vienna) in connection with any such dispute or
claim. This Software License Agreement will not be governed by the conflict of law rules of any
jurisdiction or the United Nations Convention on Contracts for the International Sale of Goods,
the application of which is expressly excluded.

Altova XMLSpy 2011 © 2010 Altova GmbH


License Information Altova End User License Agreement 1367

This Software License Agreement contains the entire agreement and understanding of the
parties with respect to the subject matter hereof, and supersedes all prior written and oral
understandings of the parties with respect to the subject matter hereof. Any notice or other
communication given under this Software License Agreement shall be in writing and shall have
been properly given by either of us to the other if sent by certified or registered mail, return
receipt requested, or by overnight courier to the address shown on Altova’s Web site for Altova
and the address shown in Altova’s records for you, or such other address as the parties may
designate by notice given in the manner set forth above. This Software License Agreement will
bind and inure to the benefit of the parties and our respective heirs, personal and legal
representatives, affiliates, successors and permitted assigns. The failure of either of us at any
time to require performance of any provision hereof shall in no manner affect such party’s right
at a later time to enforce the same or any other term of this Software License Agreement. This
Software License Agreement may be amended only by a document in writing signed by both of
us. In the event of a breach or threatened breach of this Software License Agreement by either
party, the other shall have all applicable equitable as well as legal remedies. Each party is duly
authorized and empowered to enter into and perform this Software License Agreement. If, for
any reason, any provision of this Software License Agreement is held invalid or otherwise
unenforceable, such invalidity or unenforceability shall not affect the remainder of this Software
License Agreement, and this Software License Agreement shall continue in full force and effect
to the fullest extent allowed by law. The parties knowingly and expressly consent to the
foregoing terms and conditions.

Last updated: 2010-08-24

© 2010 Altova GmbH Appendices


Index 1369

in Altova products, 1345

Index Altova extension functions,


chart functions (see chart functions), 1312
general functions, 1312
Altova extensions,
chart functions (see chart functions), 1311
. Altova Global Resources,
see under Global Resources, 446
.docx, 177, 425 Altova products, 30
.NET, Altova Scripting Projects, 849
and XMLSpy Debuggers, 493 Altova support, 30
differences to XMLSpy standalone, 491 Altova XML Parser,
integration of XMLSpy with, 488 about, 1344
.NET extension functions, Altova XSLT 1.0 Engine,
constructors, 1306 limitations and implementation-specific behavior, 1284
datatype conversions, .NET to XPath/XQuery, 1309 Altova XSLT 2.0 Engine,
datatype conversions, XPath/XQuery to .NET, 1308 general information about, 1286
for XSLT and XQuery, 1304 information about, 1286
instance methods, instance fields, 1307 API,
overview, 1304 accessing, 1261
static methods, static fields, 1306 documentation, 895
.pptx, 177, 425 JAVA, 1185
.xslx, 177, 425 JAVA Classpath, 1185
overview, 896
Append,

2 row (in Authentic View), 701


Append command,
in Grid View, 631
2005R3,
compatibility mode, 545 Application,
ActiveDocument, 922
AddMacroMenuItem, 922
Application, 922

A ClearMacroMenu, 922
CurrentProject, 923
Activating the software, 839 Dialogs, 923
Active configuration, Documents, 924
for global resources, 805 GetDatabaseImportElementList, 924
ActiveX controls, GetDatabaseSettings, 925
support, 881 GetDatabaseTables, 925
Add Child command, GetExportSettings, 926
in Grid View, 637 GetTextImportElementList, 926
ADO, GetTextImportExportSettings, 927
conversion of datatypes in XML Schema generation from ImportFromDatabase, 927
DB, 1331 ImportFromSchema, 928
ADO Connections, 436, 707 ImportFromText, 929
Alias, ImportFromWord, 930
see Global Resources, 446 NewProject, 931
Altova Engines, OnBeforeOpenDocument, 920

© 2010 Altova GmbH


1370 Index

Application, entering in Authentic View, 335


OnBeforeOpenProject, 920 AttributeFormDefault,
OnDocumentOpened, 921 settings in Schema Design View, 666
OnProjectOpened, 921 Attributes entry helper,
OpenProject, 931 in Authentic View, 169
Parent, 931 Attributes of schema components,
Quit, 932 defining in Schema View, 114
ReloadSettings, 932 Authentic menu, 696
RunMacro, 932 dynamic table editing, 165
ScriptingEnvironment, 933 markup display, 165
ShowApplication, 933 Authentic View,
ShowForm, 934 adding nodes, 330
URLDelete, 934 applying elements, 330
URLMakeDirectory, 935 CDATA sections in, 333
WarningNumber, 935 clearing elements, 330
WarningText, 935 context menu, 328
Application Events, 865 context menus, 173
Application name, 545 data entry devices in, 333
Application-level, displaying markup tags, 328
integration of XMLSpy, 1235 document display, 167
Apply, 820 editing data in an XML DB, 698
Archive View, 177, 425 editing DB data in, 697
and OOXML files, 427 editing XML in, 189
and ZIP files, 430 entering attribute values, 335
Arcroles in XBRL, 783 entering data in, 333
ASPRJ files, 849 entities in, 333
Assign, entry helpers, 328
shortcut to a command, 808 entry helpers in, 169
Assigning StyleVision Power Stylesheet to XML file, formating text in, 165
698 inserting entities in, 335
ATL, inserting nodes, 330
plug-in sample files, 885 interface, 164
atomization of nodes, main window in, 167
in XPath 2.0 and XQuery 1.0 evaluation, 1292 markup display in, 165, 167
ATTLIST declaration, opening an XML document in, 327
add as child in Grid View, 642 opening new XML file in, 696
appending in Grid View, 637 overview of GUI, 164
convert to in Grid View, 644 paste as XML/Text, 173
inserting in Grid View, 631 printing an XML document from, 336
Attribute, removing nodes, 330
add as child in Grid View, 638 special characters in, 333
appending in Grid View, 632 SPS Tables, 341
convert to in Grid View, 643 switching to, 762
in schema definitions, 58 tables (SPS and XML), 341
inserting in Grid View, 626 tables in, 330
toggle in Content model view, 58 toolbar icons, 165
Attribute preview, 824 tutorial, 326
Attribute values, usage of important features, 338

© 2010 Altova GmbH


Index 1371

Authentic View, IsLastRow, 958


usage of XML tables, 342 IsPasteEnabled, 958
XML table icons, 345 IsTextStateApplied, 959
XML tables, 342 LastTextPosition, 959
Authentic View Events, 865 LastXMLData, 960
Authentic View template, 327 LastXMLDataOffset, 960
Authentic XML, 324 MoveBegin, 961
AuthenticDataTransfer, MoveEnd, 962
dropEffect, 938 MoveRowDown, 962
getData, 938 MoveRowUp, 962
ownDrag, 938 Parent, 963
type, 938 Paste, 963
AuthenticRange, PerformAction, 963
AppendRow, 943 Select, 964
Application, 943 SelectNext, 964
CanPerformAction, 943 SelectPrevious, 965
CanPerformActionWith, 944 SetElementAttributeValue, 966
Close, 944 SetFromRange, 967
CollapsToBegin, 945 Text, 967
CollapsToEnd, 945 AuthenticView, 986
Copy, 945 Application, 979
Cut, 945 AsXMLString, 979
Delete, 946 DocumentBegin, 980
DeleteRow, 946 DocumentEnd, 981
DuplicateRow, 946 Event, 981
ExpandTo, 947 Goto, 982
FirstTextPosition, 948 IsRedoEnabled, 983
FirstXMLData, 948 IsUndoEnabled, 983
FirstXMLDataOffset, 949 MarkupVisibility, 983
GetElementAttributeNames, 950 OnBeforeCopy, 969
GetElementAttributeValue, 950 OnBeforeCut, 969
GetElementHierarchy, 951 OnBeforeDelete, 970
GetEntityNames, 952 OnBeforeDrop, 970
Goto, 952 OnBeforePaste, 971
GotoNext, 953 OnDragOver, 972
GotoNextCursorPosition, 953 OnKeyboardEvent, 973
GotoPrevious, 954 OnMouseEvent, 975
GotoPreviousCursorPosition, 954 OnSelectionChanged, 976
HasElementAttribute, 955 Parent, 984
InsertEntity, 955 Print, 984
InsertRow, 956 Redo, 984
IsCopyEnabled, 956 Selection, 985
IsCutEnabled, 956 Undo, 986
IsDeleteEnabled, 957 WholeDocument, 986
IsEmpty, 957 XMLDataRoot, 987
IsEqual, 957 Auto-complete,
IsFirstRow, 957 text view enable/disable, 823
IsInDynamicTable, 958 Auto-completion in SQL scripts, 721

© 2010 Altova GmbH


1372 Index

Auto-hiding windows, 10
Auto-Macro setting, 868
Automatic validation, 822
C
C#,

B code, 504
integration of XMLSpy, 1239, 1240
Back, settings, 545
in Schema View, 142 C++,
Background, code, 504
gradient, 545 settings, 545
status updates, 482 Call Stack Window,
status updates - increase interval, 468 in XSLT/XQuery Debugger, 299
Background Information, 1342 Callgraph profiling, 311
backwards compatibility, Calling named templates, 272
of XSLT 2.0 Engine, 1286 Carriage return key,
Base package, 545 see Enter key, 357
Big-endian, 831 Cascade,
Bookmark, 838 Window, 836
Bookmark margin, 764 Catalog,
Bookmarks, Oasis XML, 649
inserting and removing, 597 Catalogs, 241
navigating, 597 CDATA,
Bookmarks in SQL scripts, 721 add as child in Grid View, 638
Bookmarks in Text View, 99 appending in Grid View, 633
Breakpoint, convert to in Grid View, 643
dialog box, 694 inserting in Grid View, 627
Breakpoints, CDATA sections,
using in SOAP debugger, 389 inserting in Authentic View, 338
using in XSLT/XQuery Debugger, 302 Changing view,
Breakpoints dialog, 290 to Authentic View, 165
Browse, Chapters, 838
Oracle XML Db, 737 Character,
Browser, 824 position, 764
View, 762 character entities,
Browser menu, 766 in HTML output of XSLT transformation, 1284
Browser pane, character normalization,
in Database Query window, 717 in XQuery document, 1289
Browser View, 176, 766 Character-Set,
back, 766 encoding, 831
font size, 766 Chart data table,
forward, 766 how it is constructed, 196
refresh content, 766 Chart functions,
separate window, 766 chart data structure for, 1317
stop loading page, 766 example, 1322
listing, 1315
Charts,

© 2010 Altova GmbH


Index 1373

Charts, Commands,
in XSLT/XQuery Profiler, 321 listing in key map, 839
multiple tabs for, 195 Comment,
overview, 195 add as child in Grid View, 639
reloading, 195 appending in Grid View, 633
Charts Window, 24 convert to in Grid View, 644
Check, inserting in Grid View, 627
spelling checker, 792 Commenting in and out,
Class, in XML documents in Text View., 184
JAVA, 1185 Commenting XML text in and out, 597
Class ID, Comments in SQL scripts, 721
in XMLSpy integration, 1235 Communication process,
ClassPath statement, 1185 SOAP debugger, 382
Code, Comparing directories, 800
built in types, 556 Comparing files, 798
SPL, 546 options, 803
Code compatibility, Comparisons,
v2005R3, 545 of directories, 467
Code Generator, 504, 664 of files, 466
Code page, 825 of files and directories, 465
CodeGeneratorDlg, Compatibility mode,
Application, 988 v2005R3, 545
CPPSettings_DOMType, 988 Compile,
CPPSettings_LibraryType, 989 for Linux/GCC, 509
CPPSettings_UseMFC, 990 Compiler,
CSharpSettings_ProjectType, 990 settings, 545
OutputPath, 990 Complex type,
OutputPathDialogAction, 990 extending definition, 49
OutputResultDialogAction, 991 in schema definitions, 49
Parent, 991 Component definition,
ProgrammingLanguage, 991 reusing, 49
PropertySheetDialogAction, 992 Component Navigator, 129
TemplateFileName, 992 Compositor,
Collapse, for sequences, 38
unselected, 763 in Schema View, 118
collations, Configurations,
in XPath 2.0, 1292 of a global resource, 447
in XQuery document, 1289 Configurations in global resources, 458
Color, 825, 828 Configure,
tab, 829 XMLSPY UI, 882
table, 829 Configure view,
COM-API, dialog for Content Model View, 671
documentation, 895 Connecting to data source, 433, 434, 436, 440, 703,
Command, 705, 707, 711
add to toolbar/menu, 806 via a global resource, 443, 714
context menu, 813 Connecting to SchemaAgent Server, 246, 678
delete from menu, 813 Connection Wizard, 434, 705
reset menu, 813 Constraints, 132

© 2010 Altova GmbH


1374 Index

Content Model, CSV file,


creating a basic model, 38 import as XML, 739
save diagram, 668 Custom dictionary, 792
toggle attributes, 58 CustomCatalog, 649
Content Model View, 34, 118 Customization, 28
configuring, 671 Customize,
Content models, context menu, 813
of schema components, 118 Customize context menu, 818
Context menu, macros, 815
commands, 813 menu, 813
for customization, 818 toolbar/menu commands, 806
Context menus, Cut command, 584
in Authentic View, 173 CVS, 468
Context Window,
in XSLT/XQuery Debugger, 298
Convert,
database data to XML, 741 D
database schema to XML Schema, 746
Database,
MS Word data to XML, 745
ADO connections, 436, 707
Oracle XML Db, 734
connecting to, 433, 703
schema to DB structure, 751
connecting via global resource, 443, 714
text file to XML, 739
Connection Wizard, 434, 705
Convert menu, 739
create DB based on schema, 751
Convert To command,
editing records of, 724
in Grid View, 643
Existing connections, 435, 706
Copy,
export of XML data to, 757
as XML text, 584
import data as XML, 741
XML as structured text, 585
import structure as XML Schema, 746
Copy command, 584
ODBC connections, 440, 711
Copy XPath, 589
Oracle XML Db, 734
Copy XPointer, 589
Database Query,
Copyright information, 841, 1349
Browser pane in DB Query window, 717
count() function,
Connecting to DB for query, 716
in XPath 1.0, 1284
creating the query, 724
count() function in XPath 2.0,
Editing results, 724
see fn:count(), 1292
Messages pane, 724
CPU,
Results of, 724
load - increase background status updates, 468
Database Query window, 714
CR&LF, 820
Database/Table View,
Create,
how to use, 82
DB based on schema, 751
DatabaseConnection,
CSS, 360
ADOConnection, 993
auto-completion, 363
AsAttributes, 993
document outline, 363
CreateMissingTables, 994
Info window, 363
CreateNew, 994
properties, 363
DatabaseKind, 994
syntax coloring, 363
ExcludeKeys, 995
CSS Info window, 363

© 2010 Altova GmbH


Index 1375

DatabaseConnection, show curr. exec. nodes, 693


File, 995 SOAP communication example, 383
IncludeEmptyElements, 996 start XSLT Debugger, 691
NumberDateTimeFormat, 996 step into, 692
ODBCConnection, 997 step out, 692
SQLSelect, 998 step over, 692
TextFieldLen, 998 stop XSLT Debugger, 692
Databases, Debugger windows,
and global resources, 457 arrangement, 301
editing in Authentic View, 697 Debugging macros, 871
see also DB, 347 deep-equal() function in XPath 2.0,
support in XMLSpy, 445 see fn:deep-equal(), 1292
Databases in XMLSpy, 432 Default,
Datatypes, encoding, 831
conversion of DB to XML Schema, 1325 menu, 813
for DBs generated from XML Schemas, 1333 Default editor, 822
in XPath 2.0 and XQuery 1.0, 1292 default functions namespace,
see also XML Schema datatypes, 1326 for XPath 2.0 and XQueyr 1.0 expressions, 1292
Date Picker, in XSLT 2.0 stylesheets, 1286
using in Authentic View, 354 Default view,
Dates, setting in Main Window, 822
changing manually, 354 Delete,
DB, Application.URLDelete, 934
creating queries, 348 command from context menu, 813
datatype conversion for XML Schema, 1325 command from toolbar, 806
datatypes from XML Schema, 1333 icon from toolbar, 806
editing in Authentic View, 347, 352 row (in Authentic View), 701
filtering display in Authentic View, 348 shortcut, 808
navigating tables in Authentic View, 348 toolbar, 807
parameters in DB queries, 348 Delete command, 584
queries in Authentic View, 347 Deriving a schema type, 136
DB XML, Details Entry Helper, 38
assigning XML Schemas to, for IBM DB2, 730 Dialogs,
managing XML Schemas, for IBM DB2, 727 Application, 999
db2-fn:sqlquery, 284 CodeGeneratorDlg, 999
db2-fn:xmlcolumn, 284 DTDSchemaGeneratorDlg, 1000
Debugger, FileSelectionDlg, 999
breakpoints/tracepoints dialog box, 694 GenerateSampleXMLDlg, 1000
debug windows, 695 Parent, 1000
enable/disable breakpoint, 693 SchemaDocumentationDlg, 1000
enable/disable tracepoint, 694 Dictionary,
end session, 692 adding custom, 792
for SOAP, 780 modifying existing, 792
insert/remove breakpoint, 693 spelling checker, 792
insert/remove tracepoint, 693 Diffdog,
options for SOAP, 782 configure for differencing, 482
restart XSLT Debugger, 692 Differencing,
settings, 695 configuring Diffdog, 482

© 2010 Altova GmbH


1376 Index

directories, IsEditClearEnabled (obsolete), 1157


comparing two, 800 IsEditCopyEnabled (obsolete), 1157
creating with Application.URLMakeDirectory, 935 IsEditCutEnabled (obsolete), 1158
Directory comparisons, 465, 467 IsEditPasteEnabled (obsolete), 1158
Disable, IsEditRedoEnabled (obsolete), 1159
breakpoint - XSLT debugger, 693 IsEditUndoEnabled (obsolete), 1159
tracepoint - XSLT debugger, 694 IsRowAppendEnabled (obsolete), 1160
Disconnect XMLSpy from SchemaAgent, 679 IsRowDeleteEnabled (obsolete), 1160
Display all globals, 675 IsRowDuplicateEnabled (obsolete), 1161
Display diagram, 675 IsRowInsertEnabled (obsolete), 1161
Display Settings, 829 IsRowMoveDOwnEnabled (obsolete), 1162
Distribution, IsRowMoveUpEnabled (obsolete), 1162
of Altova's software products, 1349, 1350, 1352 IsTextStateApplied (obsolete), 1163
Dll, IsTextStateEnabled (obsolete), 1163
compiler settings, 545 LoadXML (obsolete), 1164
DocEditEvent (obsolete), RowAppend (obsolete), 1166
altKey (obsolete), 1127 RowDelete (obsolete), 1166
altLeft (obsolete), 1128 RowDuplicate (obsolete), 1167
button (obsolete), 1129 RowInsert (obsolete), 1167
cancelBubble (obsolete), 1130 RowMoveDown (obsolete), 1168
clientX (obsolete), 1131 RowMoveUp (obsolete), 1168
clientY (obsolete), 1132 SaveXML (obsolete), 1169
ctrlKey (obsolete), 1133 SelectionMoveTabOrder (obsolete), 1170
ctrlLeft (obsolete), 1134 SelectionSet (obsolete), 1171
dataTransfer (obsolete), 1135 XMLRoot (obsolete), 1172
fromElement (obsolete), 1136 Dockable window, 836
keyCode (obsolete), 1136 Docking windows, 10
propertyName (obsolete), 1137 DOCTYPE declaration,
repeat (obsolete), 1137 add as child in Grid View, 641
returnValue (obsolete), 1137 appending in Grid View, 635
shiftKey (obsolete), 1138 convert to in Grid View, 644
shiftLeft (obsolete), 1139 inserting in Grid View, 629
srcElement (obsolete), 1140 Document,
type (obsolete), 1141 Application, 1006
DocEditView (obsolete), AssignDTD, 1006
ApplyTextState (obsolete), 1147 AssignSchema, 1007
CurrentSelection (obsolete), 1148 AssignXSL, 1007
EditClear (obsolete), 1148 AssignXSLFO, 1007
EditCopy (obsolete), 1149 AuthenticView, 1008
EditCut (obsolete), 1149 browse Oracle XML Db, 737
EditPaste (obsolete), 1150 Close, 1008
EditRedo (obsolete), 1150 ConvertDTDOrSchema, 1009
EditSelectAll (obsolete), 1151 CreateChild, 1010
EditUndo (obsolete), 1151 CreateSchemaDiagram, 1011
event (obsolete), 1152 CurrentViewMode, 1011
GetAllowedElements (obsolete), 1152 DataRoot, 1011
GetNextVisible (obsolete), 1155 DocEditView, 1012
GetPreviousVisible (obsolete), 1156 Encoding, 1012

© 2010 Altova GmbH


Index 1377

Document, Document-level,
EndChanges, 1013 examples of integration of XMLSpy, 1239
ExecuteXQuery, 1013 integration of XMLSpy, 1238, 1239
ExportToDatabase, 1013 integration of XMLSpyControl, 1238
ExportToText, 1014 Documents,
FullName, 1015 Count, 1030
GenerateDTDOrSchema, 1015, 1016 Item, 1030
GenerateProgramCode, 1016 NewFile, 1030
GenerateSampleXML, 1016 NewFileFromText, 1031
GenerateSchemaDocumentation, 1016 OpenFile, 1031
GetExportElementList, 1018 OpenURL, 1031
GetPathName, 1019 OpenURLDialog, 1032
GridView, 1019 Documents in Main Window, 11
IsModified, 1019 DTD,
IsValid, 1020 assigning to XML document, 655
IsWellFormed, 1021 Attlist declaration in, 631, 637, 642, 644
Name, 1021 converting to UML, 661
OnBeforeCloseDocument, 1004 converting to XML Schema, 659
OnBeforeSaveDocument, 1003 Element declaration in, 630, 636, 642, 644
OnBeforeValidate, 1005 Entity declaration in, 631, 637, 642, 644
OnCloseDocument, 1005 generate outline XML file from, 663
OnViewActivation, 1006 generating code from, 664
Path, 1022 generating from XML document, 657
RootElement, 1022 generating from XML Schema (Enterprise and Professional
Save, 1022 editions), 229
SaveAs, 1023 go to definition in from XML document, 657
Saved, 1023 go to from XML document, 656
SaveInString, 1023 including entities, 656
SaveToURL, 1024 menu commands related to, 655
SetActiveDocument, 1024 Notation declaration in, 631, 637, 642, 645
SetEncoding, 1024 reference from XML to external DTD, 630
SetExternalIsValid, 1026 DTD/Schema menu, 655
SetPathName, 1026 DTDs, 226, 820, 822
Spelling checker, 792 converting to XML Schemas (Enterprise and Professional
editions), 227
StartChanges, 1026
editing in Grid View (Enterprise and Professional editions),
SwitchViewMode, 1027 227
Title, 1027 editing in Text View, 227
TransformXSL, 1028 generating XML document from, 227
TransformXSLFO, 1028 DTDSchemaGeneratorDlg,
UpdateViews, 1029 Application, 1033
UpdateXMLData, 1029 AttributeTypeDefinition, 1033
XQuery, 1013 DTDSchemaFormat, 1033
Document Events, 865 FrequentElements, 1034
Documentation, GlobalAttributes, 1034
for schema, 64 MaxEnumLength, 1034
of WSDL files, 773 MergeAllEqualNamed, 1034
of XBRL taxonomies, 788 OnlyStringEnums, 1035
of XML Schema files, 668

© 2010 Altova GmbH


1378 Index

DTDSchemaGeneratorDlg, Count, 1037


OutputPath, 1035 Item, 1037
OutputPathDialogAction, 1035 RemoveElement, 1037
Parent, 1035 ElementListItem,
ResolveEntities, 1035 ElementKind, 1037
TypeDetection, 1036 FieldCount, 1038
ValueList, 1036 Name, 1038
Duplicate, RecordCount, 1038
row (in Authentic View), 701 Elements entry helper,
Dynamic (SPS) tables in Authentic View, in Authentic View, 169
usage of, 341 E-mail,
Dynamic tables, sending files with, 579
editing, 165 Empty elements, 822
Empty lines,
in XML documents in Text View, 184
Enable breakpoint - XSLT debugger, 693
E Enable tracepoint - XSLT debugger, 694
Enclose in Element command, 648
Eclipse platform,
encoding,
and XMLSpy, 495
default, 831
and XMLSpy Integration Package, 496
in XQuery document, 1289
XMLSpy Debugger perspectives, 503
of files, 573
XMLSpy perspective in, 500
End,
Edit,
debugger session, 692
macro button, 818
End User License Agreement, 1349, 1353
Edit menu, 583
End-of-line markers, 764
Edited with XMLSPY, 820
Engine information, 1283
Editing database records, 724
Enhanced Grid View, 761
Editing in Text View, 102
see Grid View, 72
Editing views, 96
Enter key,
Element,
effects of using, 357
add as child in Grid View, 638
Entities,
appending in Grid View, 632
defining in Authentic View, 338, 355
convert to in Grid View, 643
in XML Schema-based XML, 182
inserting in Grid View, 626
inserting in Authentic View, 335, 338
making optional, 45
Entities entry helper,
restricting content, 45
in Authentic View, 169
ELEMENT declaration,
ENTITY declaration,
add as child in Grid View, 642
add as child in Grid View, 642
appending in Grid View, 636
appending in Grid View, 637
convert to in Grid View, 644
convert to in Grid View, 644
ELEMENT declaration in DTD,
inserting in Grid View, 631
inserting in Grid View, 630
Entry Helper, 33
element type,
Details, 38
specifying in XML document, 70
in Grid View, 80
ElementFormDefault,
Entry helpers, 14
settings in Schema Design View, 666
for XML documents, 191
ElementList,
for XQuery, 280

© 2010 Altova GmbH


Index 1379

Entry helpers, 14 Event, 920, 921, 969, 970, 971, 972, 973, 975, 976, 1003,
in Schema View, 129 1004, 1005, 1006, 1056, 1057, 1058
toggling display on and off, 837 Event handlers,
updating, 653 in Scripting Project, 865
Entry helpers in Text View, 104 overview, 854
Entry-Helper, 837 Events, 865, 900
Enumeration, and event handlers, 856
defining for attributes, 58 Example files,
Enumerations, tutorial, 32
in XMLSpyControl, 1278 Examples,
SPYAttributeTypeDefinition, 1174 location of installed files, 30
SPYAuthenticActions, 1174 Excel 2007, 177, 425
SPYAuthenticDocumentPosition, 1174 Exception,
SpyAuthenticElementActions, 1175 out of memory, 543
SPYAuthenticElementKind, 1175 Expand,
SPYAuthenticMarkupVisibility, 1175 fully, 763
SPYDatabaseKind, 1176 Explorer, 822
SPYDialogAction, 1176 Exporting XML data to database, 757
SPYDOMType, 1176 Exporting XML data to text files, 754
SPYDTDSchemaFormat, 1176 ExportSettings,
SPYEncodingByteOrder, 1176 CreateKeys, 1039
SPYExportNamespace, 1177 ElementList, 1039
SPYFrequentElements, 1177 EntitiesToText, 1039
SPYKeyEvent, 1178 ExportAllElements, 1039
SPYLibType, 1178 FromAttributes, 1040
SPYLoading, 1178 FromSingleSubElements, 1040
SPYMouseEvent, 1178 FromTextValues, 1040
SPYNumberDateTimeFormat, 1179 IndependentPrimaryKey, 1040
SPYProgrammingLanguage, 1179 Namespace, 1040
SPYProjectItemTypes, 1179 SubLevelLimit, 1041
SPYProjectType, 1180 Extended schema validation, 234
SPYSampleXMLGenerationOptimization, 1180 Extended validation, 253
SPYSampleXMLGenerationSchemaOrDTDAssignment, in SchemaAgent, 680
1180 Extension functions for XSLT and XQuery, 1296
SPYSchemaDefKind, 1180 Extension Functions in .NET for XSLT and XQuery,
SPYSchemaDocumentationFormat, 1181 see under .NET extension functions, 1304
SPYTextDelimiters, 1181 Extension Functions in Java for XSLT and XQuery,
SPYTextEnclosing, 1182 see under Java extension functions, 1296
SPYTypeDetection, 1182 Extension Functions in MSXSL scripts, 1309
SPYURLTapes, 1182 external functions,
SPYViewModes, 1182 in XQuery document, 1289
SPYVirtualKeyMask, 1183 External ID declaration,
SPYXMLDataKind, 1183 add as child in Grid View, 641
Evaluating XPath, 16 appending in Grid View, 636
Evaluation key, convert to in Grid View, 644
for your Altova software, 839 inserting in Grid View, 630
Evaluation period, External parsed entites, 822
of Altova's software products, 1349, 1350, 1352 External XSL processor, 831

© 2010 Altova GmbH


1380 Index

restricting search to components, 258


results, 265
search term, 256
F setting scope of, 262
window, 265
Favorites, 838
Find in Schemas Window, 23
File,
Find in XBRL, 420
closing, 573
results, 424
creating new, 565
search term, 420
default encoding, 831
window, 424
encoding, 573
Find in XBRL Window, 23
opening, 569
Floating windows, 10
opening options, 820
fn:base-uri in XPath 2.0,
printing options, 580
support in Altova Engines, 1293
saving, 574
fn:collection in XPath 2.0,
sending by e-mail, 579
support in Altova Engines, 1293
tab, 820
fn:count() in XPath 2.0,
File comparisons, 465, 466
and whitespace, 1292
File extensions,
fn:current-date in XPath 2.0,
customizing, 649
support in Altova Engines, 1293
for XQuery files, 279
fn:current-dateTime in XPath 2.0,
setting extensions as file type, 241
support in Altova Engines, 1293
File menu, 565
fn:current-time in XPath 2.0,
File path,
support in Altova Engines, 1293
inserting, 587
fn:data in XPath 2.0,
File paths,
support in Altova Engines, 1293
inserting in XMl document, 184
fn:deep-equal() in XPath 2.0,
File types, 822
and whitespace, 1292
Files,
fn:id in XPath 2.0,
adding to source control, 608
support in Altova Engines, 1293
comparing two, 798
fn:idref in XPath 2.0,
comparison options, 803
support in Altova Engines, 1293
most recently used, 581
fn:index-of in XPath 2.0,
FileSelectionDlg,
support in Altova Engines, 1293
Application, 1041
fn:in-scope-prefixes in XPath 2.0,
DialogAction, 1042
support in Altova Engines, 1293
FullName, 1042
fn:last() in XPath 2.0,
Parent, 1042
and whitespace, 1292
Find,
fn:lower-case in XPath 2.0,
and replace text in document, 593
support in Altova Engines, 1293
text in document, 590
fn:normalize-unicode in XPath 2.0,
Find in Files command, 595
support in Altova Engines, 1293
Find in Files Window, 21
fn:position() in XPath 2.0,
Find in Schemas, 255
and whitespace, 1292
executing Find and Replace commands, 263
fn:resolve-uri in XPath 2.0,
executing Find command, 422
support in Altova Engines, 1293
replace term, 256
fn:static-base-uri in XPath 2.0,
restricting search by property and property value, 259
support in Altova Engines, 1293

© 2010 Altova GmbH


Index 1381

fn:upper-case in XPath 2.0, TakeFirstChoice, 1054


support in Altova Engines, 1293 Global,
Folding margin, 764 settings, 820
Font, Global components,
schema, 826 creating in Schema Overview, 114
Schema Documentation, 826 Global declarations, 857
Font size, overview, 854
in Browser View, 766 Global element,
Fonts in Text View, 97 using in XML Schema, 56
Form Object Palette, 851 Global objects,
Form Object properties, 860 in SPL, 549
Formatting in Text View, 97 Global resources, 446
Forms, active configuration for, 805
and built-in commands, 872 changing configurations, 458
and event handling, 862 copying configurations, 453
and Form Objects, 860 defining, 447, 805
creating new, 859 defining database-type, 452
in Scripting Projects, 859 defining file-type, 449
invocation of, 856 defining folder-type, 451
naming, 859 toolbar activation, 807
overview, 854 using, 454, 457, 458
properties of, 859 using file-type and folder-type, 454
setting tab sequence of objects, 860 Global Resources XML File, 447
Forward, Global scripting project,
in Schema View, 142 of XMLSpy, 849
Full-text, Go to File, 764
search, 838 Go to line/char, 764
functions, gradient,
see under XSLT 2.0 functions, 1288 background, 545
XPath 2.0 and XQuery 1.0, 1292 Grammar, 822
Graphics formats,
in Authentic View, 356
Gray bar, 762, 763
G Grid fonts, 825
Grid view, 106, 761, 763
GCC,
and data import/export, 108
compile for Linux/GCC, 509
and Table View, 82
Generate,
appending elements and attributes, 80
code from schema, 504
data-entry in, 72
DB structure based on schema, 751
editing, 647, 648
Generate Sample XML, 1174, 1180
editing in, 107
GenerateSampleXMLDlg,
editing XML documents in (Enterprise and Professional
Application, 1053 editions), 186
FillWithSampleData, 1054 entry helpers in, 112
NonMandatoryAttributes, 1053 switching to Table View, 645
NonMandatoryElements, 1053 tables, 108
Parent, 1053 using Entry Helpers, 80
RepeatCount, 1054 Grid View Events, 865

© 2010 Altova GmbH


1382 Index

GridView, show large, 817


CurrentFocus, 1059 Identity constraint,
Deselect, 1059 toggle in Content model view, 58
IsVisible, 1059 Identity constraints, 132
OnBeforeDrag, 1056 defining in Schema View, 114
OnBeforeDrop, 1057 Image formats,
OnBeforeStartEditing, 1057 in Authentic View, 356
OnEditingFinished, 1058 implementation-specific behavior,
OnFocusChanged, 1058 of XSLT 2.0 functions, 1288
Select, 1059 implicit timezone,
SetFocus, 1059 and XPath 2.0 functions, 1292
GUI description, 10 Import,
database data as XML, 741
database data based on XML Schema, 750
database structure as XML Schema, 746
H MS Word document as XML, 745
text file as XML, 739
Help,
Import/export of data,
contents, 838
and Grid View, 108
index, 838
Importing taxonomies, 787
key map, 839
Indentation,
search, 838
in Text View, 590
Help menu, 838
Indentation guides, 764
Help system, 838
Indentation in Text View, 97
Hide, 836, 837
Index,
Hide markup, 165, 167
help, 838
Hide markup (in Authentic View), 701
Info,
Hit Count profiling, 311
window, 33
Hotkey, 808
Info Window, 14, 836, 837
HTML, 360
for CSS documents, 363
integration of XMLSpy, 1244
for HTML documents, 361
HTML documents,
in XSLT/XQuery Debugger, 300
editing, 361
Info window, XSLT tab,
Info window, 361
and creating Zip folders, 275
HTML example,
and Projects, 275
of XMLSpyControl integration, 1235, 1236, 1237
and XSLT documents, 275
HTML Info window, 361
description of, 275
see also XSL Outline, 275
Information Windows,

I arranging, 301
Insert,
IBM DB2, breakpoint - XSLT debugger, 693
assigning XML Schemas to XML file, 730 row (in Authentic View), 701
managing XML Schemas, 727 tracepoint - XSLT debugger, 693
schema management and assignment, 727 Insert command,
Icon, in Grid View, 625
add to toolbar/menu, 806 Insert file path, 587
Installation,

© 2010 Altova GmbH


Index 1383

Installation,
location of example files, 30
Installing,
version control systems, 475 L
Integrating,
Language,
XMLSpy in applications, 1234
scripting language - changing, 856
Intelligent Editing, 823
Large markup (in Authentic View), 701
Internet, 840, 841
last() function,
Internet usage,
in XPath 1.0, 1284
in Altova products, 1348
last() function in XPath 2.0,
Introduction,
see fn:last(), 1292
code generator, 505
Legal information, 1349
Lib,
compiler settings, 545

J Library, 557
library modules,
JAVA, in XQuery document, 1289
API, 1185 License, 1353
ClassPath, 1185 information about, 1349
code, 504 License metering,
settings, 545 in Altova products, 1351
Java extension functions, Licenses,
constructors, 1301 for your Altova software, 839
datatype conversions, Java to Xpath/XQuery, 1303 Line,
datatype conversions, XPath/XQuery to Java, 1302 go to, 764
for XSLT and XQuery, 1296 Line length,
instance methods, instance fields, 1302 word wrap in text view, 763
overview, 1296 Line margin, 764
static methods, static fields, 1301 Line numbering in Text View, 99
user-defined class files, 1297 Line-breaks, 820
user-defined JAR files, 1300 Linkbases,
JRE, referencing, 787
for XMLSpy Plugin for Eclipse, 496 Linkbases in taxonomies, 405
JSON, 360 Linkroles in XBRL, 785
convert from and to XML, 759 Linkroles in XBRL taxonomies, 412
editing in Text View, 367 Links,
following in Authentic View, 338
Linux /GCC,
c++ settings, 509
K Little-endian, 831
loading, 1031
Key map, 839
Keyboard shortcut, 808
Key-codes,
for your Altova software, 839
M
Macro,

© 2010 Altova GmbH


1384 Index

Macro, Menu Browser, 766


add to menu/toolbar, 815 Menus, 28
edit button, 818 Messages Window, 15
Macros, in XSLT/XQuery Debugger, 300
creating with Scripting Editor, 868 Method,
debugging, 871 Reserve name, 543
editing with Scripting Editor, 868 Microsoft Office 2007, 177, 425
execution of, 856 Microsoft® SharePoint® Server, 618
functions for, in Global Declarations, 857 MIME, 822
how to use in Scripting Project, 868 Mixed markup (in Authentic View), 701
overview, 854 Mode,
running, 869 compatible to v2005R3, 545
running application macros, 798 Mostly recently used files,
setting as Auto-Macro in Scripting Editor, 868 list of, 581
Main window, 11, 33 Move Left command, 647
MainCatalog, 649 Move Right command, 647
MapForce, 663 Move up/down,
Markup, row (Authentic View, 702
in Authentic View, 165, 167 MS Access,
Markup (in Authentic View), conversion of datatypes in XML Schema generation from
hide, 701 DB, 1326
show small/large/mixed, 701 datatypes from XML Schema, 1334
Maximum cell width, 824 MS SQL Server,
Memory, conversion of datatypes in XML Schema generation from
DB, 1327
out of exceptions, 543
datatypes from XML Schema, 1336
storage of schema information, 665
schema extensions, 676
Memory requirements, 1343
schema settings, 677, 678
Menu,
MS Visual Source Safe, 468
add macro to, 815
MSXML, 831
add/delete command, 806
msxsl:script, 1309
Authentic, 696
Multi-user, 820
Convert, 739
MySQL,
customize, 813
conversion of datatypes in XML Schema generation from
Default/XMLSPY, 813 DB, 1328
delete commands from, 813 datatypes from XML Schema, 1338
DTD/Schema, 655
Edit, 583
Help, 838
Project, 599
Schema Design, 666
N
SOAP, 776 Named schema relationships,
Tools, 792 MS SQL Server schema settings, 677
View, 761 Named templates, 272
Window, 836 Namepsaces,
WSDL, 768 in WSDL documents, 371
XML, 625 Namespace,
XSL/XQuery, 683 in schemas, 37
Menu Bar, 26 Namespace Prefix,

© 2010 Altova GmbH


Index 1385

Namespace Prefix, editing in Archive View, 427


inserting in Grid View, 653 example files, 429
namespaces, Opening options,
in XBRL taxonomies, 401 file, 820
in XQuery document, 1289 Optimal Widths, 763, 824
in XSLT 2.0 stylesheet, 1286 Optional element,
settings in Schema Design View, 666 making, 45
Namespaces in XBRL, 786 Oracle,
Navigation, conversion of datatypes in XML Schema generation from
shortcuts in schema design, 62 DB, 1329
Navigation history, 142 datatypes from XML Schema, 1340
New features, 8 schema extensions, 675
New file, schema settings, 676
creating, 565 Oracle XML Db, 734
New XML document, Browse database, 737
creating, 68 manage XML Schemas, 735
Nillable, Ordering Altova software, 839
not supported, 543 OS,
Node, for Altova products, 1343
show curr. exec. node, 693 Out of memory, 543
Non-XML files, 822 Output formatting, 820
NOTATION declaration, Output windows,
add as child in Grid View, 642 toggling display on and off, 837
appending in Grid View, 637 Overview, 33
convert to in Grid View, 645 of XMLSpy API, 896
inserting in Grid View, 631

P
O Parameters,
OASIS, in DB queries, 348
XML catalog, 649 passing to stylesheet via interface, 686
Object Locator, Parent, 1022
in Database Query window, 717 Parser,
Occurrences, built into Altova products, 1344
number of, 38 XSLT, 831
ODBC, Paste,
conversion of datatypes in XML Schema generation from as Text, 338
DB, 1330 as XML, 338
ODBC Connections, 440, 711 Paste As,
Office Open XML, 177, 425 Text, 173
OOXML, XML, 173
see under Office Open XML, 177, 425 Paste command, 584
Open, PDF,
file, 569 transforming to in XMLSpy, 269
Open Office XML, Pie charts, 207
creating in Archive View, 427 Platforms,

© 2010 Altova GmbH


1386 Index

Platforms, adding global resources to, 614


for Altova products, 1343 adding related files to, 615
Plug-in, adding to source control, 608
ATL sample files, 885 adding URL to, 614
registration, 880 batch processing with, 463
User interface configuration, 882 benefits of using, 463
XMLSPY, 879 closing, 601
Position, creating new, 601
Character, 764 how to create and edit, 460
Line, 764 location of installed files, 30
position() function, most recently used, 624
in XPath 1.0, 1284 naming, 460
position() function in XPath 2.0, opening, 601
see fn:position(), 1292 overview, 599
PowerPoint 2007, 177, 425 overview of, 459
Presentation, 824 properties of, 460
Pretty-print, reloading, 601
in Text View, 590 saving, 460, 601
Print setup, 581 using, 463
Printing, Projects in XMLSpy,
from Authentic View, 336 benefits of, 93
Printing options, 580 how to create, 93
Processing Instruction, Properties and Events pane, 851
add as child in Grid View, 639 Provider,
appending in Grid View, 633 source control, 468
convert to in Grid View, 644 PUBLIC,
inserting in Grid View, 627 identifier - catalog, 649
Profiler, 311, 690 PVCS Version Manager, 468
Profiling,
Callgraph, 311
Hit Count, 311
Program settings, 820 Q
Programmers' Reference, 844
QName serialization,
Programming points,
when returned by XPath 2.0 functions, 1293
in Scripting Project, 872
Queries,
Project,
for DB display in Authentic View, 348
properties, 622
Query,
window, 33
see under Database Query window, 714
Project management in XMLSpy, 93
see under Query Database, 714
Project menu, 599
see under XQuery, 714
Project Window, 12, 836, 837
Query Database command, 714
toggling display on and off, 837
Query pane,
Projects,
in Database Query window, 721
adding active files to, 615
adding external folders to, 615
adding external Web folders to, 618
adding files to, 614
adding folders to, 615

© 2010 Altova GmbH


Index 1387

move up/down, 702


Row in Grid View,
appending, 646
R inserting, 646
Rules,
Redo command, 584
for schema validation (see Schema Rules), 234
Regions in SQL scripts, 721
Register,
plug-in, 880
Registering your Altova software, 839
Registry,
S
settings, 820 save, 1024
Regular expressions, 595 Saving files,
in search string, 590 encoding of, 573
Relatinships in Taxonomies, 412, 414, 417 schema, 928
Release notes, also see XML Schema, 655
XMLSpy API, 845 assigning to DB XML, 730
Reload, 820 code generator, 504
Reloading, converting to UML, 661
changed files, 573 create DB based on schema, 751
Remove, Design view, 761
breakpoint - XSLT debugger, 693 documentation, 64
tracepoint - XSLT debugger, 693 Documentation font, 826
Repeated elements, 823 management and assignment in IBM DB2 databases, 727
Replace, 21 open WSDL schema, 376
text, 590 see XML Schema, 34
text in document, 593 settings, 820
text in multiple files, 595 Schema Design menu, 666
Repositories, 468 Schema Design View,
Reserve, Display all globals, 675
method name, 543 Display diagram, 675
Reset, zoom feature, 674
menu commands, 813 Schema editing,
shortcut, 808 annotations, 114, 118
toolbar & menu commands, 807 comments, 114, 118
Resources, content model, 118
increase - background status updates, 468 processing instructions, 114, 118
Restart, Schema fonts, 826
XSLT debugger, 692 Schema Overview, 34, 114
Return key, Schema Rules, 234
see Enter key, 357 adding Rule Sets to a schema, 234
RichEdit 3.0, 828 defining, 236
Right-to-left writing systems, 1347 Schema Subsets, 230, 680, 681
Row, schema validation of XML document,
append (in Authentic View), 701 for XQuery, 1289
delete (in Authentic View), 701 Schema View, 114
duplicate (in Authentic View), 701 configuring the view, 43
insert (in Authentic View), 701 entry helpers, 129

© 2010 Altova GmbH


1388 Index

Schema View, 114 schemanativetype, 547


moving back and forward, 142 Schemas,
Schema View, searching in, in memory, 665
see Find in Schemas, 255 managing for IBM DB2, 727
SchemaAgent, Schemas, finding in,
connect to server from XMLSpy, 678 see Find in Schemas, 255
disconnect from server, 679 Script language, 833
display schemas in, 679 Scripting, 833
extended validation, 680 Scripting Editor,
opening schemas from XMLSpy, 253 GUI description, 851
working with, 248, 249, 253 Main Window, 851
SchemaAgent in XMLSpy, 245 starting, 798
SchemaAgent Server, Scripting Environment, 847
connecting to, 246 usage overview, 849
schema-awareness, Scripting language, 856
of XPath 2.0 and XQuery Engines, 1292 Scripting Project,
SchemaDocumentationDlg, and Events, 865
AllDetails, 1061 application event handlers, 865
Application, 1061 Event Handlers, 854
IncludeAll, 1063 Forms, 854
IncludeAttributeGroups, 1063 Forms in, 859
IncludeComplexTypes, 1063 Global Declarations, 854
IncludeGlobalElements, 1064 Global Declarations in, 857
IncludeGroups, 1064 Macros, 854
IncludeIndex, 1064 Macros in, 868
IncludeLocalElements, 1065 programming points, 872
IncludeRedefines, 1065 steps for creating, 856
IncludeSimpleTypes, 1066 Scripting Project Tree pane, 851
OptionsDialogAction, 1066 Scripting Projects,
OutputFile, 1067 for XMLSpy, 849
OutputFileDialogAction, 1067 for XMLSpy Project, 849
OutputFormat, 1067 Scripts in XSLT/XQuery,
Parent, 1067 see under Extension functions, 1296
ShowAnnotations, 1068 Search,
ShowAttributes, 1068 help, 838
ShowChildren, 1068 see Find, 593
ShowConstraints, 1069 Searching in schemas,
ShowDiagram, 1069 see Find in Schemas, 255
ShowEnumerations, 1069 Searching in XBRL,
ShowNamespace, 1069 see Find in XBRL, 420
ShowPatterns, 1070 Select All command, 590
ShowProgressBar, 1070 Sequence compositor,
ShowProperties, 1070 using, 38
ShowResult, 1071 Settings, 28, 820
ShowSingleFacets, 1071 c++ and c#, 545
ShowSourceCode, 1071 scripting, 833
ShowType, 1071 XSLT Debugger, 695
ShowUsedBy, 1072 Settings for file comparison, 803

© 2010 Altova GmbH


Index 1389

SharePoint® Server, 618 removing from, 608


Shortcut, 808 sharing from, 609
assigning/deleting, 808 show differences, 611
show in tooltip, 817 show history, 610
Show, 836, 837 supported providers, 601
Show curr. exec. nodes, undo check out, 607
XSLT debugger, 693 Source control manager, 613
Show large markup, 165, 167 Source folding in Text View, 99
Show mixed markup, 165, 167 Speed up,
Show small arkup, 167 increase - background status updates, 468
Show small markup, 165 Spelling checker, 792
Side-by-side, 824 custom dictionary, 792
Simple type, Spelling options, 794
in schema definitions, 49 SPL, 546
Size, 828 code blocks, 546
Small markup (in Authentic View), 701 conditions, 551
Smart Restrictions, 136 foreach, 552
SOAP, 370, 381 global objects, 549
create new request, 776 subroutines, 553
debugger options, 782 using files, 550
debugger session, 780 variables, 548
request, 782 Splash screen, 824
request parameters, 779 SPP file locations, 599
requests, 778, 781 SPS,
send request to server, 778 assigning to new XML file, 565
sending request from WSDL, 377 SPS file,
start proxy server, 781 assigning to XML file, 698
stop proxy server, 782 SPS tables,
SOAP communication process, 382 editing dynamic tables, 165
SOAP Debugger, SPS tables in Authentic View,
in Visual Studio .NET, 493 usage of, 341
setting breakpoints, 389 SpyProject,
usage example, 383 CloseProject, 1072
SOAP menu, 776 ProjectFile, 1073
SOAP validation, 381 RootItems, 1073
Software product license, 1353 SaveProject, 1073
Source control, 468, 834 SaveProjectAs, 1073
add to source control, 608 SpyProjectItem,
changing provider, 613 ChildItems, 1074
checking in, 606 FileExtensions, 1074
checking out, 605 ItemType, 1074
enabling, disabling, 603 Name, 1074
get latest version, 603 Open, 1075
getting files, 604 ParentItem, 1075
getting folders, 604 Path, 1075
open project, 602 ValidateWith, 1075
properties, 612 XMLForXSLTransformation, 1075
refresh status, 613 XSLForXMLTransformation, 1075

© 2010 Altova GmbH


1390 Index

SpyProjectItem, Syntax checking of JSON documents, 367


XSLTransformationFileExtension, 1076 Syntax coloring,
XSLTransformationFolder, 1076 for XQuery, 280
SpyProjectItems, Syntax-coloring, 822, 824
AddFile, 1076
AddFolder, 1077
AddURL, 1077
Count, 1077 T
Item, 1077
Tab characters, 820
RemoveItem, 1078
Tab size,
SQL Editor,
and pretty-printing, 764
creating query in, 724
setting, 764
description of, 721
Table,
in Database Query window, 721
build automatically, 822
SQL Server,
colors, 829
manage XML Schemas, 732
Table command,
Start,
in Grid View, 645
XSLT debugger, 691
Table of contents, 838
Start group,
Table View, 823
add (context menu), 818
and switching to Grid View, 645
StarTeam, 468
append row, 646
Static (SPS) tables in Authentic View,
how to use, 82
usage of, 341
insert row, 646
Status,
sorting columns, 646, 647
background updates, 482
Tables,
Status Bar, 26
editing dynamic (SPS) tables, 165
Step into,
in Authentic View, 330
XSLT debugger, 692
in Grid View, 108
Step out,
Tables in Authentic View,
XSLT debugger, 692
icons for editing XML tables, 345
Step over,
usage of, 341
XSLT debugger, 692
using SPS (static and dynamic) tables, 341
Stop,
using XML tables, 342
XSLT debugger, 692
Target namespaces in XBRL, 787
Structured text, 823
Taxonomies,
Style, 825, 828
adding elements to, 408
Stylesheet PI, 690, 691
and linkbases, 405
StyleVision, 663
and linkroles, 412
and XBRL, 791
and New Taxonomy Wizard, 396
for editing StyleVision Power Stylesheet, 698
creating new, 396
StyleVision Power Stylesheet,
files in, 394, 405
assigning to XML file, 698
importing, 403, 787
editing in StyleVision, 698
namespaces in, 401, 786
Support Center, 840
relationships in, 412, 414, 417
Support options, 30
steps for creating, 393
Sybase,
target namespace of, 401
conversion of datatypes in XML Schema generation from
DB, 1332 target namespaces in, 787

© 2010 Altova GmbH


Index 1391

Taxonomies in XBRL, 393, 394 EnclosingCharacter, 1079


Technical Information, 1342 Encoding, 1079
Technical Support, 840 EncodingByteOrder, 1079
Template files, FieldDelimiter, 1079
for new documents, 565 FileExtension, 1079
Template folder, 32 HeaderRow, 1079
Template XML File, ImportFile, 1080
in Authentic View, 327 Tile,
Templates, horizontally, 836
of XML documents in Authentic View, 696 vertically, 836
Templates Window, Toggle, 836, 837
in XSLT/XQuery Debugger, 300 Toolbar, 26
terminate, 932 activate/deactivate, 807
Text, add command to, 806
add as child in Grid View, 638 add macro to, 815
appending in Grid View, 632 create new, 807
convert to in Grid View, 643 reset toolbar & menu commands, 807
editing in Authentic View, 338 show large icons, 817
find and replace, 593 Tools menu, 792
finding in document, 590 Tooltip,
font, 828 show, 817
formatting in Authentic View, 338 show shortcuts in, 817
inserting in Grid View, 626 Topic,
pretty-printing, 590 view on TOC, 838
Text file, Trace window, 305
export of XML data to, 754 in XSLT/XQuery Debugger, 301
import as XML, 739 Tracepoint,
Text view, 97, 761 dialog box, 694
and commenting in XML documents, 184 Tracepoints,
and empty lines in XML documents, 184 using in XSLT/XQuery Debugger, 305
auto-complete enable/disable, 823 Transformation,
bookmarks in, 99 see XSLT transformation, 685
editing in, 72 Turn off automatic validation, 822
Entry helpers in, 104 Tutorial,
font properties, 97 example files, 32
formatting of text, 97 for WSDL, 371
indentation, 97 goals, 32
indentation in, 99 Tutorials,
intelligent editing features, 102 location of installed files, 30
line numbering in, 99 type,
schema fonts, 826 extension in XML document, 70
source folding in, 99 Types,
special editing features for XML documents, 184 built in, 556
word-wrapping, 97
Text View Events, 865
Text View Settings dialog, 764
TextImportExportSettings,
DestinationFolder, 1078

© 2010 Altova GmbH


1392 Index

Variables Window,
in XSLT/XQuery Debugger, 298
Version changes,
U XMLSpy API, 845
Version control,
UCS-2, 831
Diffdog differencing editor, 482
UML,
installation procedures, 475
converting schemas to, 661
Version Number, 841
Undo command, 584
View,
Unicode,
Browser view, 762
support in Altova products, 1346
Collapse, 763
Unicode support,
Enhance Grid view, 761
in Altova products, 1346, 1347
Expand, 762, 763
Unnamed element relationships,
Go to File, 764
MS SQL Server schema settings, 678
Go to line/char, 764
Unselected, 763
Optimal widths, 763
Update,
Schema Design view, 761
background status updates, 482
Text view, 761
Update Entry Helpers command, 653
View menu, 761
URL, 934, 935, 1024, 1031, 1032
Visual Studio .Net,
sending by e-mail, 579
and XMLSpy, 488
User interface,
and XMLSpy Debuggers, 493
configure using plug-in, 882
and XMLSpy differences, 491
User interface description, 10
know issues wrt XMLSpy, 494
User Manual, 3, 6
VS .NET,
User Reference, 564
and XMLSpy Integration Package, 489
UTF-16, 831

V W
Watch for changes, 820
Validate,
Web Server, 840, 841
WSDL file, 376
web service,
Validating,
connecting to, 376
XML documents, 76
Well-formed test of JSON documents, 367
Validating XML documents, 182
Well-formedness check, 648
Validation, 28, 649
for XML document, 76
assigning DTD to XML document, 655
Well-formedness of XML documents, 182
assigning XML Schema to XML document, 656
whitespace handling,
extending with Schema Rules, 234
and XPath 2.0 functions, 1292
of related schemas using SchemaAgent, 253
whitespace in XML document,
WSDL files, 652
handling by Altova XSLT 2.0 Engine, 1286
Validation messages, 15
Whitespace markers, 764
Validator,
whitespace nodes in XML document,
in Altova products, 1344
and handling by XSLT 1.0 Engine, 1284
Variables,
Window,
in SPL, 548
Cascade, 836

© 2010 Altova GmbH


Index 1393

Window, service in 1.1, 770


Entry-Helper, 837 service in 2.0, 772
Info, 836, 837 SOAP debugger example, 383
Open, 837 types, 773
Project, 836, 837 validating, 376
Tile horizontally, 836 web service, 776
Tile vertically, 836 WSDL Design View,
Window menu, 836 Bindings, 144
Windows, description of, 143
auto-hiding, 10 file viewing in, 143
floating, docking, tabbing, 10 functionality, 143
managing display of, 10 Main Window, 144
overview, 33 PortTypes, 144
support for Altova products, 1343 Services, 144
Wizard for new taxonomies, 396 WSDL files,
Word 2007, 177, 425 Validation, 652
Word document, WSDL fonts, 826
import as XML, 745 WSDL menu, 768
Word wrap, WSDL tutorial, 371
enable/disable, 763 WSDL View,
Word-wrapping in Text View, 97 Details entry helper, 148
Wrap, entry helpers, 148
word wrap enable/disable, 763 importing into WSDL document, 148
WSDL, 370 Overview entry helper, 148
1.1 components, 768
2.0 components, 770
binding in 1.1, 769
binding in 2.0, 772 X
connecting to a web service, 376
XBRL, 392
converting from 1.1 to 2.0, 775
and MapForce, 791
create documentation, 378
and StyleVision, 791
create new document, 371
arcroles, 783
creating bindings, 373
generate documentation, 788
creating messages, 372
linkroles, 785
creating operations, 372
namespaces, 786
creating parameters, 372
target namespaces, 787
creating ports, 375
XBRL fonts, 827
creating PortTypes, 372
XBRL menu, 783
creating services, 375
XBRL taxonomies, 393
generate documentation, 773
see also Taxonomies, 394
interface in 2.0, 770
XBRL View, 153
messages in 1.1, 768
Calculation tab in main window, 157
namespaces, 371
Definition tab in main window, 157
open schema, 376
Elements tab in main window, 153
operations in 1.1, 769
entry helpers in, 160
portType in 1.1, 769
Presentation tab in main window, 157
reparse document, 775
settings, 790
sending SOAP request, 377

© 2010 Altova GmbH


1394 Index

XBRL View, searching in, editing in Grid View (Enterprise and Professional editions),
see Find in XBRL, 420 186
Xerces, encoding of, 224
support, 545 evaluating XPath expressions on, 224
XInclude, 587, 627, 633, 639 generating schemas from, 224
adding as child in Grid View, 639 importing and exporting text, 224
appending in Grid View, 633 inserting file paths in, 184
inserting in Grid View, 587, 627 inserting XInclude, 184
inserting in Text View, 587 opening, 180
inserting in XML document, 184 saving, 180
XML, searching and replacing in, 224
copying as structured text, 585 Text View editing features for, 184
Oasis catalog, 649 transforming with XSLT, 193
spelling checker, 792 validating, 182
XML data, XML file,
exporting to database, 757 generate from DTD or XML Schema, 663
exporting to text file, 754 XML Import,
XML DB, based on schema, 750
loading new data row into Authentic View, 698 XML menu, 625
loading new XML data row, 348 XML Parser,
XML Diff, about, 1344
comparing directories, 800 XML prolog,
comparing files, 798, 803 add as child in Grid View, 639
XML document, appending in Grid View, 633
assigning to XSLT stylesheet, 691 convert to in Grid View, 644
browse Oracle XML Db, 737 inserting in Grid View, 627
creating new, 68 XML Schema,
editing in Text View, 72 adding components, 38
generating from DTD, 227 adding elements with, 42
generating from XML Schema (Enterprise and Professional also see Schema, 655
editions), 229 assigning to DB XML, 730
opening in Authentic View, 327 assigning to XML document, 656
XML document creation, configuring Content Model View, 671
tutorial, 68 configuring the view, 43
XML documents, 179 content model diagram, 668
and commenting in Text View, 184 converting to DTD, 659
and empty lines in Text View, 184 creating a basic schema, 34
and XPath expression of a node, 184 creating a new file, 34
and XQuery, 193 defining namespaces in, 37
assigning schemas (incl. DTDs), 182 generate outline XML file from, 663
automatic validation, 180 generating code from, 664
automating XQuery executions of, 193 generating documentation of, 668
automating XSLT transformations of, 193 generating from DTD (Enterprise and Professional
checking validity of, 76 editions), 227
checking well-formedness, 182 generating from XML document, 657
default views of, 180 go to definition in from XML document, 657
editing in Authentic View, 189 go to from XML document, 656
management and assignment in IBM DB2 databases, 727

© 2010 Altova GmbH


Index 1395

XML Schema, XMLData,


managing for IBM DB2, 727 AppendChild, 1116
menu commands related to, 655 EraseAllChildren, 1117
modifying while editing XML document, 86 EraseCurrentChild, 1118
MS SQL Server extensions, 676 GetChild, 1119
MS SQL Server schema settings, 677, 678 GetChildKind, 1119
namespaces settings in Schema Design View, 666 GetCurrentChild, 1120
navigation in design view, 62 GetFirstChild, 1120
Oracle extensions, 675 GetNextChild, 1121
Oracle schema settings, 676 HasChildren, 1122
settings in Schema Design View, 666 HasChildrenKind, 1122
tutorial, 34 InsertChild, 1123
XML Schema datatypes, IsSameNode, 1124
converted to MS Access datatypes, 1334 Kind, 1124
converted to MS SQL Server datatypes, 1336 MayHaveChildren, 1124
converted to MySQL datatypes, 1338 Name, 1124
converted to Oracle datatypes, 1340 Parent, 1125
in generation of XML Schema from ADO DB, 1331 TextValue, 1125
in generation of XML Schema from MS Access DB, 1326 XMLSchemas,
in generation of XML Schema from MS SQL Server DB, flattening included schemas, 230, 681
1327 including other schemas in, 230
in generation of XML Schema from MySQL DB, 1328 splitting into subsets, 680
in generation of XML Schema from ODBC DB, 1330 XMLSpy, 564, 841
in generation of XML Schema from Oracle DB, 1329 features, 30
in generation of XML Schema from Sybase DB, 1332 help, 30
XML schema definitions, integration, 1234
advanced, 49 plug-in registration, 880
XML Schemas, 226 XMLSpy API,
and global resources, 182 accessing, 1261
converting to DTD (Enterprise and Professional editions), documentation, 895
229
overview, 896
editing in Grid View (Enterprise and Professional editions),
229 release notes, 845
editing in Schema View (Enterprise and Professional XMLSpy command table, 1249
editions), 229 XMLSpy Debugger perspectives in Eclipse, 503
editing in Text View, 229 XMLSpy Enterprise Edition,
generating XML document from, 229 user manual, 3
plus DTDs, 182 XMLSpy in Eclipse, 495
XML tables in Authentic View, XMLSpy integration,
icons for editing, 345 example of, 1235, 1236, 1237
usage of, 342 XMLSpy Integration Package, 489, 496
XML text, XMLSpy perspective in Eclipse, 500
copying, 584 XMLSPY plug-in, 879
xml:base, 140 XMLSpy Plugin for Eclipse,
and XInclude, 587, 627, 633, 639 installing, 496
xml:id, 140 XMLSpy Plugin for VS .NET,
xml:lang, 140 installing, 489
xml:space, 140 XMLSpyCommand,
XML-Conformance, 822 in XMLSpyControl, 1262

© 2010 Altova GmbH


1396 Index

XMLSpyCommands, XPath 2.0,


in XMLSpyControl, 1263 in XPath Evaluator, 648
XMLSpyControl, 1264 XPath 2.0 functions,
documentation of, 1234 general information about, 1292
example of integration at application level, 1235, 1236, implementation information, 1292
1237 see under fn: for specific functions, 1292
examples of integration at document level, 1239 XPath Evaluator,
integration at application level, 1235 usage, 648
integration at document level, 1238, 1239 XPath functions support,
integration using C#, 1239, 1240 see under fn: for individual functions, 1293
integration using HTML, 1244 XPath of selected node in XML document,
object reference, 1262 copying to the clipborad, 589
XMLSpyControlDocument, 1270 XPath to selected node, 164
XMLSpyControlPlaceHolder, 1276 XPath Window, 16
XMLSpyDocumentEditor, XPaths,
MarkUpView, 1164 setting for tracepoints, 305
XMLSpyLib, 895, 896 XPath-Watch Window,
Application, 918 in XSLT/XQuery Debugger, 299
AuthenticDataTransfer, 937 XPointer,
AuthenticRange, 941 generating of a node in an XML document, 184
AuthenticSelection (obsolete), 1142 XPointer of selected node in XML document,
AuthenticView, 968 copying to the clipborad, 589
CodeGeneratorDlg, 987 XPointers, 587, 627, 633, 639
DatabaseConnection, 992 XQuery,
Dialogs, 998 DB support, 284
DocEditEvent (obsolete), 1126 document validation, 283
DocEditView (obsolete), 1145 editing in Text View, 278
Document, 1002 engine information, 1283
Documents, 1029 entry helpers, 280
DTDSchemaGeneratorDlg, 1033 execution, 283
ElementList, 1036 Extension functions, 1296
ElementListItem, 1037 for querying XML databases, 284
ExportSettings, 1038 functions for IBM DB2, 284
FileSelectionDlg, 1041 intelligent editing features, 282
GenerateSampleXMLDlg, 1052 opening file, 279
GridView, 1056 passing variables to the XQuery document, 686
ProjectItem, 1073 syntax coloring, 280
SchemaDocumentationDlg, 1060 XQuery 1.0 Engine,
SpyProject, 1072 information about, 1289
SpyProjectItems, 1076 XQuery 1.0 functions,
TextImportExportSettings, 1078 general information about, 1292
XMLData, 1115 implementation information, 1292
XML-Text, 823 see under fn: for specific functions, 1292
XPath, XQuery Debugger,
evaluating, 16 see XSLT/XQuery Debugger, 288
generating of a node in an XML document, 184 XQuery documents,
XPath 1.0, analyzing execution time of, 311, 690
in XPath Evaluator, 648 XQuery Execution, 690

© 2010 Altova GmbH


Index 1397

XQuery files, debug windows, 695


setting file extensions in XMLSpy, 279 enable/disable breakpoint, 693
XQuery processor, enable/disable tracepoint, 694
in Altova products, 1345 end debugger session, 692
XQuery Profiler, in Visual Studio .NET, 493
charts of results, 321 insert/remove breakpoint, 693
xs:QName, insert/remove tracepoint, 693
also see QName, 1293 restart debugger, 692
xsi:type, settings, 695
usage, 70 show curr. exec. nodes, 693
XSL, start debugger, 691
see XSLT, 691 step into, 692
XSL Outline, 271 step out, 692
XSL Outline window, 21, 272 step over, 692
XSL transformation, stop debugger, 692
see XSLT, 89 XSLT document structure, 21
XSL/XQuery menu, 683 XSLT documents,
xsl:call-template, 272 and Info window, 275
XSL:FO, editing and managing with XSL Outline, 271
and XSLT transformations, 269 XSLT functions,
xsl:param, 272 in XSL Outline window, 272
xsl:preserve-space, 1284 XSLT parameters,
xsl:strip-space, 1284 passing to stylesheet via interface, 686
xsl:with-param, 272 XSLT processors,
XSLT, 764 in Altova products, 1345
and batch transformations, 269 XSLT Profiler,
auto-completion in Text View, 267 charts of results, 321
documents, 267 XSLT stylesheet,
engine information, 1283 assigning to XML document, 690
entry helpers for, 267 assigning XML document to, 691
Extension functions, 1296 opening, 691
functionality in XMLSpy, 267 XSLT stylesheet for FO,
modifying in XMLSpy, 91 assigning to XML document, 691
processor, 831 XSLT stylesheets,
transformations in XMLSpy, 269 analyzing execution time of, 311, 690
validating, 267 XSLT templates,
XSLT 1.0 Engine, in XSL Outline window, 272
limitations and implementation-specific behavior, 1284 XSLT transformation, 684
XSLT 2.0 Engine, assigning XSLT file, 89
general information about, 1286 in XMLSpy, 90
information about, 1286 to FO, 685
XSLT 2.0 functions, to PDF, 685
implementation-specific behavior of, 1288 tutorial, 89
see under fn: for specific functions, 1288 XSLT/XQuery Debugger,
XSLT 2.0 stylesheet, breakpoints usage, 302
namespace declarations in, 1286 Call Stack Window, 299
XSLT Debugger, Context window, 298
breakpoints/tracepoints dialog box, 694 description of interface, 289

© 2010 Altova GmbH


1398 Index

XSLT/XQuery Debugger,
description of mechanism, 289
features and usage, 288
Info Window, 300
information windows, 297
Messages Window, 300
settings, 293
starting a session, 295
Templates Window, 300
toolbar icons, 290
Trace Window, 301
tracepoints usage, 305
Variables Window, 298
XPath-Watch Window, 299
XSLT/XQuery debugging,
files used, 288
XSLT/XQuery Profiler, 311

Z
ZIP files, 177, 425
creating in Archive View, 430
editing in Archive View, 430
Zoom feature,
in Schema Design View, 674
Zooming in Text View, 99

© 2010 Altova GmbH

You might also like