ToolStripItem.ImageKey ToolStripItem.ImageKey ToolStripItem.ImageKey ToolStripItem.ImageKey Property

Definition

Ruft einen Schlüsselaccessor für das Bild in der ImageList ab, die in einem ToolStripItem angezeigt wird, oder legt diesen fest.Gets or sets the key accessor for the image in the ImageList that is displayed on a 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; }
member this.ImageKey : string with get, set
Public Property ImageKey As String

Eigenschaftswert

Eine Zeichenfolge, die den Schlüssel des Bilds darstellt.A string representing the key of the image.

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie die ImageKey -Eigenschaft festgelegt wird.The following code example demonstrates how to set the ImageKey property. Dieses Codebeispiel ist Teil eines größeren Beispiels, das für die ToolStripItem -Klasse bereitgestellt wird.This code example is part of a larger example provided for the ToolStripItem class.

// 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

Hinweise

Die ImageIndex -Eigenschaft gibt die Position des Bilds in der Bildliste an.The ImageIndex property specifies the position of the image in the image list. Die ImageKey -Eigenschaft gibt das Bild selbst an.The ImageKey property specifies the image itself.

Die ImageEigenschaften ImageAlign, ,ImageIndex ,ImageKeyund beziehenImageScaling sich auf verschiedene Aspekte der Bildverarbeitung.The Image, ImageAlign, ImageIndex, ImageKey, and ImageScaling properties pertain to various aspects of image handling. Verwenden Sie Bilder ToolStrip in Steuerelementen, indem Sie diese Eigenschaften direkt oder durch Festlegen der Lauf Zeit ImageList Eigenschaft festlegen.Use images in ToolStrip controls by setting these properties directly or by setting the run-time-only ImageList property.

Die Bildskalierung wird durch die Interaktion von Eigenschaften sowohl ToolStrip in ToolStripItemals auch in festgelegt, wie im folgenden dargestellt:Image scaling is determined by the interaction of properties in both ToolStrip and ToolStripItem, as follows:

Gilt für: