ISch_Image interface
The ISch_Image interfaces are used to represent graphical images on a schematic document.
public interface ISch_Image : ISch_Rectangle
Namespace: SCH · Assembly: Altium.SDK.Interfaces
Inherits: ISch_BasicContainer → ISch_GraphicalObject → ISch_Rectangle
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| EmbedImage | bool | get; set | |
| FileName | string | get; set | |
| KeepAspect | bool | get; set |
EmbedImage
No description yet.
bool GetState_EmbedImage();
void SetState_EmbedImage(bool argValue);
Type: bool · Access: read/write
FileName
No description yet.
string GetState_FileName();
void SetState_FileName(string argValue);
Type: string · Access: read/write
KeepAspect
No description yet.
bool GetState_KeepAspect();
void SetState_KeepAspect(bool argValue);
Type: bool · Access: read/write
Methods
| Method | Returns | Description |
|---|---|---|
| DrawToHDC | void | |
| FullPath | string | |
| SaveImageToFile | void |
DrawToHDC
No description yet.
void DrawToHDC(uint argHandle, int argx, int argy, int argWidth, int argHeight, TPaintColorMode argColorMode);
void DrawToHDC(uint argHandle, int argx, int argy, int argWidth, int argHeight, int argColorMode);
| Parameter | Type | Passing |
|---|---|---|
argHandle | uint | value |
argx | int | value |
argy | int | value |
argWidth | int | value |
argHeight | int | value |
argColorMode | TPaintColorMode | value |
Returns: nothing (void)
The first overload is an extension method of ISch_ImageHelper (using SCH;) with typed parameters; the second is declared by the interface.
FullPath
No description yet.
string FullPath();
Returns: string
SaveImageToFile
No description yet.
void SaveImageToFile(string argFileName);
| Parameter | Type | Passing |
|---|---|---|
argFileName | string | value |
Returns: nothing (void)
Inherited members
- From ISch_Rectangle: Corner, IsSolid, LineWidth, Transparent
- From ISch_GraphicalObject: AddErrorString, AreaColor, BoundingRectangle, BoundingRectangle_Full, Color, CompilationMasked, Dimmed, Disabled, DisplayError, EnableDraw, ErrorColor, ErrorKind, ErrorString, GetHash, GraphicallyInvalidate, LiveHighlightValue, Location, Mirror, MoveByXY, MoveToXY, OwnerPartDisplayMode, OwnerPartId, ResetErrorFields, RotateBy90, Selection, SetState_xSizeySize
- From ISch_BasicContainer: AddAndPositionSchObject, AddSchObject, CopyTo, DeleteAll, DescriptionString, ExportToParameters, FreeAllContainedObjects, Handle, IdentifierString, Import_FromUser, ObjectId, OwnerSchDocument, RemoveSchObject, Replicate, SchBasicContainer, SchIterator_Create, SchIterator_Destroy, SchParameterByName, Setstate_Default, Text, UniqueId, WiringDiagramOriginUniqueId