AIDocumentSuite Struct Reference
[API Suite List]

Use these functions to get and set information about the current document. More...

#include <AIDocument.h>

Public Attributes
AIAPI AIErr(*	GetDocumentFileSpecification )(ai::FilePath &file)
	Retrieves the file specification for the current document.
AIAPI AIErr(*	GetDocumentFileSpecificationFromHandle )(AIDocumentHandle document, ai::FilePath &file)
	Retrieves the file specification associated with the given document.
AIAPI AIErr(*	GetDocumentPageOrigin )(AIRealPoint *origin)
	Retrieves the coordinates of the lower left corner of the imageable page, specified relative to the ruler origin.
AIAPI AIErr(*	SetDocumentPageOrigin )(AIRealPoint *origin)
	Sets the coordinates of the lower left corner of the imageable page.
AIAPI AIErr(*	SetDocumentRulerOrigin )(AIRealPoint *origin)
	Sets the ruler origin for the current document.
AIAPI AIErr(*	GetDocumentRulerUnits )(ai::int16 *units)
	Retrieves the current unit of measurement, shown in the ruler and displayed in dialog boxes.
AIAPI AIErr(*	SetDocumentRulerUnits )(ai::int16 units)
	Sets the current unit of measurement, shown in the ruler and displayed in dialog boxes.
AIAPI AIErr(*	GetDocumentCropStyle )(AICropMarkStyle *cropStyle)
	Retrieves the style of crop marks that are created by the Create Crop Marks command and filter.
AIAPI AIErr(*	SetDocumentCropStyle )(AICropMarkStyle cropStyle)
	Sets the style of crop marks that are created by the Create Crop Marks command and filter.
AIAPI AIErr(*	GetDocumentPrintRecord )(AIDocumentPlatformPrintRecord *print)
	Not implemented.
AIAPI AIErr(*	SetDocumentPrintRecord )(AIDocumentPlatformPrintRecord print)
	Not implemented.
AIAPI AIErr(*	GetDocumentSetup )(AIDocumentSetup *setup)
	Retrieves information about the current document that is set through the document Setup dialog.
AIAPI AIErr(*	SetDocumentSetup )(AIDocumentSetup *setup)
	Sets the document setup information, as set through the document Setup dialog.
AIAPI AIErr(*	GetDocumentModified )(AIBoolean *modified)
	Reports whether the document has been edited since it was last saved.
AIAPI AIErr(*	SetDocumentModified )(AIBoolean modified)
	Sets the modification state of the current document.
AIAPI AIErr(*	GetDocumentFileFormat )(AIFileFormatHandle *fileFormat)
	Retrieves the file format to be used when saving the current document.
AIAPI AIErr(*	SetDocumentFileFormat )(AIFileFormatHandle fileFormat)
	Sets the file format to be used when saving the current document.
AIAPI AIErr(*	GetDocumentFileFormatParameters )(AIDocumentFileFormatParameters *parameters)
	Retrieves the block of user parameters associated with the current document's associated file format.
AIAPI AIErr(*	SetDocumentFileFormatParameters )(AIDocumentFileFormatParameters parameters)
	Sets the block of user parameters associated with the current document's associated file format.
AIAPI AIErr(*	RedrawDocument )(void)
	Forces the current document to be redrawn.
AIAPI AIErr(*	GetDocument )(AIDocumentHandle *document)
	Retrieves an opaque reference for the current document, to use with functions that can operate on documents other than the current one.
AIAPI AIErr(*	WriteDocument )(const ai::FilePath &file, const char *fileFormatName, AIBoolean askForParms)
	Writes the current document to a file without modifying the document or changing its modification status.
AIAPI AIErr(*	GetDocumentMiPrintRecord )(AIDocumentMiPrintRecordPtr print)
	Retrieves the print record for the current document.
AIAPI AIErr(*	SetDocumentMiPrintRecord )(AIDocumentMiPrintRecordPtr print)
	Not implemented.
AIAPI AIErr(*	GetDocumentRulerOrigin )(AIRealPoint *origin)
	Retrieves the ruler origin for the current document.
AIAPI AIErr(*	UpdateLinks )(AIBoolean *updatedSomething)
	Updates linked objects in the current document, if needed.
AIAPI AIErr(*	GetDocumentZoomLimit )(AIReal min, AIReal max)
	Retrieves the limits of zooming as scale factors.
AIAPI AIErr(*	GetDocumentMaxArtboardBounds )(AIRealRect *bounds)
	Retrieves the maximum valid bounds of any artboard, expressed relative to the ruler origin of the current document, regardless of the current size of the document's artboard.
AIAPI AIErr(*	DocumentExists )(AIDocumentHandle document, AIBoolean *exists)
	Reports whether a document exists; that is, is an open document or a clipboard document.
AIAPI AIErr(*	GetDictionary )(struct _AIDictionary **dictionary)
	Retrieves the recorded dictionary associated with the current document.
AIAPI AIErr(*	GetDocumentColorModel )(ai::int16 *colorModel)
	Retrieves the document color model.
AIAPI AIErr(*	SetDocumentColorModel )(ai::int16 colorModel)
	Sets the intended color model for documents upon load.
AIAPI AIErr(*	GetDocumentProfiles )(AIColorProfile rgbProfile, AIColorProfile cmykProfile, AIColorProfile *grayProfile)
	Retrieves the color calibration profiles for the current document.
AIAPI AIErr(*	SetDocumentProfiles )(AIColorProfile rgbProfile, AIColorProfile cmykProfile, AIColorProfile grayProfile)
	Sets the color calibration profiles for the current document.
AIAPI AIErr(*	Copy )()
	Copies the currently selected objects to the clipboard.
AIAPI AIErr(*	Cut )()
	Cuts the currently selected objects to the clipboard.
AIAPI AIErr(*	Paste )()
	Pastes the contents of the clipboard into the document.
AIAPI AIErr(*	SyncDocument )(void)
	Updates cached artwork properties.
AIAPI AIErr(*	GetDocumentTargeting )(short paintTarget, short transparencyTarget, short *effectsTarget)
	Unimplemented.
AIAPI AIErr(*	SetDocumentTargeting )(short paintTarget, short transparencyTarget, short effectsTarget)
	Unimplemented.
AIAPI AIErr(*	GetNonRecordedDictionary )(struct _AIDictionary **dictionary)
	Retrieves the non-recorded dictionary associated with the current document.
AIAPI AIErr(*	GetNonRecordedDictionaryForDocument )(AIDocumentHandle document, struct _AIDictionary **dictionary)
	Retrieves the non-recorded dictionary associated with the document passed as input.
AIAPI int(*	GetAIVersion )()
	Retrieves the version of the Illustrator file format in which the current document was last saved.
AIAPI AIErr(*	DocumentHasTransparency )(AIBoolean *hasTransparency, AIBoolean detectOverprint)
	Reports whether rendering the current document according to its current view settings requires any non-opaque drawing operations.
AIAPI AIErr(*	DocumentHasSpotColorArt )(AIBoolean *hasSpotColorArt)
	Reports whether rendering the current document according to its current view settings requires painting any spot colors.
AIAPI AIErr(*	GetDocumentAssetMgmtInfo )(AIBoolean managed, ai::int32 pNAlternates, AIBoolean checkedOut, const char URL, AIBoolean canEdit, char *fileType)
AIAPI AIErr(*	SetDocumentAssetMgmtInfo )(AIBoolean managed, AIBoolean checkedOut, const char URL, AIBoolean canEdit)
AIAPI AIErr(*	GetDocumentURL )(AIDocumentHandle document, const char **URL)
	Retrieves the URL associated with a document.
AIAPI AIErr(*	GetDocumentXAP )(const char **xap)
	Retrieves the XMP metadata for the current the document.
AIAPI AIErr(*	SetDocumentXAP )(const char *xap)
	Sets the XMP metadata of the current document.
AIAPI AIErr(*	SuspendTextReflow )()
	Halts any text reflow for all text objects in the current document.
AIAPI AIErr(*	ResumeTextReflow )()
	Resumes text reflow.
AIAPI AIErr(*	GetTextSelection )(TextRangesRef *pTextSelection)
	Retrieves the text selection object for the current document.
AIAPI AIErr(*	HasTextFocus )(AIBoolean *focus)
	Reports whether the current document is in text editing mode.
AIAPI AIErr(*	HasTextCaret )(AIBoolean *caret)
	Reports whether the current document is in text editing mode and the caret is blinking (as opposed to a range of text being selected).
AIAPI AIErr(*	GetTextFocus )(StoryRef *pStory)
	Retrieves the current story that is in editing mode.
AIAPI AIErr(*	SetTextFocus )(StoryRef story)
	Sets a story to be in editing mode.
AIAPI AIErr(*	LoseTextFocus )()
	Exits text editing mode.
AIAPI AIErr(*	GetDocumentTextResources )(DocumentTextResourcesRef *pDocResources)
	Retrieves the text resource object for the current document.
AIAPI AIErr(*	WriteDocumentMacInformationResource )(const ai::FilePath &file)
AIAPI AIErr(*	WriteDocumentWithOptions )(const ai::FilePath &file, const char *fileFormatName, ai::int32 fileFormatOptions, AIDictionaryRef additionalOptionsDict, AIBoolean askForParms)
	Writes the current document to a file with specified write options, without modifying the document or changing its modification status.
AIAPI AIErr(*	WriteDocumentAsLibrary )(const ai::FilePath &file, AILibraryType libraryType)
	Writes the current document to a file as a library of specified type without modifying the document or changing its modification status.
AIAPI AIErr(*	DocumentHasOverprint )(AIBoolean *hasOverprint)
	Reports whether rendering the current document according to its current view settings requires painting any overprinted objects.
AIAPI AIErr(*	DocumentHasManagedLinks )(AIDocumentHandle document, AIBoolean *hasManagedLinks)
AIAPI AIErr(*	GetDocumentSpotColorMode )(AIDocumentHandle document, AISpotColorMode *mode)
	Retrieves the spot color mode of a document, which controls the appearance definitions of new spot colors that are added to the document.
AIAPI AIErr(*	SetDocumentSpotColorMode )(AIDocumentHandle document, AISpotColorMode mode, AIBoolean convert, AIBoolean *converted)
	Sets the spot color mode of a document, which controls the appearance definitions of new spot colors that are added to the document.
AIAPI AIErr(*	Undo )()
	Undoes the most recent undoable transaction.
AIAPI AIErr(*	Redo )()
	Redoes the most recent redoable transaction.
AIAPI AIErr(*	DocumentRasterAttributes )(AIBoolean hasDeviceNRasters, AIBoolean hasOverprint)
	Reports whether the current document contains any DeviceN or overprinting rasters.
AIAPI AIErr(*	GetDocumentStartupProfile )(AIDocumentHandle document, AIDocumentStartupProfile *startupProfile)
	Retrieves the document startup profile.
AIAPI AIErr(*	GetDocumentBleeds )(AIRealRect *bleedOffset)
	Retrieves the document's bleed values.
AIAPI AIErr(*	SetDocumentBleeds )(const AIRealRect &bleedOffset)
	Sets the document's bleed values.
AIAPI AIErr(*	SetDocumentPixelPerfectStatus )(AIBoolean isPixelPerfect)
	Turns Pixel Perfect mode on or off for the document.
AIAPI AIBoolean(*	GetDocumentPixelPerfectStatus )()
	Reports whether the document is currently in Pixel Perfect mode.
AIAPI AIErr(*	DeleteSelection )()
	Deletes the current Selection.
AIAPI AIErr(*	SetAutoAssignUIDOnArtCreation )(ai::int16 artType, AIBoolean autoAssignUIDOnArtCreation)
	Controls whether UIDs are automatically assigned to art objects of a given type on creation, in the current document.
AIAPI AIErr(*	GetAutoAssignUIDOnArtCreation )(ai::int16 artType, AIBoolean &outAutoAssignUIDOnArtCreation)
	Reports whether UIDs are being automatically assigned on creation to art objects of a given type.
AIAPI AIReal(*	GetEffectiveScaleFactor )()
	returns scale factor applied on the document It considers os scale factor as well as app scale factor returns always integral scale factor.
AIAPI AIErr(*	GetDocumentScale )(AIReal &docScale)
	With each document there is a scale factor associated with it, So for a document with document scale factor X, each object's dimension have to multiplied by X to get the correct dimensions of the object in UI For example, if document scale factor is X, then a 10x10 rectangle will actually will be displayed as (10X)x(10X) rectangle in UI.
AIAPI AIBoolean(*	IsCloudAIDocument )()
	Reports whether the current document is a Cloud AI document.
AIAPI AIErr(*	GetDocumentFileName )(ai::UnicodeString &fileName)
	Retrieves the file name associated with the current document.
AIAPI AIErr(*	GetDocumentFileNameNoExt )(ai::UnicodeString &fileName)
	Retrieves the file name associated with the current document without extension.
AIAPI AIErr(*	GetDocumentFileNameFromHandle )(AIDocumentHandle document, ai::UnicodeString &fileName)
	Retrieves the file name associated with the given document.
AIAPI AIErr(*	GetDocumentFileNameNoExtFromHandle )(AIDocumentHandle document, ai::UnicodeString &fileName)
	Retrieves the file name associated with the given document without extension.
AIAPI AIErr(*	GetLastExportedFilePath )(const AIExportTriggeredFrom option, ai::FilePath &file)
	Retrieves the file path that was used for last export operation for current file.
AIAPI AIErr(*	SetLastExportedFilePath )(const AIExportTriggeredFrom option, ai::FilePath file)
	Set file path that was used for last export operation for current file.

Detailed Description

Use these functions to get and set information about the current document.

Some functions are only applicable while reading a file format. Some are intended for use during a file format write, but can be used at any time.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIDocumentSuite and kAIDocumentVersion.

Member Data Documentation

AIAPI AIErr(* AIDocumentSuite::Copy)()

Copies the currently selected objects to the clipboard.

This is the same as the Copy menu command.

Note:: Use only when this plug-in is issuing a command and is entirely in control of that command. Do not call when responding to messages invoked by other commands, such as save, close, update, and so on.

AIAPI AIErr(* AIDocumentSuite::Cut)()

Cuts the currently selected objects to the clipboard.

This is the same as the Cut menu command.

Note:: Use only when this plug-in is issuing a command and is entirely in control of that command. Do not call when responding to messages invoked by other commands, such as save, close, update, and so on.

AIAPI AIErr(* AIDocumentSuite::DeleteSelection)()

Deletes the current Selection.

This is the same as pressing delete key.

Note:: Use only when this plug-in is issuing a command and is entirely in control of that command. Do not call when responding to messages invoked by other commands, such as save, close, update, and so on.

AIAPI AIErr(* AIDocumentSuite::DocumentExists)(AIDocumentHandle document, AIBoolean *exists)

Reports whether a document exists; that is, is an open document or a clipboard document.

Parameters:

	document	The document reference.
	exists	[out] A buffer in which to return true if the document is open or in the clipboard.

AIAPI AIErr(* AIDocumentSuite::DocumentHasManagedLinks)(AIDocumentHandle document, AIBoolean *hasManagedLinks)

Deprecated:: Reports whether a document contains any managed links. A managed link is a URL to an Adobe Workgroup Server where one can share and keep versions of the linked document.

Parameters:

	document	The document reference.
	hasManagedLinks	[out] A buffer in which to return true if the document has managed links.

See also:: GetDocumentAssetMgmtInfo(), GetDocumentURL()

Note:: In AI 10, only a managed document could have managed links. In later versions, non-managed documents can also have managed links.

AIAPI AIErr(* AIDocumentSuite::DocumentHasOverprint)(AIBoolean *hasOverprint)

Reports whether rendering the current document according to its current view settings requires painting any overprinted objects.

Parameters:

hasOverprint

[out] A buffer in which to return true if the document has overprint.

AIAPI AIErr(* AIDocumentSuite::DocumentHasSpotColorArt)(AIBoolean *hasSpotColorArt)

Reports whether rendering the current document according to its current view settings requires painting any spot colors.

Parameters:

hasSpotColorArt

[out] A buffer in which to return true if the document has art that uses spot colors.

AIAPI AIErr(* AIDocumentSuite::DocumentHasTransparency)(AIBoolean *hasTransparency, AIBoolean detectOverprint)

Reports whether rendering the current document according to its current view settings requires any non-opaque drawing operations.

Parameters:

	hasTransparency	[out] A buffer in which to return true if the document has transparency.
	detectOverprint	When true, drawing an overprinted object is considered a non-opaque operation.

AIAPI AIErr(* AIDocumentSuite::DocumentRasterAttributes)(AIBoolean *hasDeviceNRasters, AIBoolean *hasOverprint)

Reports whether the current document contains any DeviceN or overprinting rasters.

Parameters:

	hasDeviceNRasters	[out] A buffer in which to return true if the the document has DeviceN rasters.
	hasOverprint	[out] A buffer in which to return true if the the document has overprinting rasters.

AIAPI int(* AIDocumentSuite::GetAIVersion)()

Retrieves the version of the Illustrator file format in which the current document was last saved.

(Note that this function returns a constant value, not an error code.)

Returns:: The version number, an AIVersion value, or 0 if the version is unknown or the file is not an AI file.

AIAPI AIErr(* AIDocumentSuite::GetAutoAssignUIDOnArtCreation)(ai::int16 artType, AIBoolean &outAutoAssignUIDOnArtCreation)

Reports whether UIDs are being automatically assigned on creation to art objects of a given type.

Parameters:

	artType	The art type.
	outAutoAssignUIDOnArtCreation	[out] A buffer in which to return true if auto-assignment is on for this art type, false otherwise.

See also:: AIUIDUtilsSuite::GetArtUID()

AIAPI AIErr(* AIDocumentSuite::GetDictionary)(struct _AIDictionary **dictionary)

Retrieves the recorded dictionary associated with the current document.

Changes in this dictionary and its contents are recorded in the undo history.

Dictionaries are reference counted. You must call AIDictionarySuite::Release() when you no longer need the reference.

Parameters:

dictionary

[out] A buffer in which to return a pointer to the dictionary reference.

See also:: GetNonRecordedDictionary()

Referenced by ai::Dictionary::Impl::Impl().

AIAPI AIErr(* AIDocumentSuite::GetDocument)(AIDocumentHandle *document)

Retrieves an opaque reference for the current document, to use with functions that can operate on documents other than the current one.

Parameters:

document

[out] A buffer in which to return the document reference.

AIAPI AIErr(* AIDocumentSuite::GetDocumentAssetMgmtInfo)(AIBoolean *managed, ai::int32 *pNAlternates, AIBoolean *checkedOut, const char **URL, AIBoolean *canEdit, char *fileType)

Deprecated:: Retrieves asset management information. Pass null for any parameter whose state you do not want to retrieve.

Parameters:

	managed	[out] A buffer in which to return true if the file has an associated server URL.
	pNAlternates	[out] A buffer in which to return the number of alternates for a document that is part of Version Cue project, or 0 if it is not part of a Version Cue project.
	checkedOut	[out] A buffer in which to return true if the document is being managed by a version-control system and is currently checked out (that is, editable and locked by the current user).
	URL	[out] A buffer in which to return the server URL of a managed file.
	canEdit	Deprecated, pass `null`.
	fileType	[out] A buffer in which to return the name of the plug-in used to open the current document, or to perform the last Save As operation.

AIAPI AIErr(* AIDocumentSuite::GetDocumentBleeds)(AIRealRect *bleedOffset)

Retrieves the document's bleed values.

Parameters:

bleedOffset

[out] A buffer in which to return the bleed values.

AIAPI AIErr(* AIDocumentSuite::GetDocumentColorModel)(ai::int16 *colorModel)

Retrieves the document color model.

Parameters:

colorModel [out] A buffer in which to return the color model, an AIDocumentColorModelValue.

AIAPI AIErr(* AIDocumentSuite::GetDocumentCropStyle)(AICropMarkStyle *cropStyle)

Retrieves the style of crop marks that are created by the Create Crop Marks command and filter.

This is not a document setting; it is an application preference. In AI11 and later this no longer affects separations printing.

Parameters:

cropStyle

[out] A buffer in which to return the style.

AIAPI AIErr(* AIDocumentSuite::GetDocumentFileFormat)(AIFileFormatHandle *fileFormat)

Retrieves the file format to be used when saving the current document.

By default, this is the format that opened the document or the latest native file format for a new document. If the user changes the file format from the Save As dialog, the new format is assigned to the document.

Parameters:

fileFormat

[out] A buffer in which to return the file format.

See also:: AIFileFormatSuite

AIAPI AIErr(* AIDocumentSuite::GetDocumentFileFormatParameters)(AIDocumentFileFormatParameters *parameters)

Retrieves the block of user parameters associated with the current document's associated file format.

Parameters:

parameters [out] A buffer in which to return the parameter block. This is a void* pointer. The actual format of the parameter block is determined by the file format.

See also:: AIFileFormatSuite

AIAPI AIErr(* AIDocumentSuite::GetDocumentFileName)(ai::UnicodeString &fileName)

Retrieves the file name associated with the current document.

Parameters:

fileName

[out]: A buffer in which to return the file name.

AIAPI AIErr(* AIDocumentSuite::GetDocumentFileNameFromHandle)(AIDocumentHandle document, ai::UnicodeString &fileName)

Retrieves the file name associated with the given document.

Parameters:

	document	The document reference.
	fileName	[out] A buffer in which to return the file name.

AIAPI AIErr(* AIDocumentSuite::GetDocumentFileNameNoExt)(ai::UnicodeString &fileName)

Retrieves the file name associated with the current document without extension.

Parameters:

fileName

[out]: A buffer in which to return the file name without extension

AIAPI AIErr(* AIDocumentSuite::GetDocumentFileNameNoExtFromHandle)(AIDocumentHandle document, ai::UnicodeString &fileName)

Retrieves the file name associated with the given document without extension.

Parameters:

	document	The document reference.
	fileName	[out] A buffer in which to return the file name without extension

AIAPI AIErr(* AIDocumentSuite::GetDocumentFileSpecification)(ai::FilePath &file)

Retrieves the file specification for the current document.

Parameters:

file

[out] A buffer in which to return the file specification.

AIAPI AIErr(* AIDocumentSuite::GetDocumentFileSpecificationFromHandle)(AIDocumentHandle document, ai::FilePath &file)

Retrieves the file specification associated with the given document.

Parameters:

	document	The document reference.
	file	[out] A buffer in which to return the file specification.

AIAPI AIErr(* AIDocumentSuite::GetDocumentMaxArtboardBounds)(AIRealRect *bounds)

Retrieves the maximum valid bounds of any artboard, expressed relative to the ruler origin of the current document, regardless of the current size of the document's artboard.

Parameters:

bounds

[out] A buffer in which to return the rectangle,

AIAPI AIErr(* AIDocumentSuite::GetDocumentMiPrintRecord)(AIDocumentMiPrintRecordPtr print)

Retrieves the print record for the current document.

Parameters:

print [in, out] A print record with the version and recordSize members initialized, in which to return the print information.

AIAPI AIErr(* AIDocumentSuite::GetDocumentModified)(AIBoolean *modified)

Reports whether the document has been edited since it was last saved.

When it has, the user is prompted to save the document before closing it.

Parameters:

modified

[out] A buffer in which to return true if the document has been modified.

AIAPI AIErr(* AIDocumentSuite::GetDocumentPageOrigin)(AIRealPoint *origin)

Retrieves the coordinates of the lower left corner of the imageable page, specified relative to the ruler origin.

Parameters:

origin

[out] A buffer in which to return the origin point.

AIAPI AIBoolean(* AIDocumentSuite::GetDocumentPixelPerfectStatus)()

Reports whether the document is currently in Pixel Perfect mode.

Returns:: True if Pixel Perfect mode is on, false otherwise.

AIAPI AIErr(* AIDocumentSuite::GetDocumentPrintRecord)(AIDocumentPlatformPrintRecord *print)

Not implemented.

AIAPI AIErr(* AIDocumentSuite::GetDocumentProfiles)(AIColorProfile *rgbProfile, AIColorProfile *cmykProfile, AIColorProfile *grayProfile)

Retrieves the color calibration profiles for the current document.

Parameters:

	rgbProfile	[out] A buffer in which to return the RGB profile or `NULL`.
	cmykProfile	[out] A buffer in which to return the CMYK profile or `NULL`.
	grayProfile	[out] A buffer in which to return the grayscale profile or `NULL`.

AIAPI AIErr(* AIDocumentSuite::GetDocumentRulerOrigin)(AIRealPoint *origin)

Retrieves the ruler origin for the current document.

Positive ruler values go the right and above the origin. Negative values go the left and below the origin.

Parameters:

origin

[out] A buffer in which to return the ruler origin, relative to the lower left of the artboard page, which is always (0,0).

AIAPI AIErr(* AIDocumentSuite::GetDocumentRulerUnits)(ai::int16 *units)

Retrieves the current unit of measurement, shown in the ruler and displayed in dialog boxes.

Parameters:

units The new ruler unit, an AIDocumentRulerUnitValue.

AIAPI AIErr(* AIDocumentSuite::GetDocumentScale)(AIReal &docScale)

With each document there is a scale factor associated with it, So for a document with document scale factor X, each object's dimension have to multiplied by X to get the correct dimensions of the object in UI For example, if document scale factor is X, then a 10x10 rectangle will actually will be displayed as (10*X)x(10*X) rectangle in UI.

AIAPI AIErr(* AIDocumentSuite::GetDocumentSetup)(AIDocumentSetup *setup)

Retrieves information about the current document that is set through the document Setup dialog.

Parameters:

setup

[out] A buffer in which to return the setup information.

AIAPI AIErr(* AIDocumentSuite::GetDocumentSpotColorMode)(AIDocumentHandle document, AISpotColorMode *mode)

Retrieves the spot color mode of a document, which controls the appearance definitions of new spot colors that are added to the document.

Parameters:

	document	The document reference, or `NULL` for the current document.
	mode	[out] A buffer in which to return the mode, an `AISpotColorMode` value.

Returns:: The error kNoDocumentErr if document is NULL and there is no current document.

AIAPI AIErr(* AIDocumentSuite::GetDocumentStartupProfile)(AIDocumentHandle document, AIDocumentStartupProfile *startupProfile)

Retrieves the document startup profile.

Parameters:

	document	The document reference, or `NULL` for the current document.
	startupProfile	[out] A buffer in which to return the document startup profile.

Returns:: The error kNoDocumentErr if document is NULL and there is no current document.

AIAPI AIErr(* AIDocumentSuite::GetDocumentTargeting)(short *paintTarget, short *transparencyTarget, short *effectsTarget)

Unimplemented.

Always returns kDocTargetExplicit

AIAPI AIErr(* AIDocumentSuite::GetDocumentTextResources)(DocumentTextResourcesRef *pDocResources)

Retrieves the text resource object for the current document.

You must release the object when it is no longer needed. It is recommended that you use IDocumentTextResource to wrap this object, which takes care of memory management.

The document text resources object contains various document-wide utilities and objects such as the character and paragraph styles.

Parameters:

pDocResources

[out] A buffer in which to return the text resources object.

See also:: ATE suites and IText.h.

AIAPI AIErr(* AIDocumentSuite::GetDocumentURL)(AIDocumentHandle document, const char **URL)

Retrieves the URL associated with a document.

Parameters:

	document	The document reference.
	URL	[out] A buffer in which to return the URL.

AIAPI AIErr(* AIDocumentSuite::GetDocumentXAP)(const char **xap)

Retrieves the XMP metadata for the current the document.

Parameters:

xap

[out] A buffer in which to return the XML packet (in UTF-8 Unicode format).

AIAPI AIErr(* AIDocumentSuite::GetDocumentZoomLimit)(AIReal *min, AIReal *max)

Retrieves the limits of zooming as scale factors.

Parameters:

	min	[out] A buffer in which to return the minimum zoom scale factor.
	max	[out] A buffer in which to return the maximum zoom scale factor.

AIAPI AIReal(* AIDocumentSuite::GetEffectiveScaleFactor)()

returns scale factor applied on the document It considers os scale factor as well as app scale factor returns always integral scale factor.

AIAPI AIErr(* AIDocumentSuite::GetLastExportedFilePath)(const AIExportTriggeredFrom option, ai::FilePath &file)

Retrieves the file path that was used for last export operation for current file.

Parameters:

	file	[in] option to know whether export was triggered from Export As, Export for screens or Save for Web.
	file	[out] A buffer in which to return the file path.

AIAPI AIErr(* AIDocumentSuite::GetNonRecordedDictionary)(struct _AIDictionary **dictionary)

Retrieves the non-recorded dictionary associated with the current document.

Changes to this dictionary and its contents are not recorded in the undo history.

Dictionaries are reference counted. You must call AIDictionarySuite::Release() when you no longer need the reference.

Parameters:

dictionary

[out] A buffer in which to return a pointer to the dictionary reference.

See also:: GetNonRecordedDictionary()

Referenced by ai::Dictionary::Impl::Impl().

AIAPI AIErr(* AIDocumentSuite::GetNonRecordedDictionaryForDocument)(AIDocumentHandle document, struct _AIDictionary **dictionary)

Retrieves the non-recorded dictionary associated with the document passed as input.

Changes to this dictionary and its contents are not recorded in the undo history.

Dictionaries are reference counted. You must call AIDictionarySuite::Release() when you no longer need the reference.

Parameters:

	document	The document reference whose non-recorded dictionary is being asked for.
	dictionary	[out] A buffer in which to return a pointer to the dictionary reference.

See also:: GetNonRecordedDictionary()

AIAPI AIErr(* AIDocumentSuite::GetTextFocus)(StoryRef *pStory)

Retrieves the current story that is in editing mode.

You must release the object when it is no longer needed. It is recommended that you use IStory to wrap this object, which takes care of memory management.

Parameters:

pStory [out] A buffer in which to return the story object, or NULL if the current document is not in text editing mode.

AIAPI AIErr(* AIDocumentSuite::GetTextSelection)(TextRangesRef *pTextSelection)

Retrieves the text selection object for the current document.

You must release the object when it is no longer needed. It is recommended that you use ITextRanges to wrap this object, which takes care of memory management. For example:

ATE::TextRangesRef selectionRef = NULL;
sAIDocument->GetTextSelection(&selectionRef);
{
        ITextRanges mySelection(selectionRef);
        ...
}

At this point selectionRef is released.The reference is invalid, and you must call GetTextSelection() again to get a valid object.

The text selection can describe multiple discontiguous ranges of text across multiple art objects.

If the document is in text editing mode, the result is a range representing the caret or the user selection.
If the document is not in text editing mode, there are multiple ranges for the selected text frame objects.

Parameters:

pTextSelection

[out] A buffer in which to return the text selection object.

AIAPI AIErr(* AIDocumentSuite::HasTextCaret)(AIBoolean *caret)

Reports whether the current document is in text editing mode and the caret is blinking (as opposed to a range of text being selected).

Parameters:

caret

[out] A buffer in which to return true if the document has the text focus and the caret is blinking.

AIAPI AIErr(* AIDocumentSuite::HasTextFocus)(AIBoolean *focus)

Reports whether the current document is in text editing mode.

Parameters:

focus

[out] A buffer in which to return true if the document has the text focus.

AIAPI AIBoolean(* AIDocumentSuite::IsCloudAIDocument)()

Reports whether the current document is a Cloud AI document.

(Note that this function returns a constant value, not an error code.)

Returns:: true if the current document is a Cloud AI document, else false.

AIAPI AIErr(* AIDocumentSuite::LoseTextFocus)()

Exits text editing mode.

AIAPI AIErr(* AIDocumentSuite::Paste)()

Pastes the contents of the clipboard into the document.

This is the same as the Paste menu command.

Note:: Use only when this plug-in is issuing a command and is entirely in control of that command. Do not call when responding to messages invoked by other commands, such as save, close, update, and so on.

AIAPI AIErr(* AIDocumentSuite::Redo)()

Redoes the most recent redoable transaction.

This is the same as the Redo menu command.

Note:: Use only when this plug-in is issuing a command and is entirely in control of that command. Do not call when responding to messages invoked by other commands, such as save, close, update, and so on.

AIAPI AIErr(* AIDocumentSuite::RedrawDocument)(void)

Forces the current document to be redrawn.

Illustrator automatically redraws the document when a plug-in returns, so this function is not usually needed.

AIAPI AIErr(* AIDocumentSuite::ResumeTextReflow)()

Resumes text reflow.

Reflows any text objects that modified after the call to SuspendTextReflow().

Returns:: The error kNoDocumentErr if no document is open.

AIAPI AIErr(* AIDocumentSuite::SetAutoAssignUIDOnArtCreation)(ai::int16 artType, AIBoolean autoAssignUIDOnArtCreation)

Controls whether UIDs are automatically assigned to art objects of a given type on creation, in the current document.

Parameters:

	autoAssignUIDOnArtCreation	True to turn behavior on, false to turn it off.
	artType	The art type.

See also:: AIUIDUtilsSuite::GetArtUID()

AIAPI AIErr(* AIDocumentSuite::SetDocumentAssetMgmtInfo)(AIBoolean *managed, AIBoolean *checkedOut, const char *URL, AIBoolean *canEdit)

Deprecated:: Sets asset management information. Pass null for any parameter whose state you do not want to set.

Parameters:

	managed	When true, the file has an associated server URL.
	checkedOut	Deprecated, pass `null`.
	URL	The server URL of a managed file.
	canEdit	Deprecated, pass `null`.

AIAPI AIErr(* AIDocumentSuite::SetDocumentBleeds)(const AIRealRect &bleedOffset)

Sets the document's bleed values.

Parameters:

bleedOffset

A rectangle containing the new bleed values.

AIAPI AIErr(* AIDocumentSuite::SetDocumentColorModel)(ai::int16 colorModel)

Sets the intended color model for documents upon load.

Use when reading a file. This function does not convert artwork in the current document to the new model. After Illustrator reads a file, it processes artwork in the document to ensure it matches the model.

Parameters:

colorModel The color model, an AIDocumentColorModelValue.

AIAPI AIErr(* AIDocumentSuite::SetDocumentCropStyle)(AICropMarkStyle cropStyle)

Sets the style of crop marks that are created by the Create Crop Marks command and filter.

This is not a document setting. It is an application preference. In AI11 and later this no longer affects separations printing.

AIAPI AIErr(* AIDocumentSuite::SetDocumentFileFormat)(AIFileFormatHandle fileFormat)

Sets the file format to be used when saving the current document.

Parameters:

fileFormat

The file format.

See also:: AIFileFormatSuite

AIAPI AIErr(* AIDocumentSuite::SetDocumentFileFormatParameters)(AIDocumentFileFormatParameters parameters)

Sets the block of user parameters associated with the current document's associated file format.

Parameters:

parameters [out] A buffer in which to return the parameter block. This is a void* pointer. The actual format of the parameter block is determined by the file format. Use the AIBlockSuite functions to allocate this memory, so that Illustrator can release it when it is no longer needed.

See also:: AIFileFormatSuite

AIAPI AIErr(* AIDocumentSuite::SetDocumentMiPrintRecord)(AIDocumentMiPrintRecordPtr print)

Not implemented.

AIAPI AIErr(* AIDocumentSuite::SetDocumentModified)(AIBoolean modified)

Sets the modification state of the current document.

When a document is marked as modified, the user is prompted to save before closing it.

Parameters:

modified

True to mark the document as modified, false to mark it as unmodified.

AIAPI AIErr(* AIDocumentSuite::SetDocumentPageOrigin)(AIRealPoint *origin)

Sets the coordinates of the lower left corner of the imageable page.

The origin for artwork coordinates is not changed; affects only what is printed.

Parameters:

origin

The new imageable page origin, specified relative to the ruler origin.

AIAPI AIErr(* AIDocumentSuite::SetDocumentPixelPerfectStatus)(AIBoolean isPixelPerfect)

Turns Pixel Perfect mode on or off for the document.

Parameters:

isPixelPerfect

True to turn Pixel Perfect mode on, false to turn it off.

AIAPI AIErr(* AIDocumentSuite::SetDocumentPrintRecord)(AIDocumentPlatformPrintRecord print)

Not implemented.

AIAPI AIErr(* AIDocumentSuite::SetDocumentProfiles)(AIColorProfile rgbProfile, AIColorProfile cmykProfile, AIColorProfile grayProfile)

Sets the color calibration profiles for the current document.

Parameters:

	rgbProfile	The RGB profile. Can be `NULL`.
	cmykProfile	The CMYK profile. Can be `NULL`.
	grayProfile	The grayscale profile. Can be `NULL`.

AIAPI AIErr(* AIDocumentSuite::SetDocumentRulerOrigin)(AIRealPoint *origin)

Sets the ruler origin for the current document.

Positive ruler values go the right and above the origin. Negative values go the left and below the origin,

Parameters:

origin

The new ruler origin, specified relative to the lower left of the artboard page, which is always (0,0).

AIAPI AIErr(* AIDocumentSuite::SetDocumentRulerUnits)(ai::int16 units)

Sets the current unit of measurement, shown in the ruler and displayed in dialog boxes.

Can be used only when reading a document.

Parameters:

units [out] A buffer in which to return the ruler unit, an AIDocumentRulerUnitValue.

AIAPI AIErr(* AIDocumentSuite::SetDocumentSetup)(AIDocumentSetup *setup)

Sets the document setup information, as set through the document Setup dialog.

Can be used only when reading a document.

Parameters:

setup

A pointer to a structure containing the new setup information.

AIAPI AIErr(* AIDocumentSuite::SetDocumentSpotColorMode)(AIDocumentHandle document, AISpotColorMode mode, AIBoolean convert, AIBoolean *converted)

Sets the spot color mode of a document, which controls the appearance definitions of new spot colors that are added to the document.

Parameters:

	document	The document reference, or `NULL` for the current document.
	mode	The new mode, an `AISpotColorMode` value.
	convert	When true, converts existing spot color definitions to the new mode.
	converted	[out] Optional. A buffer in which to return true if any colors were actually modified.

Returns:: The error kNoDocumentErr if document is NULL and there is no current document.

AIAPI AIErr(* AIDocumentSuite::SetDocumentTargeting)(short paintTarget, short transparencyTarget, short effectsTarget)

Unimplemented.

A no-op.

AIAPI AIErr(* AIDocumentSuite::SetDocumentXAP)(const char *xap)

Sets the XMP metadata of the current document.

Replaces any existing XMP metadata

Parameters:

xap The new XML packet (must be in UTF-8 Unicode format). This is copied into the document, and can be deleted after the call. Pass null to clear metadata.

AIAPI AIErr(* AIDocumentSuite::SetLastExportedFilePath)(const AIExportTriggeredFrom option, ai::FilePath file)

Set file path that was used for last export operation for current file.

Parameters:

	file	[in] option to know whether export was triggered from Export As, Export for screens or Save for Web.
	file	[in] file path used for last export.

AIAPI AIErr(* AIDocumentSuite::SetTextFocus)(StoryRef story)

Sets a story to be in editing mode.

The insertion point is positioned at the start of the story.

Parameters:

story

The story object.

AIAPI AIErr(* AIDocumentSuite::SuspendTextReflow)()

Halts any text reflow for all text objects in the current document.

Match this call with a call to ResumeTextReflow().

If you manipulate kTextFrameArt objects and do not need text reflow after each access, this speeds up the manipulation process. Some functions that causes text reflow are:
ATE::ITextRange::InsertAfter(), ATE::ITextRange::InsertBefore()
ATE::ITextRange::SetLocalCharFeatures(), ATE::ITextRange::SetLocalParaFeatures()
ATE::ITextRange::Remove()

Returns:: The error kNoDocumentErr if no document is open.

AIAPI AIErr(* AIDocumentSuite::SyncDocument)(void)

Updates cached artwork properties.

For example, the selection state of a group is cached, and is determined from the states of its children. You do not typically need to call this function. Illustrator recomputes cached properties as needed.

AIAPI AIErr(* AIDocumentSuite::Undo)()

Undoes the most recent undoable transaction.

This is the same as the Undo menu command.

Note:: Use only when this plug-in is issuing a command and is entirely in control of that command. Do not call when responding to messages invoked by other commands, such as save, close, update, and so on.

AIAPI AIErr(* AIDocumentSuite::UpdateLinks)(AIBoolean *updatedSomething)

Updates linked objects in the current document, if needed.

Parameters:

updatedSomething

[out] Optional. A buffer in which to return true if any links were found that needed update.

AIAPI AIErr(* AIDocumentSuite::WriteDocument)(const ai::FilePath &file, const char *fileFormatName, AIBoolean askForParms)

Writes the current document to a file without modifying the document or changing its modification status.

Parameters:

	file	The file specification.
	fileFormatName	The file format name.
	askForParms	When true, show a dialog to query user for file-format parameters. If no format parameters are available, the function queries the user even if this value is false.

See also:: WriteDocumentWithOptions() and WriteDocumentAsLibrary()

AIAPI AIErr(* AIDocumentSuite::WriteDocumentAsLibrary)(const ai::FilePath &file, AILibraryType libraryType)

Writes the current document to a file as a library of specified type without modifying the document or changing its modification status.

Parameters:

	file	The file specification.
	libraryType	The library type. See `AILibraryType` for possible values.

See also:: WriteDocument() and WriteDocumentWithOptions()

AIAPI AIErr(* AIDocumentSuite::WriteDocumentMacInformationResource)(const ai::FilePath &file)

Deprecated:: Does nothing in AI13 (CS3)

Attaches a thumbnail of the current document to the resources of the specified file. This is the thumbnail displayed in the Finder in Mac OS.

Parameters:

file

The file.

AIAPI AIErr(* AIDocumentSuite::WriteDocumentWithOptions)(const ai::FilePath &file, const char *fileFormatName, ai::int32 fileFormatOptions, AIDictionaryRef additionalOptionsDict, AIBoolean askForParms)

Writes the current document to a file with specified write options, without modifying the document or changing its modification status.

Parameters:

	file	The file specification.
	fileFormatName	The file format name.
	fileFormatOptions	The write options, a logical OR of `AIFileFormatOptions` values.
	additionalOptionsDict	Additional file format specific options to customize import/export.
	askForParms	When true, show a dialog to query user for file-format parameters. If no format parameters are available, the function queries the user even if this value is false.

See also:: WriteDocument() and WriteDocumentAsLibrary()

The documentation for this struct was generated from the following file:

AIDocument.h

AIDocumentSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIDocumentSuite Struct Reference
[API Suite List]