Class EmbedFileAttribute

Instructs ArmDot to embed a file into output assembly.

Inheritance
object
Attribute
EmbedFileAttribute
Inherited Members
Namespace: ArmDot.Client
Assembly: ArmDot.Client.dll
Syntax
[AttributeUsage(AttributeTargets.Assembly, AllowMultiple = true)]
public class EmbedFileAttribute : Attribute

Constructors

EmbedFileAttribute(string, string)

Instructs ArmDot to embed a file into output assembly.

Declaration
public EmbedFileAttribute(string SourcePath, string RuntimePath)
Parameters
Type Name Description
string SourcePath
string RuntimePath

Properties

RuntimePath

An embedded file is placed to RuntimePath at the output assembly startup.

To place an embedded file to a predefined directory, use the following form of RuntimePath:

$(predefined directory id)\relative path

For example:

[assembly: EmbedFile(SourcePath: "virtual_file_content2.txt", RuntimePath: @"$(AssemblyDirectory)\embedded_file2.txt")]

You can find all possible values of predefined directory id in the list of the predefined directories.

Declaration
public string RuntimePath { get; set; }
Property Value
Type Description
string

SourcePath

Path of the file to embed into an output assembly.

If the path is relative, then the base path is calculated as the following:

  1. If ArmDot builds an ArmDot project, then the base path is a directory path of the project.
  2. If ArmDot's NuGet package ArmDot.Engine.MSBuildTasks is used to build a project, then the base path is a directory path of the project.
Declaration
public string SourcePath { get; set; }
Property Value
Type Description
string