IExternalLinks

interface

Editor/Vixen.Editor.Core/IExternalLinks.cs:21

csharp

public interface IExternalLinks

Opening a link or a folder in whatever the operating system opens it with.

Read the guide page for this →

Remarks

Published so a module can link out (#1296). The Help menu's five lines, Show in Explorer and a console line's reveal all went through one private Browse on the application over the platform's URL opener; the Help menu is HelpModule's now, and this is the one verb it needed from the host.

⚠ Failure is said, not returned. A link that did not open is a notification naming the link — every caller showed the same one — so Open says it and the caller has nothing to decide. CanOpen is for greying a menu line on a host that has no opener at all.

Fields and properties (1)

bool CanOpen
Whether this host can open anything at all.

Methods (1)

void Open(string url)
Opens a URL — a web page, or a file:// folder — and says so if it could not.

Used by (5)

EditorApplicationVixen.Editor.App
ExternalLinksVixen.Editor.App
HelpAndWorkspaceModuleTestsVixen.Editor.App.Tests
HelpModuleVixen.Editor.App
LibraryModuleVixen.Editor.App