GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Fourteen — Project Functions (continued)

14.3 Project Entry Functions

14.3.1 Introduction

Files added and managed within a project are Project Entries. The file content is not stored in the project but rather the link to the file and various meta data such as EDGAR and publishing information.

This section covers functions that allow a script to access project entries.

14.3.2 Entry Data Items

Aside from the filename, each project entry has a number of characteristics or parameters. Some parameters are saved with the project while others are transient for the current session.

For certain functions, these parameters are represented as array key names or simple function parameters:

	Key Name		Description
	Filename		Entry filename. Generally relative but can be set as an absolute path.
	Type		General string (EDGAR Document Type)
	Description		General string (EDGAR Document Description)
	Comment		General string (User or entry comments. Also used as part of the data for EDGAR modules and segments.)
	EditStatus		General string (Also used as part of the data for EDGAR segments.)
	Switches		General string
	Member		Member set as string tokens (For EDGAR products, ‘EDGAR’ is always assumed if blank.)

 

14.3.3 Members

Each entry can have member flags. These flags can be used to control what publishing groups the entry belongs to. Tokens are used to define the membership and are defined as follows:

	Book	Entry is part of a book group.
	EDGAR	Entry is part of an EDGAR submission.
	Help	Entry is part of an HTML Help Library.
	Support	Entry is general support and is not published.
	UserA	A user designation.
	UserB	A user designation.
	Web	Entry is published to a website.

 

14.3.4 Functions

ProjectDeleteEntry — Deletes the specified entry.

ProjectFindEntry — Finds an entry within a project.

ProjectGetEntry — Gets the filename associated with an entry.

ProjectGetEntryCount — Gets the count of primary entries.

ProjectGetEntryAsNumber — Gets a specified field associated with a project file entry as a numeric value.

ProjectGetEntryAsString — Gets a specified field associated with a project file entry as a string.

ProjectGetEntryData — Gets all the fields associated with a project file entry.

ProjectInsertEntry — Inserts an entry at position with optional parameters.

ProjectSetEntryData — Sets fields for an existing entry.

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.