-
Notifications
You must be signed in to change notification settings - Fork 503
Project file properties
See also: Project-file-properties-dotnet-migration
Android's build properties are documented here.
The AOT mode when AOT-compiling for macOS (this maps to the --aot=VALUE command-line option for mmp).
mmp --help will show all the valid options.
Only applicable to legacy Xamarin.Mac projects.
Any extra libraries to pass to the binding generator to reference when compiling generated source code.
Applicable to all platforms.
.NET: the same.
The location of the built app bundle.
Applicable to all platforms.
.NET: the same.
If set, specifies the CFBundleShortVersionString value in the app manifest (Info.plist).
This is a property that supports .NET "Single Project".
See OneDotNetSingleProject for more information.
Applicable to .NET projects (for all platforms).
If set, specifies the CFBundleIdentifier value in the app manifest (Info.plist).
This is a property that supports .NET "Single Project".
See OneDotNetSingleProject for more information.
Applicable to .NET projects (for all platforms).
If set, specifies the CFBundleDisplayName in the app manifest (Info.plist).
This is a property that supports .NET "Single Project".
See OneDotNetSingleProject for more information.
Applicable to .NET projects (for all platforms).
If set, specifies the CFBundleVersion in the app manifest (Info.plist).
This is a property that supports .NET "Single Project".
See OneDotNetSingleProject for more information.
Applicable to .NET projects (for all platforms).
The location where archives are stored on Windows for a remote build.
The default is: %LocalAppData%\Xamarin\iOS\Archives
Only applicable to iOS and tvOS projects when they're built remotely (from Windows).
.NET: the same.
Specifies whether the binding generator should enable debug information when compiling generated binding code.
Applicable to all platforms.
.NET: the same.
Any extra arguments that should be passed to the binding generator.
Applicable to all platforms.
.NET: the same.
This variable is used internally when building a project remotely from Windows.
This is an extension point for the build: a developer can add any targets to this property to execute those targets before the app bundle is signed.
Applicable to all platforms.
.NET: the same.
The keychain to use during code signing.
Applicable to all platforms.
.NET: the same.
The path to the ResourceRules.plist to copy to the app bundle.
Applicable to all platforms.
.NET: the same.
This variable is used internally when building a project remotely from Windows.
This is an extension point for the build: a developer can add any targets to this property to execute those targets when creating the app bundle.
Applicable to all platforms.
This is an extension point for the build: a developer can add any targets to this property to execute those targets when creating an IPA.
Applicable to all platforms that build IPA archives (currently iOS, tvOS and watchOS).
.NET: the same.
If the build should be specific to the selected device.
Applicable to all platforms that support device-specific builds (currently iOS, tvOS and watchOS).
.NET: the same.
The intermediate output path to use when device-specific builds are enabled.
Applicable to all platforms that support device-specific builds (currently iOS, tvOS and watchOS).
.NET: the same.
The output path to use when device-specific builds are enabled.
Applicable to all platforms that support device-specific builds (currently iOS, tvOS and watchOS).
.NET: the same.
If on-demand resources should be embedded in the app bundle.
Default: true
Applicable to all platforms.
.NET: the same.
If on-demand resources are enabled.
Default: false for macOS, true for all other platforms.
Applicable to all platforms.
.NET: the same.
If an application manifest (Info.plist) should be generated.
Applicable to .NET projects
Where the generated source from the generator are saved.
Applicable to all platforms.
.NET: the same.
The HttpClientHandler to use at runtime.
Applicable to all platforms (although the valid values depend on the platform).
.NET: the same.
If hybrid AOT is enabled for Xamarin.Mac.
Only applicable to legacy Xamarin.Mac projects.
If mobile projects (iOS, tvOS, watchOS) projects should be debugged over WiFi (as opposed to a USB connection).
Only applicable to iOS, tvOS and watchOS projects.
.NET: the same.
If mobile projects (iOS, tvOS, watchOS) projects should be debugged using the USB connection (as opposed to over WiFi).
Only applicable to iOS, tvOS and watchOS projects.
.NET: the same.
The hostname or IP addresses where the app should try to connect when connecting from a mobile device.
This is typically the IP address of the Mac where the debugger is running.
Only applicable to iOS, tvOS and watchOS projects.
.NET: the same.
The port where the app should try to connect when connecting from a mobile device.
This is used in conjunction with the IOSDebuggerHosts property.
Only applicable to iOS, tvOS and watchOS projects.
.NET: the same.
The directory where resources are stored (this prefix will be removed when copying resources to the app bundle).
Applicable to all iOS, tvOS, watchOS and Mac Catalyst projects.
.NET: the same.
See also MonoMacResourcePrefix and XamMacResourcePrefix.
If the Mono runtime should be embedded with the app bundle.
Only applicable to legacy Xamarin.Mac projects.
If artwork should be included in the IPA.
Only applicable to iOS, tvOS and watchOS projects.
.NET: the same.
If a project is an app extension.
Applicable to all platforms.
.NET: the same.
If a project is a binding project.
Applicable to all platforms.
.NET: the same.
Determines whether the current build (if a remote build) is connected to a Mac.
Applicable to all platforms that support remote builds (currently iOS, tvOS and watchOS).
If a project is a watch app project.
Only applicable to watchOS.
If a project is a watch extension project.
Only applicable to watchOS.
If a Xamarin.Mac extension is an xpc service.
Only applicable to macOS projects.
.NET: the same.
Specifies the link mode for the project (None, SdkOnly, Full).
Applicable to macOS projects.
.NET: the same.
See also MtouchLink.
If set to true, the build will tell the native linker where to find Swift's system libraries.
This is useful when a native library uses Swift somehow, in which case the native linker needs to know where to find Swift's system libraries.
Currently this means these arguments will be passed to the native linker:
- -L/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/[platform]
- -L/Applications/Xcode.app/Contents/Developer/Platforms/[platform].platform/Developer/SDKs/[platform].sdk/usr/lib/swift
Other arguments may be added in the future.
The item group ReferenceNativeSymbol can be used to specify how we should
handle a given native symbol: either ignore it, or ask the native linker to
keep it (by passing the symbol as -u ... or in a symbol file to the native
linker).
There are two supported types of metadata:
-
SymbolType: eitherObjectiveCClass,FunctionorField. Used to compute the complete native name of a symbol (for instance, the native symbol for the Objective-C classMyClassis_OBJC_CLASS_$_MyClass, while for a functionMyFunctionit's just_MyFunction. -
SymbolMode: eitherIgnoreor not set.Ignoremeans to not pass the given symbol to the native linker, the default is to do so.
SymbolType is required, while SymbolMode isn't.
Example symbol to keep:
<ItemGroup>
<ReferenceNativeSymbol Include="MyClass" SymbolType="ObjectiveCClass" />
</ItemGroup>Example symbol to ignore:
<ItemGroup>
<ReferenceNativeSymbol Include="MyClass" SymbolType="ObjectiveCClass" SymbolMode="Ignore" />
</ItemGroup>We will automatically scan all libraries for managed classes that map to existing Objective-C classes, and then create a native reference at build time for those Objective-C classes.
This way the native linker won't remove these Objective-C classes, thinking they're not used.
However, this can cause a problem if a managed class references an Objective-C class that doesn't exist. The proper fix for this is to remove such managed classes from the build, but this may be cumbersome, in particular if the managed class comes from a binary reference (such as NuGet).
In these cases, it's possible to set the property
RequireLinkWithAttributeForObjectiveCClassSearch to true so that we'll
only scan libraries with the [LinkWith] attribute for Objective-C classes:
<PropertyGroup>
<RequireLinkWithAttributeForObjectiveCClassSearch>true</RequireLinkWithAttributeForObjectiveCClassSearch>
</PropertyGroup>The macOS SDK version to use for the build.
Default: automatically detected according to the default version shipped with the selected Xcode.
.NET: the same.
See also MtouchSdkVersion.
Applicable to legacy Xamarin.Mac projects.
Enables debug mode for app bundle creation.
Applicable to macOS projects.
.NET: the same.
See also MtouchDebug.
Additional arguments to mmp specifying how to create the app bundle.
Applicable to macOS projects.
.NET: some arguments are still applicable, some are not.
See also MtouchExtraArgs.
The directory where resources are stored (this prefix will be removed when copying resources to the app bundle).
Applicable to macOS projects.
.NET: the same.
See also IPhoneResourcePrefix and XamMacResourcePrefix.
A boolean property which controls whether .mSYM artifacts are created for
later use with mono-symbolicate, to extract “real” filename and line number
information from Release stack traces.
Only applicable to legacy Xamarin projects.
The location of the Xamarin.iOS SDK.
Also possible to override with the MD_MTOUCH_SDK_ROOT environment variable.
Default: /Library/Frameworks/Xamarin.iOS.framework/Versions/Current
Only applicable to legacy Xamarin.iOS projects.
Enables debug mode for app bundle creation.
Applicable to iOS, tvOS, watchOS and Mac Catalyst projects.
.NET: the same.
See also MmpDebug.
A boolean property that specifies whether bitcode should be generated.
Only applicable to tvOS and watchOS projects.
.NET: the same.
A boolean property that specifies whether incremental builds should be enabled.
Only applicable to legacy Xamarin.iOS (iOS, tvOS and watchOS) projects.
Specifies the link mode for the project (None, SdkOnly, Full).
Applicable to iOS, tvOS, watchOS and Mac Catalyst projects.
.NET: the same.
See also LinkMode.
A boolean property that specifies whether .dSYM generatiorn should be disabled.
Only applicable to iOS, tvOS, watchOS and Mac Catalyst projects.
.NET: the same.
A boolean property that specifies whether native symbol stripping should be disabled.
Only applicable to iOS, tvOS, watchOS and Mac Catalyst projects.
.NET: the same.
A boolean property that specifies whether profiling should be enabled.
Only applicable to legacy Xamarin.iOS (iOS, tvOS and watchOS) projects.
See also Profiling.
The iOS, tvOS or watchOS SDK version to use for the build.
Default: automatically detected according to the default version shipped with the selected Xcode.
.NET: the same.
See also MacOSXSdkVersion.
A boolean property that specifies whether native code generation should be done using LLVM.
Applicable to iOS, tvOS and watchOS projects.
.NET: the same.
For .NET, LLVM is enabled by default for release builds.
A boolean property that specifies whether thumb ARMv7 code should be generated.
Only applicable to legacy Xamarin.iOS (iOS, tvOS and watchOS) projects.
A number that specifies the verbosity during parts of the build.
Only applicable to legacy Xamarin.iOS (iOS, tvOS and watchOS) projects.
The namespace to use for generated binding code.
Applicable to all platforms.
.NET: the same.
A boolean property that specifies whether native libraries should be embedded in the managed assembly when binding those native libraries.
Applicable to all platforms.
.NET: The same.
A string property that specifies the initial install tags for on-demand resources.
Applicable to all platforms.
.NET: The same.
A string property that specifies the prefetch order for on-demand resources.
Applicable to all platforms.
.NET: The same.
A string property that specifies the resource url for on-demand resources.
Applicable to all platforms.
.NET: The same.
A boolean property that specifies whether png images should be optimized.
Applicable to all platforms.
.NET: The same.
This is an extension point for the build: a developer can add any targets to this property to execute those targets before any png images are optimized.
Applicable to all platforms.
.NET: the same.
A boolean property that specifies whether property lists (plists) should be optimized.
Applicable to all platforms.
.NET: The same.
This is an extension point for the build: a developer can add any targets to this property to execute those targets before any property lists (plists) are optimized.
Applicable to all platforms.
.NET: the same.
A boolean property that specifies whether enums should be processed as an api definition in binding projects.
Applicable to all platforms.
.NET: The same.
A boolean property that specifies whether profiling should be enabled.
Only applicable to legacy Xamarin.Mac projects.
See also MtouchProfiling.
The architecture(s) to build for.
Applicable to all projects.
.NET: N/A, uses RuntimeIdentifier instead.
A boolean property that specifies if a hardened runtime is enabled.
Applicable to macOS and Mac Catalyst projects.
.NET: the same.
A boolean property that specifies whether a Xamarin.Mac project should reference the full .NET framework.
Only applicable to legacy Xamarin.Mac projects.
A boolean property that specifies whether we're building for .NET or legacy Xamarin.
Applicable to all projects.
The directory where resources are stored (this prefix will be removed when copying resources to the app bundle).
Applicable to macOS projects.
.NET: the same.
See also IPhoneResourcePrefix and MonoMacResourcePrefix.
The location of the Xamarin.Mac SDK.
Also possible to override with the XAMMAC_FRAMEWORK_PATH environment variable.
Default: /Library/Frameworks/Xamarin.Mac.framework/Versions/Current
Only applicable to legacy Xamarin.Mac projects.
Additional arguments to mtouch specifying how to create the app bundle.
Applicable to iOS, tvOS, watchOS and Mac Catalyst projects.
.NET: some arguments are still applicable, some are not.
See also MonoBundlingExtraArgs.
The architecture(s) to build for.
Applicable to iOS, tvOS, watchOS projects.
.NET: N/A, uses RuntimeIdentifier instead.
See also XamMacArch.
The architecture(s) to build for.
Applicable to macOS projects.
.NET: N/A, uses RuntimeIdentifier instead.
Selects which HttpClientHandler will be the default.
- MtouchHttpClientHandler: applicable to iOS, tvOS and watchOS projects.
- HttpClientHandler: applicable to macOS projects.
Different platforms have different valid values:
- iOS: "HttpClientHandler", "NSUrlSessionHandler" or "CFNetworkHandler"
- tvOS: "HttpClientHandler" or "NSUrlSessionHandler"
- watchOS: only "NSUrlSessionHandler"
- macOS: "HttpClientHandler" or "NSUrlSessionHandler"
.NET: N/A, use UseNativeHttpHandler to select which HttpClientHandler implementation to use.
Enables the concurrent mode for the SGen garbage collector.
- iOS, tvOS, watchOS: historically used MtouchEnableSGenConc, but it's recommended to use EnableSGenConc.
- macOS: uses EnableSGenConc.
Applicable to all platforms.
Only applicable when using MonoVM (not when using CoreCLR).
.NET: the same
If an Xcode archive should be created at the end of the build.
Applicable to all platforms.
.NET: the same.
If code signing is enabled.
Applicable only to macOS and Mac Catalyst apps (for other platforms we automatically determine if signing is required or not).
.NET: the same.
If the .pkg that was created (if CreatePackage was enabled) should be signed.
Applicable only to macOS and Mac Catalyst projects.
.NET: the same
If a package (.ipa) should be created for the app bundle at the end of the build.
Applicable only to iOS and tvOS projects.
.NET: the same
If a package (.pkg) should be created for the app bundle at the end of the build.
Applicable only to macOS and Mac Catalyst projects.
.NET: the same
Specifies the code signing key to use.
Applicable only to macOS and Mac Catalyst apps, but it's recommended to use CodesignKey instead.
.NET: use CodesignKey instead
Specifies the code signing key to use.
Applicable to all platforms.
.NET: the same
Specifies the provisioning profile to use when signing the app bundle.
Applicable to all platforms.
.NET: the same.
Specifies whether a provisioning profile is required when signing the app bundle.
By default we require a provisioning profile if:
- macOS, Mac Catalyst: a provisioning profile has been specified (with the CodesignProvision property).
- iOS, tvOS, watchOS: building for device or an entitlements file has been specified (with the CodesignEntitlements property).
Setting this property to true or false will override the default logic.
.NET: the same
The path to the entitlements file that specifies the entitlements the app requires.
Typically "Entitlements.plist".
In .NET 7+ we'll automatically set this to "Entitlements.plist" if such a file exists in the project root directory.
This can be prevented by setting the EnableDefaultCodesignEntitlements property to false.
Applicable to all platforms.
.NET: the same.
Extra arguments passed to the 'codesign' tool when signing the app bundle.
Applicable to all platforms.
.NET: the same.
See CodesignEntitlements.
Specifies the code signing key to sign the package when creating .pkg for a macOS and Mac Catalyst project.
Applicable only to macOS and Mac Catalyst apps.
.NET: the same.
Specifies any extra arguments to pass to the 'productbuild' tool when creating .pkg for a macOS and Mac Catalyst project.
Applicable only to macOS and Mac Catalyst apps.
.NET: the same.
Applicable only to macOS and Mac Catalyst apps.
.NET: the same.
Specifies the path to the resulting .ipa file when creating an IPA package (see BuildIpa).
Applicable only to iOS and tvOS projects.
.NET: the same
Specifies the name of the resulting .ipa file (without the path) when creating an IPA package (see BuildIpa). IpaPackagePath will override this value.
Applicable only to iOS and tvOS projects.
.NET: the same
Specifies the directory of the resulting .ipa file when creating an IPA package (see BuildIpa). IpaPackagePath will override this value.
Applicable only to iOS and tvOS projects.
.NET: the same
Specifies the path to the resulting .pkg file when creating a package (see CreatePackage).
Applicable only to macOS and Mac Catalyst apps.
.NET: the same.
Determines whether 32-bit float operations should be done using 64-bit floating point math.
Disabling this option can have a hefty performance cost, especially on mobile platforms, where double precision math is considerably slower than single precision math.
Note that .NET uses double precision internally, even for float, so enabling this option affects precision and, possibly, compatibility.
Applicable to all platforms (when doing AOT compilation).
.NET: the same.
Enables the interpreter, and optionally takes a comma-separated list of assemblies to interpret (if prefixed with a minus sign, the assembly will be AOT-compiled instead). 'all' can be used to specify all assemblies. This argument can be specified multiple times.
Example:
-
all: interpret all the assemblies. -
System: AOT-compile all assemblies, except System.dll, which will be interpreted. -
all,-System.Core: interpret all assemblies, except System.Core.dll, which will be AOT-compiled.
Applicable to iOS, tvOS, watchOS and Mac Catalyst apps.
.NET: the same.
Specifies the minimum OS version the app can run on.
Applicable to iOS, tvOS, watchOS and Mac Catalyst apps.
This is only applicable to .NET projects.
Specifies the minimum iOS version the app can run on.
Applicable to iOS; setting this value will set SupportedOSPlatformVersion for iOS projects (only).
This is only applicable to .NET projects.
Specifies the minimum tvOS version the app can run on.
Applicable to tvOS; setting this value will set SupportedOSPlatformVersion for tvOS projects (only).
This is only applicable to .NET projects.
Specifies the minimum macOS version the app can run on.
Applicable to macOS; setting this value will set SupportedOSPlatformVersion for macOS projects (only).
This is only applicable to .NET projects.
Specifies the minimum Mac Catalyst (iOS) version the app can run on.
Applicable to Mac Catalyst; setting this value will set SupportedOSPlatformVersion for Mac Catalyst projects (only).
This is only applicable to .NET projects.
Enables the interpreter (for all assemblies).
This is equivalent to setting MtouchInterpreter=all.
Applicable to iOS, tvOS, watchOS and Mac Catalyst apps.
.NET: the same.
Android's build items are documented here.
An item group that contains any additional app extensions to copy into the app bundle.
Applicable to all platforms.
.NET: the same.
An item group that contains atlas textures.
Applicable to all platforms.
.NET: the same.
Files to be copied to the app bundle.
Applicable to all platforms.
.NET: the same
Additional bundles inside the final app that should be signed.
The purpose is to include in the app signing any other bundles that are copied manually (for instance through custom MSBuild targets during the build) to the app bundle.
The path to include is the path to the app bundle to sign inside the main app bundle, including the app bundle name itself.
Example:
<ItemGroup>
<CodesignBundle Include="$(AssemblyName).app/Contents/SharedSupport/MyCustomBundle.app" />
</ItemGroup>There are several metadata that can be set on the CodesignBundle item to direct how signing occurs:
- CodesignAllocate
- CodesignEntitlements
- CodesignExtraArgs
- CodesignKeychain
- CodesignResourceRules
- CodesignSigningKey
- CodesignUseHardenedRuntime
- CodesignUseSecureTimestamp
Example:
<ItemGroup>
<CodesignBundle Include="$(AssemblyName).app/Contents/SharedSupport/MyCustomBundle.app">
<CodesignEntitlements>path/to/Entitlements.plist</CodesignEntitlements>
</CodesignBundle>
</ItemGroup>Any metadata not set will use the corresponding property instead (for instance if the CodesignSigningKey metadata is not set, the value of the CodesignSigningKey property will be used instead.)
Introduced in .NET 7.
Applicable to all platforms.
An item group that contains atlas assets.
Applicable to all platforms.
.NET: the same.
Resources (files) to be copied to the app bundle.
They will be placed in the the following directory inside the app bundle:
- /Resources: iOS, tvOS, watchOS
- /Contents/Resources: macOS, Mac Catalyst
It's possible to set the Link metadata to a path relative to the target
directory to change the location in the app bundle.
Example:
<ItemGroup>
<Content Include="Readme.txt" Link="Documentation/Readme.txt" />
</ItemGroup>would place the file in the following location:
- /Resources/Documentation/Readme.txt: iOS, tvOS, watchOS
- /Contents/Resources/Documentation/Readme.txt: macOS, Mac Catalyst
Applicable to all platforms.
.NET: the same
An item group that contains CoreML models.
Applicable to all platforms.
.NET: the same.
An item group that contains iTunes artwork for IPAs.
Applicable to all iOS, tvOS and watchOS.
.NET: the same.
An item group that contains iTunes metadata for IPAs.
Applicable to all iOS, tvOS and watchOS.
.NET: the same.
An item group that contains image assets.
Applicable to all platforms.
.NET: the same.
An item group that contains interface definitions (*.xib or *.storyboard files).
Applicable to all platforms.
.NET: the same.
Additional xml files to the managed linker.
Applicable to all platforms.
.NET: the same
An item group that contains metal assets.
Applicable to all platforms.
.NET: the same.
An item group that contains any native references that should be linked into or linked with when building the native executable.
Applicable to all platforms.
.NET: the same.
An item group that lists all the API definitions for binding projects.
Applicable to all platforms.
.NET: the same.
An item group that lists all the core source code for binding projects.
Applicable to all platforms.
.NET: the same.
An item group that lists all the native frameworks that should be included in a binding project.
Applicable to all platforms.
.NET: the same.
An item group that lists all the native libraries that should be included in a binding project.
Applicable to all platforms.
.NET: the same.
Additional partial app manifests that will be merged with the main app manifest (Info.plist).
Any values in the partial app manifests will override values in the main app manifest.
If the same value is specified in multiple partial app manifests, it's undetermined which one will be the one used.
If the developer needs to execute a target to compute what to add to the PartialAppManifest item group, it's possible to make sure this target is executed before the PartialAppManifest items are procesed by adding it to the CollectAppManifestsDependsOn property:
<PropertyGroup>
<CollectAppManifestsDependsOn>
AddPartialAppManifests;
$(CollectAppManifestsDependsOn);
</CollectAppManifestsDependsOn>
</PropertyGroup>
<Target Name="AddPartialAppManifests">
<ItemGroup>
<PartialAppManifest Include="MyPartialAppManifest.plist" />
</ItemGroup>
</Target>Applicable to all platforms.
.NET: the same
An item group that contains SceneKit assets.
Applicable to all platforms.
.NET: the same.
An item group that specifies files or directories in the app bundle that should not be signed.
The purpose is to exclude from signing files and directories that are copied manually (for instance through custom MSBuild targets in the project file) to the app bundle, and which are already signed.
The path to include is the path to the file or directory relative to the root of the app bundle.
Example:
<ItemGroup>
<SkipCodesignItems Include="Contents/SharedSupport/mysignedlibrary.dylib" />
</ItemGroup>Applicable to all platforms.
.NET: the same.
- README
- xcode13.0 Binding Status
- xcode13.1 Binding Status
- xcode13.2 Binding Status
- xcode13.3 Binding Status
- xcode13.4 Binding Status
- xcode14.0 Binding Status
- xcode14.1 Binding Status
- xcode14.2 Binding Status
- xcode14.3 Binding Status
- xcode15.0 Binding Status
- xcode15.1 Binding Status
- xcode15.3 Binding Status
- xcode15.4 Binding Status