ImagesBase.SpriteImageUrl Property

Gets or sets the path to a sprite image.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v20.2.dll

NuGet Package: DevExpress.Web

Declaration

C#

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

VB.NET

<DefaultValue("")>
Public Property SpriteImageUrl As String

Property Value

Type	Default	Description
String	String.Empty	A String value that specifies the path to the sprite image.

Remarks

Use the SpriteImageUrl property to specify a custom sprite image used by the control. Settings of individual control images combined into the sprite can be defined using the ImagePropertiesBase.Height, ImagePropertiesBase.Width and ImageSpriteProperties.Left and ImageSpriteProperties.Top properties, which are exposed at the image level.

To learn more, see the topic CSS Image Sprites.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SpriteImageUrl 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-images-for-tentative-and-working-elsewhere-appointment-statuses-t344062/CS/CustomStatusSample/DevExpress/ASPxSchedulerForms/RecurrentAppointmentEditForm.ascx.cs#L73

    image.SpriteCssClass = images.GetStatusInfoImage(Page).SpriteProperties.CssClass;
    image.SpriteImageUrl = images.SpriteImageUrl;
}

how-to-show-color-icons-for-labels-and-statuses-in-the-appointment-edit-form-and-popup-menu-t344486/CS/CustomFormStatusEditors/DevExpress/ASPxSchedulerForms/RecurrentAppointmentEditForm.ascx.cs#L73

    image.SpriteCssClass = images.GetStatusInfoImage(Page).SpriteProperties.CssClass;
    image.SpriteImageUrl = images.SpriteImageUrl;
}

VB.NET

how-to-show-images-for-tentative-and-working-elsewhere-appointment-statuses-t344062/VB/CustomStatusSample/DevExpress/ASPxSchedulerForms/RecurrentAppointmentEditForm.ascx.vb#L75

    image.SpriteCssClass = images.GetStatusInfoImage(Page).SpriteProperties.CssClass
    image.SpriteImageUrl = images.SpriteImageUrl
End Sub

how-to-show-color-icons-for-labels-and-statuses-in-the-appointment-edit-form-and-popup-menu-t344486/VB/CustomFormStatusEditors/DevExpress/ASPxSchedulerForms/RecurrentAppointmentEditForm.ascx.vb#L75

    image.SpriteCssClass = images.GetStatusInfoImage(Page).SpriteProperties.CssClass
    image.SpriteImageUrl = images.SpriteImageUrl
End Sub