Skip to main content
View as Markdown

IDocumentPreviewManager interface

No description yet.

public interface IDocumentPreviewManager

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Methods​

MethodReturnsDescription
FindPreviewIPreviewImage
InvalidatePreviewvoid
SavePreviewvoid

FindPreview​

No description yet.

IPreviewImage FindPreview(string argDocumentPath, bool argForceGeneration);
ParameterTypePassing
argDocumentPathstringvalue
argForceGenerationboolvalue

Returns: IPreviewImage

Extension method of IDocumentPreviewManagerHelper (using DXP;).

InvalidatePreview​

No description yet.

void InvalidatePreview(IServerDocument argServerDocument);
void InvalidatePreview(object argServerDocument);
ParameterTypePassing
argServerDocumentIServerDocumentvalue

Returns: nothing (void)

The first overload is an extension method of IDocumentPreviewManagerHelper (using DXP;) with typed parameters; the second is declared by the interface.

SavePreview​

No description yet.

void SavePreview(IServerDocument argServerDocument, bool argForceGeneration);
void SavePreview(object argServerDocument, bool argForceGeneration);
ParameterTypePassing
argServerDocumentIServerDocumentvalue
argForceGenerationboolvalue

Returns: nothing (void)

The first overload is an extension method of IDocumentPreviewManagerHelper (using DXP;) with typed parameters; the second is declared by the interface.

Returned by​

IClient.GetDocumentPreviewManager