ImagePropertiesBase.Url Property

Gets or sets the URL of the image used for an element’s normal state.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v20.2.dll

NuGet Package: DevExpress.Web

Declaration

C#

[DefaultValue("")]
public virtual string Url { get; set; }

VB.NET

<DefaultValue("")>
Public Overridable Property Url As String

Property Value

Type	Default	Description
String	String.Empty	A String value that specifies the location of an image.

Remarks

Use the Url property to specify the URL of an image which is defined by the current ImagePropertiesBase object, and is used to represent the corresponding element in the normal state.

You can use a relative or an absolute URL. A relative URL relates the location of the image to the location of the Web page, without specifying a complete path on the server. The path is relative to the location of the Web page. This makes it easier to move the entire site to another directory on the server without updating the code. An absolute URL provides the complete path, thus moving the site to another directory requires a code update.

An image’s size can be defined via the ImagePropertiesBase.Width and ImagePropertiesBase.Height properties. Note that in order to correctly display a PNG file with alpha channel at runtime, the image’s size (the ImagePropertiesBase.Width and ImagePropertiesBase.Height properties) should be specified explicitly.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Url property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-show-color-icons-for-labels-and-statuses-in-the-appointment-edit-form-and-popup-menu-t344486/CS/CustomFormStatusEditors/Default.aspx.cs#L35

string imageUrl = String.Format("~/Images/{0}/{1}.png", folderName, item.Text);
if (item.Image.Url == String.Empty)
    item.Image.Url = imageUrl;

aspxhtmleditor-how-to-open-and-display-files-using-a-custom-button-and-dialog-e4650/CS/DevExpress.Example/Default.aspx.cs#L18

var btn = new ToolbarCustomDialogButton("cdialog", "Open HTML File", false, true);
btn.Image.Url = "~/icons/folder-open.ico";
htmlEditor.Toolbars[0].Items.Insert(0, btn);

gridview-how-to-implement-export-from-an-embedded-context-menu-t150435/CS/Controllers/HomeController.cs#L56

    var exportToXlsItem = parentItem.Items.Add(text, name);
    exportToXlsItem.Image.Url = imageUrl;
}

Custom-Responsive-Web-Application/CS/ResponsiveWebApplication/Root.master.cs#L84

protected void ApplicationMenu_ItemDataBound(object source, MenuItemEventArgs e) {
    e.Item.Image.Url = string.Format("Content/Images/{0}.svg", e.Item.Text);
    e.Item.Image.UrlSelected = string.Format("Content/Images/{0}-white.svg", e.Item.Text);

VB.NET

aspxhtmleditor-how-to-open-and-display-files-using-a-custom-button-and-dialog-e4650/VB/DevExpress.Example/Default.aspx.vb#L20

Dim btn = New ToolbarCustomDialogButton("cdialog", "Open HTML File", False, True)
btn.Image.Url = "~/icons/folder-open.ico"
htmlEditor.Toolbars(0).Items.Insert(0, btn)

gridview-how-to-implement-export-from-an-embedded-context-menu-t150435/VB/Controllers/HomeController.vb#L64

    Dim exportToXlsItem = parentItem.Items.Add(text, name)
    exportToXlsItem.Image.Url = imageUrl
End Sub