MarkLogic XCC/.Net Library

ContentCreateOptions Members

ContentCreateOptions overview

Public Static (Shared) Methods

NewBinaryInstance Create an instance with format set to DocumentFormat.BINARY.
NewTextInstance Create an instance with format set to DocumentFormat.TEXT.
NewXmlInstance Create an instance with format set to DocumentFormat.XML.

Public Instance Constructors

ContentCreateOptions Constructor Initializes a new instance of the ContentCreateOptions class.

Public Instance Properties

Collections Document collection(s) property. An array of URIs that represent collections to which the document(s) will be added when inserted. The default is null, which indicates that the document(s) should be added to the users default collections.
Format Document format property. If never set, the default format (NONE) indicates that the server should apply its configured rules for determining the document format. This may include choosing a format according to the suffix of the document URI.
Language Document language property. The language name to associate with inserted documents. A value of 
en
indicates that the document is in English. The default is null, which indicates to use the server default.
Locale Document Locale property. The default is null, which indicates that the local default value is to be applied. Note that the server may not support the locale configured as the local client default. In such a case it may be necessary to explicitly set the Locale to a value recognized by the server for content insertion to succeed.
Namespace Document namespace property. A namespace name, which will used as the namespace associated with inserted documents. The default is null, which indicates that the default namespace should be used.
Permissions Document permission(s) property. Permissions (ContentPermission) to be applied when documents are inserted. The default is null, which indicates that the default permissions for the user should be applied.
PlaceKeys Document permission(s) property. A set of forest placement keys (forest IDs) currently to control where content will be stored. Although forest placement keys may be specified in two ways, as UInt64 or as long, they are always stored internally as UInt64 objects. If the URI of the document being inserted already exists exists in the contentbase, it will remain in the same forest. If a specified forest ID does not exist, that is an error. If more than one forest ID is given, the document will be placed in one of them at the server's discretion.
Quality Document quality property. The quality value that should be applied to the inserted document.
RepairLevel Document repair level property. The default value is DocumentRepairLevel.FULL, but this option is only applicable when the document format is DocumentFormat.XML.
ResolveBufferSize Document entity resolution buffer size property. This value is passed to the server and is not used directly by XCC. The default is 0, which indicates that a reasonable default should be used. The default should be appropriate for all but the most unusual of circumstances.
ResolveEntities Document entity resolution flag property. If true, any entity references in a document being inserted will be resolved (if possible) by XCC and sent to the server for inline expansion. If false, entities will simply be stored as text. The default is false and this flag is only meaningful when the format is DocumentFormat.XML.

Public Instance Methods

Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) Gets the Type of the current instance.
SetFormatBinary Convenience method equivalent to 
setFormat (DocumentFormat.BINARY);
.
SetFormatText Convenience method equivalent to 
setFormat (DocumentFormat.TEXT);
.
SetFormatXml Convenience method equivalent to 
setFormat (DocumentFormat.XML);
.
ToString (inherited from Object) Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

ContentCreateOptions Class | Marklogic.Xcc Namespace