Email this Page Log Support Call Send Feedback Print

Previous Topic

Next Topic

Book Contents

Book Index

GetNewObject(LogonID, ObjectType, BasedOn)

Returns an Author-it Object as XML. The object has not been created in the Library and SetObjects should be used to save it after properties have been set in the XML.

If based on an object template, properties will be pre-populated appropriately.

This function is the recommended starting point for programmatically creating an object.

Parameter

Type

Explanation

LogonID

String

ID returned from LogOn function.

ObjectType

Enum

An enum containing the Object Type to create.

BasedOn

Integer

The Object Key of the Template on which to base the new Object, 0 if no template is desired.

Return

String

Object as XML

The following error messages may be returned:

Error - Not currently logged on

Error: Cannot use ObjectType 'AllTypes'

Error: Invalid ObjectType

See Also

Object Functions

Search(Code, Description, BasedOn, ObjectType, FromDate, ToDate, ContainingText, InBook, ReleaseState

SearchPageByIndex(LogonID, Code, Description, BasedOn, ObjectType, FromDate, ToDate, ContainingText, InBook, ReleaseState, FolderId, IsTemplate, ResolveDependancies, ReturnAsObjectBases, SortBy, SortAsc, StartIndex, PageSize, ResultsLimit)

GetObject(LogonID, ObjectID, LockObject)

GetObjects(LogonID, XMLSummarys, LockObjects)

GetObjectsBrief(LogonID, XMLSummarys, LockObjects)

GetObjectsInFolder(LogonID, FolderID)

SetObjects(LogonID, XML, Unlock)

IsObjectLocked(LogonID, ObjectID)

UnlockObject(LogonID, ObjectID)

UnlockObjects(LogonID)

Top of Page Email this Page Log Support Call Send Feedback Print