Click or drag to resize

IDocument Interface

Documents represent files (usually Word documents or e-mail messages). The file should be generated before it can be edited/viewed

Namespace:  SuperOffice.COM.Application
Assembly:  SOCRM.Interop (in SOCRM.Interop.dll) Version: 8.0.0.0
Syntax
public interface IDocument : IModelBase

The IDocument type exposes the following members.

Properties
  NameDescription
Public propertyActiveLinks
ActiveLinks - Number of active links to documents, projects, Urls, appointments, sales, contacts, persons, selections
Public propertyActivityLinks
The ActivityLinks attached to this document
Public propertyapplication
Application used for editing this document. Not used.
Public propertyArchiveProvider
Archive system where the document content is stored.
Public propertyArchiveProviderName
Archive provider name. Which system the document content is stored in.
Public propertyAssociate
Author/owner of document
Public propertyAttention
Attention
Public propertyAutoSaveOnChangeIdentity
Should the model save on IdentityChanged?
Public propertyAutoSaveOnFlush
Should the model save on flush cache?
Public propertyChanged
has record been changed since read?
Public propertyCompleted
Is Completed
Public propertyContact
Contact this document refers to.
Public propertyCreatedAssociate
The user that created the object
Public propertyCreatedDate
The date the object was saved to the database.
Public propertyDescription
Description - keywords
Public propertyDone
Done date
Public propertyExternalFieldChanged
Have external fields been changed? If set then the model will save even if no internal fields have been modified.
Public propertyExtRef
External Reference - identity in document archive system.
Public propertyfilename
Filename - does not include path
Public propertyForeignKey
ForeignKey
Public propertyFullPath
FullPath - path and filename
Public propertyGroup
Primary usergroup of the owning associate - set implicitly when Associate is set
Public propertyHeader
Title of document. Changing this does not change the document after the document has been created.
Public propertyIdentity
The primary key on the primary table. Is zero for new objects. Is set when an object is saved.
Public propertyIsAvailable
is record available in db?
Public propertyIsFavourite
Add/Remove this document from my favourites
Public propertyIsRequiredFilled
Are all the required fields filled out? Can we save the record?
Public propertyIsValid
does the record exist?
Public propertyOurRef
Our Reference - this is usually set auto-generated.
Public propertyPerson
Person this document refers to.
Public propertyPrivate
Visible for who? 0=public,1=private,2=group
Public propertyPrivateToGroup
The group this document is visible for when Private=Group
Public propertyProject
Project this document refers to
Public propertyPublishType
Publish type for this document
Public propertyReference
External Reference - can be used for an external identifier like an e-mail Message-id
Public propertySale
Sale this document refers to
Public propertySalutation
Salutation - this is a dynamically calculated field!
Public propertySearchName
SearchName
Public propertySentry
Sentry settings for this object. Lets you find out your read/write access to the object.
Public propertyStatus
Status indicates whether the document has been completed or not.
Public propertySuggestedDocumentId
Gets the suggested document id
Public propertyTemplate
Document Template
Public propertyType
Type distinguishes different kinds of documents: 4 = document, 8=draft, 9=mergedoc
Public propertyUDef
The user-defined fields on the document
Public propertyUpdatedAssociate
The last user to modify the object
Public propertyUpdatedDate
The date of the most recent update.
Public propertyValidationMessage
Get validation message, if empty model will think it is ok to save
Public propertyYourRef
Your Reference
Top
Methods
  NameDescription
Public methodCancelChanges
Undo any changes made since the object was loaded.
Public methodChangeIdentity
Loads a different record into the object. Causes changes to the existing object to be saved first.
Public methodClone
Clone this document
Public methodDelete
Delete the object from the database. May throw an error if you are not allowed to delete the object.
Public methodGenerateDocumentFile
GenerateDocumentFile - copies the template and substitutes the given contact/person/project values. Returns false on failure.
Public methodGetFileCopy
make a copy of the file and return the path
Public methodIsSuggestedItem
Is this document used as a suggested document?
Public methodReplaceFile
ReplaceFile - archive the file provided and update record if necessary, or replace contents of existing file with same name, or
Public methodSave
Persist the object to the database. May throw an error if you are not allowed to save changes to the object.
Public methodSetDefaults
Populate the object with default values, such as setting the owner to the current user.
Public methodSuggestedItemId
Get the suggested item id
Top
See Also