| 1 | <?xml version="1.0"?> |
|---|
| 2 | <doc> |
|---|
| 3 | <assembly> |
|---|
| 4 | <name>DragDropLib</name> |
|---|
| 5 | </assembly> |
|---|
| 6 | <members> |
|---|
| 7 | <member name="T:System.Runtime.InteropServices.ComTypes.ComDataObjectExtensions"> |
|---|
| 8 | <summary> |
|---|
| 9 | Provides extended functionality for the COM IDataObject interface. |
|---|
| 10 | </summary> |
|---|
| 11 | </member> |
|---|
| 12 | <member name="M:System.Runtime.InteropServices.ComTypes.ComDataObjectExtensions.SetDropDescription(System.Runtime.InteropServices.ComTypes.IDataObject,DragDropLib.DropDescription)"> |
|---|
| 13 | <summary> |
|---|
| 14 | Sets the drop description for the drag image manager. |
|---|
| 15 | </summary> |
|---|
| 16 | <param name="dataObject">The DataObject to set.</param> |
|---|
| 17 | <param name="dropDescription">The drop description.</param> |
|---|
| 18 | </member> |
|---|
| 19 | <member name="M:System.Runtime.InteropServices.ComTypes.ComDataObjectExtensions.GetDropDescription(System.Runtime.InteropServices.ComTypes.IDataObject)"> |
|---|
| 20 | <summary> |
|---|
| 21 | Gets the DropDescription format data. |
|---|
| 22 | </summary> |
|---|
| 23 | <param name="dataObject">The DataObject.</param> |
|---|
| 24 | <returns>The DropDescription, if set.</returns> |
|---|
| 25 | </member> |
|---|
| 26 | <member name="M:System.Runtime.InteropServices.ComTypes.ComDataObjectExtensions.Advise(System.Runtime.InteropServices.ComTypes.IDataObject,System.Runtime.InteropServices.ComTypes.IAdviseSink,System.String,System.Runtime.InteropServices.ComTypes.ADVF)"> |
|---|
| 27 | <summary> |
|---|
| 28 | Sets up an advisory connection to the data object. |
|---|
| 29 | </summary> |
|---|
| 30 | <param name="dataObject">The data object on which to set the advisory connection.</param> |
|---|
| 31 | <param name="sink">The advisory sink.</param> |
|---|
| 32 | <param name="format">The format on which to callback on.</param> |
|---|
| 33 | <param name="advf">Advisory flags. Can be 0.</param> |
|---|
| 34 | <returns>The ID of the newly created advisory connection.</returns> |
|---|
| 35 | </member> |
|---|
| 36 | <member name="M:System.Runtime.InteropServices.ComTypes.ComDataObjectExtensions.FillFormatETC(System.String,System.Runtime.InteropServices.ComTypes.TYMED,System.Runtime.InteropServices.ComTypes.FORMATETC@)"> |
|---|
| 37 | <summary> |
|---|
| 38 | Fills a FORMATETC structure. |
|---|
| 39 | </summary> |
|---|
| 40 | <param name="format">The format name.</param> |
|---|
| 41 | <param name="tymed">The accepted TYMED.</param> |
|---|
| 42 | <param name="formatETC">The structure to fill.</param> |
|---|
| 43 | </member> |
|---|
| 44 | <member name="M:System.Runtime.InteropServices.ComTypes.ComDataObjectExtensions.SetManagedData(System.Runtime.InteropServices.ComTypes.IDataObject,System.String,System.Object)"> |
|---|
| 45 | <summary> |
|---|
| 46 | Sets managed data to a clipboard DataObject. |
|---|
| 47 | </summary> |
|---|
| 48 | <param name="dataObject">The DataObject to set the data on.</param> |
|---|
| 49 | <param name="format">The clipboard format.</param> |
|---|
| 50 | <param name="data">The data object.</param> |
|---|
| 51 | <remarks> |
|---|
| 52 | Because the underlying data store is not storing managed objects, but |
|---|
| 53 | unmanaged ones, this function provides intelligent conversion, allowing |
|---|
| 54 | you to set unmanaged data into the COM implemented IDataObject.</remarks> |
|---|
| 55 | </member> |
|---|
| 56 | <member name="M:System.Runtime.InteropServices.ComTypes.ComDataObjectExtensions.GetManagedData(System.Runtime.InteropServices.ComTypes.IDataObject,System.String)"> |
|---|
| 57 | <summary> |
|---|
| 58 | Gets managed data from a clipboard DataObject. |
|---|
| 59 | </summary> |
|---|
| 60 | <param name="dataObject">The DataObject to obtain the data from.</param> |
|---|
| 61 | <param name="format">The format for which to get the data in.</param> |
|---|
| 62 | <returns>The data object instance.</returns> |
|---|
| 63 | </member> |
|---|
| 64 | <member name="M:System.Runtime.InteropServices.ComTypes.ComDataObjectExtensions.GetMediumFromObject(System.Object,System.Runtime.InteropServices.ComTypes.STGMEDIUM@)"> |
|---|
| 65 | <summary> |
|---|
| 66 | Serializes managed data to an HGLOBAL. |
|---|
| 67 | </summary> |
|---|
| 68 | <param name="data">The managed data object.</param> |
|---|
| 69 | <returns>An STGMEDIUM pointing to the allocated HGLOBAL.</returns> |
|---|
| 70 | </member> |
|---|
| 71 | <member name="M:System.Runtime.InteropServices.ComTypes.ComDataObjectExtensions.GetAsSerializable(System.Object)"> |
|---|
| 72 | <summary> |
|---|
| 73 | Gets a serializable object representing the data. |
|---|
| 74 | </summary> |
|---|
| 75 | <param name="obj">The data.</param> |
|---|
| 76 | <returns>If the data is serializable, then it is returned. Otherwise, |
|---|
| 77 | type conversion is attempted. If successful, a string value will be |
|---|
| 78 | returned.</returns> |
|---|
| 79 | </member> |
|---|
| 80 | <member name="M:System.Runtime.InteropServices.ComTypes.ComDataObjectExtensions.ConvertDataFromString(System.String,System.Type)"> |
|---|
| 81 | <summary> |
|---|
| 82 | Converts data from a string to the specified format. |
|---|
| 83 | </summary> |
|---|
| 84 | <param name="data">The data to convert.</param> |
|---|
| 85 | <param name="dataType">The target data type.</param> |
|---|
| 86 | <returns>Returns the converted data instance.</returns> |
|---|
| 87 | </member> |
|---|
| 88 | <member name="M:System.Runtime.InteropServices.ComTypes.ComDataObjectExtensions.GetTypeConverterForType(System.Type)"> |
|---|
| 89 | <summary> |
|---|
| 90 | Gets a TypeConverter instance for the specified type. |
|---|
| 91 | </summary> |
|---|
| 92 | <param name="dataType">The type.</param> |
|---|
| 93 | <returns>An instance of a TypeConverter for the type, if one exists.</returns> |
|---|
| 94 | </member> |
|---|
| 95 | <member name="T:DragDropLib.DataObject"> |
|---|
| 96 | <summary> |
|---|
| 97 | Implements the COM version of IDataObject including SetData. |
|---|
| 98 | </summary> |
|---|
| 99 | <remarks> |
|---|
| 100 | <para>Use this object when using shell (or other unmanged) features |
|---|
| 101 | that utilize the clipboard and/or drag and drop.</para> |
|---|
| 102 | <para>The System.Windows.DataObject (.NET 3.0) and |
|---|
| 103 | System.Windows.Forms.DataObject do not support SetData from their COM |
|---|
| 104 | IDataObject interface implementation.</para> |
|---|
| 105 | <para>To use this object with .NET drag and drop, create an instance |
|---|
| 106 | of System.Windows.DataObject (.NET 3.0) or System.Window.Forms.DataObject |
|---|
| 107 | passing an instance of DataObject as the only constructor parameter. For |
|---|
| 108 | example:</para> |
|---|
| 109 | <code> |
|---|
| 110 | System.Windows.DataObject data = new System.Windows.DataObject(new DragDropLib.DataObject()); |
|---|
| 111 | </code> |
|---|
| 112 | </remarks> |
|---|
| 113 | </member> |
|---|
| 114 | <member name="M:DragDropLib.DataObject.#ctor"> |
|---|
| 115 | <summary> |
|---|
| 116 | Creates an empty instance of DataObject. |
|---|
| 117 | </summary> |
|---|
| 118 | </member> |
|---|
| 119 | <member name="M:DragDropLib.DataObject.Finalize"> |
|---|
| 120 | <summary> |
|---|
| 121 | Releases unmanaged resources. |
|---|
| 122 | </summary> |
|---|
| 123 | </member> |
|---|
| 124 | <member name="M:DragDropLib.DataObject.ClearStorage"> |
|---|
| 125 | <summary> |
|---|
| 126 | Clears the internal storage array. |
|---|
| 127 | </summary> |
|---|
| 128 | <remarks> |
|---|
| 129 | ClearStorage is called by the IDisposable.Dispose method implementation |
|---|
| 130 | to make sure all unmanaged references are released properly. |
|---|
| 131 | </remarks> |
|---|
| 132 | </member> |
|---|
| 133 | <member name="M:DragDropLib.DataObject.Dispose"> |
|---|
| 134 | <summary> |
|---|
| 135 | Releases resources. |
|---|
| 136 | </summary> |
|---|
| 137 | </member> |
|---|
| 138 | <member name="M:DragDropLib.DataObject.Dispose(System.Boolean)"> |
|---|
| 139 | <summary> |
|---|
| 140 | Releases resources. |
|---|
| 141 | </summary> |
|---|
| 142 | <param name="disposing">Indicates if the call was made by a managed caller, or the garbage collector. |
|---|
| 143 | True indicates that someone called the Dispose method directly. False indicates that the garbage collector |
|---|
| 144 | is finalizing the release of the object instance.</param> |
|---|
| 145 | </member> |
|---|
| 146 | <member name="M:DragDropLib.DataObject.DAdvise(System.Runtime.InteropServices.ComTypes.FORMATETC@,System.Runtime.InteropServices.ComTypes.ADVF,System.Runtime.InteropServices.ComTypes.IAdviseSink,System.Int32@)"> |
|---|
| 147 | <summary> |
|---|
| 148 | Adds an advisory connection for the specified format. |
|---|
| 149 | </summary> |
|---|
| 150 | <param name="pFormatetc">The format for which this sink is called for changes.</param> |
|---|
| 151 | <param name="advf">Advisory flags to specify callback behavior.</param> |
|---|
| 152 | <param name="adviseSink">The IAdviseSink to call for this connection.</param> |
|---|
| 153 | <param name="connection">Returns the new connection's ID.</param> |
|---|
| 154 | <returns>An HRESULT.</returns> |
|---|
| 155 | </member> |
|---|
| 156 | <member name="M:DragDropLib.DataObject.DUnadvise(System.Int32)"> |
|---|
| 157 | <summary> |
|---|
| 158 | Removes an advisory connection. |
|---|
| 159 | </summary> |
|---|
| 160 | <param name="connection">The connection id to remove.</param> |
|---|
| 161 | </member> |
|---|
| 162 | <member name="M:DragDropLib.DataObject.EnumFormatEtc(System.Runtime.InteropServices.ComTypes.DATADIR)"> |
|---|
| 163 | <summary> |
|---|
| 164 | Gets an enumerator for the formats contained in this DataObject. |
|---|
| 165 | </summary> |
|---|
| 166 | <param name="direction">The direction of the data.</param> |
|---|
| 167 | <returns>An instance of the IEnumFORMATETC interface.</returns> |
|---|
| 168 | </member> |
|---|
| 169 | <member name="M:DragDropLib.DataObject.GetData(System.Runtime.InteropServices.ComTypes.FORMATETC@,System.Runtime.InteropServices.ComTypes.STGMEDIUM@)"> |
|---|
| 170 | <summary> |
|---|
| 171 | Gets the specified data. |
|---|
| 172 | </summary> |
|---|
| 173 | <param name="format">The requested data format.</param> |
|---|
| 174 | <param name="medium">When the function returns, contains the requested data.</param> |
|---|
| 175 | </member> |
|---|
| 176 | <member name="M:DragDropLib.DataObject.GetDataHere(System.Runtime.InteropServices.ComTypes.FORMATETC@,System.Runtime.InteropServices.ComTypes.STGMEDIUM@)"> |
|---|
| 177 | <summary> |
|---|
| 178 | Gets the specified data. |
|---|
| 179 | </summary> |
|---|
| 180 | <param name="format">The requested data format.</param> |
|---|
| 181 | <param name="medium">When the function returns, contains the requested data.</param> |
|---|
| 182 | <remarks>Differs from GetData only in that the STGMEDIUM storage is |
|---|
| 183 | allocated and owned by the caller.</remarks> |
|---|
| 184 | </member> |
|---|
| 185 | <member name="M:DragDropLib.DataObject.QueryGetData(System.Runtime.InteropServices.ComTypes.FORMATETC@)"> |
|---|
| 186 | <summary> |
|---|
| 187 | Determines if data of the requested format is present. |
|---|
| 188 | </summary> |
|---|
| 189 | <param name="format">The request data format.</param> |
|---|
| 190 | <returns>Returns the status of the request. If the data is present, S_OK is returned. |
|---|
| 191 | If the data is not present, an error code with the best guess as to the reason is returned.</returns> |
|---|
| 192 | </member> |
|---|
| 193 | <member name="M:DragDropLib.DataObject.SetData(System.Runtime.InteropServices.ComTypes.FORMATETC@,System.Runtime.InteropServices.ComTypes.STGMEDIUM@,System.Boolean)"> |
|---|
| 194 | <summary> |
|---|
| 195 | Sets data in the specified format into storage. |
|---|
| 196 | </summary> |
|---|
| 197 | <param name="formatIn">The format of the data.</param> |
|---|
| 198 | <param name="medium">The data.</param> |
|---|
| 199 | <param name="release">If true, ownership of the medium's memory will be transferred |
|---|
| 200 | to this object. If false, a copy of the medium will be created and maintained, and |
|---|
| 201 | the caller is responsible for the memory of the medium it provided.</param> |
|---|
| 202 | </member> |
|---|
| 203 | <member name="M:DragDropLib.DataObject.CopyMedium(System.Runtime.InteropServices.ComTypes.STGMEDIUM@)"> |
|---|
| 204 | <summary> |
|---|
| 205 | Creates a copy of the STGMEDIUM structure. |
|---|
| 206 | </summary> |
|---|
| 207 | <param name="medium">The data to copy.</param> |
|---|
| 208 | <returns>The copied data.</returns> |
|---|
| 209 | </member> |
|---|
| 210 | <member name="M:DragDropLib.DataObject.GetDataEntry(System.Runtime.InteropServices.ComTypes.FORMATETC@,System.Collections.Generic.KeyValuePair{System.Runtime.InteropServices.ComTypes.FORMATETC,System.Runtime.InteropServices.ComTypes.STGMEDIUM}@)"> |
|---|
| 211 | <summary> |
|---|
| 212 | Gets a data entry by the specified format. |
|---|
| 213 | </summary> |
|---|
| 214 | <param name="pFormatetc">The format to locate the data entry for.</param> |
|---|
| 215 | <param name="dataEntry">The located data entry.</param> |
|---|
| 216 | <returns>True if the data entry was found, otherwise False.</returns> |
|---|
| 217 | </member> |
|---|
| 218 | <member name="M:DragDropLib.DataObject.RaiseDataChanged(System.Int32,System.Collections.Generic.KeyValuePair{System.Runtime.InteropServices.ComTypes.FORMATETC,System.Runtime.InteropServices.ComTypes.STGMEDIUM}@)"> |
|---|
| 219 | <summary> |
|---|
| 220 | Raises the DataChanged event for the specified connection. |
|---|
| 221 | </summary> |
|---|
| 222 | <param name="connection">The connection id.</param> |
|---|
| 223 | <param name="dataEntry">The data entry for which to raise the event.</param> |
|---|
| 224 | </member> |
|---|
| 225 | <member name="M:DragDropLib.DataObject.RaiseDataChanged(System.Collections.Generic.KeyValuePair{System.Runtime.InteropServices.ComTypes.FORMATETC,System.Runtime.InteropServices.ComTypes.STGMEDIUM}@)"> |
|---|
| 226 | <summary> |
|---|
| 227 | Raises the DataChanged event for any advisory connections that |
|---|
| 228 | are listening for it. |
|---|
| 229 | </summary> |
|---|
| 230 | <param name="dataEntry">The relevant data entry.</param> |
|---|
| 231 | </member> |
|---|
| 232 | <member name="M:DragDropLib.DataObject.IsFormatCompatible(System.Runtime.InteropServices.ComTypes.FORMATETC,System.Runtime.InteropServices.ComTypes.FORMATETC)"> |
|---|
| 233 | <summary> |
|---|
| 234 | Determines if the formats are compatible. |
|---|
| 235 | </summary> |
|---|
| 236 | <param name="format1">A FORMATETC.</param> |
|---|
| 237 | <param name="format2">A FORMATETC.</param> |
|---|
| 238 | <returns>True if the formats are compatible, otherwise False.</returns> |
|---|
| 239 | <remarks>Compatible formats have the same DVASPECT, same format ID, and share |
|---|
| 240 | at least one TYMED.</remarks> |
|---|
| 241 | </member> |
|---|
| 242 | <member name="M:DragDropLib.DataObject.IsFormatCompatible(System.Runtime.InteropServices.ComTypes.FORMATETC@,System.Runtime.InteropServices.ComTypes.FORMATETC@)"> |
|---|
| 243 | <summary> |
|---|
| 244 | Determines if the formats are compatible. |
|---|
| 245 | </summary> |
|---|
| 246 | <param name="format1">A FORMATETC.</param> |
|---|
| 247 | <param name="format2">A FORMATETC.</param> |
|---|
| 248 | <returns>True if the formats are compatible, otherwise False.</returns> |
|---|
| 249 | <remarks>Compatible formats have the same DVASPECT, same format ID, and share |
|---|
| 250 | at least one TYMED.</remarks> |
|---|
| 251 | </member> |
|---|
| 252 | <member name="T:DragDropLib.DataObject.EnumFORMATETC"> |
|---|
| 253 | <summary> |
|---|
| 254 | Helps enumerate the formats available in our DataObject class. |
|---|
| 255 | </summary> |
|---|
| 256 | </member> |
|---|
| 257 | <member name="M:DragDropLib.DataObject.EnumFORMATETC.#ctor(System.Collections.Generic.IList{System.Collections.Generic.KeyValuePair{System.Runtime.InteropServices.ComTypes.FORMATETC,System.Runtime.InteropServices.ComTypes.STGMEDIUM}})"> |
|---|
| 258 | <summary> |
|---|
| 259 | Creates an instance from a list of key value pairs. |
|---|
| 260 | </summary> |
|---|
| 261 | <param name="storage">List of FORMATETC/STGMEDIUM key value pairs</param> |
|---|
| 262 | </member> |
|---|
| 263 | <member name="M:DragDropLib.DataObject.EnumFORMATETC.#ctor(System.Runtime.InteropServices.ComTypes.FORMATETC[])"> |
|---|
| 264 | <summary> |
|---|
| 265 | Creates an instance from an array of FORMATETC's. |
|---|
| 266 | </summary> |
|---|
| 267 | <param name="formats">Array of formats to enumerate.</param> |
|---|
| 268 | </member> |
|---|
| 269 | <member name="M:DragDropLib.DataObject.EnumFORMATETC.Clone(System.Runtime.InteropServices.ComTypes.IEnumFORMATETC@)"> |
|---|
| 270 | <summary> |
|---|
| 271 | Creates a clone of this enumerator. |
|---|
| 272 | </summary> |
|---|
| 273 | <param name="newEnum">When this function returns, contains a new instance of IEnumFORMATETC.</param> |
|---|
| 274 | </member> |
|---|
| 275 | <member name="M:DragDropLib.DataObject.EnumFORMATETC.Next(System.Int32,System.Runtime.InteropServices.ComTypes.FORMATETC[],System.Int32[])"> |
|---|
| 276 | <summary> |
|---|
| 277 | Retrieves the next elements from the enumeration. |
|---|
| 278 | </summary> |
|---|
| 279 | <param name="celt">The number of elements to retrieve.</param> |
|---|
| 280 | <param name="rgelt">An array to receive the formats requested.</param> |
|---|
| 281 | <param name="pceltFetched">An array to receive the number of element fetched.</param> |
|---|
| 282 | <returns>If the fetched number of formats is the same as the requested number, S_OK is returned. |
|---|
| 283 | There are several reasons S_FALSE may be returned: (1) The requested number of elements is less than |
|---|
| 284 | or equal to zero. (2) The rgelt parameter equals null. (3) There are no more elements to enumerate. |
|---|
| 285 | (4) The requested number of elements is greater than one and pceltFetched equals null or does not |
|---|
| 286 | have at least one element in it. (5) The number of fetched elements is less than the number of |
|---|
| 287 | requested elements.</returns> |
|---|
| 288 | </member> |
|---|
| 289 | <member name="M:DragDropLib.DataObject.EnumFORMATETC.Reset"> |
|---|
| 290 | <summary> |
|---|
| 291 | Resets the state of enumeration. |
|---|
| 292 | </summary> |
|---|
| 293 | <returns>S_OK</returns> |
|---|
| 294 | </member> |
|---|
| 295 | <member name="M:DragDropLib.DataObject.EnumFORMATETC.Skip(System.Int32)"> |
|---|
| 296 | <summary> |
|---|
| 297 | Skips the number of elements requested. |
|---|
| 298 | </summary> |
|---|
| 299 | <param name="celt">The number of elements to skip.</param> |
|---|
| 300 | <returns>If there are not enough remaining elements to skip, returns S_FALSE. Otherwise, S_OK is returned.</returns> |
|---|
| 301 | </member> |
|---|
| 302 | <member name="T:System.Windows.Forms.SwfDataObjectExtensions"> |
|---|
| 303 | <summary> |
|---|
| 304 | Provides extended functionality to the System.Windows.Forms.IDataObject interface. |
|---|
| 305 | </summary> |
|---|
| 306 | </member> |
|---|
| 307 | <member name="M:System.Windows.Forms.SwfDataObjectExtensions.SetDragImage(System.Windows.Forms.IDataObject,System.Windows.Forms.Control,System.Drawing.Point)"> |
|---|
| 308 | <summary> |
|---|
| 309 | Sets the drag image as the rendering of a control. |
|---|
| 310 | </summary> |
|---|
| 311 | <param name="dataObject">The DataObject to set the drag image on.</param> |
|---|
| 312 | <param name="control">The Control to render as the drag image.</param> |
|---|
| 313 | <param name="cursorOffset">The location of the cursor relative to the control.</param> |
|---|
| 314 | </member> |
|---|
| 315 | <member name="M:System.Windows.Forms.SwfDataObjectExtensions.SetDragImage(System.Windows.Forms.IDataObject,System.Drawing.Image,System.Drawing.Point)"> |
|---|
| 316 | <summary> |
|---|
| 317 | Sets the drag image. |
|---|
| 318 | </summary> |
|---|
| 319 | <param name="dataObject">The DataObject to set the drag image on.</param> |
|---|
| 320 | <param name="image">The drag image.</param> |
|---|
| 321 | <param name="cursorOffset">The location of the cursor relative to the image.</param> |
|---|
| 322 | </member> |
|---|
| 323 | <member name="M:System.Windows.Forms.SwfDataObjectExtensions.GetHbitmapFromImage(System.Drawing.Image)"> |
|---|
| 324 | <summary> |
|---|
| 325 | Gets an HBITMAP from any image. |
|---|
| 326 | </summary> |
|---|
| 327 | <param name="image">The image to get an HBITMAP from.</param> |
|---|
| 328 | <returns>An HBITMAP pointer.</returns> |
|---|
| 329 | <remarks> |
|---|
| 330 | The caller is responsible to call DeleteObject on the HBITMAP. |
|---|
| 331 | </remarks> |
|---|
| 332 | </member> |
|---|
| 333 | <member name="M:System.Windows.Forms.SwfDataObjectExtensions.SetDropDescription(System.Windows.Forms.IDataObject,System.Windows.Forms.DropImageType,System.String,System.String)"> |
|---|
| 334 | <summary> |
|---|
| 335 | Sets the drop description for the drag image manager. |
|---|
| 336 | </summary> |
|---|
| 337 | <param name="dataObject">The DataObject to set.</param> |
|---|
| 338 | <param name="type">The type of the drop image.</param> |
|---|
| 339 | <param name="format">The format string for the description.</param> |
|---|
| 340 | <param name="insert">The parameter for the drop description.</param> |
|---|
| 341 | <remarks> |
|---|
| 342 | When setting the drop description, the text can be set in two part, |
|---|
| 343 | which will be rendered slightly differently to distinguish the description |
|---|
| 344 | from the subject. For example, the format can be set as "Move to %1" and |
|---|
| 345 | the insert as "Temp". When rendered, the "%1" in format will be replaced |
|---|
| 346 | with "Temp", but "Temp" will be rendered slightly different from "Move to ". |
|---|
| 347 | </remarks> |
|---|
| 348 | </member> |
|---|
| 349 | <member name="M:System.Windows.Forms.SwfDataObjectExtensions.SetDataEx(System.Windows.Forms.IDataObject,System.String,System.Object)"> |
|---|
| 350 | <summary> |
|---|
| 351 | Sets managed data to a clipboard DataObject. |
|---|
| 352 | </summary> |
|---|
| 353 | <param name="dataObject">The DataObject to set the data on.</param> |
|---|
| 354 | <param name="format">The clipboard format.</param> |
|---|
| 355 | <param name="data">The data object.</param> |
|---|
| 356 | <remarks> |
|---|
| 357 | Because the underlying data store is not storing managed objects, but |
|---|
| 358 | unmanaged ones, this function provides intelligent conversion, allowing |
|---|
| 359 | you to set unmanaged data into the COM implemented IDataObject.</remarks> |
|---|
| 360 | </member> |
|---|
| 361 | <member name="M:System.Windows.Forms.SwfDataObjectExtensions.GetCompatibleTymed(System.String,System.Object)"> |
|---|
| 362 | <summary> |
|---|
| 363 | Gets a system compatible TYMED for the given format. |
|---|
| 364 | </summary> |
|---|
| 365 | <param name="format">The data format.</param> |
|---|
| 366 | <param name="data">The data.</param> |
|---|
| 367 | <returns>A TYMED value, indicating a system compatible TYMED that can |
|---|
| 368 | be used for data marshaling.</returns> |
|---|
| 369 | </member> |
|---|
| 370 | <member name="M:System.Windows.Forms.SwfDataObjectExtensions.IsFormatEqual(System.String,System.String)"> |
|---|
| 371 | <summary> |
|---|
| 372 | Compares the equality of two clipboard formats. |
|---|
| 373 | </summary> |
|---|
| 374 | <param name="formatA">First format.</param> |
|---|
| 375 | <param name="formatB">Second format.</param> |
|---|
| 376 | <returns>True if the formats are equal. False otherwise.</returns> |
|---|
| 377 | </member> |
|---|
| 378 | <member name="M:System.Windows.Forms.SwfDataObjectExtensions.GetDataEx(System.Windows.Forms.IDataObject,System.String)"> |
|---|
| 379 | <summary> |
|---|
| 380 | Gets managed data from a clipboard DataObject. |
|---|
| 381 | </summary> |
|---|
| 382 | <param name="dataObject">The DataObject to obtain the data from.</param> |
|---|
| 383 | <param name="format">The format for which to get the data in.</param> |
|---|
| 384 | <returns>The data object instance.</returns> |
|---|
| 385 | </member> |
|---|
| 386 | <member name="M:DragDropLib.SwfDragDropLibExtensions.ToWin32Point(System.Drawing.Point)"> |
|---|
| 387 | <summary> |
|---|
| 388 | Converts a System.Windows.Point value to a DragDropLib.Win32Point value. |
|---|
| 389 | </summary> |
|---|
| 390 | <param name="pt">Input value.</param> |
|---|
| 391 | <returns>Converted value.</returns> |
|---|
| 392 | </member> |
|---|
| 393 | <member name="F:System.Windows.Forms.DropTargetHelper.s_instance"> |
|---|
| 394 | <summary> |
|---|
| 395 | Internal instance of the DragDropHelper. |
|---|
| 396 | </summary> |
|---|
| 397 | </member> |
|---|
| 398 | <member name="F:System.Windows.Forms.DropTargetHelper.s_dataContext"> |
|---|
| 399 | <summary> |
|---|
| 400 | Internal cache of IDataObjects related to drop targets. |
|---|
| 401 | </summary> |
|---|
| 402 | </member> |
|---|
| 403 | <member name="M:System.Windows.Forms.DropTargetHelper.DragEnter(System.Windows.Forms.Control,System.Windows.Forms.IDataObject,System.Drawing.Point,System.Windows.Forms.DragDropEffects)"> |
|---|
| 404 | <summary> |
|---|
| 405 | Notifies the DragDropHelper that the specified Control received |
|---|
| 406 | a DragEnter event. |
|---|
| 407 | </summary> |
|---|
| 408 | <param name="control">The Control the received the DragEnter event.</param> |
|---|
| 409 | <param name="data">The DataObject containing a drag image.</param> |
|---|
| 410 | <param name="cursorOffset">The current cursor's offset relative to the window.</param> |
|---|
| 411 | <param name="effect">The accepted drag drop effect.</param> |
|---|
| 412 | </member> |
|---|
| 413 | <member name="M:System.Windows.Forms.DropTargetHelper.DragEnter(System.Windows.Forms.Control,System.Windows.Forms.IDataObject,System.Drawing.Point,System.Windows.Forms.DragDropEffects,System.String,System.String)"> |
|---|
| 414 | <summary> |
|---|
| 415 | Sets the drop description of the IDataObject and then notifies the |
|---|
| 416 | DragDropHelper that the specified Control received a DragEnter event. |
|---|
| 417 | </summary> |
|---|
| 418 | <param name="control">The Control the received the DragEnter event.</param> |
|---|
| 419 | <param name="data">The DataObject containing a drag image.</param> |
|---|
| 420 | <param name="cursorOffset">The current cursor's offset relative to the window.</param> |
|---|
| 421 | <param name="effect">The accepted drag drop effect.</param> |
|---|
| 422 | <param name="descriptionMessage">The drop description message.</param> |
|---|
| 423 | <param name="descriptionInsert">The drop description insert.</param> |
|---|
| 424 | <remarks> |
|---|
| 425 | Because the DragLeave event in SWF does not provide the IDataObject in the |
|---|
| 426 | event args, this DragEnter override of the DropTargetHelper will cache a |
|---|
| 427 | copy of the IDataObject based on the provided Control so that it may be |
|---|
| 428 | cleared using the DragLeave override that takes a Control parameter. Note that |
|---|
| 429 | if you use this override of DragEnter, you must call the DragLeave override |
|---|
| 430 | that takes a Control parameter to avoid a possible memory leak. However, calling |
|---|
| 431 | this method multiple times with the same Control parameter while not calling the |
|---|
| 432 | DragLeave method will not leak memory. |
|---|
| 433 | </remarks> |
|---|
| 434 | </member> |
|---|
| 435 | <member name="M:System.Windows.Forms.DropTargetHelper.DragOver(System.Drawing.Point,System.Windows.Forms.DragDropEffects)"> |
|---|
| 436 | <summary> |
|---|
| 437 | Notifies the DragDropHelper that the current Control received |
|---|
| 438 | a DragOver event. |
|---|
| 439 | </summary> |
|---|
| 440 | <param name="cursorOffset">The current cursor's offset relative to the window.</param> |
|---|
| 441 | <param name="effect">The accepted drag drop effect.</param> |
|---|
| 442 | </member> |
|---|
| 443 | <member name="M:System.Windows.Forms.DropTargetHelper.DragLeave"> |
|---|
| 444 | <summary> |
|---|
| 445 | Notifies the DragDropHelper that the current Control received |
|---|
| 446 | a DragLeave event. |
|---|
| 447 | </summary> |
|---|
| 448 | </member> |
|---|
| 449 | <member name="M:System.Windows.Forms.DropTargetHelper.DragLeave(System.Windows.Forms.Control)"> |
|---|
| 450 | <summary> |
|---|
| 451 | Clears the drop description of the IDataObject previously associated to the |
|---|
| 452 | provided control, then notifies the DragDropHelper that the current control |
|---|
| 453 | received a DragLeave event. |
|---|
| 454 | </summary> |
|---|
| 455 | <remarks> |
|---|
| 456 | Because the DragLeave event in SWF does not provide the IDataObject in the |
|---|
| 457 | event args, this DragLeave override of the DropTargetHelper will lookup a |
|---|
| 458 | cached copy of the IDataObject based on the provided Control and clear |
|---|
| 459 | the drop description. Note that the underlying DragLeave call of the |
|---|
| 460 | Shell IDropTargetHelper object keeps the current control cached, so the |
|---|
| 461 | control passed to this method is only relevant to looking up the IDataObject |
|---|
| 462 | on which to clear the drop description. |
|---|
| 463 | </remarks> |
|---|
| 464 | </member> |
|---|
| 465 | <member name="M:System.Windows.Forms.DropTargetHelper.Drop(System.Windows.Forms.IDataObject,System.Drawing.Point,System.Windows.Forms.DragDropEffects)"> |
|---|
| 466 | <summary> |
|---|
| 467 | Notifies the DragDropHelper that the current Control received |
|---|
| 468 | a DragOver event. |
|---|
| 469 | </summary> |
|---|
| 470 | <param name="data">The DataObject containing a drag image.</param> |
|---|
| 471 | <param name="cursorOffset">The current cursor's offset relative to the window.</param> |
|---|
| 472 | <param name="effect">The accepted drag drop effect.</param> |
|---|
| 473 | </member> |
|---|
| 474 | <member name="M:System.Windows.Forms.DropTargetHelper.Show(System.Boolean)"> |
|---|
| 475 | <summary> |
|---|
| 476 | Tells the DragDropHelper to show or hide the drag image. |
|---|
| 477 | </summary> |
|---|
| 478 | <param name="show">True to show the image. False to hide it.</param> |
|---|
| 479 | </member> |
|---|
| 480 | <member name="M:DragDropLib.SwfDropTargetHelperExtensions.DragEnter(DragDropLib.IDropTargetHelper,System.Windows.Forms.Control,System.Windows.Forms.IDataObject,System.Drawing.Point,System.Windows.Forms.DragDropEffects)"> |
|---|
| 481 | <summary> |
|---|
| 482 | Notifies the DragDropHelper that the specified Control received |
|---|
| 483 | a DragEnter event. |
|---|
| 484 | </summary> |
|---|
| 485 | <param name="dropHelper">The DragDropHelper instance to notify.</param> |
|---|
| 486 | <param name="control">The Control the received the DragEnter event.</param> |
|---|
| 487 | <param name="data">The DataObject containing a drag image.</param> |
|---|
| 488 | <param name="cursorOffset">The current cursor's offset relative to the window.</param> |
|---|
| 489 | <param name="effect">The accepted drag drop effect.</param> |
|---|
| 490 | </member> |
|---|
| 491 | <member name="M:DragDropLib.SwfDropTargetHelperExtensions.DragOver(DragDropLib.IDropTargetHelper,System.Drawing.Point,System.Windows.Forms.DragDropEffects)"> |
|---|
| 492 | <summary> |
|---|
| 493 | Notifies the DragDropHelper that the current Control received |
|---|
| 494 | a DragOver event. |
|---|
| 495 | </summary> |
|---|
| 496 | <param name="dropHelper">The DragDropHelper instance to notify.</param> |
|---|
| 497 | <param name="cursorOffset">The current cursor's offset relative to the window.</param> |
|---|
| 498 | <param name="effect">The accepted drag drop effect.</param> |
|---|
| 499 | </member> |
|---|
| 500 | <member name="M:DragDropLib.SwfDropTargetHelperExtensions.Drop(DragDropLib.IDropTargetHelper,System.Windows.Forms.IDataObject,System.Drawing.Point,System.Windows.Forms.DragDropEffects)"> |
|---|
| 501 | <summary> |
|---|
| 502 | Notifies the DragDropHelper that the current Control received |
|---|
| 503 | a Drop event. |
|---|
| 504 | </summary> |
|---|
| 505 | <param name="dropHelper">The DragDropHelper instance to notify.</param> |
|---|
| 506 | <param name="data">The DataObject containing a drag image.</param> |
|---|
| 507 | <param name="cursorOffset">The current cursor's offset relative to the window.</param> |
|---|
| 508 | <param name="effect">The accepted drag drop effect.</param> |
|---|
| 509 | </member> |
|---|
| 510 | <member name="T:System.Windows.Forms.DragSourceHelper"> |
|---|
| 511 | <summary> |
|---|
| 512 | Provides helper methods for working with the Shell drag image manager. |
|---|
| 513 | </summary> |
|---|
| 514 | </member> |
|---|
| 515 | <member name="F:System.Windows.Forms.DragSourceHelper.s_dataContext"> |
|---|
| 516 | <summary> |
|---|
| 517 | Keeps a cached drag source context, keyed on the drag source control. |
|---|
| 518 | </summary> |
|---|
| 519 | </member> |
|---|
| 520 | <member name="F:System.Windows.Forms.DragSourceHelper.s_dropDescriptions"> |
|---|
| 521 | <summary> |
|---|
| 522 | Keeps drop description info for a data object. |
|---|
| 523 | </summary> |
|---|
| 524 | </member> |
|---|
| 525 | <member name="M:System.Windows.Forms.DragSourceHelper.CreateDataObject"> |
|---|
| 526 | <summary> |
|---|
| 527 | Creates a default DataObject with an internal COM callable implemetation of IDataObject. |
|---|
| 528 | </summary> |
|---|
| 529 | <returns>A new instance of System.Windows.Forms.IDataObject.</returns> |
|---|
| 530 | </member> |
|---|
| 531 | <member name="M:System.Windows.Forms.DragSourceHelper.CreateDataObject(System.Drawing.Bitmap,System.Drawing.Point)"> |
|---|
| 532 | <summary> |
|---|
| 533 | Creates a DataObject with an internal COM callable implementation of IDataObject. |
|---|
| 534 | This override also sets the drag image to the specified Bitmap and sets a flag |
|---|
| 535 | on the system IDragSourceHelper2 to allow drop descriptions. |
|---|
| 536 | </summary> |
|---|
| 537 | <param name="dragImage">A Bitmap from which to create the drag image.</param> |
|---|
| 538 | <param name="cursorOffset">The drag image cursor offset.</param> |
|---|
| 539 | <returns>A new instance of System.Windows.Forms.IDataObject.</returns> |
|---|
| 540 | </member> |
|---|
| 541 | <member name="M:System.Windows.Forms.DragSourceHelper.CreateDataObject(System.Windows.Forms.Control,System.Drawing.Point)"> |
|---|
| 542 | <summary> |
|---|
| 543 | Creates a DataObject with an internal COM callable implementation of IDataObject. |
|---|
| 544 | This override also sets the drag image to a bitmap created from the specified |
|---|
| 545 | Control instance's UI. It also sets a flag on the system IDragSourceHelper2 to |
|---|
| 546 | allow drop descriptions. |
|---|
| 547 | </summary> |
|---|
| 548 | <param name="control">A Control to initialize the drag image from.</param> |
|---|
| 549 | <param name="cursorOffset">The drag image cursor offset.</param> |
|---|
| 550 | <returns>A new instance of System.Windows.Forms.IDataObject.</returns> |
|---|
| 551 | </member> |
|---|
| 552 | <member name="M:System.Windows.Forms.DragSourceHelper.RegisterDefaultDragSource(System.Windows.Forms.Control,System.Windows.Forms.IDataObject)"> |
|---|
| 553 | <summary> |
|---|
| 554 | Registers a Control as a drag source and provides default implementations of |
|---|
| 555 | GiveFeedback and QueryContinueDrag. |
|---|
| 556 | </summary> |
|---|
| 557 | <param name="control">The drag source Control instance.</param> |
|---|
| 558 | <param name="data">The DataObject associated to the drag source.</param> |
|---|
| 559 | <remarks>Callers must call UnregisterDefaultDragSource when the drag and drop |
|---|
| 560 | operation is complete to avoid memory leaks.</remarks> |
|---|
| 561 | </member> |
|---|
| 562 | <member name="M:System.Windows.Forms.DragSourceHelper.RegisterDefaultDragSource(System.Windows.Forms.Control,System.Drawing.Point)"> |
|---|
| 563 | <summary> |
|---|
| 564 | Registers a Control as a drag source and provides default implementations of |
|---|
| 565 | GiveFeedback and QueryContinueDrag. This override also handles the data object |
|---|
| 566 | creation, including initialization of the drag image from the Control. |
|---|
| 567 | </summary> |
|---|
| 568 | <param name="control">The drag source Control instance.</param> |
|---|
| 569 | <param name="cursorOffset">The drag image cursor offset.</param> |
|---|
| 570 | <returns>The created data object.</returns> |
|---|
| 571 | <remarks>Callers must call UnregisterDefaultDragSource when the drag and drop |
|---|
| 572 | operation is complete to avoid memory leaks.</remarks> |
|---|
| 573 | </member> |
|---|
| 574 | <member name="M:System.Windows.Forms.DragSourceHelper.RegisterDefaultDragSource(System.Windows.Forms.Control,System.Drawing.Bitmap,System.Drawing.Point)"> |
|---|
| 575 | <summary> |
|---|
| 576 | Registers a Control as a drag source and provides default implementations of |
|---|
| 577 | GiveFeedback and QueryContinueDrag. This override also handles the data object |
|---|
| 578 | creation, including initialization of the drag image from the speicified Bitmap. |
|---|
| 579 | </summary> |
|---|
| 580 | <param name="control">The drag source Control instance.</param> |
|---|
| 581 | <param name="dragImage">A Bitmap to initialize the drag image from.</param> |
|---|
| 582 | <param name="cursorOffset">The drag image cursor offset.</param> |
|---|
| 583 | <returns>The created data object.</returns> |
|---|
| 584 | <remarks>Callers must call UnregisterDefaultDragSource when the drag and drop |
|---|
| 585 | operation is complete to avoid memory leaks.</remarks> |
|---|
| 586 | </member> |
|---|
| 587 | <member name="M:System.Windows.Forms.DragSourceHelper.UnregisterDefaultDragSource(System.Windows.Forms.Control)"> |
|---|
| 588 | <summary> |
|---|
| 589 | Unregisters a drag source from the internal cache. |
|---|
| 590 | </summary> |
|---|
| 591 | <param name="control">The drag source Control.</param> |
|---|
| 592 | </member> |
|---|
| 593 | <member name="M:System.Windows.Forms.DragSourceHelper.DoDragDrop(System.Windows.Forms.Control,System.Drawing.Point,System.Windows.Forms.DragDropEffects,System.Collections.Generic.KeyValuePair{System.String,System.Object}[])"> |
|---|
| 594 | <summary> |
|---|
| 595 | Performs a default drag and drop operation for the specified drag source. |
|---|
| 596 | </summary> |
|---|
| 597 | <param name="control">The drag source Control.</param> |
|---|
| 598 | <param name="cursorOffset">The drag image cursor offset.</param> |
|---|
| 599 | <param name="allowedEffects">The allowed drop effects.</param> |
|---|
| 600 | <param name="data">The associated data.</param> |
|---|
| 601 | <returns>The accepted drop effects from the completed operation.</returns> |
|---|
| 602 | </member> |
|---|
| 603 | <member name="M:System.Windows.Forms.DragSourceHelper.DoDragDrop(System.Windows.Forms.Control,System.Drawing.Bitmap,System.Drawing.Point,System.Windows.Forms.DragDropEffects,System.Collections.Generic.KeyValuePair{System.String,System.Object}[])"> |
|---|
| 604 | <summary> |
|---|
| 605 | Performs a default drag and drop operation for the specified drag source. |
|---|
| 606 | </summary> |
|---|
| 607 | <param name="control">The drag source Control.</param> |
|---|
| 608 | <param name="dragImage">The Bitmap to initialize the drag image from.</param> |
|---|
| 609 | <param name="cursorOffset">The drag image cursor offset.</param> |
|---|
| 610 | <param name="allowedEffects">The allowed drop effects.</param> |
|---|
| 611 | <param name="data">The associated data.</param> |
|---|
| 612 | <returns>The accepted drop effects from the completed operation.</returns> |
|---|
| 613 | </member> |
|---|
| 614 | <member name="M:System.Windows.Forms.DragSourceHelper.DoDragDropInternal(System.Windows.Forms.Control,System.Windows.Forms.IDataObject,System.Windows.Forms.DragDropEffects,System.Collections.Generic.KeyValuePair{System.String,System.Object}[])"> |
|---|
| 615 | <summary> |
|---|
| 616 | Performs a default drag and drop operation for the specified drag source. |
|---|
| 617 | </summary> |
|---|
| 618 | <param name="control">The drag source Control.</param> |
|---|
| 619 | <param name="dataObject">The data object associated to the drag and drop operation.</param> |
|---|
| 620 | <param name="allowedEffects">The allowed drop effects.</param> |
|---|
| 621 | <param name="data">The associated data.</param> |
|---|
| 622 | <returns>The accepted drop effects from the completed operation.</returns> |
|---|
| 623 | </member> |
|---|
| 624 | <member name="M:System.Windows.Forms.DragSourceHelper.DefaultGiveFeedbackHandler(System.Object,System.Windows.Forms.GiveFeedbackEventArgs)"> |
|---|
| 625 | <summary> |
|---|
| 626 | Provides a default GiveFeedback event handler for drag sources. |
|---|
| 627 | </summary> |
|---|
| 628 | <param name="sender">The object that raised the event. Should be set to the drag source.</param> |
|---|
| 629 | <param name="e">The event arguments.</param> |
|---|
| 630 | </member> |
|---|
| 631 | <member name="M:System.Windows.Forms.DragSourceHelper.DefaultGiveFeedback(System.Windows.Forms.IDataObject,System.Windows.Forms.GiveFeedbackEventArgs)"> |
|---|
| 632 | <summary> |
|---|
| 633 | Provides a default GiveFeedback event handler for drag sources. |
|---|
| 634 | </summary> |
|---|
| 635 | <param name="data">The associated data object for the event.</param> |
|---|
| 636 | <param name="e">The event arguments.</param> |
|---|
| 637 | </member> |
|---|
| 638 | <member name="M:System.Windows.Forms.DragSourceHelper.DefaultQueryContinueDragHandler(System.Object,System.Windows.Forms.QueryContinueDragEventArgs)"> |
|---|
| 639 | <summary> |
|---|
| 640 | Provides a default handler for the QueryContinueDrag drag source event. |
|---|
| 641 | </summary> |
|---|
| 642 | <param name="sender">The object that raised the event. Not used internally.</param> |
|---|
| 643 | <param name="e">The event arguments.</param> |
|---|
| 644 | </member> |
|---|
| 645 | <member name="M:System.Windows.Forms.DragSourceHelper.DefaultQueryContinueDrag(System.Windows.Forms.QueryContinueDragEventArgs)"> |
|---|
| 646 | <summary> |
|---|
| 647 | Provides a default handler for the QueryContinueDrag drag source event. |
|---|
| 648 | </summary> |
|---|
| 649 | <param name="e">The event arguments.</param> |
|---|
| 650 | </member> |
|---|
| 651 | <member name="M:System.Windows.Forms.DragSourceHelper.AllowDropDescription(System.Boolean)"> |
|---|
| 652 | <summary> |
|---|
| 653 | Sets a flag on the system IDragSourceHelper2 object to allow drop descriptions |
|---|
| 654 | on the drag image. |
|---|
| 655 | </summary> |
|---|
| 656 | <param name="allow">True to allow drop descriptions, otherwise False.</param> |
|---|
| 657 | <remarks>Must be called before IDragSourceHelper.InitializeFromBitmap or |
|---|
| 658 | IDragSourceHelper.InitializeFromControl is called.</remarks> |
|---|
| 659 | </member> |
|---|
| 660 | <member name="M:System.Windows.Forms.DragSourceHelper.InvalidateDragImage(System.Windows.Forms.IDataObject)"> |
|---|
| 661 | <summary> |
|---|
| 662 | Invalidates the drag image. |
|---|
| 663 | </summary> |
|---|
| 664 | <param name="dataObject">The data object for which to invalidate the drag image.</param> |
|---|
| 665 | <remarks>This call tells the drag image manager to reformat the internal |
|---|
| 666 | cached drag image, based on the already set drag image bitmap and current drop |
|---|
| 667 | description.</remarks> |
|---|
| 668 | </member> |
|---|
| 669 | <member name="M:System.Windows.Forms.DragSourceHelper.GetIntPtrFromData(System.Object)"> |
|---|
| 670 | <summary> |
|---|
| 671 | Gets an IntPtr from data acquired from a data object. |
|---|
| 672 | </summary> |
|---|
| 673 | <param name="data">The data that contains the IntPtr.</param> |
|---|
| 674 | <returns>An IntPtr.</returns> |
|---|
| 675 | </member> |
|---|
| 676 | <member name="M:System.Windows.Forms.DragSourceHelper.IsShowingLayered(System.Windows.Forms.IDataObject)"> |
|---|
| 677 | <summary> |
|---|
| 678 | Determines if the IsShowingLayered flag is set on the data object. |
|---|
| 679 | </summary> |
|---|
| 680 | <param name="dataObject">The data object.</param> |
|---|
| 681 | <returns>True if the flag is set, otherwise false.</returns> |
|---|
| 682 | </member> |
|---|
| 683 | <member name="M:System.Windows.Forms.DragSourceHelper.GetBooleanFromData(System.Object)"> |
|---|
| 684 | <summary> |
|---|
| 685 | Converts compatible clipboard data to a boolean value. |
|---|
| 686 | </summary> |
|---|
| 687 | <param name="data">The clipboard data.</param> |
|---|
| 688 | <returns>True if the data can be converted to a boolean and is set, otherwise False.</returns> |
|---|
| 689 | </member> |
|---|
| 690 | <member name="M:System.Windows.Forms.DragSourceHelper.IsDropDescriptionValid(System.Windows.Forms.IDataObject)"> |
|---|
| 691 | <summary> |
|---|
| 692 | Checks if the current drop description, if any, is valid. |
|---|
| 693 | </summary> |
|---|
| 694 | <param name="dataObject">The DataObject from which to get the drop description.</param> |
|---|
| 695 | <returns>True if the drop description is set, and the |
|---|
| 696 | DropImageType is not DropImageType.Invalid.</returns> |
|---|
| 697 | </member> |
|---|
| 698 | <member name="M:System.Windows.Forms.DragSourceHelper.IsDropDescriptionDefault(System.Windows.Forms.IDataObject)"> |
|---|
| 699 | <summary> |
|---|
| 700 | Checks if the IsDefault drop description flag is set for the associated DataObject. |
|---|
| 701 | </summary> |
|---|
| 702 | <param name="dataObject">The associated DataObject.</param> |
|---|
| 703 | <returns>True if the IsDefault flag is set, otherwise False.</returns> |
|---|
| 704 | </member> |
|---|
| 705 | <member name="M:System.Windows.Forms.DragSourceHelper.InvalidateRequired(System.Windows.Forms.IDataObject)"> |
|---|
| 706 | <summary> |
|---|
| 707 | Checks if the InvalidateRequired drop description flag is set for the associated DataObject. |
|---|
| 708 | </summary> |
|---|
| 709 | <param name="dataObject">The associated DataObject.</param> |
|---|
| 710 | <returns>True if the InvalidateRequired flag is set, otherwise False.</returns> |
|---|
| 711 | </member> |
|---|
| 712 | <member name="M:System.Windows.Forms.DragSourceHelper.SetDropDescriptionIsDefault(System.Windows.Forms.IDataObject,System.Boolean)"> |
|---|
| 713 | <summary> |
|---|
| 714 | Sets the IsDefault drop description flag for the associated DataObject. |
|---|
| 715 | </summary> |
|---|
| 716 | <param name="dataObject">The associdated DataObject.</param> |
|---|
| 717 | <param name="isDefault">True to set the flag, False to unset it.</param> |
|---|
| 718 | </member> |
|---|
| 719 | <member name="M:System.Windows.Forms.DragSourceHelper.SetInvalidateRequired(System.Windows.Forms.IDataObject,System.Boolean)"> |
|---|
| 720 | <summary> |
|---|
| 721 | Sets the InvalidatedRequired drop description flag for the associated DataObject. |
|---|
| 722 | </summary> |
|---|
| 723 | <param name="dataObject">The associdated DataObject.</param> |
|---|
| 724 | <param name="isDefault">True to set the flag, False to unset it.</param> |
|---|
| 725 | </member> |
|---|
| 726 | <member name="M:System.Windows.Forms.DragSourceHelper.SetDropDescriptionFlag(System.Windows.Forms.IDataObject,System.Windows.Forms.DragSourceHelper.DropDescriptionFlags)"> |
|---|
| 727 | <summary> |
|---|
| 728 | Sets a drop description flag. |
|---|
| 729 | </summary> |
|---|
| 730 | <param name="dataObject">The associated DataObject.</param> |
|---|
| 731 | <param name="flag">The drop description flag to set.</param> |
|---|
| 732 | </member> |
|---|
| 733 | <member name="M:System.Windows.Forms.DragSourceHelper.UnsetDropDescriptionFlag(System.Windows.Forms.IDataObject,System.Windows.Forms.DragSourceHelper.DropDescriptionFlags)"> |
|---|
| 734 | <summary> |
|---|
| 735 | Unsets a drop description flag. |
|---|
| 736 | </summary> |
|---|
| 737 | <param name="dataObject">The associated DataObject.</param> |
|---|
| 738 | <param name="flag">The drop description flag to unset.</param> |
|---|
| 739 | </member> |
|---|
| 740 | <member name="M:System.Windows.Forms.DragSourceHelper.GetDropImageType(System.Windows.Forms.IDataObject)"> |
|---|
| 741 | <summary> |
|---|
| 742 | Gets the current DropDescription's drop image type. |
|---|
| 743 | </summary> |
|---|
| 744 | <param name="dataObject">The DataObject.</param> |
|---|
| 745 | <returns>The current drop image type.</returns> |
|---|
| 746 | </member> |
|---|
| 747 | <member name="T:System.Windows.Forms.DragSourceHelper.DropDescriptionFlags"> |
|---|
| 748 | <summary> |
|---|
| 749 | Internally used to track information about the current drop description. |
|---|
| 750 | </summary> |
|---|
| 751 | </member> |
|---|
| 752 | <member name="T:System.Windows.Forms.DragSourceHelper.DragSourceEntry"> |
|---|
| 753 | <summary> |
|---|
| 754 | Represents a drag source context entry. |
|---|
| 755 | </summary> |
|---|
| 756 | </member> |
|---|
| 757 | <member name="T:System.Windows.Forms.DragSourceHelper.AdviseSink"> |
|---|
| 758 | <summary> |
|---|
| 759 | Provides an advisory sink for the COM IDataObject implementation. |
|---|
| 760 | </summary> |
|---|
| 761 | </member> |
|---|
| 762 | <member name="M:System.Windows.Forms.DragSourceHelper.AdviseSink.#ctor(System.Windows.Forms.IDataObject)"> |
|---|
| 763 | <summary> |
|---|
| 764 | Creates an AdviseSink associated to the specified data object. |
|---|
| 765 | </summary> |
|---|
| 766 | <param name="data">The data object.</param> |
|---|
| 767 | </member> |
|---|
| 768 | <member name="M:System.Windows.Forms.DragSourceHelper.AdviseSink.OnDataChange(System.Runtime.InteropServices.ComTypes.FORMATETC@,System.Runtime.InteropServices.ComTypes.STGMEDIUM@)"> |
|---|
| 769 | <summary> |
|---|
| 770 | Handles DataChanged events from a COM IDataObject. |
|---|
| 771 | </summary> |
|---|
| 772 | <param name="format">The data format that had a change.</param> |
|---|
| 773 | <param name="stgmedium">The data value.</param> |
|---|
| 774 | </member> |
|---|
| 775 | <member name="M:DragDropLib.WpfDragDropLibExtensions.ToWin32Point(System.Windows.Point)"> |
|---|
| 776 | <summary> |
|---|
| 777 | Converts a System.Windows.Point value to a DragDropLib.Win32Point value. |
|---|
| 778 | </summary> |
|---|
| 779 | <param name="pt">Input value.</param> |
|---|
| 780 | <returns>Converted value.</returns> |
|---|
| 781 | </member> |
|---|
| 782 | <member name="T:System.Windows.DragSourceHelper"> |
|---|
| 783 | <summary> |
|---|
| 784 | Provides helper methods for working with the Shell drag image manager. |
|---|
| 785 | </summary> |
|---|
| 786 | </member> |
|---|
| 787 | <member name="F:System.Windows.DragSourceHelper.s_dataContext"> |
|---|
| 788 | <summary> |
|---|
| 789 | Keeps a cached drag source context, keyed on the drag source control. |
|---|
| 790 | </summary> |
|---|
| 791 | </member> |
|---|
| 792 | <member name="F:System.Windows.DragSourceHelper.s_dropDescriptions"> |
|---|
| 793 | <summary> |
|---|
| 794 | Keeps drop description info for a data object. |
|---|
| 795 | </summary> |
|---|
| 796 | </member> |
|---|
| 797 | <member name="M:System.Windows.DragSourceHelper.CreateDataObject"> |
|---|
| 798 | <summary> |
|---|
| 799 | Creates a default DataObject with an internal COM callable implemetation of IDataObject. |
|---|
| 800 | </summary> |
|---|
| 801 | <returns>A new instance of System.Windows.Forms.IDataObject.</returns> |
|---|
| 802 | </member> |
|---|
| 803 | <member name="M:System.Windows.DragSourceHelper.CreateDataObject(System.Windows.Media.Imaging.BitmapSource,System.Windows.Point)"> |
|---|
| 804 | <summary> |
|---|
| 805 | Creates a DataObject with an internal COM callable implementation of IDataObject. |
|---|
| 806 | This override also sets the drag image to the specified Bitmap and sets a flag |
|---|
| 807 | on the system IDragSourceHelper2 to allow drop descriptions. |
|---|
| 808 | </summary> |
|---|
| 809 | <param name="dragImage">A Bitmap from which to create the drag image.</param> |
|---|
| 810 | <param name="cursorOffset">The drag image cursor offset.</param> |
|---|
| 811 | <returns>A new instance of System.Windows.Forms.IDataObject.</returns> |
|---|
| 812 | </member> |
|---|
| 813 | <member name="M:System.Windows.DragSourceHelper.CreateDataObject(System.Windows.UIElement,System.Windows.Point)"> |
|---|
| 814 | <summary> |
|---|
| 815 | Creates a DataObject with an internal COM callable implementation of IDataObject. |
|---|
| 816 | This override also sets the drag image to a bitmap created from the specified |
|---|
| 817 | Control instance's UI. It also sets a flag on the system IDragSourceHelper2 to |
|---|
| 818 | allow drop descriptions. |
|---|
| 819 | </summary> |
|---|
| 820 | <param name="element">A UIElement to initialize the drag image from.</param> |
|---|
| 821 | <param name="cursorOffset">The drag image cursor offset.</param> |
|---|
| 822 | <returns>A new instance of System.Windows.Forms.IDataObject.</returns> |
|---|
| 823 | </member> |
|---|
| 824 | <member name="M:System.Windows.DragSourceHelper.RegisterDefaultDragSource(System.Windows.UIElement,System.Windows.IDataObject)"> |
|---|
| 825 | <summary> |
|---|
| 826 | Registers a Control as a drag source and provides default implementations of |
|---|
| 827 | GiveFeedback and QueryContinueDrag. |
|---|
| 828 | </summary> |
|---|
| 829 | <param name="dragSource">The drag source UIElement instance.</param> |
|---|
| 830 | <param name="data">The DataObject associated to the drag source.</param> |
|---|
| 831 | <remarks>Callers must call UnregisterDefaultDragSource when the drag and drop |
|---|
| 832 | operation is complete to avoid memory leaks.</remarks> |
|---|
| 833 | </member> |
|---|
| 834 | <member name="M:System.Windows.DragSourceHelper.RegisterDefaultDragSource(System.Windows.UIElement,System.Windows.Point)"> |
|---|
| 835 | <summary> |
|---|
| 836 | Registers a Control as a drag source and provides default implementations of |
|---|
| 837 | GiveFeedback and QueryContinueDrag. This override also handles the data object |
|---|
| 838 | creation, including initialization of the drag image from the Control. |
|---|
| 839 | </summary> |
|---|
| 840 | <param name="dragSource">The drag source UIElement instance.</param> |
|---|
| 841 | <param name="cursorOffset">The drag image cursor offset.</param> |
|---|
| 842 | <returns>The created data object.</returns> |
|---|
| 843 | <remarks>Callers must call UnregisterDefaultDragSource when the drag and drop |
|---|
| 844 | operation is complete to avoid memory leaks.</remarks> |
|---|
| 845 | </member> |
|---|
| 846 | <member name="M:System.Windows.DragSourceHelper.RegisterDefaultDragSource(System.Windows.UIElement,System.Windows.Media.Imaging.BitmapSource,System.Windows.Point)"> |
|---|
| 847 | <summary> |
|---|
| 848 | Registers a Control as a drag source and provides default implementations of |
|---|
| 849 | GiveFeedback and QueryContinueDrag. This override also handles the data object |
|---|
| 850 | creation, including initialization of the drag image from the speicified Bitmap. |
|---|
| 851 | </summary> |
|---|
| 852 | <param name="dragSource">The drag source UIElement instance.</param> |
|---|
| 853 | <param name="dragImage">A Bitmap to initialize the drag image from.</param> |
|---|
| 854 | <param name="cursorOffset">The drag image cursor offset.</param> |
|---|
| 855 | <returns>The created data object.</returns> |
|---|
| 856 | <remarks>Callers must call UnregisterDefaultDragSource when the drag and drop |
|---|
| 857 | operation is complete to avoid memory leaks.</remarks> |
|---|
| 858 | </member> |
|---|
| 859 | <member name="M:System.Windows.DragSourceHelper.UnregisterDefaultDragSource(System.Windows.UIElement)"> |
|---|
| 860 | <summary> |
|---|
| 861 | Unregisters a drag source from the internal cache. |
|---|
| 862 | </summary> |
|---|
| 863 | <param name="dragSource">The drag source UIElement.</param> |
|---|
| 864 | </member> |
|---|
| 865 | <member name="M:System.Windows.DragSourceHelper.DoDragDrop(System.Windows.UIElement,System.Windows.Point,System.Windows.DragDropEffects,System.Collections.Generic.KeyValuePair{System.String,System.Object}[])"> |
|---|
| 866 | <summary> |
|---|
| 867 | Performs a default drag and drop operation for the specified drag source. |
|---|
| 868 | </summary> |
|---|
| 869 | <param name="dragSource">The drag source UIElement.</param> |
|---|
| 870 | <param name="cursorOffset">The drag image cursor offset.</param> |
|---|
| 871 | <param name="allowedEffects">The allowed drop effects.</param> |
|---|
| 872 | <param name="data">The associated data.</param> |
|---|
| 873 | <returns>The accepted drop effects from the completed operation.</returns> |
|---|
| 874 | </member> |
|---|
| 875 | <member name="M:System.Windows.DragSourceHelper.DoDragDrop(System.Windows.UIElement,System.Windows.Media.Imaging.BitmapSource,System.Windows.Point,System.Windows.DragDropEffects,System.Collections.Generic.KeyValuePair{System.String,System.Object}[])"> |
|---|
| 876 | <summary> |
|---|
| 877 | Performs a default drag and drop operation for the specified drag source. |
|---|
| 878 | </summary> |
|---|
| 879 | <param name="dragSource">The drag source UIElement.</param> |
|---|
| 880 | <param name="dragImage">The Bitmap to initialize the drag image from.</param> |
|---|
| 881 | <param name="cursorOffset">The drag image cursor offset.</param> |
|---|
| 882 | <param name="allowedEffects">The allowed drop effects.</param> |
|---|
| 883 | <param name="data">The associated data.</param> |
|---|
| 884 | <returns>The accepted drop effects from the completed operation.</returns> |
|---|
| 885 | </member> |
|---|
| 886 | <member name="M:System.Windows.DragSourceHelper.DoDragDropInternal(System.Windows.UIElement,System.Windows.IDataObject,System.Windows.DragDropEffects,System.Collections.Generic.KeyValuePair{System.String,System.Object}[])"> |
|---|
| 887 | <summary> |
|---|
| 888 | Performs a default drag and drop operation for the specified drag source. |
|---|
| 889 | </summary> |
|---|
| 890 | <param name="dragSource">The drag source UIElement.</param> |
|---|
| 891 | <param name="dataObject">The data object associated to the drag and drop operation.</param> |
|---|
| 892 | <param name="allowedEffects">The allowed drop effects.</param> |
|---|
| 893 | <param name="data">The associated data.</param> |
|---|
| 894 | <returns>The accepted drop effects from the completed operation.</returns> |
|---|
| 895 | </member> |
|---|
| 896 | <member name="M:System.Windows.DragSourceHelper.DefaultGiveFeedbackHandler(System.Object,System.Windows.GiveFeedbackEventArgs)"> |
|---|
| 897 | <summary> |
|---|
| 898 | Provides a default GiveFeedback event handler for drag sources. |
|---|
| 899 | </summary> |
|---|
| 900 | <param name="sender">The object that raised the event. Should be set to the drag source.</param> |
|---|
| 901 | <param name="e">The event arguments.</param> |
|---|
| 902 | </member> |
|---|
| 903 | <member name="M:System.Windows.DragSourceHelper.DefaultGiveFeedback(System.Windows.IDataObject,System.Windows.GiveFeedbackEventArgs)"> |
|---|
| 904 | <summary> |
|---|
| 905 | Provides a default GiveFeedback event handler for drag sources. |
|---|
| 906 | </summary> |
|---|
| 907 | <param name="data">The associated data object for the event.</param> |
|---|
| 908 | <param name="e">The event arguments.</param> |
|---|
| 909 | </member> |
|---|
| 910 | <member name="M:System.Windows.DragSourceHelper.DefaultQueryContinueDragHandler(System.Object,System.Windows.QueryContinueDragEventArgs)"> |
|---|
| 911 | <summary> |
|---|
| 912 | Provides a default handler for the QueryContinueDrag drag source event. |
|---|
| 913 | </summary> |
|---|
| 914 | <param name="sender">The object that raised the event. Not used internally.</param> |
|---|
| 915 | <param name="e">The event arguments.</param> |
|---|
| 916 | </member> |
|---|
| 917 | <member name="M:System.Windows.DragSourceHelper.DefaultQueryContinueDrag(System.Windows.QueryContinueDragEventArgs)"> |
|---|
| 918 | <summary> |
|---|
| 919 | Provides a default handler for the QueryContinueDrag drag source event. |
|---|
| 920 | </summary> |
|---|
| 921 | <param name="e">The event arguments.</param> |
|---|
| 922 | </member> |
|---|
| 923 | <member name="M:System.Windows.DragSourceHelper.AllowDropDescription(System.Boolean)"> |
|---|
| 924 | <summary> |
|---|
| 925 | Sets a flag on the system IDragSourceHelper2 object to allow drop descriptions |
|---|
| 926 | on the drag image. |
|---|
| 927 | </summary> |
|---|
| 928 | <param name="allow">True to allow drop descriptions, otherwise False.</param> |
|---|
| 929 | <remarks>Must be called before IDragSourceHelper.InitializeFromBitmap or |
|---|
| 930 | IDragSourceHelper.InitializeFromControl is called.</remarks> |
|---|
| 931 | </member> |
|---|
| 932 | <member name="M:System.Windows.DragSourceHelper.InvalidateDragImage(System.Windows.IDataObject)"> |
|---|
| 933 | <summary> |
|---|
| 934 | Invalidates the drag image. |
|---|
| 935 | </summary> |
|---|
| 936 | <param name="dataObject">The data object for which to invalidate the drag image.</param> |
|---|
| 937 | <remarks>This call tells the drag image manager to reformat the internal |
|---|
| 938 | cached drag image, based on the already set drag image bitmap and current drop |
|---|
| 939 | description.</remarks> |
|---|
| 940 | </member> |
|---|
| 941 | <member name="M:System.Windows.DragSourceHelper.GetIntPtrFromData(System.Object)"> |
|---|
| 942 | <summary> |
|---|
| 943 | Gets an IntPtr from data acquired from a data object. |
|---|
| 944 | </summary> |
|---|
| 945 | <param name="data">The data that contains the IntPtr.</param> |
|---|
| 946 | <returns>An IntPtr.</returns> |
|---|
| 947 | </member> |
|---|
| 948 | <member name="M:System.Windows.DragSourceHelper.IsShowingLayered(System.Windows.IDataObject)"> |
|---|
| 949 | <summary> |
|---|
| 950 | Determines if the IsShowingLayered flag is set on the data object. |
|---|
| 951 | </summary> |
|---|
| 952 | <param name="dataObject">The data object.</param> |
|---|
| 953 | <returns>True if the flag is set, otherwise false.</returns> |
|---|
| 954 | </member> |
|---|
| 955 | <member name="M:System.Windows.DragSourceHelper.GetBooleanFromData(System.Object)"> |
|---|
| 956 | <summary> |
|---|
| 957 | Converts compatible clipboard data to a boolean value. |
|---|
| 958 | </summary> |
|---|
| 959 | <param name="data">The clipboard data.</param> |
|---|
| 960 | <returns>True if the data can be converted to a boolean and is set, otherwise False.</returns> |
|---|
| 961 | </member> |
|---|
| 962 | <member name="M:System.Windows.DragSourceHelper.IsDropDescriptionValid(System.Windows.IDataObject)"> |
|---|
| 963 | <summary> |
|---|
| 964 | Checks if the current drop description, if any, is valid. |
|---|
| 965 | </summary> |
|---|
| 966 | <param name="dataObject">The DataObject from which to get the drop description.</param> |
|---|
| 967 | <returns>True if the drop description is set, and the |
|---|
| 968 | DropImageType is not DropImageType.Invalid.</returns> |
|---|
| 969 | </member> |
|---|
| 970 | <member name="M:System.Windows.DragSourceHelper.IsDropDescriptionDefault(System.Windows.IDataObject)"> |
|---|
| 971 | <summary> |
|---|
| 972 | Checks if the IsDefault drop description flag is set for the associated DataObject. |
|---|
| 973 | </summary> |
|---|
| 974 | <param name="dataObject">The associated DataObject.</param> |
|---|
| 975 | <returns>True if the IsDefault flag is set, otherwise False.</returns> |
|---|
| 976 | </member> |
|---|
| 977 | <member name="M:System.Windows.DragSourceHelper.InvalidateRequired(System.Windows.IDataObject)"> |
|---|
| 978 | <summary> |
|---|
| 979 | Checks if the InvalidateRequired drop description flag is set for the associated DataObject. |
|---|
| 980 | </summary> |
|---|
| 981 | <param name="dataObject">The associated DataObject.</param> |
|---|
| 982 | <returns>True if the InvalidateRequired flag is set, otherwise False.</returns> |
|---|
| 983 | </member> |
|---|
| 984 | <member name="M:System.Windows.DragSourceHelper.SetDropDescriptionIsDefault(System.Windows.IDataObject,System.Boolean)"> |
|---|
| 985 | <summary> |
|---|
| 986 | Sets the IsDefault drop description flag for the associated DataObject. |
|---|
| 987 | </summary> |
|---|
| 988 | <param name="dataObject">The associdated DataObject.</param> |
|---|
| 989 | <param name="isDefault">True to set the flag, False to unset it.</param> |
|---|
| 990 | </member> |
|---|
| 991 | <member name="M:System.Windows.DragSourceHelper.SetInvalidateRequired(System.Windows.IDataObject,System.Boolean)"> |
|---|
| 992 | <summary> |
|---|
| 993 | Sets the InvalidatedRequired drop description flag for the associated DataObject. |
|---|
| 994 | </summary> |
|---|
| 995 | <param name="dataObject">The associdated DataObject.</param> |
|---|
| 996 | <param name="isDefault">True to set the flag, False to unset it.</param> |
|---|
| 997 | </member> |
|---|
| 998 | <member name="M:System.Windows.DragSourceHelper.SetDropDescriptionFlag(System.Windows.IDataObject,System.Windows.DragSourceHelper.DropDescriptionFlags)"> |
|---|
| 999 | <summary> |
|---|
| 1000 | Sets a drop description flag. |
|---|
| 1001 | </summary> |
|---|
| 1002 | <param name="dataObject">The associated DataObject.</param> |
|---|
| 1003 | <param name="flag">The drop description flag to set.</param> |
|---|
| 1004 | </member> |
|---|
| 1005 | <member name="M:System.Windows.DragSourceHelper.UnsetDropDescriptionFlag(System.Windows.IDataObject,System.Windows.DragSourceHelper.DropDescriptionFlags)"> |
|---|
| 1006 | <summary> |
|---|
| 1007 | Unsets a drop description flag. |
|---|
| 1008 | </summary> |
|---|
| 1009 | <param name="dataObject">The associated DataObject.</param> |
|---|
| 1010 | <param name="flag">The drop description flag to unset.</param> |
|---|
| 1011 | </member> |
|---|
| 1012 | <member name="M:System.Windows.DragSourceHelper.GetDropImageType(System.Windows.IDataObject)"> |
|---|
| 1013 | <summary> |
|---|
| 1014 | Gets the current DropDescription's drop image type. |
|---|
| 1015 | </summary> |
|---|
| 1016 | <param name="dataObject">The DataObject.</param> |
|---|
| 1017 | <returns>The current drop image type.</returns> |
|---|
| 1018 | </member> |
|---|
| 1019 | <member name="T:System.Windows.DragSourceHelper.DropDescriptionFlags"> |
|---|
| 1020 | <summary> |
|---|
| 1021 | Internally used to track information about the current drop description. |
|---|
| 1022 | </summary> |
|---|
| 1023 | </member> |
|---|
| 1024 | <member name="T:System.Windows.DragSourceHelper.DragSourceEntry"> |
|---|
| 1025 | <summary> |
|---|
| 1026 | Represents a drag source context entry. |
|---|
| 1027 | </summary> |
|---|
| 1028 | </member> |
|---|
| 1029 | <member name="T:System.Windows.DragSourceHelper.AdviseSink"> |
|---|
| 1030 | <summary> |
|---|
| 1031 | Provides an advisory sink for the COM IDataObject implementation. |
|---|
| 1032 | </summary> |
|---|
| 1033 | </member> |
|---|
| 1034 | <member name="M:System.Windows.DragSourceHelper.AdviseSink.#ctor(System.Windows.IDataObject)"> |
|---|
| 1035 | <summary> |
|---|
| 1036 | Creates an AdviseSink associated to the specified data object. |
|---|
| 1037 | </summary> |
|---|
| 1038 | <param name="data">The data object.</param> |
|---|
| 1039 | </member> |
|---|
| 1040 | <member name="M:System.Windows.DragSourceHelper.AdviseSink.OnDataChange(System.Runtime.InteropServices.ComTypes.FORMATETC@,System.Runtime.InteropServices.ComTypes.STGMEDIUM@)"> |
|---|
| 1041 | <summary> |
|---|
| 1042 | Handles DataChanged events from a COM IDataObject. |
|---|
| 1043 | </summary> |
|---|
| 1044 | <param name="format">The data format that had a change.</param> |
|---|
| 1045 | <param name="stgmedium">The data value.</param> |
|---|
| 1046 | </member> |
|---|
| 1047 | <member name="F:System.Windows.DropTargetHelper.s_instance"> |
|---|
| 1048 | <summary> |
|---|
| 1049 | Internal instance of the DragDropHelper. |
|---|
| 1050 | </summary> |
|---|
| 1051 | </member> |
|---|
| 1052 | <member name="M:System.Windows.DropTargetHelper.DragEnter(System.Windows.Window,System.Windows.IDataObject,System.Windows.Point,System.Windows.DragDropEffects)"> |
|---|
| 1053 | <summary> |
|---|
| 1054 | Notifies the DragDropHelper that the specified Window received |
|---|
| 1055 | a DragEnter event. |
|---|
| 1056 | </summary> |
|---|
| 1057 | <param name="window">The Window the received the DragEnter event.</param> |
|---|
| 1058 | <param name="data">The DataObject containing a drag image.</param> |
|---|
| 1059 | <param name="cursorOffset">The current cursor's offset relative to the window.</param> |
|---|
| 1060 | <param name="effect">The accepted drag drop effect.</param> |
|---|
| 1061 | </member> |
|---|
| 1062 | <member name="M:System.Windows.DropTargetHelper.DragEnter(System.Windows.Window,System.Windows.IDataObject,System.Windows.Point,System.Windows.DragDropEffects,System.String,System.String)"> |
|---|
| 1063 | <summary> |
|---|
| 1064 | Notifies the DragDropHelper that the specified Window received |
|---|
| 1065 | a DragEnter event. |
|---|
| 1066 | </summary> |
|---|
| 1067 | <param name="window">The Window the received the DragEnter event.</param> |
|---|
| 1068 | <param name="data">The DataObject containing a drag image.</param> |
|---|
| 1069 | <param name="cursorOffset">The current cursor's offset relative to the window.</param> |
|---|
| 1070 | <param name="effect">The accepted drag drop effect.</param> |
|---|
| 1071 | <param name="descriptionMessage">The drop description message.</param> |
|---|
| 1072 | <param name="descriptionInsert">The drop description insert.</param> |
|---|
| 1073 | <remarks>Callers of this DragEnter override should make sure to call |
|---|
| 1074 | the DragLeave override taking an IDataObject parameter in order to clear |
|---|
| 1075 | the drop description.</remarks> |
|---|
| 1076 | </member> |
|---|
| 1077 | <member name="M:System.Windows.DropTargetHelper.DragOver(System.Windows.Point,System.Windows.DragDropEffects)"> |
|---|
| 1078 | <summary> |
|---|
| 1079 | Notifies the DragDropHelper that the current Window received |
|---|
| 1080 | a DragOver event. |
|---|
| 1081 | </summary> |
|---|
| 1082 | <param name="cursorOffset">The current cursor's offset relative to the window.</param> |
|---|
| 1083 | <param name="effect">The accepted drag drop effect.</param> |
|---|
| 1084 | </member> |
|---|
| 1085 | <member name="M:System.Windows.DropTargetHelper.DragLeave"> |
|---|
| 1086 | <summary> |
|---|
| 1087 | Notifies the DragDropHelper that the current Window received |
|---|
| 1088 | a DragLeave event. |
|---|
| 1089 | </summary> |
|---|
| 1090 | </member> |
|---|
| 1091 | <member name="M:System.Windows.DropTargetHelper.DragLeave(System.Windows.IDataObject)"> |
|---|
| 1092 | <summary> |
|---|
| 1093 | Notifies the DragDropHelper that the current Window received |
|---|
| 1094 | a DragLeave event. |
|---|
| 1095 | </summary> |
|---|
| 1096 | <param name="data">The data object associated to the event.</param> |
|---|
| 1097 | </member> |
|---|
| 1098 | <member name="M:System.Windows.DropTargetHelper.Drop(System.Windows.IDataObject,System.Windows.Point,System.Windows.DragDropEffects)"> |
|---|
| 1099 | <summary> |
|---|
| 1100 | Notifies the DragDropHelper that the current Window received |
|---|
| 1101 | a DragOver event. |
|---|
| 1102 | </summary> |
|---|
| 1103 | <param name="data">The DataObject containing a drag image.</param> |
|---|
| 1104 | <param name="cursorOffset">The current cursor's offset relative to the window.</param> |
|---|
| 1105 | <param name="effect">The accepted drag drop effect.</param> |
|---|
| 1106 | </member> |
|---|
| 1107 | <member name="M:System.Windows.DropTargetHelper.Show(System.Boolean)"> |
|---|
| 1108 | <summary> |
|---|
| 1109 | Tells the DragDropHelper to show or hide the drag image. |
|---|
| 1110 | </summary> |
|---|
| 1111 | <param name="show">True to show the image. False to hide it.</param> |
|---|
| 1112 | </member> |
|---|
| 1113 | <member name="M:DragDropLib.WpfDropTargetHelperExtensions.DragEnter(DragDropLib.IDropTargetHelper,System.Windows.Window,System.Windows.IDataObject,System.Windows.Point,System.Windows.DragDropEffects)"> |
|---|
| 1114 | <summary> |
|---|
| 1115 | Notifies the DragDropHelper that the specified Window received |
|---|
| 1116 | a DragEnter event. |
|---|
| 1117 | </summary> |
|---|
| 1118 | <param name="dropHelper">The DragDropHelper instance to notify.</param> |
|---|
| 1119 | <param name="window">The Window the received the DragEnter event.</param> |
|---|
| 1120 | <param name="data">The DataObject containing a drag image.</param> |
|---|
| 1121 | <param name="cursorOffset">The current cursor's offset relative to the window.</param> |
|---|
| 1122 | <param name="effect">The accepted drag drop effect.</param> |
|---|
| 1123 | </member> |
|---|
| 1124 | <member name="M:DragDropLib.WpfDropTargetHelperExtensions.DragOver(DragDropLib.IDropTargetHelper,System.Windows.Point,System.Windows.DragDropEffects)"> |
|---|
| 1125 | <summary> |
|---|
| 1126 | Notifies the DragDropHelper that the current Window received |
|---|
| 1127 | a DragOver event. |
|---|
| 1128 | </summary> |
|---|
| 1129 | <param name="dropHelper">The DragDropHelper instance to notify.</param> |
|---|
| 1130 | <param name="cursorOffset">The current cursor's offset relative to the window.</param> |
|---|
| 1131 | <param name="effect">The accepted drag drop effect.</param> |
|---|
| 1132 | </member> |
|---|
| 1133 | <member name="M:DragDropLib.WpfDropTargetHelperExtensions.Drop(DragDropLib.IDropTargetHelper,System.Windows.IDataObject,System.Windows.Point,System.Windows.DragDropEffects)"> |
|---|
| 1134 | <summary> |
|---|
| 1135 | Notifies the DragDropHelper that the current Window received |
|---|
| 1136 | a Drop event. |
|---|
| 1137 | </summary> |
|---|
| 1138 | <param name="dropHelper">The DragDropHelper instance to notify.</param> |
|---|
| 1139 | <param name="data">The DataObject containing a drag image.</param> |
|---|
| 1140 | <param name="cursorOffset">The current cursor's offset relative to the window.</param> |
|---|
| 1141 | <param name="effect">The accepted drag drop effect.</param> |
|---|
| 1142 | </member> |
|---|
| 1143 | <member name="T:System.Windows.WpfDataObjectExtensions"> |
|---|
| 1144 | <summary> |
|---|
| 1145 | Provides extended functionality to the System.Windows.IDataObject interface. |
|---|
| 1146 | </summary> |
|---|
| 1147 | </member> |
|---|
| 1148 | <member name="M:System.Windows.WpfDataObjectExtensions.SetDragImage(System.Windows.IDataObject,System.Windows.UIElement,System.Windows.Point)"> |
|---|
| 1149 | <summary> |
|---|
| 1150 | Sets the drag image by rendering the specified UIElement. |
|---|
| 1151 | </summary> |
|---|
| 1152 | <param name="dataObject">The DataObject to set the drag image for.</param> |
|---|
| 1153 | <param name="element">The element to render as the drag image.</param> |
|---|
| 1154 | <param name="cursorOffset">The offset of the cursor relative to the UIElement.</param> |
|---|
| 1155 | </member> |
|---|
| 1156 | <member name="M:System.Windows.WpfDataObjectExtensions.SetDragImage(System.Windows.IDataObject,System.Windows.Media.Imaging.BitmapSource,System.Windows.Point)"> |
|---|
| 1157 | <summary> |
|---|
| 1158 | Sets the drag image from a BitmapSource. |
|---|
| 1159 | </summary> |
|---|
| 1160 | <param name="dataObject">The DataObject on which to set the drag image.</param> |
|---|
| 1161 | <param name="image">The image source.</param> |
|---|
| 1162 | <param name="cursorOffset">The offset relative to the bitmap image.</param> |
|---|
| 1163 | </member> |
|---|
| 1164 | <member name="M:System.Windows.WpfDataObjectExtensions.SetDragImage(System.Windows.IDataObject,System.Drawing.Bitmap,System.Windows.Point)"> |
|---|
| 1165 | <summary> |
|---|
| 1166 | Sets the drag image. |
|---|
| 1167 | </summary> |
|---|
| 1168 | <param name="dataObject">The DataObject to set the drag image on.</param> |
|---|
| 1169 | <param name="image">The drag image.</param> |
|---|
| 1170 | <param name="cursorOffset">The location of the cursor relative to the image.</param> |
|---|
| 1171 | </member> |
|---|
| 1172 | <member name="M:System.Windows.WpfDataObjectExtensions.SetDropDescription(System.Windows.IDataObject,System.Windows.DropImageType,System.String,System.String)"> |
|---|
| 1173 | <summary> |
|---|
| 1174 | Sets the drop description for the drag image manager. |
|---|
| 1175 | </summary> |
|---|
| 1176 | <param name="dataObject">The DataObject to set.</param> |
|---|
| 1177 | <param name="type">The type of the drop image.</param> |
|---|
| 1178 | <param name="format">The format string for the description.</param> |
|---|
| 1179 | <param name="insert">The parameter for the drop description.</param> |
|---|
| 1180 | <remarks> |
|---|
| 1181 | When setting the drop description, the text can be set in two part, |
|---|
| 1182 | which will be rendered slightly differently to distinguish the description |
|---|
| 1183 | from the subject. For example, the format can be set as "Move to %1" and |
|---|
| 1184 | the insert as "Temp". When rendered, the "%1" in format will be replaced |
|---|
| 1185 | with "Temp", but "Temp" will be rendered slightly different from "Move to ". |
|---|
| 1186 | </remarks> |
|---|
| 1187 | </member> |
|---|
| 1188 | <member name="M:System.Windows.WpfDataObjectExtensions.SetDataEx(System.Windows.IDataObject,System.String,System.Object)"> |
|---|
| 1189 | <summary> |
|---|
| 1190 | Sets managed data to a clipboard DataObject. |
|---|
| 1191 | </summary> |
|---|
| 1192 | <param name="dataObject">The DataObject to set the data on.</param> |
|---|
| 1193 | <param name="format">The clipboard format.</param> |
|---|
| 1194 | <param name="data">The data object.</param> |
|---|
| 1195 | <remarks> |
|---|
| 1196 | Because the underlying data store is not storing managed objects, but |
|---|
| 1197 | unmanaged ones, this function provides intelligent conversion, allowing |
|---|
| 1198 | you to set unmanaged data into the COM implemented IDataObject.</remarks> |
|---|
| 1199 | </member> |
|---|
| 1200 | <member name="M:System.Windows.WpfDataObjectExtensions.GetCompatibleTymed(System.String,System.Object)"> |
|---|
| 1201 | <summary> |
|---|
| 1202 | Gets a system compatible TYMED for the given format. |
|---|
| 1203 | </summary> |
|---|
| 1204 | <param name="format">The data format.</param> |
|---|
| 1205 | <param name="data">The data.</param> |
|---|
| 1206 | <returns>A TYMED value, indicating a system compatible TYMED that can |
|---|
| 1207 | be used for data marshaling.</returns> |
|---|
| 1208 | </member> |
|---|
| 1209 | <member name="M:System.Windows.WpfDataObjectExtensions.IsFormatEqual(System.String,System.String)"> |
|---|
| 1210 | <summary> |
|---|
| 1211 | Compares the equality of two clipboard formats. |
|---|
| 1212 | </summary> |
|---|
| 1213 | <param name="formatA">First format.</param> |
|---|
| 1214 | <param name="formatB">Second format.</param> |
|---|
| 1215 | <returns>True if the formats are equal. False otherwise.</returns> |
|---|
| 1216 | </member> |
|---|
| 1217 | <member name="M:System.Windows.WpfDataObjectExtensions.GetDataEx(System.Windows.IDataObject,System.String)"> |
|---|
| 1218 | <summary> |
|---|
| 1219 | Gets managed data from a clipboard DataObject. |
|---|
| 1220 | </summary> |
|---|
| 1221 | <param name="dataObject">The DataObject to obtain the data from.</param> |
|---|
| 1222 | <param name="format">The format for which to get the data in.</param> |
|---|
| 1223 | <returns>The data object instance.</returns> |
|---|
| 1224 | </member> |
|---|
| 1225 | <member name="M:System.Windows.WpfDataObjectExtensions.GetDeviceDpi(System.Windows.Media.Visual,System.Int32@,System.Int32@)"> |
|---|
| 1226 | <summary> |
|---|
| 1227 | Gets the device capabilities. |
|---|
| 1228 | </summary> |
|---|
| 1229 | <param name="reference">A reference UIElement for getting the relevant device caps.</param> |
|---|
| 1230 | <param name="dpix">The horizontal DPI.</param> |
|---|
| 1231 | <param name="dpiy">The vertical DPI.</param> |
|---|
| 1232 | </member> |
|---|
| 1233 | <member name="M:System.Windows.WpfDataObjectExtensions.GetBitmapFromBitmapSource(System.Windows.Media.Imaging.BitmapSource,System.Windows.Media.Color)"> |
|---|
| 1234 | <summary> |
|---|
| 1235 | Gets a System.Drawing.Bitmap from a BitmapSource. |
|---|
| 1236 | </summary> |
|---|
| 1237 | <param name="source">The source image from which to create our Bitmap.</param> |
|---|
| 1238 | <param name="transparencyKey">The transparency key. This is used by the DragDropHelper |
|---|
| 1239 | in rendering transparent pixels.</param> |
|---|
| 1240 | <returns>An instance of Bitmap which is a copy of the BitmapSource's image.</returns> |
|---|
| 1241 | </member> |
|---|
| 1242 | <member name="M:System.Windows.WpfDataObjectExtensions.ReplaceTransparentPixelsWithTransparentKey(System.Drawing.Imaging.BitmapData,System.Drawing.Color)"> |
|---|
| 1243 | <summary> |
|---|
| 1244 | Replaces any pixel with a zero alpha value with the specified transparency key. |
|---|
| 1245 | </summary> |
|---|
| 1246 | <param name="bmpData">The bitmap data in which to perform the operation.</param> |
|---|
| 1247 | <param name="transKey">The transparency color. This color is rendered transparent |
|---|
| 1248 | by the DragDropHelper.</param> |
|---|
| 1249 | <remarks> |
|---|
| 1250 | This function only supports 32-bit pixel formats for now. |
|---|
| 1251 | </remarks> |
|---|
| 1252 | </member> |
|---|
| 1253 | <member name="M:System.Windows.WpfDataObjectExtensions.ToDrawingColor(System.Windows.Media.Color)"> |
|---|
| 1254 | <summary> |
|---|
| 1255 | Converts a System.Windows.Media.Color to System.Drawing.Color. |
|---|
| 1256 | </summary> |
|---|
| 1257 | <param name="color">System.Windows.Media.Color value to convert.</param> |
|---|
| 1258 | <returns>System.Drawing.Color value.</returns> |
|---|
| 1259 | </member> |
|---|
| 1260 | <member name="M:System.Windows.WpfDataObjectExtensions.ToDrawingRectangle(System.Windows.Int32Rect)"> |
|---|
| 1261 | <summary> |
|---|
| 1262 | Converts a System.Windows.Int32Rect to a System.Drawing.Rectangle value. |
|---|
| 1263 | </summary> |
|---|
| 1264 | <param name="rect">The System.Windows.Int32Rect to convert.</param> |
|---|
| 1265 | <returns>The System.Drawing.Rectangle converted value.</returns> |
|---|
| 1266 | </member> |
|---|
| 1267 | <member name="M:System.Windows.WpfDataObjectExtensions.ConvertColorPalette(System.Drawing.Imaging.ColorPalette,System.Windows.Media.Imaging.BitmapPalette)"> |
|---|
| 1268 | <summary> |
|---|
| 1269 | Converts the entries in a BitmapPalette to ColorPalette entries. |
|---|
| 1270 | </summary> |
|---|
| 1271 | <param name="destPalette">ColorPalette destination palette.</param> |
|---|
| 1272 | <param name="bitmapPalette">BitmapPalette source palette.</param> |
|---|
| 1273 | </member> |
|---|
| 1274 | <member name="M:System.Windows.WpfDataObjectExtensions.ConvertPixelFormat(System.Windows.Media.PixelFormat)"> |
|---|
| 1275 | <summary> |
|---|
| 1276 | Converts a System.Windows.Media.PixelFormat instance to a |
|---|
| 1277 | System.Drawing.Imaging.PixelFormat value. |
|---|
| 1278 | </summary> |
|---|
| 1279 | <param name="pixelFormat">The input PixelFormat.</param> |
|---|
| 1280 | <returns>The converted value.</returns> |
|---|
| 1281 | </member> |
|---|
| 1282 | </members> |
|---|
| 1283 | </doc> |
|---|