Skip to content

FileAssociations

Summary

Represents the collection of plugin file associations.

Signature

1
public abstract interface FileAssociations

Namespace

cAlgo.API

Methods

Add (3)

Add (1 of 3)

Summary

Adds a file extension to the list of associations along with a specified icon file path.

Remarks

These file extensions aren't allowed: exe, dll, bat, cmd, msi, ps1, com, sys, inf, ini, iso, img, vmdk, vdi, ova, app, dmg, pkg, command, sh, bin, iso, xcappdata

Signature

1
public abstract void Add(string fileExtension, string iconFilePath)

Parameters

Name Type Description
fileExtension string File extension with dot, ex: .pdf
iconFilePath string Icon file path

Return Value

void

Add (2 of 3)

Summary

Adds a file extension to the list of associations along with a specified icon file path.

Remarks

These file extensions aren't allowed: exe, dll, bat, cmd, msi, ps1, com, sys, inf, ini, iso, img, vmdk, vdi, ova, app, dmg, pkg, command, sh, bin, iso, xcappdata

Signature

1
public abstract void Add(string fileExtension, SvgIcon svgIcon)

Parameters

Name Type Description
fileExtension string File extension with dot, ex: .pdf
svgIcon SvgIcon SVG Icon

Return Value

void

Add (3 of 3)

Summary

Adds a file extension to the list of associations without specifying an icon.

Remarks

These file extensions aren't allowed: exe, dll, bat, cmd, msi, ps1, com, sys, inf, ini, iso, img, vmdk, vdi, ova, app, dmg, pkg, command, sh, bin, iso, xcappdata

Signature

1
public abstract void Add(string fileExtension)

Parameters

Name Type Description
fileExtension string File extension with dot, ex: .pdf

Return Value

void

Contains

Summary

Checks if the specified file extension is already associated.

Signature

1
public abstract bool Contains(string fileExtension)

Parameters

Name Type Description
fileExtension string File extension with dot, ex: .pdf

Return Value

bool

Remove

Summary

Removes a file extension from the list of associations.

Signature

1
public abstract void Remove(string fileExtension)

Parameters

Name Type Description
fileExtension string File extension with dot, ex: .pdf

Return Value

void

Events

FileOpened

Summary

Event triggered when a file associated with a registered extension is opened.

Signature

1
public abstract event Action<FileAssociationsFileOpenedEventArgs> FileOpened;