Interface VisualStudioProject

All Superinterfaces:
Buildable, Named

public interface VisualStudioProject extends Named, Buildable
A visual studio project, created from one or more native binaries.

The content and location of the generate project file can be modified by the supplied methods:

 plugins {
     id 'visual-studio'
 }

 visualStudio {
     projects.all {
         projectFile.location = "vs/${name}.vcxproj"
         projectFile.withXml {
             asNode().appendNode('PropertyGroup', [Label: 'Custom'])
                     .appendNode('ProjectDetails', "Project is named ${project.name}")
         }
     }
 }
Since:
1.11
  • Method Details

    • getProjectFile

      @Incubating XmlConfigFile getProjectFile()
      Configuration for the generated project file.
      Since:
      1.11
    • getFiltersFile

      @Incubating XmlConfigFile getFiltersFile()
      Configuration for the generated filters file.
      Since:
      1.11
    • getBuildDependencies

      @Incubating TaskDependency getBuildDependencies()
      Description copied from interface: Buildable
      Returns a dependency which contains the tasks which build this artifact. All Buildable implementations must ensure that the returned dependency object is live, so that it tracks changes to the dependencies of this buildable.
      Specified by:
      getBuildDependencies in interface Buildable
      Returns:
      The dependency. Never returns null. Returns an empty dependency when this artifact is not built by any tasks.
    • getName

      String getName()
      Description copied from interface: Named
      The object's name.

      Must be constant for the life of the object.

      Implementations should not declare a Object.toString() that returns anything other than this name. Gradle derives the name from this method wherever it needs one, but renders the object with toString() in diagnostics, so the two disagreeing produces output that contradicts the behavior it describes. This is easy to miss on an enum, which inherits a toString() returning Enum.name().

      Specified by:
      getName in interface Named
      Returns:
      The name. Never null.