ToolStripItem.ImageKey Propriété

Définition

Espace de noms:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Obtient ou définit l'accesseur de clé pour l'image dans le ImageList qui est affiché dans 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

Valeur de propriété

String

Chaîne représentant la clé de l'image.

Attributs

BrowsableAttribute TypeConverterAttribute RelatedImageListAttribute

Exemples

L’exemple de code suivant montre comment définir la ImageKey propriété . Cet exemple de code fait partie d’un exemple plus grand fourni pour la ToolStripItem classe .

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

Remarques

ImageKey et ImageIndex s’excluent mutuellement, ce qui signifie que si l’un est défini, l’autre est défini sur une valeur non valide et ignoré. Si vous définissez la ImageKey propriété, la ImageIndex propriété est automatiquement définie sur -1. Si vous définissez la propriété, ImageKey le ImageIndex est automatiquement défini sur une chaîne vide («  »).

Les Imagepropriétés , ImageAlign, ImageIndex, ImageKeyet ImageScaling se rapportent à différents aspects de la gestion des images. Utilisez des images dans des contrôles en définissant ces propriétés directement ou en ToolStrip définissant la propriété d’exécution uniquement ImageList .

La mise à l’échelle des images est déterminée par l’interaction des propriétés dans ToolStrip et ToolStripItem, comme suit :

• ImageScalingSize est l’échelle de l’image finale, déterminée par la combinaison du paramètre de ImageScaling l’image et du paramètre du AutoSize conteneur.

  • Si AutoSize est true (la valeur par défaut) et ToolStripItemImageScaling est SizeToFit, aucune mise à l’échelle d’image ne se produit, et la ToolStrip taille est celle du plus grand élément ou une taille minimale prescrite.

  • Si AutoSize est false et ToolStripItemImageScaling est None, ni image ni ToolStrip mise à l’échelle ne se produisent.