dotmailer SDK: dotMailer.Sdk.Objects.Collections.DmDocumentCollection Class Reference

dotmailer SDK

dotMailer.Sdk.Objects.Collections.DmDocumentCollection Class Reference

Collection of objects that implement the IDmDocument interface. More...

Inheritance diagram for dotMailer.Sdk.Objects.Collections.DmDocumentCollection:

Public Member Functions

 DmDocumentCollection ()
 Constructor
 
 DmDocumentCollection (IEnumerable< IDmDocument > documents)
 Constructor - adds the specified collection of IDmDocuments to the list
 
int IndexOf (string documentName, bool caseSensitive=false)
 Searches for the specified document and returns the zero-based index of the first occurrence within the entire collection.
 

Properties

override string ObjectType [get, set]
 Returns the type name of the class Used by the serialisation process
 

Detailed Description

Collection of objects that implement the IDmDocument interface.

Constructor & Destructor Documentation

dotMailer.Sdk.Objects.Collections.DmDocumentCollection.DmDocumentCollection ( )

Constructor

dotMailer.Sdk.Objects.Collections.DmDocumentCollection.DmDocumentCollection ( IEnumerable< IDmDocument documents)

Constructor - adds the specified collection of IDmDocuments to the list

Parameters
documents

Member Function Documentation

int dotMailer.Sdk.Objects.Collections.DmDocumentCollection.IndexOf ( string  documentName,
bool  caseSensitive = false 
)

Searches for the specified document and returns the zero-based index of the first occurrence within the entire collection.

Parameters
documentNameThe name of the document to find.
caseSensitivePass true if the search should be case senstive.
Returns
The document index

Property Documentation

override string dotMailer.Sdk.Objects.Collections.DmDocumentCollection.ObjectType
getset

Returns the type name of the class Used by the serialisation process

Generated by   doxygen 1.8.3