2025.3 Class
Changes 2
C

InCanvasControlData

Description:
Represents a collection of data which is used by to create and update an in-canvas control.
Remarks:

So far, only bitmap file is supported for ImagePath. The rendered image is the same size in pixel dimensions as the original one. To get a better result, the caller should prepare the image with proper size, for exmaple: 32x32 or 64x64 in pixels, before use. To achive a "transparent" backgound color effect over the provided bitmap, the bitmap should use color RGB(0, 128, 128) as its background and it will be cleared during rendering by Revit.

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.InCanvasControlData
public class InCanvasControlData : IDisposable
Name Return Type Description Inherited From
C InCanvasControlData(String) None Constructs an InCanvasControlData with specific values assigned.
C InCanvasControlData(String, XYZ) None Constructs an InCanvasControlData with specific values assigned.
Name Return Type Description Inherited From
M Dispose() None Releases all resources used by the InCanvasControlData
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object
Name Return Type Description Inherited From
P ImagePath string The path to the image file to be used. This must be an absolute path to a location on disk.
P IsValidObject Boolean Specifies whether the .NET object represents a valid Revit entity.
P Position XYZ The position of the in-canvas control in model coordinates.