8.1
Table Of Contents
- Contents
- Overview
- Changes in this version
- Getting started
- Using the Web interface
- Understanding rendering
- Understanding render types
- Understanding render modifiers
- Using content modifiers
- Using XML modify
- Using XML deconstruct and construct
- Deconstructing a project
- Constructing a project
- Working with pages and spreads
- Working with layers
- Working with boxes
- Working with groups
- Working with pictures
- Working with text
- Working with tables
- Working with sections
- Working with Composition Zones
- Using XSL transformation
- Working with lists
- Working with anchored boxes
- Working with placeholders
- Working with metadata
- Working with hidden text
- Using administrative request handlers
- Modifier DTD (annotated)
- Entities (Modifier DTD)
- PROJECT (Modifier DTD)
- SAVEAS (Modifier DTD)
- LAYOUT (Modifier DTD)
- ID (Modifier DTD)
- LAYOUTPROPERTY (Modifier DTD)
- COLUMNGUIDES (Modifier DTD)
- ARTICLE (Modifier DTD)
- COMPONENT (Modifier DTD)
- SPREAD (Modifier DTD)
- PAGE (Modifier DTD)
- SECTION (Modifier DTD)
- BOX (Modifier DTD)
- METADATA (Modifier DTD)
- VALUE (Modifier DTD)
- TEXT (Modifier DTD)
- INSET (Modifier DTD)
- STORY (Modifier DTD)
- COPYFIT (Modifier DTD)
- PARAGRAPH (Modifier DTD)
- TEXTNODEPH (Modifier DTD)
- TEXTPH (Modifier DTD)
- GROUPCHARACTERS (Modifier DTD)
- FORMAT (Modifier DTD)
- KEEPLINESTOGETHER (Modifier DTD)
- DROPCAP (Modifier DTD)
- LOCKTOGRID (Modifier DTD)
- TABSPEC (Modifier DTD)
- TAB (Modifier DTD)
- RULE (Modifier DTD)
- HIDDEN (Modifier DTD)
- RICHTEXT (Modifier DTD)
- RUBITEXT (Modifier DTD)
- ANCHOREDBOXREF (Modifier DTD)
- LINKEDBOX (Modifier DTD)
- OVERMATTER (Modifier DTD)
- PICTURE (Modifier DTD)
- CLIPPING (Modifier DTD)
- SPLINESHAPE (Modifier DTD)
- CONTOURS (Modifier DTD)
- CONTOUR (Modifier DTD)
- VERTICES (Modifier DTD)
- VERTEX (Modifier DTD)
- LEFTCONTROLPOINT (Modifier DTD)
- VERTEXPOINT (Modifier DTD)
- RIGHTCONTROLPOINT (Modifier DTD)
- GEOMETRY (Modifier DTD)
- FIT (Modifier DTD)
- MAX (Modifier DTD)
- MIN (Modifier DTD)
- LOCATION (Modifier DTD)
- SIZE (Modifier DTD)
- SCALETO (Modifier DTD)
- RELPOSITION (Modifier DTD)
- ORIGIN (Modifier DTD)
- WIDTH (Modifier DTD)
- HEIGHT(Modifier DTD)
- POSITION (Modifier DTD)
- MOVEUP (Modifier DTD)
- MOVEDOWN (Modifier DTD)
- MOVELEFT (Modifier DTD)
- MOVERIGHT (Modifier DTD)
- GROWACROSS (Modifier DTD)
- GROWDOWN (Modifier DTD)
- SHRINKACROSS (Modifier DTD)
- SHRINKDOWN (Modifier DTD)
- ALLOWBOXONTOPASTEBOARD (Modifier DTD)
- ALLOWBOXOFFPAGE (Modifier DTD)
- STACKINGORDER (Modifier DTD)
- SUPPRESSOUTPUT (Modifier DTD)
- TOP (Modifier DTD)
- LEFT (Modifier DTD)
- BOTTOM (Modifier DTD)
- RIGHT (Modifier DTD)
- RUNAROUND (Modifier DTD)
- LAYER (Modifier DTD)
- RGBCOLOR (Modifier DTD)
- LINESTYLE (Modifier DTD)
- CONTENTPH (Modifier DTD)
- CONTENT (Modifier DTD)
- SHADOW (Modifier DTD)
- FRAME (Modifier DTD)
- PLACEHOLDER (Modifier DTD)
- TABLE (Modifier DTD)
- PARENTTABLE (Modifier DTD)
- TABLEBREAK (Modifier DTD)
- CHILDID (Modifier DTD)
- ADDCELLS (Modifier DTD)
- DELETECELLS (Modifier DTD)
- COLSPEC (Modifier DTD)
- COLUMN (Modifier DTD)
- ROW (Modifier DTD)
- HEADER (Modifier DTD)
- FOOTER (Modifier DTD)
- CELL (Modifier DTD)
- GRID (Modifier DTD)
- GRIDLINE (Modifier DTD)
- GROUP (Modifier DTD)
- BOXREF (Modifier DTD)
- COMPOSITIONZONE (Modifier DTD)
- LIST (Modifier DTD)
- RUBI (Modifier DTD)
- Sample applications
- Contacting Quark
- Index
Max number of times to try executing the command before
returning failure.
Integer
maxRetries
Max time out in milliseconds.Integer
requestTimeout
Indicates whether the cache should be checked for an existing
result or if the command should be executed again.
Boolean
useCache
This value indicates whether the server should send the response
as-is (text or binary) or store the response on the server and return
Boolean
responseAsURL
its location as a URL. Because the object model works on SOAP,
which can be slow when transferring large binary files, you might
choose to set this value to "true" if you suspect that the response
is going to be several megabytes or larger.
Indicates whether file info should be fetched before executing the
command.
Boolean
bypassFileInfo
Context in which the command is being executed.String
context
QuarkXPress Server request is instances of request objects chained
together.
QRequestrequest
sdk.QRequestContext rc = new sdk.QRequestContext();
rc.documentName = this.DocumentSettings1.documentName.Text;
Example, object
model
rc.responseAsURL = this.DocumentSettings1.responseAsURL.Checked;
rc.useCache = this.DocumentSettings1.useCache.Checked;
rc.bypassFileInfo = this.DocumentSettings1.bypassFileInfo.Checked;
//Create the service and call it QRequestContext object
QManagerSDKSvcService svc = new QManagerSDKSvcService();
sdk.QContentData qc = svc.processRequest(rc);
QManagerSDKSvc
Web service called to process the QuarkXPress Server request. QManagerSDKSvc has a generic method
named processRequest() that takes QRequestContext as an argument and returns QContentData
as the QuarkXPress Server response.
Description
Web serviceType
Processes the request context and returns the result.
processRequest
Methods
DescriptionTypeParameter
Argument passed to
QManagerSDKSvc. Contains settings
QRequestContextrequestCmd
that must be set once per request.
All chained requests are set inside
the request context.
Creates a new session and returns a session ID.
createSession
DescriptionTypeParameter
Timeout for the session in
milliseconds. If no call is executed
Long
timeout
in that time, session is expired and
all the open documents in that
QXP SERVER 8.1 WEB INTEGRATION GUIDE | 19
GETTING STARTED