AINewDocumentPreset Struct Reference

Parameters for creating a new document with AIDocumentListSuite::New(). More...

#include <AIDocumentList.h>

List of all members.

Public Attributes
ai::UnicodeString	docTitle
	The title of the new document.
AIReal	docWidth
	The width of the new document in document points.
AIReal	docHeight
	The height of the new document in document points.
ai::int32	docNumArtboards
	Number of artboards for new document.
AIArtboardLayout	docArtboardLayout
	Layout for artboards.
AIReal	docArtboardSpacing
	Spacing between artboards.
ai::int32	docArtboardRowsOrCols
	Number of rows (For rows layout) OR column(For column layouts)of artboards For docArtboardLayout = kAIArtboardLayoutRow or docArtboardLayout = kAIArtboardLayoutCol or docArtboardLayout = kAIArtboardLayoutRLRow docArtboardRowsOrCols value is ignored (if specified) & taken as 1 For other layouts its range is 1 to (docNumArtboards - 1), otherwise default value is taken which is sqrt(docNumArtboards).
AIColorModel	docColorMode
	The color mode of the new document, an AIColorModel value.
AIDocumentRulerUnitValue	docUnits
	Ruler unit type for the new document.
AIPreviewMode	docPreviewMode
	The preview mode for the new document, an AIPreviewMode value.
AITransparencyGrid	docTransparencyGrid
	The style of transparency grid for the new document, an AITransparencyGrid value.
AIRasterResolution	docRasterResolution
	The raster resolution for the new document, an AIRasterResolution value.
AIRealRect	docBleedOffset
	The bleed settings for the new document.
AIBoolean	docBleedLinkStatus
	Lock status for bleed settings.
ai::FilePath	docCustomFile
	Custom filepath.

---

Detailed Description

Parameters for creating a new document with AIDocumentListSuite::New().

---

Member Data Documentation

AIArtboardLayout AINewDocumentPreset::docArtboardLayout

Layout for artboards.

See AIDocumentSuite::AIArtboardLayout

ai::int32 AINewDocumentPreset::docArtboardRowsOrCols

Number of rows (For rows layout) OR column(For column layouts)of artboards For docArtboardLayout = kAIArtboardLayoutRow or docArtboardLayout = kAIArtboardLayoutCol or docArtboardLayout = kAIArtboardLayoutRLRow docArtboardRowsOrCols value is ignored (if specified) & taken as 1 For other layouts its range is 1 to (docNumArtboards - 1), otherwise default value is taken which is sqrt(docNumArtboards).

AIReal AINewDocumentPreset::docArtboardSpacing

Spacing between artboards.

For one artboard spacing value is ignored

AIBoolean AINewDocumentPreset::docBleedLinkStatus

Lock status for bleed settings.

AIRealRect AINewDocumentPreset::docBleedOffset

The bleed settings for the new document.

AIColorModel AINewDocumentPreset::docColorMode

The color mode of the new document, an AIColorModel value.

ai::FilePath AINewDocumentPreset::docCustomFile

Custom filepath.

AIReal AINewDocumentPreset::docHeight

The height of the new document in document points.

Should be less than or equal to document canvas size

ai::int32 AINewDocumentPreset::docNumArtboards

Number of artboards for new document.

Range (1:100).

AIPreviewMode AINewDocumentPreset::docPreviewMode

The preview mode for the new document, an AIPreviewMode value.

AIRasterResolution AINewDocumentPreset::docRasterResolution

The raster resolution for the new document, an AIRasterResolution value.

ai::UnicodeString AINewDocumentPreset::docTitle

The title of the new document.

An empty string results in the default title, "Untitled \e nn".

AITransparencyGrid AINewDocumentPreset::docTransparencyGrid

The style of transparency grid for the new document, an AITransparencyGrid value.

AIDocumentRulerUnitValue AINewDocumentPreset::docUnits

Ruler unit type for the new document.

See AIDocumentSuite::GetDocumentRulerUnits()

AIReal AINewDocumentPreset::docWidth

The width of the new document in document points.

Should be less than or equal to document canvas size

---

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

• AIDocumentList.h