This object is a collection of all the pattern areas found on a page. More...

Public Member Functions
Integer	Add (const WideString Name, Single Left, Single Top, Single Width, Single Height, TPatternAreaType AreaType, Integer GroupIndex, WordBool AllowRewrite)
	Adds a new pattern area in the collection.
Integer	Add2 (const WideString Name, Single Left, Single Top, Single Width, Single Height, TPatternAreaType AreaType, Integer GroupIndex, WordBool AllowRewrite, TPatternAreaStyle AreaStyle)
	Adds a new pattern area in the collection.
Integer	Add3 (const WideString Name, Single Left, Single Top, Single Width, Single Height, TPatternAreaType AreaType, Integer GroupIndex, WordBool AllowRewrite, TPatternAreaStyle AreaStyle, TMaskType MaskType, const WideString MaskName, const WideString MaskFormat, Integer Rows, Integer Columns, const WideString MultiAreaColor)
	Adds a new pattern area in the collection.
Public Attributes
IPatternArea	Item
	Returns the pattern area at index `ItemIndex`.
IPatternArea	ItemByID
	Returns the pattern area whose ID is `ItemID`.
integer	Count
	Number of pattern areas in the collection.

Detailed Description

This object is a collection of all the pattern areas found on a page.

Member Function Documentation

Integer TPatternAreas::Add	(	const WideString	Name,
		Single	Left,
		Single	Top,
		Single	Width,
		Single	Height,
		TPatternAreaType	AreaType,
		Integer	GroupIndex,
		WordBool	AllowRewrite
	)

Adds a new pattern area in the collection.

Parameters:

Name	Name of the area. This usually corresponds to the PressTalk name of the User Area object in the PlanetPress document.
Left	Left coordinate of the pattern area, in points.
Top	Top coordinate of the pattern area, in points.
Width	Width of the pattern area, in points.
Height	Height of the pattern area, in points.
AreaType	Type of pattern for this pattern area. It can be one of: `ptMandatory` (0), `ptOptional` (1) `ptFinal` (2).
GroupIndex	Index of the group if the pattern area is a mandatory field.
AllowRewrite	Whether or not the area can be written to more than once.

Returns:: Item ID of the new entry.

Integer TPatternAreas::Add2	(	const WideString	Name,
		Single	Left,
		Single	Top,
		Single	Width,
		Single	Height,
		TPatternAreaType	AreaType,
		Integer	GroupIndex,
		WordBool	AllowRewrite,
		TPatternAreaStyle	AreaStyle
	)

Adds a new pattern area in the collection.

This method allows adding an area with a style other than the default psTextBox style. Area with the psMultiArea style should be added using Add3 instead.

Parameters:

Name	Name of the area. This usually corresponds to the PressTalk name of the User Area object in the PlanetPress document.
Left	Left coordinate of the pattern area, in points.
Top	Top coordinate of the pattern area, in points.
Width	Width of the pattern area, in points.
Height	Height of the pattern area, in points.
AreaType	Type of pattern for this pattern area. It can be one of: `ptMandatory` (0), `ptOptional` (1) `ptFinal` (2).
GroupIndex	Index of the group if the pattern area is a mandatory field.
AllowRewrite	Whether or not the area can be written to more than once.
AreaStyle	Style of the pattern area. This can be one of: `psCheckBox` (0) `psListBox` (1) `psTextBox` (2) `psMultiArea` (3)

Returns:: Item ID of the new entry.

See also:: Add3

Integer TPatternAreas::Add3	(	const WideString	Name,
		Single	Left,
		Single	Top,
		Single	Width,
		Single	Height,
		TPatternAreaType	AreaType,
		Integer	GroupIndex,
		WordBool	AllowRewrite,
		TPatternAreaStyle	AreaStyle,
		TMaskType	MaskType,
		const WideString	MaskName,
		const WideString	MaskFormat,
		Integer	Rows,
		Integer	Columns,
		const WideString	MultiAreaColor
	)

Adds a new pattern area in the collection.

This method allows adding the multi-area style of pattern area with extra properties.

Parameters:

Name	Name of the area. This usually corresponds to the PressTalk name of the User Area object in the PlanetPress document.
Left	Left coordinate of the pattern area, in points.
Top	Top coordinate of the pattern area, in points.
Width	Width of the pattern area, in points.
Height	Height of the pattern area, in points.
AreaType	Type of pattern for this pattern area. It can be one of: `ptMandatory` (0), `ptOptional` (1) `ptFinal` (2).
GroupIndex	Index of the group if the pattern area is a mandatory field.
AllowRewrite	Whether or not the area can be written to more than once.
AreaStyle	Style of the pattern area. This can be one of: `psCheckBox` (0) `psListBox` (1) `psTextBox` (2) `psMultiArea` (3)
MaskType	Type of mask for a multi-area field. It can be one of: `mtNone` (0) `mtNumeric` (1) `mtAlphabetic` (2) `mtAlphanumeric` (3) `mtCustom` (4) `mtRegExp` (5)
MaskName	Name of the multi-area field mask as specified by the document designer.
MaskFormat	Format of the multi-area field mask as sepecified by the document designer.
Rows	Number of rows.
Columns	Number of columns.
MultiAreaColor	Color of the line separating each area in a multi-area field. The format of the string is a PressTalk language-compliant color array.

Returns:: Item ID of the new entry.

Member Data Documentation

integer TPatternAreas::Count

Number of pattern areas in the collection.

IPatternArea TPatternAreas::Item

Returns the pattern area at index ItemIndex.

Note:: The index of a pattern area within a pattern area collection can change over time. Do not rely on the index once the item has been retrieved; use its Item ID instead.

Parameters:

ItemIndex Index of the PatternArea object to retrieve.

See also:: TPatternArea

IPatternArea TPatternAreas::ItemByID

Returns the pattern area whose ID is ItemID.

Parameters:

ItemID ID of the PatternArea object to retrieve.

See also:: TPatternArea

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation