AIDocumentListSuite Struct Reference
[API Suite List]

These functions enumerate and operate on the list of open Illustrator documents. More...

#include <AIDocumentList.h>

Public Attributes
AIAPI AIErr(*	Count )(ai::int32 *count)
	Counts the number of open document windows.
AIAPI AIErr(*	GetNthDocument )(AIDocumentHandle *document, ai::int32 lIndex)
	Retrieves a document by position index in the list of open document windows.
AIAPI AIErr(*	New )(ai::UnicodeString &preset, AINewDocumentPreset parameter, ActionDialogStatus dialogStatus, AIDocumentHandle document)
	Creates a new document, makes it the current document, and opens a window for the new document, which becomes the front most document window.
AIAPI AIErr(*	Open )(const ai::FilePath &fileSpec, AIColorModel colorMode, ActionDialogStatus dialogStatus, AIBoolean forceCopy, AIDocumentHandle *document)
	Opens a document from a file in a new window, and makes the new document and view current.
AIAPI AIErr(*	OpenNoHistory )(const ai::FilePath &fileSpec, AIColorModel colorMode, ActionDialogStatus dialogStatus, AIBoolean forceCopy, AIDocumentHandle *document)
	Opens a document from a file in a new window, and makes the new document and view current.
AIAPI AIErr(*	Save )(AIDocumentHandle document)
	Saves a document.
AIAPI AIErr(*	Close )(AIDocumentHandle document)
	Closes a view for a document.
AIAPI AIErr(*	CloseAll )()
	Closes all open document windows.
AIAPI AIErr(*	Activate )(AIDocumentHandle document, ASBoolean bSetFocus)
	Activates a window for a document, and makes that document and view current.
AIAPI AIErr(*	Print )(AIDocumentHandle document, ActionDialogStatus dialogStatus)
	Prints a document.
AIAPI AIErr(*	GetPresetSettings )(ai::UnicodeString &preset, AINewDocumentPreset *param)
	Retrieves the preset settings from one of the startup template documents.
AIAPI ai::int32(*	CountRecentDocuments )()
	Reports the number of recent documents.
AIAPI AIErr(*	GetNthRecentDocument )(ai::int32 index, ai::FilePath &document)
	Retrieves the location of a document from the recent-documents list.
AIAPI AIErr(*	OpenNthRecentDocument )(ai::int32 index)
	Opens a document in the recent-documents list.
AIAPI AIErr(*	AddToRecentFiles )(const ai::FilePath &document)
	Adds a file to the most-recently-used-files list.

Detailed Description

These functions enumerate and operate on the list of open Illustrator documents.

Many functions act on the current document and document view, which is usually, but not always, the document and view of the active document window. Use Activate() to change the current document. Documents that you create or open become current.

Switching the current document or view commits any modifications that have been made. This means that an undo entry is added to the list of undoable operations, any deferred notifications are sent, and the document windows are updated.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIDocumentListSuite and kAIDocumentListVersion.

Member Data Documentation

AIAPI AIErr(* AIDocumentListSuite::Activate)(AIDocumentHandle document, ASBoolean bSetFocus)

Activates a window for a document, and makes that document and view current.

Parameters:

	document	The document reference.
	bSetFocus	Must be true. If false, the function does nothing.

AIAPI AIErr(* AIDocumentListSuite::AddToRecentFiles)(const ai::FilePath &document)

Adds a file to the most-recently-used-files list.

Parameters:

document

The file to add.

AIAPI AIErr(* AIDocumentListSuite::Close)(AIDocumentHandle document)

Closes a view for a document.

If the document has only one open window, this closes the document. If the document has been modified since last saved, prompts the user to save. Switches the current document to the active document window, regardless of whether it was the current view that was closed.

Parameters:

document

The document reference.

AIAPI AIErr(* AIDocumentListSuite::CloseAll)()

Closes all open document windows.

This is equivalent to calling Close() for each open window.

AIAPI AIErr(* AIDocumentListSuite::Count)(ai::int32 *count)

Counts the number of open document windows.

Multiple windows can be open for a single document, so this is not a count of the number of open documents. Use with GetNthDocument() to retrieve documents.

Parameters:

count

[out] A buffer in which to return the number of windows.

AIAPI ai::int32(* AIDocumentListSuite::CountRecentDocuments)()

Reports the number of recent documents.

Use with GetNthRecentDocument() to iterate through recent-documents list. (Note that this function returns a numeric value, not an error code.)

Returns:: The number of recent documents in the list.

AIAPI AIErr(* AIDocumentListSuite::GetNthDocument)(AIDocumentHandle *document, ai::int32 lIndex)

Retrieves a document by position index in the list of open document windows.

Use with Count() to iterate through windows.

Parameters:

	document	[out] A buffer in which to return the document reference.
	lIndex	The 0-based position index, in the range `[0..numWindows-1]`.

AIAPI AIErr(* AIDocumentListSuite::GetNthRecentDocument)(ai::int32 index, ai::FilePath &document)

Retrieves the location of a document from the recent-documents list.

Use with CountRecentDocuments() to iterate through recent-document list.

Parameters:

	index	The 0-based position index of the document in the list.
	document	[out] The path of the document.

AIAPI AIErr(* AIDocumentListSuite::GetPresetSettings)(ai::UnicodeString &preset, AINewDocumentPreset *param)

Retrieves the preset settings from one of the startup template documents.

Parameters:

	preset	The preset name. Preset names are those that appear in the New Document dialog. such as "Mobile", "Basic RGB", and so on.
	param	[out] A buffer in which to return the settings.

AIAPI AIErr(* AIDocumentListSuite::New)(ai::UnicodeString &preset, AINewDocumentPreset *parameter, ActionDialogStatus dialogStatus, AIDocumentHandle *document)

Creates a new document, makes it the current document, and opens a window for the new document, which becomes the front most document window.

Parameters:

	preset	(New in AICS3) The name of a startup preset to create a new document. If empty or invalid, the function uses the startup template for the color mode specified in the `parameter` overrides. Preset names are those that appear in the New Document dialog, such as "Mobile", "Print", and so on.
	parameter	(New in AICS3) The parameters for the new document. These values override those in the preset. When a parameter has a `NULL` value here, the function uses the value from the preset.In case it is not NULL,It is required to initialize all parameters of structure.
	dialogStatus	An `ActionDialogStatus` value. When `kDialogOn`, shows the New dialog to query user for parameters.
	document	[out] A buffer in which to return the document reference.

Note:: The parameters for this function changed in Illustrator 13 (Creative Suite 3).

AIAPI AIErr(* AIDocumentListSuite::Open)(const ai::FilePath &fileSpec, AIColorModel colorMode, ActionDialogStatus dialogStatus, AIBoolean forceCopy, AIDocumentHandle *document)

Opens a document from a file in a new window, and makes the new document and view current.

If the document is already open, opens a new view for the document, and makes that document and view current.

Parameters:

	fileSpec	The file.
	colorMode	The color mode for the new document.
	dialogStatus	An `ActionDialogStatus` value. When `kDialogOn`, shows the New dialog to query user for parameters. Otherwise, does not allow user interaction.
	forceCopy	When true, duplicates the file and names the copy "Untitled", regardless of whether it is marked as a template file.
	document	[out] A buffer in which to return the document reference.

AIAPI AIErr(* AIDocumentListSuite::OpenNoHistory)(const ai::FilePath &fileSpec, AIColorModel colorMode, ActionDialogStatus dialogStatus, AIBoolean forceCopy, AIDocumentHandle *document)

Opens a document from a file in a new window, and makes the new document and view current.

This does not add this file to the recent files list. If the document is already open, opens a new view for the document, and makes that document and view current.

Parameters:

	fileSpec	The file.
	colorMode	The color mode for the new document.
	dialogStatus	An `ActionDialogStatus` value. When `kDialogOn`, shows the New dialog to query user for parameters. Otherwise, does not allow user interaction.
	forceCopy	When true, duplicates the file and names the copy "Untitled", regardless of whether it is marked as a template file.
	document	[out] A buffer in which to return the document reference.