IDocumentPreviewHint interface
No description yet.
public interface IDocumentPreviewHint
Namespace: DXP · Assembly: Altium.SDK.Interfaces
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| ActivatedPath | string | get | |
| ActivatedPos | Point | get |
ActivatedPath
No description yet.
string Get_ActivatedPath();
Type: string · Access: read-only
ActivatedPos
No description yet.
Point Get_ActivatedPos();
Type: Point · Access: read-only
The accessors are extension methods of IDocumentPreviewHintHelper (using DXP;).
Methods
| Method | Returns | Description |
|---|---|---|
| ActivateDocumentChooser | void | |
| ActivateDocumentPath | void | |
| ActivateDocumentPreview | void | |
| DeActivate | void |
ActivateDocumentChooser
No description yet.
void ActivateDocumentChooser(string argProjectPath, Point argPos);
void ActivateDocumentChooser(string argProjectPath, IPoint argPos);
| Parameter | Type | Passing |
|---|---|---|
argProjectPath | string | value |
argPos | Point | value |
Returns: nothing (void)
The first overload is an extension method of IDocumentPreviewHintHelper (using DXP;) with typed parameters; the second is declared by the interface.
ActivateDocumentPath
No description yet.
void ActivateDocumentPath(string argDocumentPath, Point argPos);
void ActivateDocumentPath(string argDocumentPath, IPoint argPos);
| Parameter | Type | Passing |
|---|---|---|
argDocumentPath | string | value |
argPos | Point | value |
Returns: nothing (void)
The first overload is an extension method of IDocumentPreviewHintHelper (using DXP;) with typed parameters; the second is declared by the interface.
ActivateDocumentPreview
No description yet.
void ActivateDocumentPreview(string argDocumentPath, Point argPos, int argMouseGap);
void ActivateDocumentPreview(string argDocumentPath, IPoint argPos, int argMouseGap);
| Parameter | Type | Passing |
|---|---|---|
argDocumentPath | string | value |
argPos | Point | value |
argMouseGap | int | value |
Returns: nothing (void)
The first overload is an extension method of IDocumentPreviewHintHelper (using DXP;) with typed parameters; the second is declared by the interface.
DeActivate
No description yet.
void DeActivate(bool argImmediate);
| Parameter | Type | Passing |
|---|---|---|
argImmediate | bool | value |
Returns: nothing (void)