C# Class Microsoft.VisualStudio.R.Package.ProjectProperties

Inheritance: StronglyTypedPropertyAccess, IRProjectProperties

Public Methods

Method	Description
GetCommandLineArgsAsync ( ) : Task	Gets command line arguments of the application.
GetFileFilterAsync ( ) : Task	Gets the filter string that selects files to be sent to remote host. Default filter string is ".r;.rmd;". This selects all R script files, R markdown files.
GetProjectName ( ) : string	Gets the current project name.
GetRFilePaths ( ) : IEnumerable	Gets all the R script files in the current project.
GetRemoteProjectPathAsync ( ) : Task	Gets the destination path for a project on the remote host. Default destination is ~/
GetResetReplOnRunAsync ( ) : Task	Defines if REPL is to be reset before starting the application.
GetSettingsFileAsync ( ) : Task	Sets R path to the settings file. Settings file contains project settings as R code. The file is to be sourced before running the application. Null means no settings are defined. In order to read the actual settings, use ConfigurationSettingCollection
GetStartupFileAsync ( ) : Task	Defines which file contains the application entry point.
GetTransferProjectOnRunAsync ( ) : Task	Defines if project has to be transfered to remote host during run.
SetCommandLineArgsAsync ( string val ) : System.Threading.Tasks.Task	Sets command line arguments of the application.
SetFileFilterAsync ( string fileTransferFilter ) : System.Threading.Tasks.Task	Gets the filter string that selects files to be sent to remote host. Default filter string is ".r;.rmd;". This selects all R script files, R markdown files.
SetRemoteProjectPathAsync ( string remoteProjectPath ) : System.Threading.Tasks.Task	Gets the destination path for a project on the remote host. Default destination is ~/RTVSProjects/.
SetResetReplOnRunAsync ( bool val ) : System.Threading.Tasks.Task	Defines if REPL is to be reset before starting the application.
SetSettingsFileAsync ( string rFilePath ) : System.Threading.Tasks.Task	Gets R path to the settings file. Settings file contains project settings as R code. The file is to be sourced before running the application. Null means no settings are defined. In order to read the actual settings, use ConfigurationSettingCollection
SetStartupFileAsync ( string val ) : System.Threading.Tasks.Task	Defines which file contains the application entry point.
SetTransferProjectOnRunAsync ( bool val ) : System.Threading.Tasks.Task	Defines if project has to be transfered to remote host during run.

Private Methods

Method	Description
ParseBooleanProperty ( string propertyText, bool defaultVal ) : bool
ProjectProperties ( ConfiguredProject configuredProject ) : System.ComponentModel.Composition

Method Details

GetCommandLineArgsAsync() public method

Gets command line arguments of the application.

public GetCommandLineArgsAsync ( ) : Task
return	Task

GetFileFilterAsync() public method

Gets the filter string that selects files to be sent to remote host.

Default filter string is ".r;.rmd;". This selects all R script files, R markdown files.

public GetFileFilterAsync ( ) : Task
return	Task

GetProjectName() public method

Gets the current project name.

public GetProjectName ( ) : string
return	string

GetRFilePaths() public method

Gets all the R script files in the current project.

public GetRFilePaths ( ) : IEnumerable
return	IEnumerable

GetRemoteProjectPathAsync() public method

Gets the destination path for a project on the remote host.

Default destination is ~/

public GetRemoteProjectPathAsync ( ) : Task
return	Task

GetResetReplOnRunAsync() public method

Defines if REPL is to be reset before starting the application.

public GetResetReplOnRunAsync ( ) : Task
return	Task

GetSettingsFileAsync() public method

Sets R path to the settings file.

Settings file contains project settings as R code. The file is to be sourced before running the application. Null means no settings are defined. In order to read the actual settings, use ConfigurationSettingCollection

public GetSettingsFileAsync ( ) : Task
return	Task

GetStartupFileAsync() public method

Defines which file contains the application entry point.

public GetStartupFileAsync ( ) : Task
return	Task

GetTransferProjectOnRunAsync() public method

Defines if project has to be transfered to remote host during run.

public GetTransferProjectOnRunAsync ( ) : Task
return	Task

SetCommandLineArgsAsync() public method

Sets command line arguments of the application.

public SetCommandLineArgsAsync ( string val ) : System.Threading.Tasks.Task
val	string
return	System.Threading.Tasks.Task

SetFileFilterAsync() public method

Gets the filter string that selects files to be sent to remote host.

Default filter string is ".r;.rmd;". This selects all R script files, R markdown files.

public SetFileFilterAsync ( string fileTransferFilter ) : System.Threading.Tasks.Task
fileTransferFilter	string
return	System.Threading.Tasks.Task

SetRemoteProjectPathAsync() public method

Gets the destination path for a project on the remote host.

Default destination is ~/RTVSProjects/.

public SetRemoteProjectPathAsync ( string remoteProjectPath ) : System.Threading.Tasks.Task
remoteProjectPath	string
return	System.Threading.Tasks.Task

SetResetReplOnRunAsync() public method

Defines if REPL is to be reset before starting the application.

public SetResetReplOnRunAsync ( bool val ) : System.Threading.Tasks.Task
val	bool
return	System.Threading.Tasks.Task

SetSettingsFileAsync() public method

Gets R path to the settings file.

public SetSettingsFileAsync ( string rFilePath ) : System.Threading.Tasks.Task
rFilePath	string
return	System.Threading.Tasks.Task

SetStartupFileAsync() public method

Defines which file contains the application entry point.

public SetStartupFileAsync ( string val ) : System.Threading.Tasks.Task
val	string
return	System.Threading.Tasks.Task

SetTransferProjectOnRunAsync() public method

Defines if project has to be transfered to remote host during run.

public SetTransferProjectOnRunAsync ( bool val ) : System.Threading.Tasks.Task
val	bool
return	System.Threading.Tasks.Task