DataFormats.GetFormat Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Возвращает DataFormats.Format с числовым идентификатором и именем буфера обмена Windows.
Перегрузки
| Имя | Описание |
|---|---|
| GetFormat(Int32) |
Возвращает DataFormats.Format с числовым идентификатором буфера обмена Windows и именем указанного идентификатора. |
| GetFormat(String) |
Возвращает DataFormats.Format с числовым идентификатором буфера обмена Windows и именем указанного формата. |
GetFormat(Int32)
- Исходный код:
- DataFormats.cs
- Исходный код:
- DataFormats.cs
- Исходный код:
- DataFormats.cs
- Исходный код:
- DataFormats.cs
- Исходный код:
- DataFormats.cs
Возвращает DataFormats.Format с числовым идентификатором буфера обмена Windows и именем указанного идентификатора.
public:
static System::Windows::Forms::DataFormats::Format ^ GetFormat(int id);
public static System.Windows.Forms.DataFormats.Format GetFormat(int id);
static member GetFormat : int -> System.Windows.Forms.DataFormats.Format
Public Shared Function GetFormat (id As Integer) As DataFormats.Format
Параметры
- id
- Int32
Идентификатор формата.
Возвращаемое значение
Объект DataFormats.Format с числовым идентификатором буфера обмена Windows и именем формата.
Примеры
В следующем примере кода демонстрируется использование этого элемента.
using namespace System;
using namespace System::Windows::Forms;
int main()
{
// Create a DataFormats::Format for the Unicode data format.
DataFormats::Format^ myFormat = DataFormats::GetFormat( 13 );
// Display the contents of myFormat.
Console::WriteLine( "The Format Name corresponding to the ID {0} is :", myFormat->Id );
Console::WriteLine( myFormat->Name );
}
using System;
using System.Windows.Forms;
public class DataFormat_GetFormat
{
static void Main()
{
// Create a DataFormats.Format for the Unicode data format.
DataFormats.Format myFormat = DataFormats.GetFormat(13);
// Display the contents of myFormat.
Console.WriteLine("The Format Name corresponding to the ID "+myFormat.Id+" is :");
Console.WriteLine(myFormat.Name);
}
}
Imports System.Windows.Forms
Public Class DataFormat_GetFormat
Shared Sub Main()
' Create a DataFormats.Format for the Unicode data format.
Dim myFormat As DataFormats.Format = DataFormats.GetFormat(13)
' Display the contents of myFormat.
Console.WriteLine(("The Format Name corresponding to the ID " + myFormat.Id.ToString + " is :"))
Console.WriteLine(myFormat.Name)
End Sub
End Class
Комментарии
Обычно этот элемент используется для регистрации собственных форматов буфера обмена.
Вызов GetFormat с идентификатором, если требуется получить DataFormats.Format экземпляр, содержащий пару имен идентификатора и формата. Как правило, имя и номер идентификатора публикуются создателем приложения, с которым вы используете Clipboard интерфейс. Например, идентификатор для сведений о беседе с динамическими данными Exchange (DDE) в Visual Basic имеет значение &HBF00, а имя формата — vbCFLink.
Вызовите этот метод с любым уникальным номером идентификатора, чтобы добавить пару имен идентификатора и формата в static список пар имени и идентификатора в DataFormats классе. Новое имя будет создано путем объединения "Формат" и номера идентификатора. Эта пара не зарегистрирована в качестве нового Clipboard формата, так как вы не указали имя.
См. также раздел
Применяется к
GetFormat(String)
- Исходный код:
- DataFormats.cs
- Исходный код:
- DataFormats.cs
- Исходный код:
- DataFormats.cs
- Исходный код:
- DataFormats.cs
- Исходный код:
- DataFormats.cs
Возвращает DataFormats.Format с числовым идентификатором буфера обмена Windows и именем указанного формата.
public:
static System::Windows::Forms::DataFormats::Format ^ GetFormat(System::String ^ format);
public static System.Windows.Forms.DataFormats.Format GetFormat(string format);
static member GetFormat : string -> System.Windows.Forms.DataFormats.Format
Public Shared Function GetFormat (format As String) As DataFormats.Format
Параметры
- format
- String
Имя формата.
Возвращаемое значение
Объект DataFormats.Format с числовым идентификатором буфера обмена Windows и именем формата.
Исключения
.NET 5 и более поздних версий: format имеет значение null, Empty или пробелы.
Не удалось зарегистрировать новый Clipboard формат.
Примеры
В следующем примере кода показано, как получить DataFormats.Format пару "Имя формата"/ "Идентификатор". Формат UnicodeText запрашивается, а содержимое извлеченного DataFormats.Format поля отображается в текстовом поле.
Этот код требует textBox1 создания экземпляра.
private:
void GetMyFormatInfomation()
{
// Creates a DataFormats.Format for the Unicode data format.
DataFormats::Format^ myFormat = DataFormats::GetFormat(
DataFormats::UnicodeText );
// Displays the contents of myFormat.
textBox1->Text = String::Format( "ID value: {0}\nFormat name: {1}",
myFormat->Id, myFormat->Name );
}
private void GetMyFormatInfomation() {
// Creates a DataFormats.Format for the Unicode data format.
DataFormats.Format myFormat = DataFormats.GetFormat(DataFormats.UnicodeText);
// Displays the contents of myFormat.
textBox1.Text = "ID value: " + myFormat.Id + '\n' +
"Format name: " + myFormat.Name;
}
Private Sub GetMyFormatInfomation()
' Creates a DataFormats.Format for the Unicode data format.
Dim myFormat As DataFormats.Format = _
DataFormats.GetFormat(DataFormats.UnicodeText)
' Displays the contents of myFormat.
textBox1.Text = "ID value: " + myFormat.Id.ToString() + ControlChars.Cr _
+ "Format name: " + myFormat.Name
End Sub
Комментарии
Вызовите GetFormat с именем формата, если требуется числовой идентификатор буфера обмена Windows для существующего формата.
Вызовите этот метод с собственным именем формата, чтобы создать новый Clipboard тип формата. Если указанный формат не существует, этот метод регистрирует имя в качестве формата буфера обмена в реестре Windows и получает уникальный идентификатор формата. Эта новая пара name/ID будет добавлена в static список пар имени и идентификатора формата в DataFormats классе.