Class Constants.Properties

String constants for document-dependent property names

Inheritance
object
Constants.Properties
Inherited Members
Namespace: SuperOffice.CRM.Documents
Assembly: SuperOffice.Plugins.dll
Syntax
public static class Constants.Properties

Fields

FileName

The filename of the template or suggested filename of a document.

Declaration
public const string FileName = "file-name"
Field Value
Type Description
string
Remarks

Used in queries regarding document templates and documents.

FileType

The file type of the document, such as DOC, PDF, XLS or whatever. This is used by NetServer if it needs to analyze the file content, for instance for freetext indexing. It is also used to set the extension of the file name generated for download/editing, and will usually control which document editor is loaded by the client operating system to edit the document.

Declaration
public const string FileType = "file-type"
Field Value
Type Description
string

HasLocking

Can this document be locked for changes? Values are False and True

Declaration
public const string HasLocking = "has-locking"
Field Value
Type Description
string
Remarks

Versioning implies Locking, so if HasVersioning is true, then HasLocking must be true also.

HasVersioning

Is this document turned on for versioning? Values are False and True

Declaration
public const string HasVersioning = "has-versioning"
Field Value
Type Description
string

IsSafeFileExtension

If true, this file is safe according to the UnsafeFileTypes preference

Declaration
public const string IsSafeFileExtension = "is-safe-file-extension"
Field Value
Type Description
string

LastModified

Last Modified date + time (UTC) of the document file, rather than the database record. Values should be returned as string in SuperOffice format "[d 2012-03-21T12:20:30]"

Declaration
public const string LastModified = "last-modified"
Field Value
Type Description
string

Length

Document size in bytes.

Declaration
public const string Length = "length"
Field Value
Type Description
string

PreferredOpen

What is the preferred method for editing documents? Values are Url and Stream, depending on whether the plugin supports WebDAV and prefers this method.

The client GUI is not guaranteed to respect preferred-open = 'url'; depending on the platform and other circumstances, the client may still use the GetDocumentStream interface to get the document content.

If a document is opened through WebDAV, SuperOffice code no longer controls the flow of events and cannot be responsible for proper phasing, access control or other features.
Declaration
public const string PreferredOpen = "preferred-open"
Field Value
Type Description
string

Tooltip

A descriptive string that is suitable for display as a tooltip; may be blank

Simple tooltips can be literals, and can contain resource tags (including culture-independent formatted dates, see the CultureDataFormatter class for examples and encoding methods.

More complex tooltips can be represented as tooltip hints, which cause a runtime call to the tooltip provider system. A document plugin can add its own tooltip provider in order to process such hints into the final tooltip text. This is the recommended approach for tooltips that are time-consuming to precalculate.

Tooltip hints can be constructed using the SuperOffice.CRM.Tooltips.TooltipProvider.SuperOffice.CRM.Tooltips.TooltipProvider.MakeTooltipHint method. They are parsed by provider plugins, either standard ones or custom plugins that can be written together with a document plugin.

This member may be blank, if no tooltip is provided.
Declaration
public const string Tooltip = "tooltip"
Field Value
Type Description
string