Class OutlookDataObject
Inheritance
Implements
Inherited Members
Namespace: Simplic.Framework.DocumentProcessing.Outlook
Assembly: Simplic.Framework.DocumentProcessing.dll
Syntax
public class OutlookDataObject : IDataObject
Constructors
| Improve this Doc View SourceOutlookDataObject(IDataObject)
Initialize new instance
Declaration
public OutlookDataObject(IDataObject underlyingDataObject)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.IDataObject | underlyingDataObject | Instance of an IDataObject (WPF) |
Methods
| Improve this Doc View SourceGetData(String)
Declaration
public object GetData(string format)
Parameters
Type | Name | Description |
---|---|---|
System.String | format |
Returns
Type | Description |
---|---|
System.Object |
GetData(String, Boolean)
Declaration
public object GetData(string format, bool autoConvert)
Parameters
Type | Name | Description |
---|---|---|
System.String | format | |
System.Boolean | autoConvert |
Returns
Type | Description |
---|---|
System.Object |
GetData(String, Int32)
Retrieves the data associated with the specified data format at the specified index.
Declaration
public MemoryStream GetData(string format, int index)
Parameters
Type | Name | Description |
---|---|---|
System.String | format | The format of the data to retrieve. See System.Windows.Forms.DataFormats for predefined formats. |
System.Int32 | index | The index of the data to retrieve. |
Returns
Type | Description |
---|---|
System.IO.MemoryStream | A System.IO.MemoryStream containing the raw data for the specified data format at the specified index. |
GetData(Type)
Declaration
public object GetData(Type format)
Parameters
Type | Name | Description |
---|---|---|
System.Type | format |
Returns
Type | Description |
---|---|
System.Object |
GetDataPresent(String)
Determines whether data stored in this instance is associated with, or can be converted to, the specified format.
Declaration
public bool GetDataPresent(string format)
Parameters
Type | Name | Description |
---|---|---|
System.String | format | The format for which to check. See System.Windows.Forms.DataFormats for predefined formats. |
Returns
Type | Description |
---|---|
System.Boolean | true if data stored in this instance is associated with, or can be converted to, the specified format; otherwise false. |
GetDataPresent(String, Boolean)
Determines whether data stored in this instance is associated with the specified format, using a Boolean value to determine whether to convert the data to the format.
Declaration
public bool GetDataPresent(string format, bool autoConvert)
Parameters
Type | Name | Description |
---|---|---|
System.String | format | The format for which to check. See System.Windows.Forms.DataFormats for predefined formats. |
System.Boolean | autoConvert | true to determine whether data stored in this instance can be converted to the specified format; false to check whether the data is in the specified format. |
Returns
Type | Description |
---|---|
System.Boolean | true if the data is in, or can be converted to, the specified format; otherwise, false. |
GetDataPresent(Type)
Determines whether data stored in this instance is associated with, or can be converted to, the specified format.
Declaration
public bool GetDataPresent(Type format)
Parameters
Type | Name | Description |
---|---|---|
System.Type | format | A System.Type representing the format for which to check. See System.Windows.Forms.DataFormats for predefined formats. |
Returns
Type | Description |
---|---|
System.Boolean | true if data stored in this instance is associated with, or can be converted to, the specified format; otherwise, false. |
GetFormats()
Returns a list of all formats that data stored in this instance is associated with or can be converted to.
Declaration
public string[] GetFormats()
Returns
Type | Description |
---|---|
System.String[] | An array of the names that represents a list of all formats that are supported by the data stored in this object. |
GetFormats(Boolean)
Declaration
public string[] GetFormats(bool autoConvert)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | autoConvert |
Returns
Type | Description |
---|---|
System.String[] |
SetData(Object)
Stores the specified data in this instance, using the class of the data for the format.
Declaration
public void SetData(object data)
Parameters
Type | Name | Description |
---|---|---|
System.Object | data | The data to store. |
SetData(String, Boolean, Object)
Stores the specified data and its associated format in this instance, using a Boolean value to specify whether the data can be converted to another format.
Declaration
public void SetData(string format, bool autoConvert, object data)
Parameters
Type | Name | Description |
---|---|---|
System.String | format | The format associated with the data. See System.Windows.Forms.DataFormats for predefined formats. |
System.Boolean | autoConvert | true to allow the data to be converted to another format; otherwise, false. |
System.Object | data | The data to store. |
SetData(String, Object)
Stores the specified data and its associated format in this instance.
Declaration
public void SetData(string format, object data)
Parameters
Type | Name | Description |
---|---|---|
System.String | format | The format associated with the data. See System.Windows.Forms.DataFormats for predefined formats. |
System.Object | data | The data to store. |
SetData(Type, Object)
Stores the specified data and its associated class type in this instance.
Declaration
public void SetData(Type format, object data)
Parameters
Type | Name | Description |
---|---|---|
System.Type | format | A System.Type representing the format associated with the data. See System.Windows.Forms.DataFormats for predefined formats. |
System.Object | data | The data to store. |
TryGetOutlookDataObject(IDataObject, out OutlookDataObject)
Try to get an OutlookDataObject from System.Windows.IDataObject
Declaration
public static bool TryGetOutlookDataObject(IDataObject underlyingDataObject, out OutlookDataObject odo)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.IDataObject | underlyingDataObject | DataObject |
OutlookDataObject | odo | Null or a created OutlookDataObject |
Returns
Type | Description |
---|---|
System.Boolean | True if getting the data object was successfull |