TextRange.PasteSpecial Method
Replaces the text range with the contents of the Clipboard in the format specified.
Namespace: Microsoft.Office.Interop.PowerPoint
Assembly: Microsoft.Office.Interop.PowerPoint (in Microsoft.Office.Interop.PowerPoint.dll)
Syntax
'Declaration
Function PasteSpecial ( _
DataType As PpPasteDataType, _
DisplayAsIcon As MsoTriState, _
IconFileName As String, _
IconIndex As Integer, _
IconLabel As String, _
Link As MsoTriState _
) As TextRange
'Usage
Dim instance As TextRange
Dim DataType As PpPasteDataType
Dim DisplayAsIcon As MsoTriState
Dim IconFileName As String
Dim IconIndex As Integer
Dim IconLabel As String
Dim Link As MsoTriState
Dim returnValue As TextRange
returnValue = instance.PasteSpecial(DataType, _
DisplayAsIcon, IconFileName, IconIndex, _
IconLabel, Link)
TextRange PasteSpecial(
PpPasteDataType DataType,
MsoTriState DisplayAsIcon,
string IconFileName,
int IconIndex,
string IconLabel,
MsoTriState Link
)
Parameters
- DataType
Type: Microsoft.Office.Interop.PowerPoint.PpPasteDataType
A format for the Clipboard contents when they're inserted into the document. The default value varies, depending on the contents in the Clipboard. An error occurs if the specified data type in the DataType argument is not supported by the clipboard contents.
- DisplayAsIcon
Type: Microsoft.Office.Core.MsoTriState
msoTrue to display the embedded object (or link) as an icon.
- IconFileName
Type: System.String
If DisplayAsIcon is set to msoTrue, this argument is the path and file name for the file in which the icon to be displayed is stored. If DisplayAsIcon is set to msoFalse, this argument is ignored.
- IconIndex
Type: System.Int32
If DisplayAsIcon is set to msoTrue, this argument is a number that corresponds to the icon you want to use in the program file specified by IconFilename. For example, 0 (zero) corresponds to the first icon, 1 corresponds to the second icon. If this argument is omitted, the first (default) icon is used. If DisplayAsIcon is set to msoFalse, then this argument is ignored. If IconIndex is outside the valid range, then the default icon (index 0) is used.
- IconLabel
Type: System.String
If DisplayAsIcon is set to msoTrue, this argument is the text that appears below the icon. If this label is missing, Microsoft PowerPoint generates an icon label based on the Clipboard contents. If DisplayAsIcon is set to msoFalse, then this argument is ignored.
- Link
Type: Microsoft.Office.Core.MsoTriState
Determines whether to create a link to the source file of the Clipboard contents. An error occurs if the Clipboard contents do not support a link.
Return Value
Type: Microsoft.Office.Interop.PowerPoint.TextRange
Remarks
An error occurs if there is no data on the Clipboard when the PasteSpecial(PpPasteDataType, MsoTriState, String, Int32, String, MsoTriState) method is called.
Valid data types for the TextRange object are ppPasteText, ppPasteHTML, and ppPasteRTF (any other format generates an error). If the paste succeeds, this method returns a TextRange object representing the text range that was pasted.
The DataType parameter value can be one of these PpPasteDataType constants.
The DisplayAsIcon parameter value can be one of these MsoTriState constants.
Constant |
Description |
|---|---|
The default. Does not display the embedded object (or link) as an icon. |
|
Displays the embedded object (or link) as an icon. |