ToolStripItem.ImageKey Свойство

Определение

Пространство имен:

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

Исходный код:

ToolStripItem.cs

Возвращает или задает метод доступа к ключу для изображения, отображаемого в ImageList объекте ToolStripItem.

public:
 property System::String ^ ImageKey { System::String ^ get(); void set(System::String ^ value); };

[System.ComponentModel.Browsable(false)]
[System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.ImageKeyConverter))]
[System.Windows.Forms.RelatedImageList("Owner.ImageList")]
public string ImageKey { get; set; }

[<System.ComponentModel.Browsable(false)>]
[<System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.ImageKeyConverter))>]
[<System.Windows.Forms.RelatedImageList("Owner.ImageList")>]
member this.ImageKey : string with get, set

Public Property ImageKey As String

Значение свойства

String

Строка, представляющая ключ изображения.

Атрибуты

BrowsableAttribute TypeConverterAttribute RelatedImageListAttribute

Примеры

В следующем примере кода показано, как задать ImageKey свойство. Этот пример кода является частью более крупного примера, предоставленного для ToolStripItem класса.

// This utility method creates a RolloverItem 
// and adds it to a ToolStrip control.
private RolloverItem CreateRolloverItem(
    ToolStrip owningToolStrip,
    string txt,
    Font f,
    string imgKey,
    TextImageRelation tir,
    string backImgKey)
{
    RolloverItem item = new RolloverItem();

    item.Alignment = ToolStripItemAlignment.Left;
    item.AllowDrop = false;
    item.AutoSize = true;

    item.BackgroundImage = owningToolStrip.ImageList.Images[backImgKey];
    item.BackgroundImageLayout = ImageLayout.Center;
    item.DisplayStyle = ToolStripItemDisplayStyle.ImageAndText;
    item.DoubleClickEnabled = true;
    item.Enabled = true;
    item.Font = f;

    // These assignments are equivalent. Each assigns an
    // image from the owning toolstrip's image list.
    item.ImageKey = imgKey;
    //item.Image = owningToolStrip.ImageList.Images[infoIconKey];
    //item.ImageIndex = owningToolStrip.ImageList.Images.IndexOfKey(infoIconKey);
    item.ImageScaling = ToolStripItemImageScaling.None;

    item.Owner = owningToolStrip;
    item.Padding = new Padding(2);
    item.Text = txt;
    item.TextAlign = ContentAlignment.MiddleLeft;
    item.TextDirection = ToolStripTextDirection.Horizontal;
    item.TextImageRelation = tir;

    return item;
}

' This utility method creates a RolloverItem 
' and adds it to a ToolStrip control.
 Private Function CreateRolloverItem( _
 ByVal owningToolStrip As ToolStrip, _
 ByVal txt As String, _
 ByVal f As Font, _
 ByVal imgKey As String, _
 ByVal tir As TextImageRelation, _
 ByVal backImgKey As String) As RolloverItem

     Dim item As New RolloverItem()

     item.Alignment = ToolStripItemAlignment.Left
     item.AllowDrop = False
     item.AutoSize = True

     item.BackgroundImage = owningToolStrip.ImageList.Images(backImgKey)
     item.BackgroundImageLayout = ImageLayout.Center
     item.DisplayStyle = ToolStripItemDisplayStyle.ImageAndText
     item.DoubleClickEnabled = True
     item.Enabled = True
     item.Font = f

     ' These assignments are equivalent. Each assigns an
     ' image from the owning toolstrip's image list.
     item.ImageKey = imgKey
     'item.Image = owningToolStrip.ImageList.Images[infoIconKey];
     'item.ImageIndex = owningToolStrip.ImageList.Images.IndexOfKey(infoIconKey);
     item.ImageScaling = ToolStripItemImageScaling.None

     item.Owner = owningToolStrip
     item.Padding = New Padding(2)
     item.Text = txt
     item.TextAlign = ContentAlignment.MiddleLeft
     item.TextDirection = ToolStripTextDirection.Horizontal
     item.TextImageRelation = tir

     Return item
 End Function

Комментарии

ImageKey и ImageIndex являются взаимоисключающими, то есть, если задано одно, другое имеет недопустимое значение и игнорируется. Если задано ImageKey свойство, ImageIndex свойство автоматически присваивается значение -1. Кроме того, если задать ImageIndex свойство, ImageKey оно автоматически присваивается пустой строке ("").

Свойства Image, и ImageIndexImageAlignImageKeyImageScaling свойства относятся к различным аспектам обработки изображений. Используйте изображения в ToolStrip элементах управления, задав эти свойства напрямую или задав свойство только ImageList во время выполнения.

Масштабирование изображений определяется взаимодействием свойств в обоих ToolStrip и ToolStripItemследующим образом:

• ImageScalingSize — это масштаб окончательного изображения, определяемого сочетанием параметра образа ImageScaling и параметра контейнера AutoSize .

  • Если AutoSize значение равно true (по умолчанию) и ToolStripItemImageScalingSizeToFitне выполняется масштабирование изображений, а ToolStrip размер является самым большим элементом или заданным минимальным размером.

  • Если AutoSize и ToolStripItemImageScaling есть falseNone, ни изображение, ToolStrip ни масштабирование не происходит.