IGridSetting interface
The IGridSetting interface represents the grid settings for the Schematic documents part of a project.
public interface IGridSetting
Namespace: SCH · Assembly: Altium.SDK.Interfaces
Remarks
The IGridSetting interface hierarchy is a standalone.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| HotspotGridOn | bool | get; set | This method determines whether the hot spot grid is enabled or not and returns a true or false value. |
| HotspotGridSize | int | get; set | This method determines the size of the hot spot grid size. |
| SnapGridOn | bool | get; set | |
| SnapGridSize | int | get; set | |
| VisibleGridOn | bool | get; set | |
| VisibleGridSize | int | get; set |
HotspotGridOn
This method determines whether the hot spot grid is enabled or not and returns a true or false value.
bool GetState_HotspotGridOn();
void SetState_HotspotGridOn(bool argB);
Type: bool · Access: read/write
HotspotGridSize
This method determines the size of the hot spot grid size.
int GetState_HotspotGridSize();
void SetState_HotspotGridSize(int argC);
Type: int · Access: read/write
SnapGridOn
No description yet.
bool GetState_SnapGridOn();
void SetState_SnapGridOn(bool argB);
Type: bool · Access: read/write
SnapGridSize
No description yet.
int GetState_SnapGridSize();
void SetState_SnapGridSize(int argC);
Type: int · Access: read/write
VisibleGridOn
No description yet.
bool GetState_VisibleGridOn();
void SetState_VisibleGridOn(bool argB);
Type: bool · Access: read/write
VisibleGridSize
No description yet.
int GetState_VisibleGridSize();
void SetState_VisibleGridSize(int argC);
Type: int · Access: read/write
Methods
| Method | Returns | Description |
|---|---|---|
| CopyTo | void | |
| SameAs | bool |
CopyTo
No description yet.
void CopyTo(IGridSetting argGridSetting);
void CopyTo(object argGridSetting);
| Parameter | Type | Passing |
|---|---|---|
argGridSetting | IGridSetting | value |
Returns: nothing (void)
The first overload is an extension method of IGridSettingHelper (using SCH;) with typed parameters; the second is declared by the interface.
SameAs
No description yet.
bool SameAs(IGridSetting argGridSetting);
bool SameAs(object argGridSetting);
| Parameter | Type | Passing |
|---|---|---|
argGridSetting | IGridSetting | value |
Returns: bool
The first overload is an extension method of IGridSettingHelper (using SCH;) with typed parameters; the second is declared by the interface.