SpssSyntaxDoc Class (Python)

The SpssSyntaxDoc class represents an open syntax document.

Example: Obtaining the Designated Syntax Document

import SpssClient
SpssClient.StartClient()
DesignatedSyntaxDoc = SpssClient.GetDesignatedSyntaxDoc()
  • The variable DesignatedSyntaxDoc is an SpssSyntaxDoc object for the designated syntax document.

Example: Obtaining the First Opened Syntax Document

import SpssClient
SpssClient.StartClient()
SyntaxDocsList = SpssClient.GetSyntaxDocuments()
FirstSyntaxDoc = SyntaxDocsList.GetItemAt(0)
  • SpssClient.GetSyntaxDocuments() returns a SyntaxDocsList object, which provides access to all open syntax documents.
  • The GetItemAt method from the SyntaxDocsList class is used to get the syntax document with index 0 (the first opened syntax document) from the list of open syntax documents. The variable FirstSyntaxDoc is an SpssSyntaxDoc object for this syntax document.

Example: Create a New Syntax Document and Set it as the Designated One

import SpssClient
SpssClient.StartClient()
NewSyntaxDoc = SpssClient.NewSyntaxDoc()
NewSyntaxDoc.SetAsDesignatedSyntaxDoc()
  • The variable NewSyntaxDoc is an SpssSyntaxDoc object for the new syntax document.