ToolStripItem.ImageKey Eigenschaft

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Ruft einen Schlüsselaccessor für das Bild in der ImageList ab, die in einem ToolStripItem angezeigt wird, oder legt diesen fest.

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

Eigenschaftswert

String

Eine Zeichenfolge, die den Schlüssel des Bilds darstellt.

Attribute

BrowsableAttribute TypeConverterAttribute RelatedImageListAttribute

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie die -Eigenschaft festgelegt wird ImageKey . Dieses Codebeispiel ist Teil eines größeren Beispiels, das für die ToolStripItem-Klasse bereitgestellt wird.

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

ImageKey und ImageIndex schließen sich gegenseitig aus, d. h. wenn eine festgelegt ist, wird der andere auf einen ungültigen Wert festgelegt und ignoriert. Wenn Sie die ImageKey Eigenschaft festlegen, wird die ImageIndex Eigenschaft automatisch auf -1 festgelegt. Alternativ wird beim Festlegen der ImageIndex -Eigenschaft ImageKey automatisch eine leere Zeichenfolge ("") festgelegt.

Die Eigenschaften Image, ImageAlign, ImageIndex, ImageKey und ImageScaling beziehen sich auf verschiedene Aspekte der Bildbehandlung. Verwenden Sie Bilder in ToolStrip Steuerelementen, indem Sie diese Eigenschaften direkt oder durch Festlegen der Laufzeiteigenschaft festlegen ImageList .

Die Bildskalierung wird durch die Interaktion von Eigenschaften in ToolStrip und ToolStripItem wie folgt bestimmt:

• ImageScalingSize ist die Skalierung des endgültigen Bilds, die sich aus der Kombination der ImageScaling-Einstellung des Bilds und der AutoSize-Einstellung des Containers ergibt.

  • Wenn AutoSize entsprechend true (die Standardeinstellung) und ToolStripItemImageScalingSizeToFit ist, erfolgt keine Skalierung des Bilds und die ToolStrip-Größe entspricht der des größten Elements oder einer vorgegebenen Mindestgröße.

  • Wenn AutoSize entsprechend false und ToolStripItemImageScaling wiederum None ist, werden weder Bild noch ToolStrip skaliert.