API Suite List

An alphabetical index of function suites for the Adobe Illustrator API. More...

Classes
struct	AIActionManagerSuite
	The Action Manager suite allows you to access the internal scripting system built into Adobe Illustrator. More...
struct	AIAnnotatorSuite
	The annotator suite allows plug-ins to draw annotations into the document window that are not a part of the artwork. More...
struct	AIAnnotatorDrawerSuite
	The annotator drawer suite allows plug-ins to draw annotations into the document window that are not a part of the artwork. More...
struct	AIApplicationSuite
	The Application suite provides functions for querying and controlling the state of a plug-in host application. More...
struct	AIArraySuite
	This suite defines the array, a heterogeneous container whose elements are accessed by sequential integer indices. More...
struct	AIArtSuite
	This suite allows you to access and modify the artwork in Illustrator documents. More...
struct	AIArtboardSuite
	This suite provides utilities that allow you to create and manipulate Artboards in a document. More...
struct	AIArtboardRangeSuite
	This suite allows you to validate a string containing a range of artboard indices and sequentially iterate over the range. More...
struct	AIArtConverterSuite
	This suite allows you to convert art to paths or outlines. More...
struct	AIArtSetSuite
	An art set is an ordered list of art object handles. More...
struct	AIArtStyleSuite
	The functions in the Art Style suite are used to access and modify art styles on artwork in Illustrator documents. More...
struct	AIArtStyleParserSuite
	The AIArtStyleParser allows you to manipulate art styles, and access information typically shown in the Appearance palette. More...
struct	AIAssetMgmtSuite
	This suite provides simple XMP metadata manipulation routines and Adobe Version Cue(TM) functionality. More...
struct	AIATECurrentTextFeaturesSuite
	These functions allow you to access and manipulate the character and paragraph style attributes of text. More...
struct	AIATEPaintSuite
	Allows you to convert between ATE and Illustrator types that describe color and other text style attributes. More...
struct	AIATETextUtilSuite
	It provides utilities for working with text. More...
struct	AIBeautifulStrokesSuite
	This suite allows you to control advanced features for stroking paths. More...
struct	AIBlockSuite
	This suite provides a cross-platform way to manage memory. More...
struct	AICharacterEncodingSuite
	The character encoding suite provides facilities for translating between different encodings of textual data. More...
struct	AIClipboardSuite
	The clipboard suite enables plug-ins to register new clipboard format handlers. More...
struct	AIColorSuite
	Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIColorSuite and kAIColorSuiteVersion. More...
struct	AIColorConversionSuite
	Provides functions for converting color values and image sample values between color spaces. More...
struct	AIColorHarmonySuite
	These functions allow you to use the three Color Harmony dialogs:. More...
struct	AIColorSpaceSuite
	These function allow you to manipulate color-space objects and the application's global list of color spaces. More...
struct	AIAppContextSuite
	Use these functions to manage the application context. More...
struct	AIControlBarSuite
	This suite provides functions for creating and managing control bars. More...
struct	AICountedObjectSuite
	These functions allow you to maintain the reference count for Illustrator object types that are returned through plug-in APIs. More...
struct	AICSXSExtensionSuite
	This suite provides access to information about the status of Creative Suite extensions that might be loaded into Illustrator. More...
struct	AICursorSnapSuite
	Tools that use the Smart Guides snapping facility use these functions in the cursor-tracking code. More...
struct	AICurveFittingSuite
	This suite provides functions to fit a vector of sample points to a cubic Bezier curve. More...
struct	AICustomColorSuite
	Use the functions in this suite to access, create, delete, and modify custom colors. More...
struct	AIDataFilterSuite
	A data filter is an object that bytes of data can be read from or written to. More...
struct	AIDeviceInfoSuite
	This suite provides functions that allow you to access various informations about the device on which illustrator is running or the device which is being connected for using illustrator through it. More...
struct	AIDictionarySuite
	This suite provides function to create and manage Illustrator data dictionaries. More...
struct	AIDocumentSuite
	Use these functions to get and set information about the current document. More...
struct	AIDocumentListSuite
	These functions enumerate and operate on the list of open Illustrator documents. More...
struct	AIDocumentViewSuite
	Use these functions to get and set properties of a document view, including the bounds, center, zoom, and screen mode. More...
struct	AIDrawArtSuite
	These functions draw Illustrator artwork to an output port (drawing surface). More...
struct	AIEntrySuite
	This suite provides functions for constructing and inspecting dictionary and array entries. More...
struct	AIEnvelopeSuite
	This suite provides functions to create and manage envelopes, which allow you to apply a set of deformations to a set of source art objects. More...
struct	AI70ExpandSuite
	This suite provides a legacy version of a single function that expands an art object into a set of objects with equivalent appearance. More...
struct	AIExpandSuite
	This suite provides a single function that expands an art object into a set of objects with equivalent appearance. More...
struct	AIFileFormatSuite
	This suite provides functions for creating and managing file-format plug-ins, which extend the number of file formats that Illustrator can read and write. More...
struct	AIFilePathSuite
	Provides cross-platform file referencing. More...
struct	AIFilterSuite
	This suite provides functions to add and manage menu items in the Filter menu. More...
struct	AIFixedMathSuite
	Use these functions to work with fixed-point numbers. More...
struct	AIFOConversionSuite
	These functions allows you to convert artwork and collect information about its contents. More...
struct	AIFoldersSuite
	This suite provides functions to get the locations of the standard folders used by Illustrator. More...
struct	AIFontSuite
	This suite provides functions to access the set of fonts that is available to Illustrator documents, and provide information about individual fonts. More...
struct	AIForeignObjectSuite
	This suite allows you to work with foreign objects, that is, art objects that encapsulate imaging constructs which are supported by PDF and the Adobe Imaging Model, but are not native to Illustrator. More...
struct	AIFXGFileFormatSuite
	Stream interface to be passed to AIFXGFileFormatSuite::ExportFXGToStream(). More...
struct	AIGeometrySuite
	This suite provides an iteration mechanism for collecting information about the art objects in the various kinds of artwork trees. More...
struct	AIGlobalUnicodeStringSuite
struct	AIGradientSuite
	This suite provides the basic definition of the gradient, a graduated blend between two or more colors. More...
struct	AIGridSuite
	This suite allows you to access the grid settings for the current document. More...
struct	AIGroupSuite
	This suite provides functions for working with clipping and compound paths in art group objects. More...
struct	AIHardSoftSuite
	This suite provides functions for converting between different coordinate systems used at different levels of Illustrator. More...
struct	AIHitTestSuite
	These function allow you to query a document or art subtree for objects based on positional information. More...
struct	AIHTMLConversionSuite
	This suite is not, by default, provided by Illustrator. More...
struct	AIHTMLConversionSuitesSuite
	This suite allows you to register an HTML conversion suite, implemented as AIHTMLConversionSuite. More...
struct	AIImageOptSuite
	These functions allow you to rasterize an art object and stream the resulting raster to a data filter in various image formats. More...
struct	AIIsolationModeSuite
	This suite provides functions that handle isolation mode, in which an artwork selection is moved onto a special isolation layer for editing, and that isolation layer (and any contents) becomes the only layer displayed in the Layers panel or accessible to edits. More...
struct	AILayerSuite
	The artwork in an Illustrator document is contained within layers. More...
struct	AILayerListSuite
	The artwork in an Illustrator document is contained within layers. More...
struct	AILegacyTextConversionSuite
	This suite provides functions to convert legacy text objects (from earlier versions of Illustrator) to native text objects. More...
struct	AILiveEffectSuite
	This suite allows your plug-in to implement a Live Effect. More...
struct	AIBlendStyleSuite
	This suite provides function for working with blend styles. More...
struct	AIMaskSuite
	This suite provides functions to access the opacity mask that can be associated with an art object. More...
struct	AIMaskFlattenerSuite
	This suite provides functions that allow you to flatten transparent artwork into an equivalent collection of opaque artwork. More...
struct	AIMatchingArtSuite
	This suite allows you to get lists of art objects that are currently selected, or that match specified criteria, from among all available art objects, or from artwork in a particular set of layers. More...
struct	AIMdMemorySuite
	This suite provides functions that allocate and dispose of blocks of memory. More...
struct	AIMenuSuite
	This suite provides functions that allow you to add menu items to the Illustrator menu structure. More...
struct	AIMeshSuite
	This suite and related suites provides functions for creating and managing mesh objects, which are art object of type kMeshArt. More...
struct	AIMeshHitSuite
	This suite provides functions that operate on hit objects obtained by AIHitTestSuite functions, when the result of the test is a hit on a mesh object. More...
struct	AIMeshSelectionSuite
	This suite provides functions that allow you to create and manipulate mesh selections, which identify a subset of the vertices and segments of a mesh. More...
struct	AIMeshPatchIteratorSuite
	This suite provides functions that allow you to traverse and manipulate the patches in a mesh through a reference-counted iterator object. More...
struct	AIMeshVertexIteratorSuite
	This suite provides functions that allow you to traverse and manipulate the vertices in a mesh through a reference-counted iterator object. More...
struct	AIMeshSegmentIteratorSuite
	This suite provides functions that allow you to traverse and manipulate the segments in a mesh through a reference-counted iterator object. More...
struct	AIModalParentSuite
	This suite provides functions for specifying the parent window of an AI dialog. More...
struct	AINameSpaceSuite
	This suite provides functions that allow you to create and manage namespaces. More...
struct	AINotifierSuite
	This suite provides functions that allow your plug-in to use Illustrator's event notification system. More...
struct	AIOverrideColorConversionSuite
	This suite provides functions that allow you to manage color profiles and perform color conversions between profiles. More...
struct	AIPaintStyleSuite
	This suite provides functions to examine and operate on the Color and Gradient palettes, which display and modify the paint style of the current selection, and the Color Editor, which allows a user to choose and edit colors. More...
struct	AIPanelSuite
	Provides functions for creating and managing panels. More...
struct	AIPanelFlyoutMenuSuite
	Provides functions for creating and managing panel flyout menus. More...
struct	AIPathSuite
	This suite provides functions that allow you to examine and manipulate paths, which are art objects of type kPathArt. More...
struct	AIPathConstructionSuite
	Utilities to convert paths to and from line segments. More...
struct	AIPathfinderSuite
	This suite provides functions that perform operations on paths (art objects of type kPathArt), which apply various effects to selected path art. More...
struct	AIPathInterpolateSuite
	This suite provides functions that allow you to interpolate paths and styles, creating a smooth blend between two existing art objects. More...
struct	AIPathStyleSuite
	This suite provides functions to access or set stroke and fill paint style information for art objects. More...
struct	AIPatternSuite
	This suite provides functions that allow you to create, delete, and modify patterns. More...
struct	AIPerspectiveGridSuite
	This suite allows you to query and set parameters of the currently defined perspective grid in a document. More...
struct	AIPerspectiveTransformSuite
	This suite allows you to project or reverse-project points and art objects using the currently defined perspective grid in the current document. More...
struct	AIPlacedSuite
	This suite provides functions that allow you to access and manipulate placed art. More...
struct	AIPlanarObjectSuite
	This suite provides functions for working with planar objects, which are temporary objects used to construct a planar plug-in-group art object. More...
struct	AIPlatformMemorySuite
	This suite provides functions with which to manage memory for ASSliceSettings values, used with the AIOptimizationSettingsSuite. More...
struct	AIPluginSuite
	These functions access Illustrator-specific plug-in options, and allow Illustrator plug-ins to send messages to one another. More...
struct	AIPluginGroupSuite
	This suite provides functions for working with plug-in groups. More...
struct	AIPreferenceSuite
	This suite provides cross-platform access to Illustrator preferences. More...
struct	AIRandomSuite
	Together with the AIRandomBellCurveSuite, this suite allows you to add a degree of randomness, or "noise" to an effect. More...
struct	AIRandomBellCurveSuite
	Together with the AIRandomSuite, allows you to add a degree of randomness, or "noise" to an effect. More...
struct	AIRasterSuite
	This suite provides functions with which to access and modify the data associated with an art object of type kRasterArt. More...
struct	AIRasterizeSuite
	This suite provides functions that allow you to convert any art set (see AIArtSetSuite) into a single image, represented by a standard raster art object (an art object of type kRasterArt). More...
struct	AIRealBezierSuite
	This suite provides utilities for working with cubic Beziers curves. More...
struct	AIRealMathSuite
	This suite provides functions for working with the AIReal values that Illustrator uses for coordinates. More...
struct	AIRuntimeSuite
	This suite provide functions that allow you to obtain information about the name and version number of the plug-in host application. More...
struct	AISelectionContextManagerSuite
	This suite provides functions to access current selection context information. More...
struct	AISFWUtilitiesSuite
	This suite provides access to save-for-Web features. More...
struct	AIShapeConstructionSuite
	This suite provides utilities for creating paths whose shapes describe a particular geometric figure. More...
struct	AISlicingSuite
	This suite provides functions that allow you to create and manipulate image slices, subsets of raster data that can be used in copying from one buffer to another. More...
struct	AIOptimizationSettingsSuite
	This suite provides functions that allow you to access format-specific optimization settings and color table information, used for saving and placing images. More...
struct	AISmoothShadingStyleSuite
	This suite provides you functions which allow you to interact with the smooth style. More...
struct	AIStringFormatUtilsSuite
	This suite provides support for the ai::NumberFormat and ai::Locale classes in plug-ins. More...
struct	AIStringPoolSuite
	This suite provides functions for working with string pools. More...
struct	AISVGFilterSuite
	The SVG-filter Effect makes it possible to apply SVG filters to Illustrator artwork, from a global list associated with the current document. More...
struct	AISwatchListSuite
	This suite provides functions that allow you to access and modify swatches and swatch lists. More...
struct	AISwatchGroupSuite
	Swatch lists are hierarchically organized into swatch groups, which can be named. More...
struct	AISymbolSuite
	This suite is always available. More...
struct	AISymbolPaletteSuite
	These functions access and manipulate the currency and selection state of symbols. More...
struct	AITabletDataSuite
	This suite provides functions that allow you to access and manipulate tablet-device data that is attached to path objects. More...
struct	AITagSuite
	Tags allow you to assign arbitrary data to Illustrator artwork objects. More...
struct	AITextFrameSuite
	This suite provides functions that manage art objects of type kTextFrameArt. More...
struct	AITextFrameMESuite
	This suite is used in conjunction with AITextFrameSuite. More...
struct	AITextFrameHitSuite
	This suite is used in conjunction with AIHitTestSuite and AITextFrameSuite. More...
struct	AITimerSuite
	These functions allow you to schedule events by registering timer plug-ins. More...
struct	AIToolSuite
	This suite allows you to provide plug-in tools for Illustrator. More...
struct	AIToolboxSuite
	This suite allows you to create additional tool palettes, of which there can be any number. More...
struct	AITransformAgainSuite
	When Illustrator performs a transformation using a built-in tool or menu item, the user can repeat the action again easily by using the Transform Again command. More...
struct	AITransformArtSuite
	This suite provides a function that transforms an art object of any type by a given transformation matrix, making special transformation routines for the different art types unnecessary. More...
struct	AIUIDPoolSuite
	These functions allow you to create, query, and manage name pools. More...
struct	AIUIDSuite
	This suite allows you to access and manage unique identifiers. More...
struct	AIUIDREFSuite
	This suite allows you to access and manage references to unique identifiers. More...
struct	AIUIDUtilsSuite
	This suite allows you to query and manage the unique identifiers for art objects. More...
struct	AIUIThemeSuite
	This suite allows you to query UI color and brightness parameters. More...
struct	AIUndoSuite
	This suites provides access to the Undo/Redo mechanism. More...
struct	AIUnicodeStringSuite
	This suite provides utilities that allow you to create and manipulate Unicode strings. More...
struct	AIURLSuite
	This suite provides a simple interface to go to a URL through a web browser. More...
struct	AIUserSuite
	This suite provides utility functions for working with Illustrator, including unit conversion utilities and a progress bar. More...
struct	AIUUIDSuite
	This suite is in an experimental state, it is not completely production-ready. More...
struct	AIVectorizeSuite
	This suite gives you access to the object model for the tracing art type, a plug-in group containing:. More...
struct	AIWorkspaceSuite
	This suite allows you to access workspaces. More...
struct	AIXMLNodeSuite
	This suite allows you to create and manipulate XML nodes. More...
struct	AIXMLDocumentSuite
	An Illustrator document can store an XML document element in its dictionary. More...
struct	AIXMLElementSuite
	This suite allows you to access XML metadata attributes. More...
struct	AIXMLNodeListSuite
	This suite allows you to iterate through and manage lists of XML nodes. More...
struct	AIXMLNamedNodeMapSuite
	This suite allows you to access XML named node maps. More...
struct	AIXMLNameUtilSuite
	This suite allows you to create and manipulate XML names, and convert them to and from strings. More...
struct	ASUserInteractionSuite
	This suite provides access to the application preference for how the application responds to messages. More...
struct	SPAccessSuite
	This suite is used to load and unload plug-ins. More...
struct	SPAdaptersSuite
	An adapter is an interface between the PICA plug-in manager and an individual plug-in. More...
struct	SPBasicSuite
	This suite provides basic memory management for PICA (the Adobe plug-in manager) and defines the basic functions for acquiring and releasing other suites. More...
struct	SPBlockDebugSuite
	This suite provides basic debugging capability for blocks of memory allocated with the SPBlocksSuite. More...
struct	SPBlocksSuite
	This suite provides basic memory management for PICA (the Adobe plug-in manager), with debugging capability for the development version of the application. More...
struct	SPCachesSuite
	This suite allows you to manage PICA cache memory. More...
struct	SPFilesSuite
	This suite allows you to access the PICA files list. More...
struct	SPFilesSuiteV3
	This suite allows you to access the PICA files list. More...
struct	SPInterfaceSuite
	This suite provides is the ability for a plug-in to call other plug-ins, by sending a message to the main entry point. More...
struct	SPPropertiesSuite
	Use these functions to create, access, and manage plug-in property lists associated with a specific plug-in. More...
struct	SPRuntimeSuite
	This suite allows you to obtain specific references to the PICA global lists and string pool. More...
struct	SPRuntimeSuiteV6
	This suite allows you to obtain specific references to the PICA global lists and string pool. More...
struct	SPStringsSuite
	This suite allows you to work with the PICA string pool. More...
struct	SPSuitesSuite
	This suite allows you to create, manage, and access PICA function suites. More...
Enumerations
enum	AIDecimalPrecisionType {   kValue = 0, kDimension, kType, kScale,   kArtboardSize, kPercentage, kColor, kAngle,   kResolution, kStroke }
	This suite provides utilities that allow you to get the Limits . More...

---

Detailed Description

An alphabetical index of function suites for the Adobe Illustrator API.

Acquire a suite using SPBasicSuite::AcquireSuite() with the suite and version constants, kAI<name>Suite and kAI<name>Version.

The SPBasicSuite itself is a part of the message data passed to your plug-in with any call. To access it from the message data structure:

SPBasicSuite sBasic = message->d.basic;
sBasic->function( )

For example, to load the AIArtSuite in response to a plug-in manager call:

SPErr error;
SPBasicSuite *sBasic = message->d.basic;
AIArtSuite *sArt;
sBasic->AcquireSuite( kAIArtSuite, kAIArtVersion, &sArt );

---

Enumeration Type Documentation

enum AIDecimalPrecisionType

This suite provides utilities that allow you to get the Limits .

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAILimitsSuite and kAILimitsSuiteVersion.

Enumerator:

kValue
kDimension
kType
kScale
kArtboardSize
kPercentage
kColor
kAngle
kResolution
kStroke