You are here: Function Reference > Alphabetical Listing > A > AddImage

AddImage

Use this procedure/function to add a new section to a form in the current document. You can also use the Paginate parameter to specify whether form pagination should occur after the section is added. Form pagination includes the application of section origin rules to determine whether new pages are required for the pre-defined page sizes.

Syntax

AddImage (FAP, Section, Form, Group, Flag, Paginate)

Parameter	Description
FAP	Enter the name of the section file to load and add to the form.
Section	Enter the name of a section which will precede the new section. The default is the current section.
Form	Enter the name of a form in the form set. If you specify the Section parameter, that section must occur on this form. The default is the current form.
Group	Enter the name of a group that contains the specified form. The default is the current group.
Flag	Determines if the section is inserted on the same page or on a new page. 0 - (zero) new page 1 - same page The default is zero (0).
Paginate	(Optional) This parameter follows the Flag parameter. If you enter anything other than a zero (0), it tells the system you do want form pagination to occur upon successful inclusion of the new section. If the section does contain an origin rule and you omit the Paginate option or set it to zero (0), the section origin rule executes upon insertion. Whether the inserted section has an origin rule or not, the positioning of this section when the Paginate option is omitted or zero (0) does not cause the entire form to be re-paginated. This means if the placement of the section causes it to overlap another section or to be out of the page boundary, no additional re-pagination occurs. If you are manipulating multiple sections in series, you may want to conclude your script with a call to PaginateForm to make sure the entire form is re-paginated. Here is an example: AddlImage( "myFAP", "mainImage" , , , 1,1) This example omits the Form and Group parameters, but does specify the Flag parameter as well as the Pagination parameter. Note: If you enter zero (0) or omit this parameter, the function works as it prior to version 11.2. The default is zero (0).

The system optionally returns one (1) on success or zero (0) on failure.

This procedure adds a copy of the section you specify to a form. The system loads the new section onto the page after the section, form, or group you specified or onto a new page which it creates after the section, form, or group you specified. The section added does not have to be predefined for the form.

Note

If you use this procedure to add sections to forms and you also plan to import and export those forms, be sure to set the IgnoreInvalidImage option in the ImpFile_cd control group in the FSISYS.INI file. Otherwise, users will receive an error message. For detailed instructions, see the Documaker Desktop Administration Guide.
Any section you add using this procedure is positioned the same way as other sections. The specific location of sections is determined by your master resource setup.
If the section parameter specifies one of multiple sections on the same page, the new section is added after the section, form, or group you specified. The system does not move sections already defined for a page. Therefore, you can overlay existing sections on the page. Make sure you do not unintentionally overlay an existing section. Move the new section using the ImageRect and SetImagePos procedures.
Use the Refresh procedure after this procedure to refresh the screen display.
When adding a section, there is no way for you to specify what section options or recipients you want included on the new section. So, the AddImage procedure takes the missing information from an associated section. The system will, however, exclude the In-lined, Copy on Overflow, Duplex Front, Duplex Back, and Caused by Overflow settings. These options are not normally associated with a section being added via DAL.

Example

Here are some examples:

Procedure	Result	Explanation
AddImage ("IMG1")	1 - if successfully added 0 - if not added	Insert the named section, IMG1, on a new page after the current page.
AddImage("NEW1", "IMG\3",,"GRP")	1 - if successfully added 0 - if not added	Insert the named section, NEW1, after the third occurrence of IMG, within GRP. This section is placed on a new page after the third occurrence of the specified section.
AddImage ("IMG1",,,, 1)	1 - if successfully added 0 - if not added.	Insert the named section, IMG1, after the current section on the same page.
AddImage("NEW1", "IMG\3", , , 1)	1 - if successfully added 0 - if not added	Insert the named section, NEW1, after the third occurrence of IMG on the same page.

AddImage

Syntax

Note

Example

See also