FileAssociations.Add

method · FileAssociations · cAlgo.API Since 5.1

DesktopCLICloud

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

Environment behaviour

CLI — not supported. Available to plugins only, and plugins cannot run in the CLI.

Cloud — not supported. Available to plugins only, and plugins cannot run in the cloud.

Overloads

Signature	Description
`Add(string fileExtension, string iconFilePath)`	Adds a file extension to the list of associations along with a specified icon file path.
`Add(string fileExtension, SvgIcon svgIcon)`	Adds a file extension to the list of associations along with a specified icon file path.
`Add(string fileExtension)`	Adds a file extension to the list of associations without specifying an icon.

Add(string fileExtension, string iconFilePath)

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

C#Python

void Add(string fileExtension, string iconFilePath)

api.FileAssociations.Add(fileExtension: str, iconFilePath: str) -> None

Parameters

Name	C# type	Python type	Description
`fileExtension`	`string`	`str`	File extension with dot, ex: .pdf
`iconFilePath`	`string`	`str`	Icon file path

Examples

C#Python

FileAssociations.Add(".mydata", @"C:\Users\Me\Documents\icons\mydata.ico");
Print("Associated: {0}", FileAssociations.Contains(".mydata"));

api.FileAssociations.Add(".mydata", r"C:\Users\Me\Documents\icons\mydata.ico")
api.Print(f"Associated: {api.FileAssociations.Contains('.mydata')}")

Add(string fileExtension, SvgIcon svgIcon)

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

C#Python

void Add(string fileExtension, SvgIcon svgIcon)

api.FileAssociations.Add(fileExtension: str, svgIcon: SvgIcon) -> None

Parameters

Name	C# type	Python type	Description
`fileExtension`	`string`	`str`	File extension with dot, ex: .pdf
`svgIcon`	`SvgIcon`	`SvgIcon`	SVG Icon

Examples

C#Python

var icon = new SvgIcon("<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16'><circle cx='8' cy='8' r='6' fill='#2F4BFF' /></svg>");
FileAssociations.Add(".mydata", icon);
Print("Associated: {0}", FileAssociations.Contains(".mydata"));

icon = SvgIcon("<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16'><circle cx='8' cy='8' r='6' fill='#2F4BFF' /></svg>")
api.FileAssociations.Add(".mydata", icon)
api.Print(f"Associated: {api.FileAssociations.Contains('.mydata')}")

Add(string fileExtension)

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

C#Python

void Add(string fileExtension)

api.FileAssociations.Add(fileExtension: str) -> None

Parameters

Name	C# type	Python type	Description
`fileExtension`	`string`	`str`	File extension with dot, ex: .pdf

Examples

C#Python

FileAssociations.Add(".mydata");
foreach (var fileExtension in FileAssociations)
    Print("Associated extension: {0}", fileExtension);

api.FileAssociations.Add(".mydata")
for fileExtension in api.FileAssociations:
    api.Print(f"Associated extension: {fileExtension}")