From 9ea6d00b5a219b5f60a68bddd22bc8a8947ecec4 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Mon, 30 Mar 2026 15:58:02 -0700 Subject: [PATCH 1/6] System.Xaml and System.Xml --- .../XamlLoadPermission.xml | 104 +- xml/System.Xaml.Schema/XamlMemberInvoker.xml | 10 +- xml/System.Xaml.Schema/XamlTypeInvoker.xml | 16 +- xml/System.Xaml.Schema/XamlTypeName.xml | 104 +- .../XamlValueConverter`1.xml | 18 +- xml/System.Xaml/AmbientPropertyValue.xml | 38 +- .../AttachablePropertyServices.xml | 34 +- xml/System.Xaml/IAmbientProvider.xml | 10 +- xml/System.Xaml/IDestinationTypeProvider.xml | 8 +- xml/System.Xaml/IXamlNameResolver.xml | 4 +- xml/System.Xaml/IXamlObjectWriterFactory.xml | 10 +- xml/System.Xaml/NamespaceDeclaration.xml | 2 +- xml/System.Xaml/XamlDirective.xml | 10 +- xml/System.Xaml/XamlMember.xml | 100 +- xml/System.Xaml/XamlNodeList.xml | 48 +- xml/System.Xaml/XamlObjectEventArgs.xml | 10 +- xml/System.Xaml/XamlObjectReader.xml | 6 +- xml/System.Xaml/XamlObjectWriter.xml | 30 +- xml/System.Xaml/XamlObjectWriterSettings.xml | 110 +- xml/System.Xaml/XamlReader.xml | 188 +- xml/System.Xaml/XamlSchemaContext.xml | 154 +- xml/System.Xaml/XamlSchemaContextSettings.xml | 20 +- xml/System.Xaml/XamlServices.xml | 18 +- xml/System.Xaml/XamlType.xml | 154 +- xml/System.Xaml/XamlWriter.xml | 72 +- xml/System.Xaml/XamlXmlReader.xml | 10 +- xml/System.Xaml/XamlXmlWriter.xml | 160 +- xml/System.Xaml/XamlXmlWriterSettings.xml | 20 +- xml/System.Xml.Linq/Extensions.xml | 4106 ++++++++--------- xml/System.Xml.Linq/XAttribute.xml | 44 +- xml/System.Xml.Linq/XContainer.xml | 3152 ++++++------- xml/System.Xml.Linq/XDeclaration.xml | 2 +- xml/System.Xml.Linq/XDocument.xml | 52 +- xml/System.Xml.Linq/XDocumentType.xml | 2 +- xml/System.Xml.Linq/XElement.xml | 90 +- xml/System.Xml.Linq/XName.xml | 4 +- xml/System.Xml.Linq/XNamespace.xml | 2 +- xml/System.Xml.Linq/XNode.xml | 54 +- .../XNodeDocumentOrderComparer.xml | 176 +- xml/System.Xml.Linq/XNodeEqualityComparer.xml | 6 +- xml/System.Xml.Linq/XObject.xml | 4 +- xml/System.Xml.Linq/XStreamingElement.xml | 24 +- xml/System.Xml.Schema/Extensions.xml | 30 +- xml/System.Xml.Schema/ValidationEventArgs.xml | 4 +- xml/System.Xml.Schema/XmlAtomicValue.xml | 2 +- xml/System.Xml.Schema/XmlSchema.xml | 10 +- xml/System.Xml.Schema/XmlSchemaCollection.xml | 4 +- xml/System.Xml.Schema/XmlSchemaDatatype.xml | 10 +- xml/System.Xml.Schema/XmlSchemaInference.xml | 18 +- xml/System.Xml.Schema/XmlSchemaInfo.xml | 2 +- .../XmlSchemaObjectCollection.xml | 8 +- .../XmlSchemaObjectTable.xml | 10 +- xml/System.Xml.Schema/XmlSchemaSet.xml | 56 +- xml/System.Xml.Schema/XmlSchemaType.xml | 2 +- xml/System.Xml.Schema/XmlSchemaValidator.xml | 88 +- .../SchemaImporterExtension.xml | 136 +- .../CodeIdentifier.xml | 6 +- .../CodeIdentifiers.xml | 10 +- .../IXmlSerializable.xml | 16 +- .../SoapAttributeAttribute.xml | 2 +- .../SoapAttributeOverrides.xml | 12 +- .../SoapAttributes.xml | 2 +- .../SoapElementAttribute.xml | 2 +- .../SoapEnumAttribute.xml | 6 +- .../SoapIgnoreAttribute.xml | 2 +- .../SoapIncludeAttribute.xml | 2 +- .../SoapReflectionImporter.xml | 14 +- .../SoapSchemaImporter.xml | 18 +- .../SoapTypeAttribute.xml | 2 +- .../UnreferencedObjectEventArgs.xml | 2 +- .../UnreferencedObjectEventHandler.xml | 2 +- .../XmlAnyAttributeAttribute.xml | 2 +- .../XmlAnyElementAttribute.xml | 4 +- .../XmlAnyElementAttributes.xml | 4 +- .../XmlArrayAttribute.xml | 2 +- .../XmlArrayItemAttributes.xml | 4 +- .../XmlAttributeEventArgs.xml | 4 +- .../XmlAttributeEventHandler.xml | 2 +- .../XmlAttributeOverrides.xml | 8 +- .../XmlAttributes.xml | 8 +- .../XmlElementAttributes.xml | 2 +- .../XmlElementEventArgs.xml | 2 +- .../XmlElementEventHandler.xml | 2 +- .../XmlEnumAttribute.xml | 2 +- .../XmlIgnoreAttribute.xml | 2 +- .../XmlIncludeAttribute.xml | 2 +- .../XmlMappingAccess.xml | 10 +- .../XmlNamespaceDeclarationsAttribute.xml | 264 +- .../XmlNodeEventArgs.xml | 8 +- .../XmlNodeEventHandler.xml | 2 +- .../XmlReflectionImporter.xml | 12 +- .../XmlSchemaExporter.xml | 2 +- .../XmlSchemaImporter.xml | 16 +- xml/System.Xml.Serialization/XmlSchemas.xml | 8 +- .../XmlSerializationReader.xml | 60 +- .../XmlSerializationWriter.xml | 60 +- .../XmlSerializer.xml | 62 +- .../XmlSerializerFactory.xml | 10 +- .../XmlSerializerNamespaces.xml | 10 +- .../XmlTextAttribute.xml | 2 +- .../XmlTypeMapping.xml | 2 +- xml/System.Xml.XPath/Extensions.xml | 12 +- xml/System.Xml.XPath/IXPathNavigable.xml | 20 +- xml/System.Xml.XPath/XPathDocument.xml | 12 +- xml/System.Xml.XPath/XPathExpression.xml | 44 +- xml/System.Xml.XPath/XPathItem.xml | 4 +- xml/System.Xml.XPath/XPathNamespaceScope.xml | 2 +- xml/System.Xml.XPath/XPathNavigator.xml | 402 +- xml/System.Xml.XPath/XPathNodeIterator.xml | 34 +- .../AncestorDocOrderIterator.xml | 4 +- .../AncestorIterator.xml | 4 +- .../AttributeContentIterator.xml | 6 +- .../AttributeIterator.xml | 6 +- .../ContentIterator.xml | 6 +- .../ContentMergeIterator.xml | 2 +- .../DescendantIterator.xml | 4 +- .../DescendantMergeIterator.xml | 2 +- .../DifferenceIterator.xml | 2 +- .../ElementContentIterator.xml | 4 +- .../FollowingSiblingIterator.xml | 6 +- .../FollowingSiblingMergeIterator.xml | 2 +- xml/System.Xml.Xsl.Runtime/IdIterator.xml | 4 +- .../IntersectIterator.xml | 2 +- .../NamespaceIterator.xml | 4 +- .../NodeKindContentIterator.xml | 4 +- .../NodeRangeIterator.xml | 4 +- xml/System.Xml.Xsl.Runtime/ParentIterator.xml | 6 +- .../PrecedingIterator.xml | 6 +- .../PrecedingSiblingDocOrderIterator.xml | 6 +- .../PrecedingSiblingIterator.xml | 6 +- xml/System.Xml.Xsl.Runtime/UnionIterator.xml | 2 +- .../XPathFollowingIterator.xml | 4 +- .../XPathFollowingMergeIterator.xml | 2 +- .../XPathPrecedingDocOrderIterator.xml | 4 +- .../XPathPrecedingIterator.xml | 4 +- .../XPathPrecedingMergeIterator.xml | 2 +- .../XmlQueryRuntime.xml | 20 +- xml/System.Xml.Xsl.Runtime/XsltLibrary.xml | 6 +- xml/System.Xml.Xsl/XslCompiledTransform.xml | 58 +- xml/System.Xml.Xsl/XslTransform.xml | 90 +- xml/System.Xml.Xsl/XsltArgumentList.xml | 4 +- xml/System.Xml.Xsl/XsltSettings.xml | 10 +- xml/System.Xml/IHasXmlNode.xml | 4 +- xml/System.Xml/IStreamProvider.xml | 4 +- xml/System.Xml/IXmlNamespaceResolver.xml | 6 +- xml/System.Xml/NewLineHandling.xml | 2 +- xml/System.Xml/UniqueId.xml | 4 +- xml/System.Xml/ValidationType.xml | 24 +- xml/System.Xml/XmlAttribute.xml | 26 +- xml/System.Xml/XmlAttributeCollection.xml | 6 +- xml/System.Xml/XmlCDataSection.xml | 48 +- xml/System.Xml/XmlComment.xml | 44 +- xml/System.Xml/XmlConvert.xml | 22 +- xml/System.Xml/XmlDataDocument.xml | 22 +- .../XmlDateTimeSerializationMode.xml | 10 +- xml/System.Xml/XmlDeclaration.xml | 6 +- xml/System.Xml/XmlDictionaryWriter.xml | 4 +- xml/System.Xml/XmlDocument.xml | 68 +- xml/System.Xml/XmlDocumentFragment.xml | 6 +- xml/System.Xml/XmlDocumentType.xml | 6 +- xml/System.Xml/XmlElement.xml | 12 +- xml/System.Xml/XmlEntityReference.xml | 2 +- xml/System.Xml/XmlImplementation.xml | 6 +- xml/System.Xml/XmlNamespaceManager.xml | 36 +- xml/System.Xml/XmlNode.xml | 12 +- xml/System.Xml/XmlNodeChangedEventArgs.xml | 2 +- xml/System.Xml/XmlNodeList.xml | 8 +- xml/System.Xml/XmlNodeReader.xml | 134 +- xml/System.Xml/XmlProcessingInstruction.xml | 4 +- xml/System.Xml/XmlQualifiedName.xml | 48 +- xml/System.Xml/XmlReader.xml | 188 +- xml/System.Xml/XmlReaderSettings.xml | 10 +- xml/System.Xml/XmlResolver.xml | 10 +- xml/System.Xml/XmlSecureResolver.xml | 14 +- xml/System.Xml/XmlSignificantWhitespace.xml | 2 +- xml/System.Xml/XmlText.xml | 54 +- xml/System.Xml/XmlTextReader.xml | 196 +- xml/System.Xml/XmlTextWriter.xml | 106 +- xml/System.Xml/XmlUrlResolver.xml | 12 +- xml/System.Xml/XmlValidatingReader.xml | 162 +- xml/System.Xml/XmlWhitespace.xml | 4 +- xml/System.Xml/XmlWriter.xml | 298 +- xml/System.Xml/XmlWriterSettings.xml | 38 +- 183 files changed, 6369 insertions(+), 6369 deletions(-) diff --git a/xml/System.Xaml.Permissions/XamlLoadPermission.xml b/xml/System.Xaml.Permissions/XamlLoadPermission.xml index 60c540f576d..d950faf1b3d 100644 --- a/xml/System.Xaml.Permissions/XamlLoadPermission.xml +++ b/xml/System.Xaml.Permissions/XamlLoadPermission.xml @@ -54,14 +54,14 @@ Declares permissions for loading types from assemblies that are used by a XAML reader or writer. - is relevant for scenarios such as whether internal types are permitted to load under partial trust. - + is relevant for scenarios such as whether internal types are permitted to load under partial trust. + ]]> @@ -106,11 +106,11 @@ An enumerable set of specific values. Initializes a new instance of the class, using an enumerable set of specific values. - collection with each `allowedAccess` entry as an item, and sets the return for to `false` in the created instance. - + collection with each `allowedAccess` entry as an item, and sets the return for to `false` in the created instance. + ]]> @@ -150,11 +150,11 @@ A enumeration value. Initializes a new instance of the class, using existing permissions. - sets the return for to `true` in the created instance. Any call to this constructor sets the collection to `null` because it is not relevant if permissions are being reported rather than . - + sets the return for to `true` in the created instance. Any call to this constructor sets the collection to `null` because it is not relevant if permissions are being reported rather than . + ]]> @@ -190,11 +190,11 @@ The defining value. Initializes a new instance of the class, using a single value. - collection with `allowedAccess` as the only item, and sets the return for to `false` in the created instance. - + collection with `allowedAccess` as the only item, and sets the return for to `false` in the created instance. + ]]> @@ -242,11 +242,11 @@ Gets the list of all values that this represents. A read-only list of values, or . - is initialized such that is `true`, may be `null`. - + is initialized such that is `true`, may be `null`. + ]]> @@ -283,11 +283,11 @@ Creates and returns an identical copy of the current . A copy of the current . - this value is in the signature but can be cast to . - + this value is in the signature but can be cast to . + ]]> @@ -372,10 +372,10 @@ is . - does not contain the XML encoding for a . - - -or- - + does not contain the XML encoding for a . + + -or- + The version attribute within is not supported. @@ -494,11 +494,11 @@ Creates and returns a that is the intersection of the current and the specified permission. A new permission that represents the intersection of the current and the specified . This new permission is if the intersection is empty. - is checked first, and might return a result based solely on that check. Next, is checked. - + is checked first, and might return a result based solely on that check. Next, is checked. + ]]> @@ -541,13 +541,13 @@ if the current is a subset of the specified permission; otherwise, . - is checked first, and might return a result based solely on that check. Next, is checked. - - If `target` is `null` and the current is both `false` and has an empty list, this method returns `true`. - + is checked first, and might return a result based solely on that check. Next, is checked. + + If `target` is `null` and the current is both `false` and has an empty list, this method returns `true`. + ]]> @@ -661,13 +661,13 @@ Creates a permission that is the union of the current and the specified permission. A new that represents the union of the current and the specified . - is checked first, and might return a result based solely on that check. Next, is checked. - - If `other` is `null`, the current is returned. - + is checked first, and might return a result based solely on that check. Next, is checked. + + If `other` is `null`, the current is returned. + ]]> diff --git a/xml/System.Xaml.Schema/XamlMemberInvoker.xml b/xml/System.Xaml.Schema/XamlMemberInvoker.xml index a3775a800b1..1e4251205e5 100644 --- a/xml/System.Xaml.Schema/XamlMemberInvoker.xml +++ b/xml/System.Xaml.Schema/XamlMemberInvoker.xml @@ -30,10 +30,10 @@ has a default implementation. The default implementation follows a similar model to the default implementation of XAML schema types and : the CLR type system is used for instantiation, values and lookups, including using CLR attributes, and , and so on. - provides methods for basic get and set operations (; ). It also provides the properties and , but these are not virtual. + provides methods for basic get and set operations (; ). It also provides the properties and , but these are not virtual. > [!NOTE] -> It may be possible to obtain a value that represents a XAML directive, which is implemented as a private class in the System.Xaml implementation. If you attempt to call or on this invoker, an exception is thrown. +> It may be possible to obtain a value that represents a XAML directive, which is implemented as a private class in the System.Xaml implementation. If you attempt to call or on this invoker, an exception is thrown. ]]> @@ -81,7 +81,7 @@ ## Remarks The default implementation is empty. - This constructor is invoked internally to provide a value for . For a subclass, it is expected that you either use the signature for construction or provide an override that calls as base. Providing the implements a default pattern where is immutable. + This constructor is invoked internally to provide a value for . For a subclass, it is expected that you either use the signature for construction or provide an override that calls as base. Providing the implements a default pattern where is immutable. ]]> @@ -293,7 +293,7 @@ on the constructing . For an unknown , or for cases where returns `null`, this property returns `null`. + This property relies on calling on the constructing . For an unknown , or for cases where returns `null`, this property returns `null`. ]]> @@ -328,7 +328,7 @@ on the constructing . For an unknown , or for cases where returns `null`, this property returns `null`. + This property relies on calling on the constructing . For an unknown , or for cases where returns `null`, this property returns `null`. ]]> diff --git a/xml/System.Xaml.Schema/XamlTypeInvoker.xml b/xml/System.Xaml.Schema/XamlTypeInvoker.xml index b0aa5d3b4df..03732a14416 100644 --- a/xml/System.Xaml.Schema/XamlTypeInvoker.xml +++ b/xml/System.Xaml.Schema/XamlTypeInvoker.xml @@ -30,7 +30,7 @@ has a default implementation. The default implementation follows a similar model to the default implementation of XAML schema types and : the CLR type system is used for instantiation, values and lookups, including using CLR attributes, and , and so on. - provides methods for basic instantiation () and methods that are relevant for types where the represents a collection, dictionary or array (; ; ; ; ). + provides methods for basic instantiation () and methods that are relevant for types where the represents a collection, dictionary or array (; ; ; ; ). ]]> @@ -78,7 +78,7 @@ ## Remarks The default implementation is empty. - This constructor is invoked internally to provide a value for . For a subclass, it is expected that you either use the signature for construction or provide an override that calls as base. Providing the implements a default pattern where is immutable. + This constructor is invoked internally to provide a value for . For a subclass, it is expected that you either use the signature for construction or provide an override that calls as base. Providing the implements a default pattern where is immutable. ]]> @@ -309,7 +309,7 @@ for this is not a writeable collection or dictionary. Specifically, should return `null` for cases where returns `None`. + This method should return `null` for cases where the for this is not a writeable collection or dictionary. Specifically, should return `null` for cases where returns `None`. > [!IMPORTANT] > If you are not accessing a fully trusted XAML type system, this method has the potential to report false information to callers. @@ -356,7 +356,7 @@ returns `None`. + Should return `null` for cases where returns `None`. > [!IMPORTANT] > If you are not accessing a fully trusted XAML type system, this method has the potential to report false information to callers. @@ -441,9 +441,9 @@ constrained with event data. + The event handler is based on constrained with event data. - The value returned invokes the behavior of the that the is based on. + The value returned invokes the behavior of the that the is based on. The return value is `null` for a that is based on an unknown . @@ -480,9 +480,9 @@ constrained with event data. + The event handler is based on constrained with event data. - The value returned invokes the behavior of the that the is based on. + The value returned invokes the behavior of the that the is based on. The return value is `null` for a that is based on an unknown . diff --git a/xml/System.Xaml.Schema/XamlTypeName.xml b/xml/System.Xaml.Schema/XamlTypeName.xml index 22c44c86d32..d26aa78d0ab 100644 --- a/xml/System.Xaml.Schema/XamlTypeName.xml +++ b/xml/System.Xaml.Schema/XamlTypeName.xml @@ -29,11 +29,11 @@ Provides a means to specify a XAML type in terms of name and namespace. - is the type information class in the XAML type system, whereas is more of a data structure that provides different ways of specifying that type. also provides static helper methods for generating a by resolving an existing type identifier in a XAML namespace. - + is the type information class in the XAML type system, whereas is more of a data structure that provides different ways of specifying that type. also provides static helper methods for generating a by resolving an existing type identifier in a XAML namespace. + ]]> @@ -173,11 +173,11 @@ An array of type arguments, each of which must be a . Initializes a new instance of the class, based on name and namespace strings as well as an array of type arguments. - @@ -218,11 +218,11 @@ Gets the name used to construct this . The name of the type. - was used to construct this , the value of is . - + was used to construct this , the value of is . + ]]> @@ -263,11 +263,11 @@ Gets the XAML namespace identifier used to construct this . The XAML namespace identifier. - was used to construct this , the value of is `xamlType.GetXamlNamespaces()[0]`. - + was used to construct this , the value of is `xamlType.GetXamlNamespaces()[0]`. + ]]> @@ -341,20 +341,20 @@ Provides a value based on a string that can specify multiple type names, and an object that can resolve a markup prefix into a namespace. The created . - @@ -404,11 +404,11 @@ XamlTypeNameList1 = empty | ',' XamlTypeNameList Converts the value of this to its equivalent string representation. The equivalent string representation of this . - , passing `null` for `prefixLookup`. s - + , passing `null` for `prefixLookup`. s + ]]> @@ -444,14 +444,14 @@ XamlTypeNameList1 = empty | ',' XamlTypeNameList A prefixed usage string. To be added. - for this is . - - -or- - - is not valid. - - -or- - + for this is . + + -or- + + is not valid. + + -or- + Could not look up the prefix. @@ -595,11 +595,11 @@ XamlTypeNameList1 = empty | ',' XamlTypeNameList Gets the type arguments used to construct this . The type arguments, if any. May be null. - was used to construct this , the value of is formed from . - + was used to construct this , the value of is formed from . + ]]> diff --git a/xml/System.Xaml.Schema/XamlValueConverter`1.xml b/xml/System.Xaml.Schema/XamlValueConverter`1.xml index c36e6e39009..64f7faa60bd 100644 --- a/xml/System.Xaml.Schema/XamlValueConverter`1.xml +++ b/xml/System.Xaml.Schema/XamlValueConverter`1.xml @@ -38,11 +38,11 @@ . The generic implementation of provides indirection for the System.Xaml assembly so that the basic XAML schema and type system does not have to take dependencies on different value conversion techniques that are typically implementations in other assemblies. + Instances of this type are returned by methods of the XAML schema API such as . The generic implementation of provides indirection for the System.Xaml assembly so that the basic XAML schema and type system does not have to take dependencies on different value conversion techniques that are typically implementations in other assemblies. - A can be constructed with a null implementation type, but such a will return `null` for . + A can be constructed with a null implementation type, but such a will return `null` for . - Constructor signatures for use a `converterType` parameter that references the specific type that implements the conversion behavior. For a properly functioning (one that has a nonnull ), the `converterType` type is expected to be castable to the `TConverterBase` constraint. A mismatch condition is not enforced by constructors, but might produce an at run time. + Constructor signatures for use a `converterType` parameter that references the specific type that implements the conversion behavior. For a properly functioning (one that has a nonnull ), the `converterType` type is expected to be castable to the `TConverterBase` constraint. A mismatch condition is not enforced by constructors, but might produce an at run time. ]]> @@ -162,9 +162,9 @@ calls the protected default implementation of to get its value (and might be accessing a stored value if was already called once on this . + calls the protected default implementation of to get its value (and might be accessing a stored value if was already called once on this . - A can be constructed with a null implementation type, but such a will return `null` for . + A can be constructed with a null implementation type, but such a will return `null` for . ]]> @@ -239,9 +239,9 @@ is protected. To get a converter instance with a public API, get the value of . + is protected. To get a converter instance with a public API, get the value of . - A can be constructed with a null implementation type, but such a will return `null` for . + A can be constructed with a null implementation type, but such a will return `null` for . ]]> @@ -402,7 +402,7 @@ ## Remarks The value of this property is established by one of the following: -- A constructor parameter (see ). +- A constructor parameter (see ). - Internal logic that processes other constructor inputs and forms a string. @@ -555,7 +555,7 @@ value is based on . + The value is based on . ]]> diff --git a/xml/System.Xaml/AmbientPropertyValue.xml b/xml/System.Xaml/AmbientPropertyValue.xml index b44e2c63ade..11e4e931a2c 100644 --- a/xml/System.Xaml/AmbientPropertyValue.xml +++ b/xml/System.Xaml/AmbientPropertyValue.xml @@ -23,25 +23,25 @@ Reports information about an ambient property, as part of an implementation. - represents an information item that is returned by calling an service method. The `GetAll` methods return enumerations or arrays of items; the `GetFirst` methods return a single . - -## About Ambient Properties - An ambient property is a property whose property value should be available to value converter usage in the XAML node structure and to the object graph underneath it. The ambient concept is relevant for a XAML processor during the object-writing phase of the load path or the serialization phase of a save path. - - A type can also be attributed as ambient. In this case, all properties that use the attributed type are reported as ambient. - - In the load path case, the ambient property value might influence the object graph produced value of other properties that exist underneath it in a XAML node structure. When processed as a XAML node stream, the ambient concept implies that the ambient property value must be available to type converters and markup extensions from `StartObject` to `EndObject`. Similarly, a type converter or markup extension that is used for the save path can look up the ambient property and its value. Therefore, the XAML that is produced is a better round-trip representation. - - By its language definition, XAML does not specify the order in which members of an object must be processed. However, any ambient property value must be processed first by the XAML reader so that the type converter and markup extension usage that are contained in other properties can access it through the service. - - is a similar concept that also influences XAML node-processing order. However, can only be used for peer member and node relationships; it cannot influence all descendants. Also, directly influences object graph property setting, whereas the ambient technique relies on type converters or markup extensions. In the ambient technique, there must also be a specific type converter or markup extension definition. It is up to each type converter or markup extension to determine how the ambient property value should be interpreted and applied to the object graph location where the type converter or markup extension is used. - -## WPF Usage Notes - An ambient property scenario that is illustrated in the WPF feature set is , which can qualify the necessary property name lookups for other values. In this case, the value qualifies the values in the XAML nodes underneath it. uses the type converter behavior for a . This behavior accesses the ambient value by querying from a service context that is available to type converters and markup extensions. - + represents an information item that is returned by calling an service method. The `GetAll` methods return enumerations or arrays of items; the `GetFirst` methods return a single . + +## About Ambient Properties + An ambient property is a property whose property value should be available to value converter usage in the XAML node structure and to the object graph underneath it. The ambient concept is relevant for a XAML processor during the object-writing phase of the load path or the serialization phase of a save path. + + A type can also be attributed as ambient. In this case, all properties that use the attributed type are reported as ambient. + + In the load path case, the ambient property value might influence the object graph produced value of other properties that exist underneath it in a XAML node structure. When processed as a XAML node stream, the ambient concept implies that the ambient property value must be available to type converters and markup extensions from `StartObject` to `EndObject`. Similarly, a type converter or markup extension that is used for the save path can look up the ambient property and its value. Therefore, the XAML that is produced is a better round-trip representation. + + By its language definition, XAML does not specify the order in which members of an object must be processed. However, any ambient property value must be processed first by the XAML reader so that the type converter and markup extension usage that are contained in other properties can access it through the service. + + is a similar concept that also influences XAML node-processing order. However, can only be used for peer member and node relationships; it cannot influence all descendants. Also, directly influences object graph property setting, whereas the ambient technique relies on type converters or markup extensions. In the ambient technique, there must also be a specific type converter or markup extension definition. It is up to each type converter or markup extension to determine how the ambient property value should be interpreted and applied to the object graph location where the type converter or markup extension is used. + +## WPF Usage Notes + An ambient property scenario that is illustrated in the WPF feature set is , which can qualify the necessary property name lookups for other values. In this case, the value qualifies the values in the XAML nodes underneath it. uses the type converter behavior for a . This behavior accesses the ambient value by querying from a service context that is available to type converters and markup extensions. + ]]> diff --git a/xml/System.Xaml/AttachablePropertyServices.xml b/xml/System.Xaml/AttachablePropertyServices.xml index cbb4d7bb461..a87c38c39df 100644 --- a/xml/System.Xaml/AttachablePropertyServices.xml +++ b/xml/System.Xaml/AttachablePropertyServices.xml @@ -23,13 +23,13 @@ Provides static helper methods that obtain values and accessor method information from an attachable property and that work with an attached property store. - interface. However, parameters for passing the store into are not typed as the interface and are instead typed as `object`. This is because you can pass an arbitrary object, and in this case, an internal default attachable property store is used. - - Best practice for the arbitrary object is to pass the object that would otherwise be associated with the store. Do not pass `null` to indicate that you do not have an to use. Passing `null` enters code paths that do nothing. Passing an object that is non-null, but evaluates as `null` on an attempted cast, uses the default attachable property store. - + interface. However, parameters for passing the store into are not typed as the interface and are instead typed as `object`. This is because you can pass an arbitrary object, and in this case, an internal default attachable property store is used. + + Best practice for the arbitrary object is to pass the object that would otherwise be associated with the store. Do not pass `null` to indicate that you do not have an to use. Passing `null` enters code paths that do nothing. Passing an object that is non-null, but evaluates as `null` on an attempted cast, uses the default attachable property store. + ]]> @@ -67,11 +67,11 @@ The source index into which to copy. Copies all attachable property/value pairs from a specified attachable property store and into a destination array. - implementation that is constrained with a key/value pair, which might be the source of exceptions that are not listed in this topic. - + implementation that is constrained with a key/value pair, which might be the source of exceptions that are not listed in this topic. + ]]> @@ -141,11 +141,11 @@ if an attachable property entry for was found in the store and removed from it; otherwise, . - diff --git a/xml/System.Xaml/IAmbientProvider.xml b/xml/System.Xaml/IAmbientProvider.xml index 60917bb4575..1b35d642888 100644 --- a/xml/System.Xaml/IAmbientProvider.xml +++ b/xml/System.Xaml/IAmbientProvider.xml @@ -26,7 +26,7 @@ ## Remarks This interface represents the service that can help type converters and markup extensions to get the ambient property identifiers for the XAML type system ( objects). The service can also get the ambient property values from classes. Types can also be ambient; any member that uses that type as its value should be considered ambient. - This service is typically returned through a call to , which is made against a context-specific service provider. The service provider is generally available to contexts that need it, such as the execution code of a value converter. For more information, see [Type Converters and Markup Extensions for XAML](/dotnet/framework/xaml-services/type-converters-and-markup-extensions-for-xaml) and [Service Contexts Available to Type Converters and Markup Extensions](/dotnet/framework/xaml-services/service-contexts-available-to-type-converters-and-markup-extensions). + This service is typically returned through a call to , which is made against a context-specific service provider. The service provider is generally available to contexts that need it, such as the execution code of a value converter. For more information, see [Type Converters and Markup Extensions for XAML](/dotnet/framework/xaml-services/type-converters-and-markup-extensions-for-xaml) and [Service Contexts Available to Type Converters and Markup Extensions](/dotnet/framework/xaml-services/service-contexts-available-to-type-converters-and-markup-extensions). ## About Ambient Properties An ambient property is a property whose property value should be available to type converter and markup extension usages that exist in the XAML node structure and in the object graph created from it. This is relevant for a XAML processor during the object-writing phase of the load path or the serialization phase of a save path. @@ -38,9 +38,9 @@ is a similar concept that also influences XAML node-processing order. However, can only be used for peer member and node relationships; it cannot influence all descendants. Also, directly influences object graph property setting; whereas the ambient technique relies on type converters or markup extensions. In the ambient technique, there must also be a specific type converter or markup extension definition that specifies how the ambient property value should be interpreted and applied to the object. ## WPF Usage Notes - An ambient property scenario that is illustrated in the WPF feature set is , which can qualify the necessary property name lookups for other values. In this case, the value qualifies the values that are located in the XAML nodes underneath it. uses the type converter behavior for a . This behavior accesses the ambient value by querying from a service context that is available to type converters and markup extensions. + An ambient property scenario that is illustrated in the WPF feature set is , which can qualify the necessary property name lookups for other values. In this case, the value qualifies the values that are located in the XAML nodes underneath it. uses the type converter behavior for a . This behavior accesses the ambient value by querying from a service context that is available to type converters and markup extensions. - An ambient type scenario that is illustrated in the WPF feature set is . has a property that can contain other objects to merge, and the intended order of resource resolution for the merged scenario clashes with the order that types are loaded. applies so that a XAML processor can correctly process the references in a merged dictionary with `StaticResource` usages. Specifically, `StaticResource` is a markup extension, which calls . + An ambient type scenario that is illustrated in the WPF feature set is . has a property that can contain other objects to merge, and the intended order of resource resolution for the merged scenario clashes with the order that types are loaded. applies so that a XAML processor can correctly process the references in a merged dictionary with `StaticResource` usages. Specifically, `StaticResource` is a markup extension, which calls . ]]> @@ -192,9 +192,9 @@ ## Remarks Each that is returned contains the identifier and a property value. - This particular overload can search for ambient types and ambient properties in the same pass through a tree. Using this overload results in an ordering of items in the return value that is different from or . + This particular overload can search for ambient types and ambient properties in the same pass through a tree. Using this overload results in an ordering of items in the return value that is different from or . - This overload also permits the search to not use any saved context. The or overloads implicitly use a saved context if it is available (they always act as if an implicit `searchLiveStackOnly` parameter is `false`). The concept of a saved context is potentially handled differently by particular XAML schema contexts, or by frameworks that incorporate XAML. In the WPF XAML implementation, saved contexts are used for template expansion, as well as other feature areas. + This overload also permits the search to not use any saved context. The or overloads implicitly use a saved context if it is available (they always act as if an implicit `searchLiveStackOnly` parameter is `false`). The concept of a saved context is potentially handled differently by particular XAML schema contexts, or by frameworks that incorporate XAML. In the WPF XAML implementation, saved contexts are used for template expansion, as well as other feature areas. ]]> diff --git a/xml/System.Xaml/IDestinationTypeProvider.xml b/xml/System.Xaml/IDestinationTypeProvider.xml index d29961ed3b9..1aec03d9558 100644 --- a/xml/System.Xaml/IDestinationTypeProvider.xml +++ b/xml/System.Xaml/IDestinationTypeProvider.xml @@ -24,9 +24,9 @@ is resolved from the current position of the XAML node stream by using current XAML schema context. + The type that is returned by is resolved from the current position of the XAML node stream by using current XAML schema context. - If you use the XAML type system as implemented by .NET Framework XAML Services and access the service context under these conditions, returns the based on available XAML type system information and CLR-based XAML schema context. + If you use the XAML type system as implemented by .NET Framework XAML Services and access the service context under these conditions, returns the based on available XAML type system information and CLR-based XAML schema context. This service is relevant for situations where pure CLR reflection or other mechanisms might not provide enough information about a destination type. The following is a list of some relevant scenarios for : @@ -34,7 +34,7 @@ - You want to ensure that the destination type of a type converter usage matches the expected type that the type converter can produce. This scenario is useful when the destination type is parameterized or generic. -- Your value converter is being called from a usage that nested in another value converter. In this case, unwinds the nesting and returns the destination type of the actual property being set, instead of returning the output type of any intervening value converter. +- Your value converter is being called from a usage that nested in another value converter. In this case, unwinds the nesting and returns the destination type of the actual property being set, instead of returning the output type of any intervening value converter. Type converters and markup extensions can query for as a service on the service context that is provided by a XAML object writer, when the XAML object writer invokes value conversion behavior. For more information, see [Type Converters and Markup Extensions for XAML](/dotnet/framework/xaml-services/type-converters-and-markup-extensions-for-xaml) and [Service Contexts Available to Type Converters and Markup Extensions](/dotnet/framework/xaml-services/service-contexts-available-to-type-converters-and-markup-extensions). @@ -77,7 +77,7 @@ This method has no input parameter. What to return (and whether to return anything other than `null`) is determined by the current node position in the XAML node stream. ## Service Implementers - If you reimplement this service, the method should return the type that a markup extension or type converter expects to check against its most specific conversion or output type. + If you reimplement this service, the method should return the type that a markup extension or type converter expects to check against its most specific conversion or output type. ]]> diff --git a/xml/System.Xaml/IXamlNameResolver.xml b/xml/System.Xaml/IXamlNameResolver.xml index 804f4d1c045..9bfcd3d6a26 100644 --- a/xml/System.Xaml/IXamlNameResolver.xml +++ b/xml/System.Xaml/IXamlNameResolver.xml @@ -192,7 +192,7 @@ does not return a token because a is involved in the second pass on an existing token. + This property returns `false` when does not return a token because a is involved in the second pass on an existing token. ]]> @@ -267,7 +267,7 @@ and APIs. + If a value is returned as `null`, a forward reference might exist. Implementations that want to support forward references can use the `FixupToken` pattern through the and APIs. ]]> diff --git a/xml/System.Xaml/IXamlObjectWriterFactory.xml b/xml/System.Xaml/IXamlObjectWriterFactory.xml index 6ee60be02fd..95686d82d47 100644 --- a/xml/System.Xaml/IXamlObjectWriterFactory.xml +++ b/xml/System.Xaml/IXamlObjectWriterFactory.xml @@ -21,11 +21,11 @@ Represents a service that generates a that is based on the current internal parser context. - to construct a new compatible XAML object writer. The factory-constructed object writer can resume writing to the object graph after the first write operation is suspended. - + to construct a new compatible XAML object writer. The factory-constructed object writer can resume writing to the object graph after the first write operation is suspended. + ]]> diff --git a/xml/System.Xaml/NamespaceDeclaration.xml b/xml/System.Xaml/NamespaceDeclaration.xml index 1558658310c..346f31992a9 100644 --- a/xml/System.Xaml/NamespaceDeclaration.xml +++ b/xml/System.Xaml/NamespaceDeclaration.xml @@ -38,7 +38,7 @@ By convention, the identifier of a XAML namespace resembles a Uniform Resource Identifier (URI). However, the property of is of type . The APIs of .NET Framework XAML Services usually treat XAML namespace identifiers as strings. The relative versus absolute distinctions in the true type are irrelevant for identifying a XAML (or XML) namespace. The URI-as-namespace convention is also typical in XML. - Objects of this type are used as input for the method when writing XAML node stream information into an object graph. Objects of this type are used as input for the method when writing XAML node stream information as XML for serialization. + Objects of this type are used as input for the method when writing XAML node stream information into an object graph. Objects of this type are used as input for the method when writing XAML node stream information as XML for serialization. A namespace declaration may have a value for the prefix. A prefix represents a declaration of the default XAML namespace. diff --git a/xml/System.Xaml/XamlDirective.xml b/xml/System.Xaml/XamlDirective.xml index bffdfc7e231..9741821bcca 100644 --- a/xml/System.Xaml/XamlDirective.xml +++ b/xml/System.Xaml/XamlDirective.xml @@ -30,7 +30,7 @@ The following list shows the returned results of a XAML directive for when the member is actually a : -- is always `null`. +- is always `null`. - is always `null`. @@ -103,7 +103,7 @@ ## Remarks > [!IMPORTANT] -> This signature of the constructor always generates an identifier for the directive where reports `true` for the XAML type system. If the necessary information is available (the backing type and a text syntax information item for conversion) and you want an identifier that can apply the directive, use the constructor signature instead. +> This signature of the constructor always generates an identifier for the directive where reports `true` for the XAML type system. If the necessary information is available (the backing type and a text syntax information item for conversion) and you want an identifier that can apply the directive, use the constructor signature instead. If you use this signature, the value for the instance is ; and the value and value are both `null`. @@ -190,7 +190,7 @@ constructor signature. If you construct by using the constructor signature, the value for the instance is . However, the instance always reports as `true`. This behavior typically affects attempts to write object graphs and also affects other practical uses of a value. + You can set this value in the constructor signature. If you construct by using the constructor signature, the value for the instance is . However, the instance always reports as `true`. This behavior typically affects attempts to write object graphs and also affects other practical uses of a value. You typically would not construct a XAML directive case where is . @@ -740,7 +740,7 @@ ## Remarks The implementation only calls base and does nothing more. The base implementation returns results based either on internal reflection, or checking for a null value of , processing in that order. seals this virtual member; therefore, all types and all predefined XAML directives must use this behavior. - See Remarks in for more information about what information carries. + See Remarks in for more information about what information carries. ]]> @@ -777,7 +777,7 @@ implementation only calls base and does nothing more. See . seals this virtual member; therefore, all types and all predefined XAML directives must use this behavior. + The implementation only calls base and does nothing more. See . seals this virtual member; therefore, all types and all predefined XAML directives must use this behavior. ]]> diff --git a/xml/System.Xaml/XamlMember.xml b/xml/System.Xaml/XamlMember.xml index d6a5927412f..f4a21ad7f1c 100644 --- a/xml/System.Xaml/XamlMember.xml +++ b/xml/System.Xaml/XamlMember.xml @@ -33,24 +33,24 @@ can use three methodologies for returning information about a XAML member: standard common language runtime (CLR) reflection; a reference-only reflection technique calling internal APIs that use optimized bit flags; or calling into virtual overrides of the `Lookup*` API that is provided by possible subclasses. For most uses of .NET Framework XAML Services APIs and the API, you use the default XAML schema context. The default XAML schema context for .NET Framework XAML Services uses CLR backing for the type system. This enables the XAML readers and XAML writers to work with any type or member that is defined in, or otherwise available to, the CLR and its reflection techniques. ## Lookup* APIs and XamlMember Derived Classes - defines several virtual members that derived classes might override. These members have names that always start with the string `Lookup`. The remainder of the API name then references the property that the virtual method influences. For example, a derived class might override to influence what the base-defined property returns in a derived class. You can predict return values for such properties in or existing derived classes by reading the documentation for the relevant `Lookup*` methods. + defines several virtual members that derived classes might override. These members have names that always start with the string `Lookup`. The remainder of the API name then references the property that the virtual method influences. For example, a derived class might override to influence what the base-defined property returns in a derived class. You can predict return values for such properties in or existing derived classes by reading the documentation for the relevant `Lookup*` methods. The purpose of the `Lookup*` methods is to provide a XAML type system extension technique that incorporates the base class. By deriving from and overriding the `Lookup` virtual members, you can define the concept of a XAML member for a XAML schema in a XAML type system without being tied to the specifics of a backing type system or technology. You can also use a provided XAML schema context under this scheme and still return the results you want. - As an example, consider the property . This property informs callers that operations such as using a for serialization can write a value for this member on a target object. In the default implementation, the determination of whether the member is writable is made by using reflection techniques against the backing CLR and its members (the ). Therefore, by default, the XAML type system depends on the CLR type system. However, you can remove this dependency for your XAML type system reporting of by overriding the API . Within your override, you can use other determinations, such as metadata that is specific to your technology, a primary lookup table that is optimized for a fixed XAML vocabulary, or a variety of other strategies for determining whether a XAML member is writable in your XAML vocabulary. + As an example, consider the property . This property informs callers that operations such as using a for serialization can write a value for this member on a target object. In the default implementation, the determination of whether the member is writable is made by using reflection techniques against the backing CLR and its members (the ). Therefore, by default, the XAML type system depends on the CLR type system. However, you can remove this dependency for your XAML type system reporting of by overriding the API . Within your override, you can use other determinations, such as metadata that is specific to your technology, a primary lookup table that is optimized for a fixed XAML vocabulary, or a variety of other strategies for determining whether a XAML member is writable in your XAML vocabulary. ## Constructing XamlMember Without XAML Schema Context Most constructors of require a as part of their initialization. The is also necessary for many internal operations, such as obtaining information that is being forwarded from the backing type. When you are working with the API, you typically have a that is available from a surrounding construct such as a . In this case, you can pass the reference through to all XAML type system calls that require a XAML schema context. - One specific constructor, , does not require a . However, a that is constructed with the signature returns `true` for . + One specific constructor, , does not require a . However, a that is constructed with the signature returns `true` for . - For a load path that involves , such a member cannot be written into an object graph. Using the .NET Framework XAML services implementation, the call throws a when the relevant reports `true` for . + For a load path that involves , such a member cannot be written into an object graph. Using the .NET Framework XAML services implementation, the call throws a when the relevant reports `true` for . You should not construct a that has a value of `true` for unless your implementation can handle the exceptions from , or you have other ways to adjust the behavior. For example, one or more of the following might be true of your implementation: - The XAML schema context is available later. - You use a member invoker pattern. -- You deliberately override in a custom XAML writer. +- You deliberately override in a custom XAML writer. ]]> @@ -312,9 +312,9 @@ that is constructed with the signature returns `true` for . + A that is constructed with the signature returns `true` for . - For a load path that involves , such a member cannot be written into an object graph. Using the .NET Framework XAML Services implementation, the call throws a when the relevant reports `true` for . + For a load path that involves , such a member cannot be written into an object graph. Using the .NET Framework XAML Services implementation, the call throws a when the relevant reports `true` for . You should not construct a with `true` unless your implementation can handle the exceptions from , or you have other ways to adjust the behavior. For example, one or more of the following might be true of your implementation: @@ -322,7 +322,7 @@ - You use a member invoker pattern. -- You deliberately override in a custom XAML writer. +- You deliberately override in a custom XAML writer. ]]> @@ -534,7 +534,7 @@ invokes or a specific override of that method. This behavior occurs in cases where the initial internal reflection logic has not already set the information. + Calling invokes or a specific override of that method. This behavior occurs in cases where the initial internal reflection logic has not already set the information. ]]> @@ -569,7 +569,7 @@ invokes or a specific override of that method. This behavior occurs in cases where the initial internal reflection logic has not already set the information. + Calling invokes or a specific override of that method. This behavior occurs in cases where the initial internal reflection logic has not already set the information. The `DependsOn` pattern can be applied to object model cases that deliberately contradict a general XAML rule. The general XAML rule is that members of a type that are not passed as initialization text (or by a factory method in XAML 2009) must be able to be assigned in any order. By applying a `DependsOn` pattern to a member, you can instruct XAML writers to always process the referenced member before this member. You can apply this pattern in situations where the value of the current member requires context or other information that is only available after the other member is set. @@ -725,7 +725,7 @@ call result from the that is associated with this . + The default implementation returns the call result from the that is associated with this . ]]> @@ -762,11 +762,11 @@ ## Remarks The `Invoker` pattern is an advanced XAML type system extension technique. The `Invoker` pattern provides a way to inject different schema type mapping behavior, while still using XAML type system definitions from .NET Framework XAML Services. - If a override returns `null`, or if the default implementation returns `null` because it lacks the for this , the property returns . + If a override returns `null`, or if the default implementation returns `null` because it lacks the for this , the property returns . is the default. This is true for most operations that use .NET Framework XAML Services and the default XAML schema context, and where no specific override `Invoker` patterns are passed for construction of XAML type system entities. - Calling invokes or a specific override of that method. + Calling invokes or a specific override of that method. ]]> @@ -808,9 +808,9 @@ invokes or a specific override of that method. This behavior occurs in implementations where the initial internal reflection logic has not already set the information. + Calling invokes or a specific override of that method. This behavior occurs in implementations where the initial internal reflection logic has not already set the information. - Checking for ambient properties is are usually part of XAML processing logic to make sure that objects and values that rely on ambient usage for type qualification can function correctly. The .NET Framework XAML Services APIs and the default XAML schema context populates this value based on attribution with . The default implementation of uses this existing technique, and it returns `true` if exists on a member declaration. + Checking for ambient properties is are usually part of XAML processing logic to make sure that objects and values that rely on ambient usage for type qualification can function correctly. The .NET Framework XAML Services APIs and the default XAML schema context populates this value based on attribution with . The default implementation of uses this existing technique, and it returns `true` if exists on a member declaration. is found on members of several WPF types, which include , , and . It is also found on the type, which connotes that any member that uses as its type should be considered ambient even if the member is not specifically attributed. @@ -929,7 +929,7 @@ invokes or a specific override of that method. + Calling invokes or a specific override of that method. ]]> @@ -1001,7 +1001,7 @@ invokes or a specific override of that method. + Calling invokes or a specific override of that method. ]]> @@ -1039,10 +1039,10 @@ ## Remarks The value checks whether the is public. If is nonpublic, the `get` accessor is not callable in a practical way, and returns `false`. - Calling invokes or a specific override of that method. + Calling invokes or a specific override of that method. > [!IMPORTANT] -> The method is virtual and therefore, can be overridden. The override has the potential to change (maliciously or otherwise) the reported access information of a XAML member so that it no longer aligns in an expected way with the type system access information of its underlying CLR declaration. For any security-critical checks of access levels, use the underlying CLR type instead. +> The method is virtual and therefore, can be overridden. The override has the potential to change (maliciously or otherwise) the reported access information of a XAML member so that it no longer aligns in an expected way with the type system access information of its underlying CLR declaration. For any security-critical checks of access levels, use the underlying CLR type instead. ]]> @@ -1078,13 +1078,13 @@ that is constructed with the signature returns `true` for . + A that is constructed with the signature returns `true` for . - For a load path that involves , a with `true` for cannot be written into an object graph. Under the default implementations in .NET Framework XAML Services APIs, the call throws a when the relevant reports `true` for . + For a load path that involves , a with `true` for cannot be written into an object graph. Under the default implementations in .NET Framework XAML Services APIs, the call throws a when the relevant reports `true` for . You should not construct a that has a value of `true` for unless your implementation can handle the exceptions from , or you have other ways to adjust the behavior. - Calling invokes or a specific override of that method. + Calling invokes or a specific override of that method. ]]> @@ -1126,7 +1126,7 @@ invokes or a specific override of that method. + Calling invokes or a specific override of that method. ]]> @@ -1164,10 +1164,10 @@ ## Remarks The value considers whether the is public as part of the determination. If is nonpublic, the `set` accessor is not callable in a practical way, and returns `false`. - Calling invokes or a specific override of that method. + Calling invokes or a specific override of that method. > [!IMPORTANT] -> The method is virtual and therefore, can be overridden. The override has the potential to change (maliciously or otherwise) the reported access information of a XAML member so that it no longer aligns in an expected way with the type system access information of its underlying CLR declaration. For any security-critical checks of access levels, use the underlying CLR type instead. +> The method is virtual and therefore, can be overridden. The override has the potential to change (maliciously or otherwise) the reported access information of a XAML member so that it no longer aligns in an expected way with the type system access information of its underlying CLR declaration. For any security-critical checks of access levels, use the underlying CLR type instead. ]]> @@ -1203,7 +1203,7 @@ . + Override this method to provide the internal reflection with an alternative way to obtain CLR attribute values. In the absence of an override, the internal reflector uses typical CLR reflection logic such as calls to . The default implementation returns `null`. @@ -1366,11 +1366,11 @@ are usually part of XAML processing logic to make sure that objects and values that rely on ambient usage for type qualification can function correctly. The default .NET Framework XAML Services implementation uses CLR attributing to obtain this information from reflection over backing types. Specifically, the default implementation checks for and returns `true` for if exists on a member definition. + This method is invoked by internal calls that check for ambient XAML property information. Ambient property behavior is accounted for in the public API behavior of XAML readers and XAML writers. The internal calls that reference are usually part of XAML processing logic to make sure that objects and values that rely on ambient usage for type qualification can function correctly. The default .NET Framework XAML Services implementation uses CLR attributing to obtain this information from reflection over backing types. Specifically, the default implementation checks for and returns `true` for if exists on a member definition. Override this method if you are not using for this purpose and intend to replace that technique for indicating ambient XAML properties with your own technique. - Example APIs from WPF that attribute with are and . + Example APIs from WPF that attribute with are and . ]]> @@ -1490,12 +1490,12 @@ ## Remarks The default implementation returns results based either on internal reflection or the negation of , processing in that order. - returns whether the member itself is public; it returns `true` for a public member on a nonpublic declaring type. Use instead, if you also want to consider the visibility of the declaring type. + returns whether the member itself is public; it returns `true` for a public member on a nonpublic declaring type. Use instead, if you also want to consider the visibility of the declaring type. This method is invoked when a caller gets a value from . Override this method if you want to report uniform results for an entire derived class, or if you have specialized metadata available to determine this on a per-case basis. > [!IMPORTANT] -> The method is virtual and therefore, can be overridden. The override has the potential to change (maliciously or otherwise) the reported access information of a XAML member so that it no longer aligns in an expected way with the type system access information of its underlying CLR declaration. For any security-critical checks of access levels, use the underlying CLR type instead. +> The method is virtual and therefore, can be overridden. The override has the potential to change (maliciously or otherwise) the reported access information of a XAML member so that it no longer aligns in an expected way with the type system access information of its underlying CLR declaration. For any security-critical checks of access levels, use the underlying CLR type instead. ]]> @@ -1618,7 +1618,7 @@ This method is invoked when a caller gets a value from . Override this method if you want to report uniform results for an entire derived class, or if you have specialized metadata available to determine this on a per-case basis. > [!IMPORTANT] -> The method is virtual and therefore, can be overridden. The override has the potential to change (maliciously or otherwise) the reported access information of a XAML member so that it no longer aligns in an expected way with the type system access information of its underlying CLR declaration. For any security-critical checks of access levels, use the underlying CLR type instead. +> The method is virtual and therefore, can be overridden. The override has the potential to change (maliciously or otherwise) the reported access information of a XAML member so that it no longer aligns in an expected way with the type system access information of its underlying CLR declaration. For any security-critical checks of access levels, use the underlying CLR type instead. ]]> @@ -1684,7 +1684,7 @@ always returns . For attachable members, returns a result based on examining the accessor parameter type and interprets that type based on XAML schema context. + The default implementation distinguishes between attachable and non-attachable members. For non-attachable members, always returns . For attachable members, returns a result based on examining the accessor parameter type and interprets that type based on XAML schema context. This method is invoked when a caller gets a value from . Override this method if you want to report uniform results for an entire derived class, or if you have specialized metadata available to determine this on a per-case basis. @@ -1774,7 +1774,7 @@ ## Remarks The default implementation uses the following logic and processing order: -- If attributing exists at the member level (), the attribute information is used for a call to against the XAML schema context. +- If attributing exists at the member level (), the attribute information is used for a call to against the XAML schema context. - If is valid, a type converter that is associated with the type is returned. @@ -1817,9 +1817,9 @@ property as and returns the value of (with the parameter set to `true`), which means that the returned method can be nonpublic. This behavior can result in `null` for certain cases. including cases where no associated accessor exists or the member is not a property. + The default implementation interprets the property as and returns the value of (with the parameter set to `true`), which means that the returned method can be nonpublic. This behavior can result in `null` for certain cases. including cases where no associated accessor exists or the member is not a property. - This method is invoked when a caller gets a value from the property on an associated . Override this method if you want to report uniform results for an entire derived class, or if you have specialized metadata available to determine this on a per-case basis. Make sure to implement , , and so that they all return correlated results. + This method is invoked when a caller gets a value from the property on an associated . Override this method if you want to report uniform results for an entire derived class, or if you have specialized metadata available to determine this on a per-case basis. Make sure to implement , , and so that they all return correlated results. ]]> @@ -1859,7 +1859,7 @@ If an underlying member was set during construction, you should not need to call this method. - This method is invoked when a caller gets a value from . Override this method if you want to report uniform results for an entire derived class, or if you have specialized metadata available to determine this on a per-case basis. Make sure to implement , , and so that they all return correlated results. + This method is invoked when a caller gets a value from . Override this method if you want to report uniform results for an entire derived class, or if you have specialized metadata available to determine this on a per-case basis. Make sure to implement , , and so that they all return correlated results. ]]> @@ -1896,9 +1896,9 @@ as and returns the value of (with the parameter set to `true`), which means that the returned method can be nonpublic. This can result in `null` for certain cases, including cases where there is no such accessor, or the member is not a property. + The default implementation interprets as and returns the value of (with the parameter set to `true`), which means that the returned method can be nonpublic. This can result in `null` for certain cases, including cases where there is no such accessor, or the member is not a property. - This method is invoked when a caller gets a value from on an associated .Override this method if you want to report uniform results for an entire derived class, or if you have specialized metadata available to determine this on a per-case basis. Make sure to implement , , and so that they all return correlated results. + This method is invoked when a caller gets a value from on an associated .Override this method if you want to report uniform results for an entire derived class, or if you have specialized metadata available to determine this on a per-case basis. Make sure to implement , , and so that they all return correlated results. ]]> @@ -1936,7 +1936,7 @@ ## Remarks The default implementation uses the following logic and processing order: -- If attributing exists at the member level (), the attribute information is used for a call to against the XAML schema context. +- If attributing exists at the member level (), the attribute information is used for a call to against the XAML schema context. - If is valid, a value converter that is associated with the type is returned. @@ -2120,7 +2120,7 @@ property provides the same value as calling and then getting the first value string from the returned list. The preferred XAML namespace should be used when writing the member back to text or other representations that preserve XAML namespace information. + The property provides the same value as calling and then getting the first value string from the returned list. The preferred XAML namespace should be used when writing the member back to text or other representations that preserve XAML namespace information. ]]> @@ -2183,11 +2183,11 @@ returns . For attachable members, returns a result that is based on this logic: + The returned value is different for attachable and non-attachable members. For non-attachable members, returns . For attachable members, returns a result that is based on this logic: - If reflection cannot resolve a backing ( `true`), this method returns an internal constant that represents a generic object type. -- If the previous condition does not apply, is called. The default implementation returns a that is based on examining the methods that implement the `get` and `set` accessors. A class might override to use a different behavior such as other metadata forms that might report target types for attachable members. +- If the previous condition does not apply, is called. The default implementation returns a that is based on examining the methods that implement the `get` and `set` accessors. A class might override to use a different behavior such as other metadata forms that might report target types for attachable members. ]]> @@ -2258,9 +2258,9 @@ invokes or a specific override of that method. This occurs when the initial internal reflection logic has not already set the information. + Calling invokes or a specific override of that method. This occurs when the initial internal reflection logic has not already set the information. - In the default behavior (no override), the returned can have different conceptual meanings. Which meaning applies depends on whether this represents a property, method, or event, as the following list shows: + In the default behavior (no override), the returned can have different conceptual meanings. Which meaning applies depends on whether this represents a property, method, or event, as the following list shows: - For a property, the returned is the type that sets the property or is returned by the property. @@ -2303,17 +2303,17 @@ invokes or a specific override of that method. This behavior occurs when the initial internal reflection logic has not already set the information. + Calling invokes or a specific override of that method. This behavior occurs when the initial internal reflection logic has not already set the information. Implementations that return a non-null property value for are not necessarily a working . The following is a list of possible non-null return values for and what these values represent: - The return value reports a type converter that is attributed specifically to that member or more generally to the target type of the converter. This behavior is typically what most XAML type systems and XAML processors look for in order to instantiate a type converter and invoke its methods. -- The return value reports a built-in value converter. These converters exist for certain internal operations that are performed by a XAML writer. In particular, these built-in value converters convert the raw attribute string values to the XAML language-level primitives. For the .NET Framework XAML Services implementation, these built-in type conversions often forward to a type converter that is defined in the System assembly. For example, a conversion for an value has built-in forwarded conversion, and therefore, the value references . +- The return value reports a built-in value converter. These converters exist for certain internal operations that are performed by a XAML writer. In particular, these built-in value converters convert the raw attribute string values to the XAML language-level primitives. For the .NET Framework XAML Services implementation, these built-in type conversions often forward to a type converter that is defined in the System assembly. For example, a conversion for an value has built-in forwarded conversion, and therefore, the value references . -- The return value reports the special case of an unconstrained object model; that is, the has a value of . In this case, the reports that the is {`Object}`. However, is `null` because no actual type or instance is available to perform this conversion. Instead, the object model behavior cannot be determined until run time, when the runtime of the specific technology determines the handling of its object graph. +- The return value reports the special case of an unconstrained object model; that is, the has a value of . In this case, the reports that the is {`Object}`. However, is `null` because no actual type or instance is available to perform this conversion. Instead, the object model behavior cannot be determined until run time, when the runtime of the specific technology determines the handling of its object graph. - If you can access a working from , you can invoke its conversion methods. However, many conversion methods rely on service context. If you do not have the same service context available that the type converter expects for its typical role of writing objects for object graphs, the converter methods can throw exceptions. + If you can access a working from , you can invoke its conversion methods. However, many conversion methods rely on service context. If you do not have the same service context available that the type converter expects for its typical role of writing objects for object graphs, the converter methods can throw exceptions. ]]> @@ -2354,7 +2354,7 @@ invokes or a specific override of that method. + Calling invokes or a specific override of that method. ]]> @@ -2389,7 +2389,7 @@ invokes or a specific override of that method. This behavior occurs when the initial internal reflection logic has not already set the information. + Calling invokes or a specific override of that method. This behavior occurs when the initial internal reflection logic has not already set the information. Not all cases that return a non-null property value for are necessarily a working . See ; the same considerations apply to . diff --git a/xml/System.Xaml/XamlNodeList.xml b/xml/System.Xaml/XamlNodeList.xml index 5abfb77159c..071c0b622ec 100644 --- a/xml/System.Xaml/XamlNodeList.xml +++ b/xml/System.Xaml/XamlNodeList.xml @@ -23,11 +23,11 @@ Provides a list of XAML nodes, which can be used for scenarios such as writing XAML nodes in a deferred manner. - , you create a writer delegate that exists as the value. The writer delegate is based on an internal XAML writer class that is specifically for XAML nodes. - + , you create a writer delegate that exists as the value. The writer delegate is based on an internal XAML writer class that is specifically for XAML nodes. + ]]> @@ -68,11 +68,11 @@ The schema context to use for node operations. Initializes a new instance of the class, using a provided schema context. - value. - + value. + ]]> @@ -137,11 +137,11 @@ Clears the items in this list. - @@ -201,17 +201,17 @@ Returns a XAML reader implementation delegate. A XAML reader implementation delegate. - delegate that is returned from in a service mode, where you cast it to . In that mode you can get and set the index values for . In this manner, the set mode enables skipping nodes without using the standard `Read` and `Skip`. - + delegate that is returned from in a service mode, where you cast it to . In that mode you can get and set the index values for . In this manner, the set mode enables skipping nodes without using the standard `Read` and `Skip`. + ]]> - The is still in Write mode. - - -or- - + The is still in Write mode. + + -or- + The writer that is used for the node list has no schema context. diff --git a/xml/System.Xaml/XamlObjectEventArgs.xml b/xml/System.Xaml/XamlObjectEventArgs.xml index d9cd2753bd0..80a6b972384 100644 --- a/xml/System.Xaml/XamlObjectEventArgs.xml +++ b/xml/System.Xaml/XamlObjectEventArgs.xml @@ -23,11 +23,11 @@ Provides data for callbacks that can be inserted in the sequence for object initialization and property setting. This influences the object graph that is produced by . - that carries event data. You define the handlers and then set references to them by setting properties of . - + that carries event data. You define the handlers and then set references to them by setting properties of . + ]]> diff --git a/xml/System.Xaml/XamlObjectReader.xml b/xml/System.Xaml/XamlObjectReader.xml index 20a6c8d9cc1..6245d3becf9 100644 --- a/xml/System.Xaml/XamlObjectReader.xml +++ b/xml/System.Xaml/XamlObjectReader.xml @@ -30,7 +30,7 @@ More advanced scenarios might supply a override and a specific XAML schema context that the uses and then passes to the writer override. - Typical scenarios for using call the members that implements; they also call , , and from the base class. + Typical scenarios for using call the members that implements; they also call , , and from the base class. ]]> @@ -360,7 +360,7 @@ APIs, you typically check the property after every operation that potentially advances the reader position, such as the , , or methods. indicates the information that you can obtain from the current reader position and the methods that you call next. For example, you might access the , , , or properties; or you might call the method if you are not interested in the contents of the current node type. + When using the APIs, you typically check the property after every operation that potentially advances the reader position, such as the , , or methods. indicates the information that you can obtain from the current reader position and the methods that you call next. For example, you might access the , , , or properties; or you might call the method if you are not interested in the contents of the current node type. ]]> @@ -397,7 +397,7 @@ method and obtain a `true` result, you typically access the node properties. Depending on the property, you can access the , , , or properties. + After you call the method and obtain a `true` result, you typically access the node properties. Depending on the property, you can access the , , , or properties. ]]> diff --git a/xml/System.Xaml/XamlObjectWriter.xml b/xml/System.Xaml/XamlObjectWriter.xml index 838236f1a58..2ba26d92125 100644 --- a/xml/System.Xaml/XamlObjectWriter.xml +++ b/xml/System.Xaml/XamlObjectWriter.xml @@ -30,28 +30,28 @@ implement a pattern so that the uses the that is defined by the method. logic switches between the `Write` methods, depending on which node type is at the current position in the reader. + The `Write` methods of implement a pattern so that the uses the that is defined by the method. logic switches between the `Write` methods, depending on which node type is at the current position in the reader. ## Scope - A has a concept of scope; that is, the maintains a conceptual point of reference in its output object graph. For a particular scope, certain operations might be valid or invalid, or produce a no-operation result. For example, if you call to write directives for initialization on an object that already exists as an instance, the default implementation throws an exception. + A has a concept of scope; that is, the maintains a conceptual point of reference in its output object graph. For a particular scope, certain operations might be valid or invalid, or produce a no-operation result. For example, if you call to write directives for initialization on an object that already exists as an instance, the default implementation throws an exception. A possible technique for tracking scope in a custom is to align the node actions with a stack or frame class. The stack or frame can keep track of push and pop for each level of object-model depth that is entered or exited while the writes the object graph. ## Callbacks To support intermediate and advanced scenarios, the mechanism of writing an object graph provides callback entry points that occur when a commits or is about to commit certain actions. Some callbacks are enabled in the settings and are not specific to the object type or the member being written; however, callback information is often available in context or is in the event data that is sent through the callback. The following is a list of relevant callbacks: -- The callback that is declared by is invoked when the scope goes to a new object and at the phase of object lifetime for each created object. +- The callback that is declared by is invoked when the scope goes to a new object and at the phase of object lifetime for each created object. -- The callback that is declared by is invoked when the scope goes to a new object and at the phase of object lifetime for each created object. +- The callback that is declared by is invoked when the scope goes to a new object and at the phase of object lifetime for each created object. -- The callback that is declared by is invoked when the scope starts in an object, and occurs when the first call to that object scope is made but not yet committed. +- The callback that is declared by is invoked when the scope starts in an object, and occurs when the first call to that object scope is made but not yet committed. -- The callback that is declared by is invoked when the scope starts in an object, and happens when the call to that object scope is made but not yet committed. +- The callback that is declared by is invoked when the scope starts in an object, and happens when the call to that object scope is made but not yet committed. -- The callback that is declared by is invoked when is called. +- The callback that is declared by is invoked when is called. ## Writing Dictionary Keys - The default implementation of supports type conversion on the constraints of a before the dictionary contents are added to the object graph. In this manner, a generic dictionary can be keyed at run time by objects and can match the relevant generic `Add` and indexer behavior. However, as implemented for the base , this capability exists only for object graph creation from the base class and not for derived classes of . + The default implementation of supports type conversion on the constraints of a before the dictionary contents are added to the object graph. In this manner, a generic dictionary can be keyed at run time by objects and can match the relevant generic `Add` and indexer behavior. However, as implemented for the base , this capability exists only for object graph creation from the base class and not for derived classes of . ## Checks for Disposed XAML writers are potentially used for deferred operations or where a call is made against a XAML writer instance that has been disposed in the interim. Various APIs of might throw in these cases. @@ -354,7 +354,7 @@ is declared in ), this method creates new and passes them to the handler. The return value is set by reading the value that is passed through the event data. If no handler exists and this method is invoked, the call returns `false`. + If the `SetValue` operation for this XAML writer has an associated handler (a is declared in ), this method creates new and passes them to the handler. The return value is set by reading the value that is passed through the event data. If no handler exists and this method is invoked, the call returns `false`. ]]> @@ -397,7 +397,7 @@ ## Remarks The most typical usage of is to call it only when the node stream is known to be at its end, and the object graph is complete. Otherwise, the object graph is likely to be incomplete, and is not useful for most platform scenarios. - typically only contains a non-null value if it is called immediately after a call to , and if the current scope is in the member where the object provides a value. + typically only contains a non-null value if it is called immediately after a call to , and if the current scope is in the member where the object provides a value. ]]> @@ -615,7 +615,7 @@ ## Remarks If this `EndObject` position scope is closing the root object, the new object scope becomes the root scope. - The call to might not yet have created the object because an object member might be a necessary initialization pathway, such as initialization text or initialization parameters. For these cases, the call to actually writes the object. + The call to might not yet have created the object because an object member might be a necessary initialization pathway, such as initialization text or initialization parameters. For these cases, the call to actually writes the object. ]]> @@ -650,9 +650,9 @@ and writing with can be seen in the resulting object graph. does not construct an instance of a type because the API has no information to inform the object graph of what to construct. Instead, the object was created when the parent property was initialized; so a does not need to construct it. In contrast, specifies that an instance of that type should be constructed and inserted into the object graph. + The difference between writing with and writing with can be seen in the resulting object graph. does not construct an instance of a type because the API has no information to inform the object graph of what to construct. Instead, the object was created when the parent property was initialized; so a does not need to construct it. In contrast, specifies that an instance of that type should be constructed and inserted into the object graph. - If you think of the XAML node stream as a series of frames, a is balanced to a call. Therefore, the number of plus calls should equal the number of calls as part of a complete object-writing evaluation of the XAML node stream. + If you think of the XAML node stream as a series of frames, a is balanced to a call. Therefore, the number of plus calls should equal the number of calls as part of a complete object-writing evaluation of the XAML node stream. The conceptual `StartObject` position for an implicit object in the object graph is necessary because although the object value itself is an implicit default, that object might still have members that need to be written based on the XAML node stream. A typical scenario where this occurs is when writes member nodes for a collection property, and the collection initialization is implicit to creating the object that owns the collection property. @@ -692,9 +692,9 @@ can only be called immediately before a call to one of the following: , , or . The consecutive case is for writing multiple namespace declarations to the same node. Eventually, either or must be called. + A namespace declaration can be written if the current scope is a root scope, object scope, or member scope. However, can only be called immediately before a call to one of the following: , , or . The consecutive case is for writing multiple namespace declarations to the same node. Eventually, either or must be called. - does not use a `Start`/`End` metaphor. Although a XAML namespace has members in the CLR representation sense, the members are known and do not need to be represented as a special type of for extensibility. To access the values of a , you access its and properties. + does not use a `Start`/`End` metaphor. Although a XAML namespace has members in the CLR representation sense, the members are known and do not need to be represented as a special type of for extensibility. To access the values of a , you access its and properties. A namespace declaration may have a value for the prefix. A prefix represents a declaration of the default XAML namespace. Do not attempt to use null to represent the default prefix; it throws an exception in this API. For more information, see . diff --git a/xml/System.Xaml/XamlObjectWriterSettings.xml b/xml/System.Xaml/XamlObjectWriterSettings.xml index 522614e0727..4e1b30b383e 100644 --- a/xml/System.Xaml/XamlObjectWriterSettings.xml +++ b/xml/System.Xaml/XamlObjectWriterSettings.xml @@ -23,11 +23,11 @@ Provides specific XAML writer settings for . - can function within specified . Where settings are not specified, an instance of exists that has default values for a constructed , and this instance can be used in merges of settings for a derived class. - + can function within specified . Where settings are not specified, an instance of exists that has default values for a constructed , and this instance can be used in merges of settings for a derived class. + ]]> @@ -139,11 +139,11 @@ Gets or sets permissions that the XAML writer observes. The permissions. - @@ -344,14 +344,14 @@ Gets or sets the XAML namescope to use for registering names from the XAML writer if is . The XAML namescope to use for registering names. The default is . - might use an external XAML namescope. - -## WPF Usage Notes - In the WPF XAML implementation, XAML writer operations that are initiated by specify a separate XAML namescope. In this WPF scenario, templates should not share a XAML namescope with the root of the XAML page that defines them. Instead, they should process into a separate, designated XAML namescope. - + might use an external XAML namescope. + +## WPF Usage Notes + In the WPF XAML implementation, XAML writer operations that are initiated by specify a separate XAML namescope. In this WPF scenario, templates should not share a XAML namescope with the root of the XAML page that defines them. Instead, they should process into a separate, designated XAML namescope. + ]]> @@ -393,13 +393,13 @@ if the XAML writer ignores implementations; otherwise, . The default is . - class and its method are part of an overall design for type conversion in the CLR. In XAML systems, you can typically assume that type-converter input is identifiable by the XAML reader, and for purposes of input, is always a string. If you set this property to `true`, you enable a mode where this assumption is codified in the XAML object writer behavior. - - This mode supports a compatibility requirement for previous versions of WPF XAML. - + class and its method are part of an overall design for type conversion in the CLR. In XAML systems, you can typically assume that type-converter input is identifiable by the XAML reader, and for purposes of input, is always a string. If you set this property to `true`, you enable a mode where this assumption is codified in the XAML object writer behavior. + + This mode supports a compatibility requirement for previous versions of WPF XAML. + ]]> @@ -441,11 +441,11 @@ if type conversion for a object should be disabled. if performing type conversion for a object applies. The default is . - . - + . + ]]> @@ -525,11 +525,11 @@ Gets or sets a preexisting root object for operations. A preexisting root object for operations. - call (with object input that is direct instead of coming from the reader) that precedes the first explicit node-write call by the . Any error checking, such as verifying the XAML type of the provided root object, is deferred until that implicit call, instead of being checked when you set this settings property. - + call (with object input that is direct instead of coming from the reader) that precedes the first explicit node-write call by the . Any error checking, such as verifying the XAML type of the provided root object, is deferred until that implicit call, instead of being checked when you set this settings property. + ]]> @@ -571,11 +571,11 @@ if the duplicate property check should be omitted; otherwise, . - . - + . + ]]> @@ -617,11 +617,11 @@ if the should omit to call on a markup extension; otherwise, . - processes the root node (, or members within the root node). This property is relevant for template and defer-load scenarios. - + processes the root node (, or members within the root node). This property is relevant for template and defer-load scenarios. + ]]> @@ -652,11 +652,11 @@ Used in the in place of the actual . A to be used in place of the actual . - @@ -697,11 +697,11 @@ Gets or sets the handler to use when the object writer calls into a CLR-implemented for dependency properties. A handler implementation that handles this case. - delegate that uses the event data. - + delegate that uses the event data. + ]]> diff --git a/xml/System.Xaml/XamlReader.xml b/xml/System.Xaml/XamlReader.xml index 06c3204ef90..701d7f04ff1 100644 --- a/xml/System.Xaml/XamlReader.xml +++ b/xml/System.Xaml/XamlReader.xml @@ -27,30 +27,30 @@ Provides base definitions for classes that consume XAML input and produce XAML node streams. - is an abstract class and does not provide implementations or definitions that have a working result for all members. Members that do have an implementation in are noted in the remarks for that member. Specifically, has several abstract members that must be implemented, and several virtual members. - - Of the virtual members, and each provide a default implementation that is appropriate for most cases. However, the and default implementations rely on other expected behavior of the implementing XAML reader; in particular, they rely on the override. is also a virtual member that has a working default implementation. - - The following two classes are the most relevant and practical derived classes in .NET Framework XAML Services and the System.Xaml assembly: - -- , which reads an object graph, such as the active object graph of an application at run time. - -- , which reads XAML in the form of a XML text file by using a general that loads the file as an intermediary helper class. - - Other XAML readers from other frameworks include and . - - differs from XML Document Object Model (DOM) and design principles because does not have a `Create` method to return underlying default XAML reader implementations. You must instead instantiate specific derived XAML reader classes by calling their constructors or other class-specific helper APIs. - -## Subtree Readers - For the most part, you call API in the context of specific XAML reader classes that derive from . However, in one particular case, you access API on a practical XAML reader instance that is not public and not derived from or . This case is when you call , which returns a instance. In the default implementation, the that is returned by this API is an internal class. - - The obtained for subtree reading has valid actions for APIs such as and , and those actions are based on the parent reader class. This design enables the internal class to track the frame level where the subtree was entered. The acting subtree makes sure that if the current node position is moved beyond the bounds of the subtree, the specific subtree reader reports end-of-file or `null` at the current node. - - Notes about subtree reader usage are included on certain APIs. - + is an abstract class and does not provide implementations or definitions that have a working result for all members. Members that do have an implementation in are noted in the remarks for that member. Specifically, has several abstract members that must be implemented, and several virtual members. + + Of the virtual members, and each provide a default implementation that is appropriate for most cases. However, the and default implementations rely on other expected behavior of the implementing XAML reader; in particular, they rely on the override. is also a virtual member that has a working default implementation. + + The following two classes are the most relevant and practical derived classes in .NET Framework XAML Services and the System.Xaml assembly: + +- , which reads an object graph, such as the active object graph of an application at run time. + +- , which reads XAML in the form of a XML text file by using a general that loads the file as an intermediary helper class. + + Other XAML readers from other frameworks include and . + + differs from XML Document Object Model (DOM) and design principles because does not have a `Create` method to return underlying default XAML reader implementations. You must instead instantiate specific derived XAML reader classes by calling their constructors or other class-specific helper APIs. + +## Subtree Readers + For the most part, you call API in the context of specific XAML reader classes that derive from . However, in one particular case, you access API on a practical XAML reader instance that is not public and not derived from or . This case is when you call , which returns a instance. In the default implementation, the that is returned by this API is an internal class. + + The obtained for subtree reading has valid actions for APIs such as and , and those actions are based on the parent reader class. This design enables the internal class to track the frame level where the subtree was entered. The acting subtree makes sure that if the current node position is moved beyond the bounds of the subtree, the specific subtree reader reports end-of-file or `null` at the current node. + + Notes about subtree reader usage are included on certain APIs. + ]]> @@ -115,11 +115,11 @@ Closes the XAML node stream. - calls with the `isDisposing` parameter as `true`. - + calls with the `isDisposing` parameter as `true`. + ]]> @@ -154,11 +154,11 @@ to release the managed resources; otherwise, . Releases the unmanaged resources used by the , and optionally, releases the managed resources. - = `true`. - + = `true`. + ]]> @@ -225,11 +225,11 @@ if the position is at the conceptual end-of-file of the XAML node stream; otherwise, . - , with behavior that correctly reflects the bounds of the entered subtree. For more information, see the "Subtree Readers" section in , or see . - + , with behavior that correctly reflects the bounds of the entered subtree. For more information, see the "Subtree Readers" section in , or see . + ]]> @@ -262,11 +262,11 @@ When implemented in a derived class, gets the current member at the reader position, if the reader position is on a . The current member; or , if the reader position is not on a member. - , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . - + , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . + ]]> @@ -300,11 +300,11 @@ When implemented in a derived class, gets the XAML namespace information from the current node. The XAML namespace information, if it is available; otherwise, . - of the current node is . The property does not report the XAML namespace that applies to objects or members in a general scoping sense, as interpreted under a XAML schema context. Your application must provide a means to cache information for the acting XAML namespace as it traverses XAML nodes, if you need that information in a manner other than how the XAML schema context reports it to a writer. See for notes on the reference implementation. - + of the current node is . The property does not report the XAML namespace that applies to objects or members in a general scoping sense, as interpreted under a XAML schema context. Your application must provide a means to cache information for the acting XAML namespace as it traverses XAML nodes, if you need that information in a manner other than how the XAML schema context reports it to a writer. See for notes on the reference implementation. + ]]> @@ -337,11 +337,11 @@ When implemented in a derived class, gets the type of the current node. A value of the enumeration. - , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . - + , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . + ]]> @@ -376,11 +376,11 @@ if a node is available; otherwise, . - , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . - + , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . + ]]> @@ -414,19 +414,19 @@ Returns a that is based on the current , where the returned is used to iterate through a subtree of the XAML node structure. A new XAML reader instance for the subtree. - . The returned is an internal class that restricts certain actions. The restrictions are consistent with the purpose of reading only a dimensioned subtree of a larger source for a XAML node set, and of returning end-of-file or `null` at the current node when the subtree is exited. - - Generally, you should check the current node from the initial to determine whether you need a subtree reader. How you check this may be implementation-specific; however, avoid creating multiple subtree readers for every subtree. In addition, avoid invoking a subtree reader for certain node cases (for example, for ) that cannot contain a subtree of nodes. - - After you obtain a subtree reader, you must call on it to obtain a current node (or call to obtain a next node). You do not automatically obtain an initial node position from the subtree reader when you create it. - - The reader you obtain by calling from this default implementation is an internal class. The internal class bases its behavior on the implementation that is being used when is called. The purpose of the internal class is to wrap the and general traversal behavior. The traversal stays within the intended subtree by keeping track of / pairs or / pairs. It also correctly returns `false` for and `true` for when the reader is at the end of the subtree, as defined by its entry point. In general, you assume that any API you call from a subtree reader has the same implementation as the overall except for the traversal bounding behavior. - - However, is virtual. Therefore, a specific implementation can provide behavior that differs from the internal wrapper behavior; and a implementation can even disable subtree reader functionality by returning or other exceptions. - + . The returned is an internal class that restricts certain actions. The restrictions are consistent with the purpose of reading only a dimensioned subtree of a larger source for a XAML node set, and of returning end-of-file or `null` at the current node when the subtree is exited. + + Generally, you should check the current node from the initial to determine whether you need a subtree reader. How you check this may be implementation-specific; however, avoid creating multiple subtree readers for every subtree. In addition, avoid invoking a subtree reader for certain node cases (for example, for ) that cannot contain a subtree of nodes. + + After you obtain a subtree reader, you must call on it to obtain a current node (or call to obtain a next node). You do not automatically obtain an initial node position from the subtree reader when you create it. + + The reader you obtain by calling from this default implementation is an internal class. The internal class bases its behavior on the implementation that is being used when is called. The purpose of the internal class is to wrap the and general traversal behavior. The traversal stays within the intended subtree by keeping track of / pairs or / pairs. It also correctly returns `false` for and `true` for when the reader is at the end of the subtree, as defined by its entry point. In general, you assume that any API you call from a subtree reader has the same implementation as the overall except for the traversal bounding behavior. + + However, is virtual. Therefore, a specific implementation can provide behavior that differs from the internal wrapper behavior; and a implementation can even disable subtree reader functionality by returning or other exceptions. + ]]> @@ -487,17 +487,17 @@ Skips the current node and advances the reader position to the next node. - is called by the default implementation. You typically do not call and in sequence. - - In the default implementation, different actions are taken depending on which the reader position is currently on. If the reader position is currently on a or , that member or object is skipped. For other values, no action is taken other than calling from the current position. - - Subtree readers can call , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . - - The node tree behavior of is based on the XML equivalent . Based on the behavior equivalence, skips the node and its subtree, not just the single entry node. - + is called by the default implementation. You typically do not call and in sequence. + + In the default implementation, different actions are taken depending on which the reader position is currently on. If the reader position is currently on a or , that member or object is skipped. For other values, no action is taken other than calling from the current position. + + Subtree readers can call , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . + + The node tree behavior of is based on the XML equivalent . Based on the behavior equivalence, skips the node and its subtree, not just the single entry node. + ]]> @@ -531,12 +531,12 @@ Releases all resources used by the current instance of the class. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -567,11 +567,11 @@ This member is an explicit interface member implementation. It can be used only When implemented in a derived class, gets the of the current node. The of the current node; or , if the current reader position is not on an object. - , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . - + , with behavior restrictions. For more information, see the "Subtree Readers" section in , or see . + ]]> diff --git a/xml/System.Xaml/XamlSchemaContext.xml b/xml/System.Xaml/XamlSchemaContext.xml index 5d3612cb04a..a84907bc78f 100644 --- a/xml/System.Xaml/XamlSchemaContext.xml +++ b/xml/System.Xaml/XamlSchemaContext.xml @@ -23,18 +23,18 @@ Defines a reusable context for interpreting or mapping XAML types, and the types in the assemblies that underlie them. - - In an , a can be shared between multiple callers, which include both full and partial trust callers. This situation exists in frameworks such as WPF, which provide partial-trust access to XAML loading for portions of the WPF application model. The default implementation provides safeguards in this scenario by keeping all its properties and settings immutable. Derived implementations should also consider following this model of immutability for properties and settings of a XAML schema context. - - The base class is designed so that lookups have no externally observable side effects. The types that are referenced by APIs in the base class, such as or , also produce no side effects from lookups. All data that is needed to make a schema determination should be available from the construction and settings of the . Notice that no lookup APIs rely on explicitly passed-in services; their input relies on string input only. - + In an , a can be shared between multiple callers, which include both full and partial trust callers. This situation exists in frameworks such as WPF, which provide partial-trust access to XAML loading for portions of the WPF application model. The default implementation provides safeguards in this scenario by keeping all its properties and settings immutable. Derived implementations should also consider following this model of immutability for properties and settings of a XAML schema context. + + The base class is designed so that lookups have no externally observable side effects. The types that are referenced by APIs in the base class, such as or , also produce no side effects from lookups. All data that is needed to make a schema determination should be available from the construction and settings of the . Notice that no lookup APIs rely on explicitly passed-in services; their input relies on string input only. + The base class, and and are all thread safe in their base implementations. If you derive from or derive XAML type system classes such as and , you can choose whether your classes will behave as thread safe. @@ -144,11 +144,11 @@ The settings object to use to construct the . Initializes a new instance of the class, based on a settings object. - . - + . + ]]> @@ -209,13 +209,13 @@ Provides a nonstandard implementation that does not invoke . - properties might still be active, and disposing a XAML schema context can interfere with the related defer-load operation. - - event handlers, which are hooked internally as weak references, are cleaned up by this implementation. - + properties might still be active, and disposing a XAML schema context can interfere with the related defer-load operation. + + event handlers, which are hooked internally as weak references, are cleaned up by this implementation. + ]]> @@ -247,13 +247,13 @@ if a XAML schema and its context use fully qualified assembly names in the values that are returned by the lookup APIs; otherwise, . - value that is established in the settings for the constructor signature. If other signatures were used for construction or if is not specifically set to `true`, the value of this property is `false`. - - The value of this property influences the strings that are returned by . If is `true`, the assembly portion of the string reports the equivalent of . - + value that is established in the settings for the constructor signature. If other signatures were used for construction or if is not specifically set to `true`, the value of this property is `false`. + + The value of this property influences the strings that are returned by . If is `true`, the assembly portion of the string reports the equivalent of . + ]]> @@ -285,11 +285,11 @@ Searches the assemblies that are held by this and returns a set of namespaces. An enumerable set of namespace identifiers. These identifiers are provided as strings. - is active. - + is active. + ]]> @@ -356,13 +356,13 @@ Gets a string that is reported as the preferred prefix for consumers to use when they map the specified XAML namespace. A string that consumers should use when they map the specified XAML namespace for markup use. - at the assembly level. - + at the assembly level. + ]]> @@ -443,11 +443,11 @@ Returns a value that represents a directive, either for the XAML language or for a particular implementation. A object that represents the requested directive. - as part of a XAML type system extension scenario. - + as part of a XAML type system extension scenario. + ]]> @@ -493,11 +493,11 @@ Returns a that is based on a CLR type identifier. The that matches the input . - . - + . + ]]> @@ -613,13 +613,13 @@ Called when operations use this schema context to resolve an assembly that is required in order to resolve the XAML namespaces that it contains. The resolved assembly. - construction behavior. - - The purpose of this API is to enable first-opportunity resolution against known sets of assemblies, such as against reference assemblies instead of against a global assembly cache. If the list of reference assemblies is populated, the default implementation can access the known reference assemblies. - + construction behavior. + + The purpose of this API is to enable first-opportunity resolution against known sets of assemblies, such as against reference assemblies instead of against a global assembly cache. If the list of reference assemblies is populated, the default implementation can access the known reference assemblies. + ]]> @@ -685,15 +685,15 @@ if the schema context permits markup extensions that have duplicate arity; otherwise, . The default is . - value that is established in the settings for the constructor signature. If other signatures are used for construction or if is not specifically set to `true`, the value of this property is `false`. - - Duplicate arity of markup extensions is not specifically addressed by the XAML specification [MS-XAML], section 6.6.7.2. This is because formation of the XAML information item for a markup extension is identical regardless of duplicate arity that might exist in the markup extension implementation. Only the actual invocation of the markup extension and its `ProvideValue` exposes any issues associated with duplicate arity. Behavior for handling duplicate arity is thus undefined and is left up to each implementing XAML schema context and its XAML writer integration. The default XAML schema context as implemented for .NET Framework XAML Services operations does not support duplicate arity; various .NET Framework XAML Services APIs will throw exceptions when processing markup extension usage with underlying duplicate arity. - - For more information about defining markup extensions, see [Markup Extensions for XAML Overview](/dotnet/framework/xaml-services/markup-extensions-for-xaml-overview). - + value that is established in the settings for the constructor signature. If other signatures are used for construction or if is not specifically set to `true`, the value of this property is `false`. + + Duplicate arity of markup extensions is not specifically addressed by the XAML specification [MS-XAML], section 6.6.7.2. This is because formation of the XAML information item for a markup extension is identical regardless of duplicate arity that might exist in the markup extension implementation. Only the actual invocation of the markup extension and its `ProvideValue` exposes any issues associated with duplicate arity. Behavior for handling duplicate arity is thus undefined and is left up to each implementing XAML schema context and its XAML writer integration. The default XAML schema context as implemented for .NET Framework XAML Services operations does not support duplicate arity; various .NET Framework XAML Services APIs will throw exceptions when processing markup extension usage with underlying duplicate arity. + + For more information about defining markup extensions, see [Markup Extensions for XAML Overview](/dotnet/framework/xaml-services/markup-extensions-for-xaml-overview). + ]]> @@ -731,17 +731,17 @@ if contains a usable result; otherwise, . - parameter evaluation. - - If no other compatible namespace is discovered and this method returns `false`, the `compatibleNamespace` parameter output might have the same value as the `xamlNamespace` input. - + parameter evaluation. + + If no other compatible namespace is discovered and this method returns `false`, the `compatibleNamespace` parameter output might have the same value as the `xamlNamespace` input. + ]]> diff --git a/xml/System.Xaml/XamlSchemaContextSettings.xml b/xml/System.Xaml/XamlSchemaContextSettings.xml index 0e09793fa8b..074cea37a89 100644 --- a/xml/System.Xaml/XamlSchemaContextSettings.xml +++ b/xml/System.Xaml/XamlSchemaContextSettings.xml @@ -129,11 +129,11 @@ if a XAML schema and its context use fully qualified assembly names in the values that are returned by the lookup APIs; otherwise, . - in the constructed schema context. If is `true`, the assembly part of the string reports the equivalent of . - + in the constructed schema context. If is `true`, the assembly part of the string reports the equivalent of . + ]]> @@ -176,11 +176,11 @@ if the schema context allows for markup extensions that have duplicate arity; otherwise, . - , you cannot read the settings directly. Instead, you receive values from specific read-only properties, such as , which report the settings-based values. - + , you cannot read the settings directly. Instead, you receive values from specific read-only properties, such as , which report the settings-based values. + ]]> diff --git a/xml/System.Xaml/XamlServices.xml b/xml/System.Xaml/XamlServices.xml index 4a3a3470505..dba2bbbbeb6 100644 --- a/xml/System.Xaml/XamlServices.xml +++ b/xml/System.Xaml/XamlServices.xml @@ -77,9 +77,9 @@ method specify different types of input for the source XAML. The internal implementation first creates an by calling and then creates a new instance of a specialized that processes the input. + Different signatures for the method specify different types of input for the source XAML. The internal implementation first creates an by calling and then creates a new instance of a specialized that processes the input. - In order for the call to successfully create an object graph, the following must be true: + In order for the call to successfully create an object graph, the following must be true: - The source is well-formed and valid XML. @@ -129,7 +129,7 @@ that is constructed by using a valid XAML-as-string input for the constructor. + In order to return the object graph, the `textReader` input should be constructed by using its relevant input. For example, it should pass a that is constructed by using a valid XAML-as-string input for the constructor. ]]> @@ -170,9 +170,9 @@ method specify different types of input for the source XAML. The internal implementation first creates an by calling and then creates a new instance of a specialized that processes the input. + Different signatures for the method specify different types of input for the source XAML. The internal implementation first creates an by calling and then creates a new instance of a specialized that processes the input. - In order for the call to successfully create an object graph, the following must be true: + In order for the call to successfully create an object graph, the following must be true: - The source is well-formed and valid XML. @@ -305,7 +305,7 @@ call to successfully create an object tree, the following must be true: + In order for the call to successfully create an object tree, the following must be true: - The `xaml` input is well-formed and valid XML. @@ -366,7 +366,7 @@ ## Remarks The output from this method is the `ToString` result of an that is created by the method call. That is created by using the following settings: is `true`; and is `true`. - The returned string can be loaded as valid XML through the method if you processed the string into a stream, or into a reader more specifically dedicated for XAML. + The returned string can be loaded as valid XML through the method if you processed the string into a stream, or into a reader more specifically dedicated for XAML. ]]> @@ -485,7 +485,7 @@ , which creates a as part of the method call. + The `fileName` parameter value is used as the `outputFileName` input for a call to , which creates a as part of the method call. ]]> @@ -625,7 +625,7 @@ , where `closeWriter` is specified as `true`. + This method is a wrapper around , where `closeWriter` is specified as `true`. ]]> diff --git a/xml/System.Xaml/XamlType.xml b/xml/System.Xaml/XamlType.xml index e7f680c9456..45f8ee94d93 100644 --- a/xml/System.Xaml/XamlType.xml +++ b/xml/System.Xaml/XamlType.xml @@ -119,7 +119,7 @@ , you must use the other constructor signatures (, , or ) to initialize a object. + This is a protected constructor. No current public derived classes exist that use this particular path for construction. As a consumer of the existing , you must use the other constructor signatures (, , or ) to initialize a object. ]]> @@ -200,7 +200,7 @@ is `true`. Instead, the default reflector logic reports the underlying type as . However, this behavior can change because of the override. + Use this constructor only for "unknown" types where a XAML type that maps to an underlying type system is unavailable. This constructor might not produce a result where is `true`. Instead, the default reflector logic reports the underlying type as . However, this behavior can change because of the override. ]]> @@ -238,7 +238,7 @@ ## Remarks Types that are assignable a specific content type (for example, assignable to a base type that is an allowed content type) are not considered multiple types for purposes of . - If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. ]]> @@ -273,10 +273,10 @@ , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. By default, returns an internal constant that represents an if is `null`. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. By default, returns an internal constant that represents an if is `null`. > [!IMPORTANT] -> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the reported type information about a XAML type so that it no longer aligns in an expected way with the type system information of its underlying CLR type. For any security-critical checks of assignment operations and access, use the underlying CLR type instead. +> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the reported type information about a XAML type so that it no longer aligns in an expected way with the type system information of its underlying CLR type. For any security-critical checks of assignment operations and access, use the underlying CLR type instead. ]]> @@ -320,12 +320,12 @@ If one of the two instances that are used for comparison has equal to `true`, this method has a special Unknown mode that returns `true` if the two instances are equivalent. - The default implementation uses the CLR from for this and the input , and calls . Override this method if you want a different determination of assignable types. + The default implementation uses the CLR from for this and the input , and calls . Override this method if you want a different determination of assignable types. Passing a null `xamlType` does not throw an exception and always returns `false`. > [!IMPORTANT] -> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the assignability of a XAML type so that it no longer aligns in an expected way with the type-casting behavior of its underlying CLR type. For any security-critical checks of assignment operations and access, use the underlying CLR type instead. +> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the assignability of a XAML type so that it no longer aligns in an expected way with the type-casting behavior of its underlying CLR type. For any security-critical checks of assignment operations and access, use the underlying CLR type instead. ]]> @@ -367,7 +367,7 @@ , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -407,7 +407,7 @@ This property aligns to the `[content property]` information item in the [MS-XAML] specification. - If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -444,11 +444,11 @@ ## Remarks If there are no wrappers to account for type match loosening, this property is `null`. - Types that evaluate as for a specific content type are not considered multiple types for purposes of . + Types that evaluate as for a specific content type are not considered multiple types for purposes of . In the CLR binding for and , the XAML content wrapper type can be specified on a type as a . - If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -485,7 +485,7 @@ ## Remarks XAML template behavior in WPF is an example of deferred loading behavior. - If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -608,7 +608,7 @@ , calls to this method can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this method can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -646,7 +646,7 @@ ## Remarks Each in the returned collection should contain values that support the concept that the is an attachable member. For example, members should return `true` for , a type for , and so on. - If you do not use the default internal CLR reflection technique for a , calls to this method can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this method can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -682,7 +682,7 @@ overrides on derived classes. + Calls to this method can invoke overrides on derived classes. ]]> @@ -721,10 +721,10 @@ overrides on derived classes. + Calls to this method can invoke overrides on derived classes. > [!IMPORTANT] -> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the reported members of a XAML type so that they no longer align in an expected way with the `Get*` information about the underlying CLR type. For any security-critical checks of member reporting, use the underlying CLR type instead. +> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the reported members of a XAML type so that they no longer align in an expected way with the `Get*` information about the underlying CLR type. For any security-critical checks of member reporting, use the underlying CLR type instead. ]]> @@ -792,12 +792,12 @@ instead. Prefixed member names should not be used; a prefix is situational to a usage and the XAML type system cannot know the context of such a usage and how the prefix is mapped. + The value for `name` is expected to be unqualified. Type-qualified names that indicate an attached member should be submitted to instead. Prefixed member names should not be used; a prefix is situational to a usage and the XAML type system cannot know the context of such a usage and how the prefix is mapped. - Calls to this method can invoke overrides on derived classes. + Calls to this method can invoke overrides on derived classes. > [!IMPORTANT] -> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the reported members of a XAML type so that they no longer align in an expected way with the `Get*` information about the underlying CLR type. For any security-critical checks of member reporting, use the underlying CLR type instead. +> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the reported members of a XAML type so that they no longer align in an expected way with the `Get*` information about the underlying CLR type. For any security-critical checks of member reporting, use the underlying CLR type instead. ]]> @@ -838,9 +838,9 @@ ## Remarks This API is only relevant if this represents a markup extension ( is `true`). - The input `parameterCount` is not for requesting the type of a specific positional parameter. It is for specifying the arity of a markup extension usage. Markup extension usage often has multiple "signatures" and uses different parameter arity (count) of positional parameters to differentiate. However, you can configure a schema context to allow duplicate arities and use types of the positional parameters for differentiation. For more information, see . For a specific arity (count), the parameter positions and types can vary. To get the positional type of a specific arity's markup extension usage, you first call specifying the arity count. Then get the item at that position from the returned collection. + The input `parameterCount` is not for requesting the type of a specific positional parameter. It is for specifying the arity of a markup extension usage. Markup extension usage often has multiple "signatures" and uses different parameter arity (count) of positional parameters to differentiate. However, you can configure a schema context to allow duplicate arities and use types of the positional parameters for differentiation. For more information, see . For a specific arity (count), the parameter positions and types can vary. To get the positional type of a specific arity's markup extension usage, you first call specifying the arity count. Then get the item at that position from the returned collection. - Calls to this method can invoke overrides on derived classes. + Calls to this method can invoke overrides on derived classes. ]]> @@ -878,7 +878,7 @@ ## Remarks Typical XAML namespace identifiers are strings in URI form. - The default implementation checks the following, in order: the XAML namespace that is supplied in construction ( signature only); and the namespaces that are available from the schema context. If these are each `null`, a new list is generated that contains a single empty string. You can override this method to change the lookup methodology. + The default implementation checks the following, in order: the XAML namespace that is supplied in construction ( signature only); and the namespaces that are available from the schema context. If these are each `null`, a new list is generated that contains a single empty string. You can override this method to change the lookup methodology. ]]> @@ -913,9 +913,9 @@ , calling can invoke either or a specific override of that method. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calling can invoke either or a specific override of that method. For more information about return values and other behavior, see the documentation for on this type. - If a override returns `null`, or if the default implementation returns `null` because of lack of for this , then returns . + If a override returns `null`, or if the default implementation returns `null` because of lack of for this , then returns . ]]> @@ -957,7 +957,7 @@ , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -993,7 +993,7 @@ , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -1029,7 +1029,7 @@ , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -1073,7 +1073,7 @@ ## Remarks This property aligns to the `[is default constructible]` information item in the [MS-XAML] specification. - If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -1112,7 +1112,7 @@ ## Remarks This property aligns to the `[is dictionary]` information item in the [MS-XAML] specification. - If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -1192,7 +1192,7 @@ ## Remarks In XAML specification terms, this type must be assignable to `x:MarkupExtension` in order to return `true` for . - If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -1238,7 +1238,7 @@ This property aligns to the `[is name scope]` information item in the [MS-XAML] specification. - If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. ]]> @@ -1311,7 +1311,7 @@ ## Remarks This property aligns to the `[is nullable]` information item in the [MS-XAML] specification. - If you are not using the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. + If you are not using the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. ]]> @@ -1353,10 +1353,10 @@ , calls to this property can invoke overrides on derived classes. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. > [!IMPORTANT] -> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the reported access information about a XAML type so that it no longer aligns in an expected way with the type system and access information of its underlying CLR type. For any security-critical checks of assignment operations and access, use the underlying CLR type instead. +> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the reported access information about a XAML type so that it no longer aligns in an expected way with the type system and access information of its underlying CLR type. For any security-critical checks of assignment operations and access, use the underlying CLR type instead. ]]> @@ -1392,9 +1392,9 @@ , calls to this property can invoke overrides on derived classes. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. - For a load path that involves , a that has `true` for cannot be written into an object graph. Under the default implementations in , the call throws a when the relevant reports `true` for . You should not pass a that has as `true` unless you are prepared to handle the exceptions from , or you have other ways to adjust the behavior or the XAML node stream prior to writing the object graph. + For a load path that involves , a that has `true` for cannot be written into an object graph. Under the default implementations in , the call throws a when the relevant reports `true` for . You should not pass a that has as `true` unless you are prepared to handle the exceptions from , or you have other ways to adjust the behavior or the XAML node stream prior to writing the object graph. ]]> @@ -1438,7 +1438,7 @@ ## Remarks Top-down is a metaphor that approximates XAML processor behavior when creating the object graph. When built top-down, a type is instantiated, attached to the parent, and then has its properties set. Top-down construction avoids invoking property-changed handlers multiple times. Such handling ripples up the object graph and therefore, eliminates the multiple handler calls and provides a performance optimization for startup of the object graph. - If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -1482,7 +1482,7 @@ , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -1526,7 +1526,7 @@ ## Remarks This property aligns to the `[is xdata]` information item in the [MS-XAML] specification. - If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -1563,7 +1563,7 @@ ## Remarks This property is only relevant if this represents a collection ( is `true`). The `Items` property is whatever property holds items in that type of collection or array. - If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -1600,7 +1600,7 @@ ## Remarks This property is only relevant if this represents a dictionary ( is `true`). - If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -1639,7 +1639,7 @@ . + This method can be invoked when a caller gets a value from . The default implementation can return results for the following XAML directives: `Key`; `Name`; `Uid`; and `xml:lang`. Values for these depend on underlying reflection and might still return `null` if no aliased property is found. @@ -1681,13 +1681,13 @@ . + This method can be invoked when a caller gets a value from . - Although returns a generic collection, this `Lookup` method returns a generic enumerable set. + Although returns a generic collection, this `Lookup` method returns a generic enumerable set. - The default implementation uses the internal CLR reflection. When is `null`, the default implementation can use , if it is available. This behavior calls recursively to attempt to find a valid base type and returns `null` if no valid base type exists. + The default implementation uses the internal CLR reflection. When is `null`, the default implementation can use , if it is available. This behavior calls recursively to attempt to find a valid base type and returns `null` if no valid base type exists. - Override this method if you are not relying on default internal CLR reflection and are using metadata or other techniques for reporting the XAML type system information or schema information of a type. A null return should be reserved for cases where information cannot be determined because of lack of type system or reflection support. If a type is valid and reflection or other techniques are available, but a type does not have attachable members, you should instead return an empty set. + Override this method if you are not relying on default internal CLR reflection and are using metadata or other techniques for reporting the XAML type system information or schema information of a type. A null return should be reserved for cases where information cannot be determined because of lack of type system or reflection support. If a type is valid and reflection or other techniques are available, but a type does not have attachable members, you should instead return an empty set. ]]> @@ -1723,15 +1723,15 @@ . + This method can be invoked when a caller gets a value from . - Although returns a generic collection, this `Lookup` method returns a generic enumerable set. + Although returns a generic collection, this `Lookup` method returns a generic enumerable set. - The default implementation uses the internal CLR reflection. For cases where is `null`, the default implementation can use , if it is available. This behavior calls recursively to attempt to find a valid base type, and returns `null` if no valid base type exists. + The default implementation uses the internal CLR reflection. For cases where is `null`, the default implementation can use , if it is available. This behavior calls recursively to attempt to find a valid base type, and returns `null` if no valid base type exists. - Override this method if you are not relying on default internal CLR reflection and are using metadata or other techniques for reporting the XAML type system information or schema information of a type. A null return should be reserved for cases where information cannot be determined because of lack of type system or reflection support. If a type is valid, reflection or other techniques are available; if a type does not have members, you should instead return an empty set. + Override this method if you are not relying on default internal CLR reflection and are using metadata or other techniques for reporting the XAML type system information or schema information of a type. A null return should be reserved for cases where information cannot be determined because of lack of type system or reflection support. If a type is valid, reflection or other techniques are available; if a type does not have members, you should instead return an empty set. - Return values for and should be mutually exclusive. If you have a situation where a backing type system property can support a standard instance usage as well as an attachable usage, that member should be reported as two different values, with one value appearing in the attachable list and another in the standard members list. + Return values for and should be mutually exclusive. If you have a situation where a backing type system property can support a standard instance usage as well as an attachable usage, that member should be reported as two different values, with one value appearing in the attachable list and another in the standard members list. ]]> @@ -1769,7 +1769,7 @@ ## Remarks This method can be invoked when a caller gets a value from . - Types that evaluate as for a specific content type are not considered multiple types for purposes of . + Types that evaluate as for a specific content type are not considered multiple types for purposes of . The default implementation can use other properties of (, , or ) to obtain a result. The `Lookup` overrides for the preceding property list can also be invoked in this determination. @@ -1812,14 +1812,14 @@ . + This method can be invoked when a caller gets a value from . - The default implementation uses the internal CLR reflection. When is `null`, the default implementation can use , if it is available. This behavior calls recursively to attempt to find a valid base type and returns `null` if no valid base type exists. + The default implementation uses the internal CLR reflection. When is `null`, the default implementation can use , if it is available. This behavior calls recursively to attempt to find a valid base type and returns `null` if no valid base type exists. Override this method if you are not relying on default internal CLR reflection and are using metadata or other techniques for reporting the XAML type system information or schema information of a type. > [!IMPORTANT] -> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the reported members of a XAML type so that they no longer align in an expected way with the `Get*` information about the underlying CLR type. For any security-critical checks of member reporting, use the underlying CLR type instead. +> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the reported members of a XAML type so that they no longer align in an expected way with the `Get*` information about the underlying CLR type. For any security-critical checks of member reporting, use the underlying CLR type instead. ]]> @@ -1862,7 +1862,7 @@ Override this method if you are not relying on default internal CLR reflection and are using metadata or other techniques for reporting the XAML type system information or schema information of a type. > [!IMPORTANT] -> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the reported type information about a XAML type so that it no longer aligns in an expected way with the type system information of its underlying CLR type. For any security-critical checks of assignment operations and access, use the underlying CLR type instead. +> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the reported type information about a XAML type so that it no longer aligns in an expected way with the type system information of its underlying CLR type. For any security-critical checks of assignment operations and access, use the underlying CLR type instead. ]]> @@ -1900,7 +1900,7 @@ ## Remarks This method is invoked by an internal private method (no public `CollectionKind` or `GetCollectionKind` API exists on ). - The default implementation uses the internal CLR reflection. For cases where is `null`, the default implementation can use , if it is available. This behavior indirectly calls recursively to attempt to find a valid base type; it returns if no valid base type exists. In general, the default implementation attempts to find the `Add` method of the underlying type by reflection. If found, the of the `Add` method is enough information to determine which value should be returned. Otherwise, it returns . + The default implementation uses the internal CLR reflection. For cases where is `null`, the default implementation can use , if it is available. This behavior indirectly calls recursively to attempt to find a valid base type; it returns if no valid base type exists. In general, the default implementation attempts to find the `Add` method of the underlying type by reflection. If found, the of the `Add` method is enough information to determine which value should be returned. Otherwise, it returns . Override this method if you are not relying on default internal CLR reflection and are using metadata or other techniques for reporting the XAML type system information or schema information of a type. @@ -2304,7 +2304,7 @@ ## Remarks This method can be invoked by calls to . - The default implementation makes a call indirectly against the type . is an interface that is defined in the assembly WindowsBase.dll. This technique for XAML namescope identification is used both by WPF and Windows Workflow Foundation implementations of XAML. + The default implementation makes a call indirectly against the type . is an interface that is defined in the assembly WindowsBase.dll. This technique for XAML namescope identification is used both by WPF and Windows Workflow Foundation implementations of XAML. Override this method if you want to use different logic. @@ -2394,7 +2394,7 @@ Override this method if you want to use different logic. > [!IMPORTANT] -> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the reported access information about a XAML type so that it no longer aligns in an expected way with the type system or access information of its underlying CLR type. For any security-critical checks of assignment operations and access, use the underlying CLR type instead. +> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the reported access information about a XAML type so that it no longer aligns in an expected way with the type system or access information of its underlying CLR type. For any security-critical checks of assignment operations and access, use the underlying CLR type instead. ]]> @@ -2515,7 +2515,7 @@ ## Remarks This method can be invoked by calls to . - The default implementation makes a call indirectly against the type . + The default implementation makes a call indirectly against the type . Override this method if you want to use different logic. @@ -2557,7 +2557,7 @@ The default implementation can use CLR reflection concepts, such as checking for an `Add` method by and using the ; checking ; and checking and trying the same logic there. - Override this method if you want to use different logic. Cases where returns should return `null`. + Override this method if you want to use different logic. Cases where returns should return `null`. ]]> @@ -2597,7 +2597,7 @@ The default implementation can use CLR reflection concepts, such as checking for an `Add` method by and using the ; and checking and trying the same logic there. - Override this method if you want to use different logic. Cases where does not return should return `null`. + Override this method if you want to use different logic. Cases where does not return should return `null`. ]]> @@ -2679,14 +2679,14 @@ . + This method can be invoked by calls to . The default implementation returns a based on internal CLR reflection and evaluation against the schema context. - Override this method if you want to use different logic. + Override this method if you want to use different logic. > [!IMPORTANT] -> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the reported members of a XAML type so that they no longer align in an expected way with the `Get*` information about the underlying CLR type. For any security-critical checks of member reporting, use the underlying CLR type instead. +> is virtual, and therefore, can be overridden. The override has the potential (whether for malicious purposes or otherwise) to change the reported members of a XAML type so that they no longer align in an expected way with the `Get*` information about the underlying CLR type. For any security-critical checks of member reporting, use the underlying CLR type instead. ]]> @@ -2725,13 +2725,13 @@ . + This method can be invoked by calls to . - The default implementation uses internal reflection information based on finding constructors and checking the arity. Override this method if you want to use different logic. + The default implementation uses internal reflection information based on finding constructors and checking the arity. Override this method if you want to use different logic. This API is only relevant if this represents a markup extension ( is `true`). - The input `parameterCount` is not for requesting the type of a specific positional parameter. It is for specifying the arity of a markup extension usage. Markup extension usage often has multiple signatures and uses different parameter arity (count) of positional parameters to differentiate. However, you can configure a schema context to allow duplicate arities and use types of the positional parameters for differentiation. For more information, see . For a specific arity count, the parameter positions and types can vary. To get the positional type of a specific arity's markup extension usage, you first call with the arity count. Then get the item at that position from the returned collection. + The input `parameterCount` is not for requesting the type of a specific positional parameter. It is for specifying the arity of a markup extension usage. Markup extension usage often has multiple signatures and uses different parameter arity (count) of positional parameters to differentiate. However, you can configure a schema context to allow duplicate arities and use types of the positional parameters for differentiation. For more information, see . For a specific arity count, the parameter positions and types can vary. To get the positional type of a specific arity's markup extension usage, you first call with the arity count. Then get the item at that position from the returned collection. ]]> @@ -3042,7 +3042,7 @@ ## Remarks This property is only relevant if this represents a markup extension (`x:MarkupExtension` is in the assignable types list). - If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -3083,7 +3083,7 @@ signature), or the name of the , if it is constructed by using the pertinent constructor of the CLR type system. + This property typically gets the schema-constructed name (per the signature), or the name of the , if it is constructed by using the pertinent constructor of the CLR type system. ]]> @@ -3188,7 +3188,7 @@ and then getting the first value string from the returned enumerable set. + This implementation provides the same value as calling and then getting the first value string from the returned enumerable set. ]]> @@ -3265,7 +3265,7 @@ implementation of returns the property of the . + The implementation of returns the property of the . ]]> @@ -3307,7 +3307,7 @@ , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -3348,7 +3348,7 @@ where calling the parameter returns a list where the types are still open. In this case, one or more of the returned values will have placeholder values for , such as `T`, to represent that the generic is still open. This scenario can occur if you get a from a call to , instead of from a XAML reader implementation. + There are certain scenarios for a where calling the parameter returns a list where the types are still open. In this case, one or more of the returned values will have placeholder values for , such as `T`, to represent that the generic is still open. This scenario can occur if you get a from a call to , instead of from a XAML reader implementation. ]]> @@ -3383,7 +3383,7 @@ , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> @@ -3452,7 +3452,7 @@ , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. + If you do not use the default internal CLR reflection technique for a , calls to this property can invoke overrides on derived classes. For more information about return values and other behavior, see the documentation for on this type. ]]> diff --git a/xml/System.Xaml/XamlWriter.xml b/xml/System.Xaml/XamlWriter.xml index a3714b52b95..362e4da6135 100644 --- a/xml/System.Xaml/XamlWriter.xml +++ b/xml/System.Xaml/XamlWriter.xml @@ -27,17 +27,17 @@ Provides default implementation and base class definitions for a XAML writer. This is not a working default XAML writer; you must either derive from and implement its abstract members, or use an existing derived class. - are the and classes, as the following details explain: - -- processes a XAML node set and produces an XML text file. This class might be used for serialization or as part of the function of a tool that works with in-memory representation of XAML and produces XAML file output. - -- processes a XAML node set and produces an object graph. This class might be used as part of a full or partial customization of a technology's XAML parser. - - is a class for settings that are used by a ; however, by default, the class does not hold any specific settings. The base constructor does not use this settings class as an argument, nor does any other member. Instead, the and classes include their own settings classes as construction arguments. These settings classes are and . The settings classes define actual settings values and are based on , so that they can use the merge feature. - + are the and classes, as the following details explain: + +- processes a XAML node set and produces an XML text file. This class might be used for serialization or as part of the function of a tool that works with in-memory representation of XAML and produces XAML file output. + +- processes a XAML node set and produces an object graph. This class might be used as part of a full or partial customization of a technology's XAML parser. + + is a class for settings that are used by a ; however, by default, the class does not hold any specific settings. The base constructor does not use this settings class as an argument, nor does any other member. Instead, the and classes include their own settings classes as construction arguments. These settings classes are and . The settings classes define actual settings values and are based on , so that they can use the merge feature. + ]]> @@ -98,11 +98,11 @@ Closes the XAML writer object. - calls the method with the `isDisposing` parameter as `true`. - + calls the method with the `isDisposing` parameter as `true`. + ]]> @@ -137,11 +137,11 @@ to release the managed resources; otherwise, . Releases the unmanaged resources used by the and optionally releases the managed resources. - = `true`. - + = `true`. + ]]> @@ -238,12 +238,12 @@ See . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -392,15 +392,15 @@ This member is an explicit interface member implementation. It can be used only The reader to use for node determination. Performs switching based on node type from the XAML reader () and calls the relevant method for the writer implementation. - method is not a virtual method because it has practical implementation for all existing values. Based on , calls into the `Write` virtual members that are dedicated to particular node types. - - If you have an advanced XAML writing scenario that expands the XAML type system and XAML node stream concept so that new node types are defined, do not use calls in your logic. You must instead provide your own alternative for node-type switching logic in the class or in virtual overrides. - + method is not a virtual method because it has practical implementation for all existing values. Based on , calls into the `Write` virtual members that are dedicated to particular node types. + + If you have an advanced XAML writing scenario that expands the XAML type system and XAML node stream concept so that new node types are defined, do not use calls in your logic. You must instead provide your own alternative for node-type switching logic in the class or in virtual overrides. + ]]> diff --git a/xml/System.Xaml/XamlXmlReader.xml b/xml/System.Xaml/XamlXmlReader.xml index 2ad0779dbc1..1568093feec 100644 --- a/xml/System.Xaml/XamlXmlReader.xml +++ b/xml/System.Xaml/XamlXmlReader.xml @@ -32,7 +32,7 @@ ## Remarks When you construct a , an is required. The purpose of this design is to use established .NET Framework APIs for XML processing in order to handle stream input, to obtain a stream from a file, and so on. - is the first component of the standard load path for XAML operations and is incorporated by as well as by several existing framework XAML implementations for loading XAML. + is the first component of the standard load path for XAML operations and is incorporated by as well as by several existing framework XAML implementations for loading XAML. ]]> @@ -706,7 +706,7 @@ after exiting the bounds of the subtree. For more information, see . + If you are currently using a subtree reader, the subtree reader reports after exiting the bounds of the subtree. For more information, see . ]]> @@ -911,11 +911,11 @@ returns `false` also returns `true` for . + A node where returns `false` also returns `true` for . - Calling generally has the side effect of advancing the or . + Calling generally has the side effect of advancing the or . - The next operation after calling and getting a `true` result is typically to check . For more information about XAML node stream concepts, see [Understanding XAML Node Stream Structures and Concepts](/dotnet/framework/xaml-services/understanding-xaml-node-stream-structures-and-concepts). + The next operation after calling and getting a `true` result is typically to check . For more information about XAML node stream concepts, see [Understanding XAML Node Stream Structures and Concepts](/dotnet/framework/xaml-services/understanding-xaml-node-stream-structures-and-concepts). ]]> diff --git a/xml/System.Xaml/XamlXmlWriter.xml b/xml/System.Xaml/XamlXmlWriter.xml index 8d6408233f2..122bef95e98 100644 --- a/xml/System.Xaml/XamlXmlWriter.xml +++ b/xml/System.Xaml/XamlXmlWriter.xml @@ -23,24 +23,24 @@ Uses a or support class to write a XAML node stream to a text or markup serialized form. - API has several methods that write different types of XAML nodes. Collectively, these are referred to in documentation as the `Write` methods of a . uses several internal state classes to determine what to do when one of its `Write` implementations is called. A `Write` call uses the states to determine whether the requested element, attribute, or value can be written, or whether an exception is thrown. For example, if you call and the state of the current node position is on a value or within a member, an exception is thrown. Typically, callers of the API should be aware of the type of the current XAML node that is coming from the XAML reader and the XAML node stream. Based on this knowledge, callers should avoid calling `Write` APIs that are not relevant to the current node type. - -## XAML Namespaces and XamlXmlWriter - The XAML namespace writing behavior of is complex and is not limited to explicit calls to . Instead, other `Write` calls, such as , might require that the namespace declaration be written at particular points in the node structure. The XAML writer either generates a prefix by its own logic, or uses information from the service to determine a preferred prefix. Also, explicit calls might defer or might return nothing if the XAML namespace declaration is already applicable and declared elsewhere. - -## Write Method Exceptions - Exceptions thrown by the `Write` methods are typically either or . - - An often indicates that a XAML reader passed an invalid node structure into the XAML node stream. In this case the node structure is invalid for reasons that are not related to validation of a XAML schema or a XAML schema context. Rather, the node stream is invalid in its basic form. For example, if a faulty XAML reader implementation generated a XAML node stream that contained two consecutive `StartObject` nodes, the attempt to call the second would throw an . All XAML writers would consider such an operation to be invalid. Another example of an is when XAML namespace information is unavailable through the XAML schema context that applies to the current node stream position. - - A indicates an exception where this particular XAML writer implementation chooses to throw an exception based on its intended functionality. A can indicate specific cases where a violates its own state or settings. For example, a might result from attempts to write XAML namespace information into a position that the and its serialization format do not support, or writing duplicate members when the instance's forbid it. - + API has several methods that write different types of XAML nodes. Collectively, these are referred to in documentation as the `Write` methods of a . uses several internal state classes to determine what to do when one of its `Write` implementations is called. A `Write` call uses the states to determine whether the requested element, attribute, or value can be written, or whether an exception is thrown. For example, if you call and the state of the current node position is on a value or within a member, an exception is thrown. Typically, callers of the API should be aware of the type of the current XAML node that is coming from the XAML reader and the XAML node stream. Based on this knowledge, callers should avoid calling `Write` APIs that are not relevant to the current node type. + +## XAML Namespaces and XamlXmlWriter + The XAML namespace writing behavior of is complex and is not limited to explicit calls to . Instead, other `Write` calls, such as , might require that the namespace declaration be written at particular points in the node structure. The XAML writer either generates a prefix by its own logic, or uses information from the service to determine a preferred prefix. Also, explicit calls might defer or might return nothing if the XAML namespace declaration is already applicable and declared elsewhere. + +## Write Method Exceptions + Exceptions thrown by the `Write` methods are typically either or . + + An often indicates that a XAML reader passed an invalid node structure into the XAML node stream. In this case the node structure is invalid for reasons that are not related to validation of a XAML schema or a XAML schema context. Rather, the node stream is invalid in its basic form. For example, if a faulty XAML reader implementation generated a XAML node stream that contained two consecutive `StartObject` nodes, the attempt to call the second would throw an . All XAML writers would consider such an operation to be invalid. Another example of an is when XAML namespace information is unavailable through the XAML schema context that applies to the current node stream position. + + A indicates an exception where this particular XAML writer implementation chooses to throw an exception based on its intended functionality. A can indicate specific cases where a violates its own state or settings. For example, a might result from attempts to write XAML namespace information into a position that the and its serialization format do not support, or writing duplicate members when the instance's forbid it. + ]]> @@ -91,10 +91,10 @@ Initializes a new instance of the class from a stream. To be added. - is . - - -or- - + is . + + -or- + is . @@ -204,11 +204,11 @@ An instance of , which typically has specific non-default settings. Initializes a new instance of the class from a stream using a writer settings object. - instance is constructed. cannot update its internal settings based on settings values that are mutable at run time. Settings should be provided for initialization only. You can merge settings from an active XAML writer by using one of the constructor signatures; however, you must then apply these settings to a new XAML writer instance instead of attempting to adjust the existing one. - + instance is constructed. cannot update its internal settings based on settings values that are mutable at run time. Settings should be provided for initialization only. You can merge settings from an active XAML writer by using one of the constructor signatures; however, you must then apply these settings to a new XAML writer instance instead of attempting to adjust the existing one. + ]]> @@ -245,11 +245,11 @@ An instance of , which typically has specific non-default settings. Initializes a new instance of the class from a basis using a settings object. - instance is constructed. cannot update its internal settings based on settings values that are mutable at run time. Settings should be provided for initialization only. You can merge settings from an active XAML writer by using one of the constructor signatures; however, you must then apply these settings to a new XAML writer instance instead of attempting to adjust the existing one. - + instance is constructed. cannot update its internal settings based on settings values that are mutable at run time. Settings should be provided for initialization only. You can merge settings from an active XAML writer by using one of the constructor signatures; however, you must then apply these settings to a new XAML writer instance instead of attempting to adjust the existing one. + ]]> @@ -286,11 +286,11 @@ An instance of , which typically has specific non-default settings. Initializes a new instance of the class from a basis using a settings object. - instance is constructed. cannot update its internal settings based on settings values that are mutable at run time. Settings should be provided for initialization only. You can merge settings from an active XAML writer by using one of the constructor signatures; however, you must then apply these settings to a new XAML writer instance instead of attempting to adjust the existing one. - + instance is constructed. cannot update its internal settings based on settings values that are mutable at run time. Settings should be provided for initialization only. You can merge settings from an active XAML writer by using one of the constructor signatures; however, you must then apply these settings to a new XAML writer instance instead of attempting to adjust the existing one. + ]]> @@ -327,11 +327,11 @@ to release the unmanaged resources; otherwise, . Releases the unmanaged resources used by and optionally releases the managed resources. - or for cases where is `true` in any supplied . Otherwise, it calls . - + or for cases where is `true` in any supplied . Otherwise, it calls . + ]]> @@ -362,11 +362,11 @@ Calls the method of the underlying or , which writes anything that is currently in the buffer, and then closes the writer. - can be influenced by its writer settings, especially by . - + can be influenced by its writer settings, especially by . + ]]> @@ -403,11 +403,11 @@ Gets the XAML schema context that this uses for processing. The XAML schema context that this uses for XAML processing. - @@ -438,11 +438,11 @@ Gets the writer settings that this uses for XAML processing. The writer settings that this uses for XAML processing. - . - + . + ]]> @@ -503,13 +503,13 @@ Writes a XAML end object node to the underlying or . Throws an exception if the current position of the XAML node stream that is being processed is incompatible with writing an end object. - is thrown by is when the current XAML node stream position is still within a member, and is called. - + is thrown by is when the current XAML node stream position is still within a member, and is called. + ]]> The current position of the XAML node stream is not in a scope where an end member can be written. @@ -609,13 +609,13 @@ The XAML member identifier for the member to write. Writes a XAML start member node to the underlying or . Throws an exception if the current position of the XAML node stream is within another member, or if it is not in a scope or writer state where a start member can be written. - first attempts to write the member in attribute form. If no attribute form is supported because the property or its value does not support text syntax, a property element is written instead. If the property is a XAML content property, a `GetObject` case, or an implicit property, other XAML forms might be written, such as inner text or an object child that has no intervening member. - - The duplicate member exception is never thrown if is `true` in the object that was used for settings for this . - + first attempts to write the member in attribute form. If no attribute form is supported because the property or its value does not support text syntax, a property element is written instead. If the property is a XAML content property, a `GetObject` case, or an implicit property, other XAML forms might be written, such as inner text or an object child that has no intervening member. + + The duplicate member exception is never thrown if is `true` in the object that was used for settings for this . + ]]> @@ -623,10 +623,10 @@ is not a valid . The current position of the XAML node stream is invalid for writing a start member. - The writer state is not valid for writing a start member. - - -or- - + The writer state is not valid for writing a start member. + + -or- + The XAML writer attempted to write a duplicate member. This exception may have a more precise inner exception. @@ -696,11 +696,11 @@ The value information to write. Writes a XAML value node to the underlying or . Throws an exception if the current position of the XAML node stream is invalid for writing a value, or the writer is in a state where a value cannot be written. - definition as input and then immediately calls . - + definition as input and then immediately calls . + ]]> The current position of the XAML node stream is not valid for writing a value. diff --git a/xml/System.Xaml/XamlXmlWriterSettings.xml b/xml/System.Xaml/XamlXmlWriterSettings.xml index 5591d91145a..437a07bab73 100644 --- a/xml/System.Xaml/XamlXmlWriterSettings.xml +++ b/xml/System.Xaml/XamlXmlWriterSettings.xml @@ -23,11 +23,11 @@ Provides initialization settings for the XAML writer implementation. - values are `false`. - + values are `false`. + ]]> @@ -138,11 +138,11 @@ if immediately closes on a or similar operations. if the remaining buffer output is written before the is released. The default is . - , which calls `Close` on the underlying or when is `true`; or it calls (again tied to the underlying or ) if is `false`. - + , which calls `Close` on the underlying or when is `true`; or it calls (again tied to the underlying or ) if is `false`. + ]]> diff --git a/xml/System.Xml.Linq/Extensions.xml b/xml/System.Xml.Linq/Extensions.xml index 217152c9cf9..68c2a34e710 100644 --- a/xml/System.Xml.Linq/Extensions.xml +++ b/xml/System.Xml.Linq/Extensions.xml @@ -54,17 +54,17 @@ Contains the LINQ to XML extension methods. - extension methods are not axis methods, however. These methods remove attributes or nodes from the XML tree. - - Note that there is another category of axis methods, implemented in the , , and classes. These other axis methods operate on a single object, and return a collection of , , or objects. - - All of the axis extension methods use deferred execution. - + extension methods are not axis methods, however. These methods remove attributes or nodes from the XML tree. + + Note that there is another category of axis methods, implemented in the , , and classes. These other axis methods operate on a single object, and return a collection of , , or objects. + + All of the axis extension methods use deferred execution. + ]]> LINQ to XML overview @@ -82,13 +82,13 @@ Returns a collection of elements that contains the ancestors of every node in the source collection. - method. - - This method uses deferred execution. - + method. + + This method uses deferred execution. + ]]> @@ -165,205 +165,205 @@ Returns a collection of elements that contains the ancestors of every node in the source collection. An of that contains the ancestors of every node in the source collection. - method. - - This method uses deferred execution. - - - -## Examples - The following example retrieves a collection of the great grandchildren elements. It then uses this axis method to retrieve all ancestors of all elements in the collection. - -```csharp -XElement xmlTree = new XElement("Root", - new XElement("Child1", - new XElement("GrandChild1", - new XElement("GreatGrandChild1", "content") - ) - ), - new XElement("Child2", - new XElement("GrandChild2", - new XElement("GreatGrandChild2", "content") - ) - ) -); -IEnumerable greatGrandChildren = - from el in xmlTree.Descendants() - where el.Name.LocalName.StartsWith("Great") - select el; - -Console.WriteLine("Great Grand Children Elements"); -Console.WriteLine("----"); -foreach (XElement de in greatGrandChildren) - Console.WriteLine(de.Name); - -IEnumerable allAncestors = - from el in greatGrandChildren.Ancestors().Distinct() - select el; - -Console.WriteLine(""); -Console.WriteLine("Ancestors"); -Console.WriteLine("----"); -foreach (XElement de in allAncestors) - Console.WriteLine(de.Name); -``` - -```vb -Dim xmlTree As XElement = _ - - - - content - - - - - content - - - - -Dim greatGrandChildren = From el In xmlTree.Descendants _ - Where el.Name.LocalName.StartsWith("Great") _ - Select el - -Console.WriteLine("Great Grand Children Elements") -Console.WriteLine("----") - -For Each de As XElement In greatGrandChildren - Console.WriteLine(de.Name) -Next - -Dim allAncestors = From el In greatGrandChildren.Ancestors.Distinct _ - Select el - -Console.WriteLine("") -Console.WriteLine("Ancestors") -Console.WriteLine("----") - -For Each de As XElement In allAncestors - Console.WriteLine(de.Name) -Next -``` - - This example produces the following output: - -``` -Great Grand Children Elements ----- -GreatGrandChild1 -GreatGrandChild2 - -Ancestors ----- -GrandChild1 -Child1 -Root -GrandChild2 -Child2 -``` - - The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). - -```csharp -XNamespace aw = "http://www.adventure-works.com"; -XElement xmlTree = new XElement(aw + "Root", - new XElement(aw + "Child1", - new XElement(aw + "GrandChild1", - new XElement(aw + "GreatGrandChild1", "content") - ) - ), - new XElement(aw + "Child2", - new XElement(aw + "GrandChild2", - new XElement(aw + "GreatGrandChild2", "content") - ) - ) -); -IEnumerable greatGrandChildren = - from el in xmlTree.Descendants() - where el.Name.LocalName.StartsWith("Great") - select el; - -Console.WriteLine("Great Grand Children Elements"); -Console.WriteLine("----"); -foreach (XElement de in greatGrandChildren) - Console.WriteLine(de.Name); - -IEnumerable allAncestors = - from el in greatGrandChildren.Ancestors().Distinct() - select el; - -Console.WriteLine(""); -Console.WriteLine("Ancestors"); -Console.WriteLine("----"); -foreach (XElement de in allAncestors) - Console.WriteLine(de.Name); -``` - -```vb -Imports - -Module Module1 - Sub Main() - Dim xmlTree As XElement = _ - - - - content - - - - - content - - - - - Dim greatGrandChildren = From el In xmlTree.Descendants _ - Where el.Name.LocalName.StartsWith("Great") _ - Select el - - Console.WriteLine("Great Grand Children Elements") - Console.WriteLine("----") - - For Each de As XElement In greatGrandChildren - Console.WriteLine(de.Name) - Next - - Dim allAncestors = From el In greatGrandChildren.Ancestors.Distinct _ - Select el - - Console.WriteLine("") - Console.WriteLine("Ancestors") - Console.WriteLine("----") - - For Each de As XElement In allAncestors - Console.WriteLine(de.Name) - Next - End Sub -End Module -``` - - This example produces the following output: - -``` -Great Grand Children Elements ----- -{http://www.adventure-works.com}GreatGrandChild1 -{http://www.adventure-works.com}GreatGrandChild2 - -Ancestors ----- -{http://www.adventure-works.com}GrandChild1 -{http://www.adventure-works.com}Child1 -{http://www.adventure-works.com}Root -{http://www.adventure-works.com}GrandChild2 -{http://www.adventure-works.com}Child2 -``` - + method. + + This method uses deferred execution. + + + +## Examples + The following example retrieves a collection of the great grandchildren elements. It then uses this axis method to retrieve all ancestors of all elements in the collection. + +```csharp +XElement xmlTree = new XElement("Root", + new XElement("Child1", + new XElement("GrandChild1", + new XElement("GreatGrandChild1", "content") + ) + ), + new XElement("Child2", + new XElement("GrandChild2", + new XElement("GreatGrandChild2", "content") + ) + ) +); +IEnumerable greatGrandChildren = + from el in xmlTree.Descendants() + where el.Name.LocalName.StartsWith("Great") + select el; + +Console.WriteLine("Great Grand Children Elements"); +Console.WriteLine("----"); +foreach (XElement de in greatGrandChildren) + Console.WriteLine(de.Name); + +IEnumerable allAncestors = + from el in greatGrandChildren.Ancestors().Distinct() + select el; + +Console.WriteLine(""); +Console.WriteLine("Ancestors"); +Console.WriteLine("----"); +foreach (XElement de in allAncestors) + Console.WriteLine(de.Name); +``` + +```vb +Dim xmlTree As XElement = _ + + + + content + + + + + content + + + + +Dim greatGrandChildren = From el In xmlTree.Descendants _ + Where el.Name.LocalName.StartsWith("Great") _ + Select el + +Console.WriteLine("Great Grand Children Elements") +Console.WriteLine("----") + +For Each de As XElement In greatGrandChildren + Console.WriteLine(de.Name) +Next + +Dim allAncestors = From el In greatGrandChildren.Ancestors.Distinct _ + Select el + +Console.WriteLine("") +Console.WriteLine("Ancestors") +Console.WriteLine("----") + +For Each de As XElement In allAncestors + Console.WriteLine(de.Name) +Next +``` + + This example produces the following output: + +``` +Great Grand Children Elements +---- +GreatGrandChild1 +GreatGrandChild2 + +Ancestors +---- +GrandChild1 +Child1 +Root +GrandChild2 +Child2 +``` + + The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). + +```csharp +XNamespace aw = "http://www.adventure-works.com"; +XElement xmlTree = new XElement(aw + "Root", + new XElement(aw + "Child1", + new XElement(aw + "GrandChild1", + new XElement(aw + "GreatGrandChild1", "content") + ) + ), + new XElement(aw + "Child2", + new XElement(aw + "GrandChild2", + new XElement(aw + "GreatGrandChild2", "content") + ) + ) +); +IEnumerable greatGrandChildren = + from el in xmlTree.Descendants() + where el.Name.LocalName.StartsWith("Great") + select el; + +Console.WriteLine("Great Grand Children Elements"); +Console.WriteLine("----"); +foreach (XElement de in greatGrandChildren) + Console.WriteLine(de.Name); + +IEnumerable allAncestors = + from el in greatGrandChildren.Ancestors().Distinct() + select el; + +Console.WriteLine(""); +Console.WriteLine("Ancestors"); +Console.WriteLine("----"); +foreach (XElement de in allAncestors) + Console.WriteLine(de.Name); +``` + +```vb +Imports + +Module Module1 + Sub Main() + Dim xmlTree As XElement = _ + + + + content + + + + + content + + + + + Dim greatGrandChildren = From el In xmlTree.Descendants _ + Where el.Name.LocalName.StartsWith("Great") _ + Select el + + Console.WriteLine("Great Grand Children Elements") + Console.WriteLine("----") + + For Each de As XElement In greatGrandChildren + Console.WriteLine(de.Name) + Next + + Dim allAncestors = From el In greatGrandChildren.Ancestors.Distinct _ + Select el + + Console.WriteLine("") + Console.WriteLine("Ancestors") + Console.WriteLine("----") + + For Each de As XElement In allAncestors + Console.WriteLine(de.Name) + Next + End Sub +End Module +``` + + This example produces the following output: + +``` +Great Grand Children Elements +---- +{http://www.adventure-works.com}GreatGrandChild1 +{http://www.adventure-works.com}GreatGrandChild2 + +Ancestors +---- +{http://www.adventure-works.com}GrandChild1 +{http://www.adventure-works.com}Child1 +{http://www.adventure-works.com}Root +{http://www.adventure-works.com}GrandChild2 +{http://www.adventure-works.com}Child2 +``` + ]]> @@ -450,199 +450,199 @@ Ancestors Returns a filtered collection of elements that contains the ancestors of every node in the source collection. Only elements that have a matching are included in the collection. An of that contains the ancestors of every node in the source collection. Only elements that have a matching are included in the collection. - , the ancestor will be included multiple times in the result collection. - - This method uses deferred execution. - - - -## Examples - The following example retrieves a collection of the great grandchildren elements. It then uses this axis method to retrieve all ancestors of all elements in the collection that match a specified . - -```csharp -XElement xmlTree = new XElement("Root", - new XElement("Child1", - new XElement("GrandChild1", - new XElement("GreatGrandChild1", "content") - ) - ), - new XElement("Child2", - new XElement("GrandChild2", - new XElement("GreatGrandChild2", "content") - ) - ) -); -IEnumerable greatGrandChildren = - from el in xmlTree.Descendants() - where el.Name.LocalName.StartsWith("Great") - select el; - -Console.WriteLine("Great Grand Children Elements"); -Console.WriteLine("----"); -foreach (XElement de in greatGrandChildren) - Console.WriteLine(de.Name); - -IEnumerable allAncestors = - from el in greatGrandChildren.Ancestors("Child1") - select el; - -Console.WriteLine(""); -Console.WriteLine("Ancestors"); -Console.WriteLine("----"); -foreach (XElement de in allAncestors) - Console.WriteLine(de.Name); -``` - -```vb -Dim xmlTree As XElement = _ - - - - content - - - - - content - - - - -Dim greatGrandChildren = From el In xmlTree.Descendants _ - Where el.Name.LocalName.StartsWith("Great") _ - Select el - -Console.WriteLine("Great Grand Children Elements") -Console.WriteLine("----") - -For Each de As XElement In greatGrandChildren - Console.WriteLine(de.Name) -Next - -Dim allAncestors = From el In greatGrandChildren.Ancestors("Child1") _ - Select el - -Console.WriteLine("") -Console.WriteLine("Ancestors") -Console.WriteLine("----") - -For Each de As XElement In allAncestors - Console.WriteLine(de.Name) -Next - -``` - - This example produces the following output: - -``` -Great Grand Children Elements ----- -GreatGrandChild1 -GreatGrandChild2 - -Ancestors ----- -Child1 -``` - - The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). - -```csharp -XNamespace aw = "http://www.adventure-works.com"; -XElement xmlTree = new XElement(aw + "Root", - new XElement(aw + "Child1", - new XElement(aw + "GrandChild1", - new XElement(aw + "GreatGrandChild1", "content") - ) - ), - new XElement(aw + "Child2", - new XElement(aw + "GrandChild2", - new XElement(aw + "GreatGrandChild2", "content") - ) - ) -); -IEnumerable greatGrandChildren = - from el in xmlTree.Descendants() - where el.Name.LocalName.StartsWith("Great") - select el; - -Console.WriteLine("Great Grand Children Elements"); -Console.WriteLine("----"); -foreach (XElement de in greatGrandChildren) - Console.WriteLine(de.Name); - -IEnumerable allAncestors = - from el in greatGrandChildren.Ancestors(aw + "Child1") - select el; - -Console.WriteLine(""); -Console.WriteLine("Ancestors"); -Console.WriteLine("----"); -foreach (XElement de in allAncestors) - Console.WriteLine(de.Name); -``` - -```vb -Imports - -Module Module1 - Sub Main() - Dim xmlTree As XElement = _ - - - - content - - - - - content - - - - - Dim greatGrandChildren = From el In xmlTree.Descendants _ - Where el.Name.LocalName.StartsWith("Great") _ - Select el - - Console.WriteLine("Great Grand Children Elements") - Console.WriteLine("----") - - For Each de As XElement In greatGrandChildren - Console.WriteLine(de.Name) - Next - - Dim allAncestors = From el In greatGrandChildren.Ancestors(GetXmlNamespace() + "Child1") _ - Select el - - Console.WriteLine("") - Console.WriteLine("Ancestors") - Console.WriteLine("----") - - For Each de As XElement In allAncestors - Console.WriteLine(de.Name) - Next - End Sub -End Module - -``` - - This example produces the following output: - -``` -Great Grand Children Elements ----- -{http://www.adventure-works.com}GreatGrandChild1 -{http://www.adventure-works.com}GreatGrandChild2 - -Ancestors ----- -{http://www.adventure-works.com}Child1 -``` - + , the ancestor will be included multiple times in the result collection. + + This method uses deferred execution. + + + +## Examples + The following example retrieves a collection of the great grandchildren elements. It then uses this axis method to retrieve all ancestors of all elements in the collection that match a specified . + +```csharp +XElement xmlTree = new XElement("Root", + new XElement("Child1", + new XElement("GrandChild1", + new XElement("GreatGrandChild1", "content") + ) + ), + new XElement("Child2", + new XElement("GrandChild2", + new XElement("GreatGrandChild2", "content") + ) + ) +); +IEnumerable greatGrandChildren = + from el in xmlTree.Descendants() + where el.Name.LocalName.StartsWith("Great") + select el; + +Console.WriteLine("Great Grand Children Elements"); +Console.WriteLine("----"); +foreach (XElement de in greatGrandChildren) + Console.WriteLine(de.Name); + +IEnumerable allAncestors = + from el in greatGrandChildren.Ancestors("Child1") + select el; + +Console.WriteLine(""); +Console.WriteLine("Ancestors"); +Console.WriteLine("----"); +foreach (XElement de in allAncestors) + Console.WriteLine(de.Name); +``` + +```vb +Dim xmlTree As XElement = _ + + + + content + + + + + content + + + + +Dim greatGrandChildren = From el In xmlTree.Descendants _ + Where el.Name.LocalName.StartsWith("Great") _ + Select el + +Console.WriteLine("Great Grand Children Elements") +Console.WriteLine("----") + +For Each de As XElement In greatGrandChildren + Console.WriteLine(de.Name) +Next + +Dim allAncestors = From el In greatGrandChildren.Ancestors("Child1") _ + Select el + +Console.WriteLine("") +Console.WriteLine("Ancestors") +Console.WriteLine("----") + +For Each de As XElement In allAncestors + Console.WriteLine(de.Name) +Next + +``` + + This example produces the following output: + +``` +Great Grand Children Elements +---- +GreatGrandChild1 +GreatGrandChild2 + +Ancestors +---- +Child1 +``` + + The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). + +```csharp +XNamespace aw = "http://www.adventure-works.com"; +XElement xmlTree = new XElement(aw + "Root", + new XElement(aw + "Child1", + new XElement(aw + "GrandChild1", + new XElement(aw + "GreatGrandChild1", "content") + ) + ), + new XElement(aw + "Child2", + new XElement(aw + "GrandChild2", + new XElement(aw + "GreatGrandChild2", "content") + ) + ) +); +IEnumerable greatGrandChildren = + from el in xmlTree.Descendants() + where el.Name.LocalName.StartsWith("Great") + select el; + +Console.WriteLine("Great Grand Children Elements"); +Console.WriteLine("----"); +foreach (XElement de in greatGrandChildren) + Console.WriteLine(de.Name); + +IEnumerable allAncestors = + from el in greatGrandChildren.Ancestors(aw + "Child1") + select el; + +Console.WriteLine(""); +Console.WriteLine("Ancestors"); +Console.WriteLine("----"); +foreach (XElement de in allAncestors) + Console.WriteLine(de.Name); +``` + +```vb +Imports + +Module Module1 + Sub Main() + Dim xmlTree As XElement = _ + + + + content + + + + + content + + + + + Dim greatGrandChildren = From el In xmlTree.Descendants _ + Where el.Name.LocalName.StartsWith("Great") _ + Select el + + Console.WriteLine("Great Grand Children Elements") + Console.WriteLine("----") + + For Each de As XElement In greatGrandChildren + Console.WriteLine(de.Name) + Next + + Dim allAncestors = From el In greatGrandChildren.Ancestors(GetXmlNamespace() + "Child1") _ + Select el + + Console.WriteLine("") + Console.WriteLine("Ancestors") + Console.WriteLine("----") + + For Each de As XElement In allAncestors + Console.WriteLine(de.Name) + Next + End Sub +End Module + +``` + + This example produces the following output: + +``` +Great Grand Children Elements +---- +{http://www.adventure-works.com}GreatGrandChild1 +{http://www.adventure-works.com}GreatGrandChild2 + +Ancestors +---- +{http://www.adventure-works.com}Child1 +``` + ]]> @@ -662,13 +662,13 @@ Ancestors Returns a collection of elements that contains every element in the source collection, and the ancestors of every element in the source collection. - method. - - This method uses deferred execution. - + method. + + This method uses deferred execution. + ]]> @@ -732,211 +732,211 @@ Ancestors Returns a collection of elements that contains every element in the source collection, and the ancestors of every element in the source collection. An of that contains every element in the source collection, and the ancestors of every element in the source collection. - method. - - This method uses deferred execution. - - - -## Examples - The following example retrieves a collection of the great grandchildren elements. It then uses this axis method to retrieve all ancestors and self of all elements in the collection. - -```csharp -XElement xmlTree = new XElement("Root", - new XElement("Child1", - new XElement("GrandChild1", - new XElement("GreatGrandChild1", "content") - ) - ), - new XElement("Child2", - new XElement("GrandChild2", - new XElement("GreatGrandChild2", "content") - ) - ) -); -IEnumerable greatGrandChildren = - from el in xmlTree.Descendants() - where el.Name.LocalName.StartsWith("Great") - select el; - -Console.WriteLine("Great Grand Children Elements"); -Console.WriteLine("----"); -foreach (XElement de in greatGrandChildren) - Console.WriteLine(de.Name); - -IEnumerable allAncestors = - from el in greatGrandChildren.AncestorsAndSelf().Distinct() - select el; - -Console.WriteLine(""); -Console.WriteLine("Ancestors and Self"); -Console.WriteLine("----"); -foreach (XElement de in allAncestors) - Console.WriteLine(de.Name); -``` - -```vb -Dim xmlTree As XElement = _ - - - - content - - - - - content - - - - -Dim greatGrandChildren = From el In xmlTree.Descendants _ - Where el.Name.LocalName.StartsWith("Great") _ - Select el - -Console.WriteLine("Great Grand Children Elements") -Console.WriteLine("----") - -For Each de As XElement In greatGrandChildren - Console.WriteLine(de.Name) -Next - -Dim allAncestors = From el In greatGrandChildren.AncestorsAndSelf.Distinct _ - Select el - -Console.WriteLine("") -Console.WriteLine("Ancestors and Self") -Console.WriteLine("----") - -For Each de As XElement In allAncestors - Console.WriteLine(de.Name) -Next - -``` - - This example produces the following output: - -``` -Great Grand Children Elements ----- -GreatGrandChild1 -GreatGrandChild2 - -Ancestors and Self ----- -GreatGrandChild1 -GrandChild1 -Child1 -Root -GreatGrandChild2 -GrandChild2 -Child2 -``` - - The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). - -```csharp -XNamespace aw = "http://www.adventure-works.com"; -XElement xmlTree = new XElement(aw + "Root", - new XElement(aw + "Child1", - new XElement(aw + "GrandChild1", - new XElement(aw + "GreatGrandChild1", "content") - ) - ), - new XElement(aw + "Child2", - new XElement(aw + "GrandChild2", - new XElement(aw + "GreatGrandChild2", "content") - ) - ) -); -IEnumerable greatGrandChildren = - from el in xmlTree.Descendants() - where el.Name.LocalName.StartsWith("Great") - select el; - -Console.WriteLine("Great Grand Children Elements"); -Console.WriteLine("----"); -foreach (XElement de in greatGrandChildren) - Console.WriteLine(de.Name); - -IEnumerable allAncestors = - from el in greatGrandChildren.AncestorsAndSelf().Distinct() - select el; - -Console.WriteLine(""); -Console.WriteLine("Ancestors and Self"); -Console.WriteLine("----"); -foreach (XElement de in allAncestors) - Console.WriteLine(de.Name); -``` - -```vb -Imports - -Module Module1 - Sub Main() - Dim xmlTree As XElement = _ - - - - content - - - - - content - - - - - Dim greatGrandChildren = From el In xmlTree.Descendants _ - Where el.Name.LocalName.StartsWith("Great") _ - Select el - - Console.WriteLine("Great Grand Children Elements") - Console.WriteLine("----") - - For Each de As XElement In greatGrandChildren - Console.WriteLine(de.Name) - Next - - Dim allAncestors = From el In greatGrandChildren.AncestorsAndSelf.Distinct _ - Select el - - Console.WriteLine("") - Console.WriteLine("Ancestors and Self") - Console.WriteLine("----") - - For Each de As XElement In allAncestors - Console.WriteLine(de.Name) - Next - End Sub -End Module - -``` - - This example produces the following output: - -``` -Great Grand Children Elements ----- -{http://www.adventure-works.com}GreatGrandChild1 -{http://www.adventure-works.com}GreatGrandChild2 - -Ancestors and Self ----- -{http://www.adventure-works.com}GreatGrandChild1 -{http://www.adventure-works.com}GrandChild1 -{http://www.adventure-works.com}Child1 -{http://www.adventure-works.com}Root -{http://www.adventure-works.com}GreatGrandChild2 -{http://www.adventure-works.com}GrandChild2 -{http://www.adventure-works.com}Child2 -``` - + method. + + This method uses deferred execution. + + + +## Examples + The following example retrieves a collection of the great grandchildren elements. It then uses this axis method to retrieve all ancestors and self of all elements in the collection. + +```csharp +XElement xmlTree = new XElement("Root", + new XElement("Child1", + new XElement("GrandChild1", + new XElement("GreatGrandChild1", "content") + ) + ), + new XElement("Child2", + new XElement("GrandChild2", + new XElement("GreatGrandChild2", "content") + ) + ) +); +IEnumerable greatGrandChildren = + from el in xmlTree.Descendants() + where el.Name.LocalName.StartsWith("Great") + select el; + +Console.WriteLine("Great Grand Children Elements"); +Console.WriteLine("----"); +foreach (XElement de in greatGrandChildren) + Console.WriteLine(de.Name); + +IEnumerable allAncestors = + from el in greatGrandChildren.AncestorsAndSelf().Distinct() + select el; + +Console.WriteLine(""); +Console.WriteLine("Ancestors and Self"); +Console.WriteLine("----"); +foreach (XElement de in allAncestors) + Console.WriteLine(de.Name); +``` + +```vb +Dim xmlTree As XElement = _ + + + + content + + + + + content + + + + +Dim greatGrandChildren = From el In xmlTree.Descendants _ + Where el.Name.LocalName.StartsWith("Great") _ + Select el + +Console.WriteLine("Great Grand Children Elements") +Console.WriteLine("----") + +For Each de As XElement In greatGrandChildren + Console.WriteLine(de.Name) +Next + +Dim allAncestors = From el In greatGrandChildren.AncestorsAndSelf.Distinct _ + Select el + +Console.WriteLine("") +Console.WriteLine("Ancestors and Self") +Console.WriteLine("----") + +For Each de As XElement In allAncestors + Console.WriteLine(de.Name) +Next + +``` + + This example produces the following output: + +``` +Great Grand Children Elements +---- +GreatGrandChild1 +GreatGrandChild2 + +Ancestors and Self +---- +GreatGrandChild1 +GrandChild1 +Child1 +Root +GreatGrandChild2 +GrandChild2 +Child2 +``` + + The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). + +```csharp +XNamespace aw = "http://www.adventure-works.com"; +XElement xmlTree = new XElement(aw + "Root", + new XElement(aw + "Child1", + new XElement(aw + "GrandChild1", + new XElement(aw + "GreatGrandChild1", "content") + ) + ), + new XElement(aw + "Child2", + new XElement(aw + "GrandChild2", + new XElement(aw + "GreatGrandChild2", "content") + ) + ) +); +IEnumerable greatGrandChildren = + from el in xmlTree.Descendants() + where el.Name.LocalName.StartsWith("Great") + select el; + +Console.WriteLine("Great Grand Children Elements"); +Console.WriteLine("----"); +foreach (XElement de in greatGrandChildren) + Console.WriteLine(de.Name); + +IEnumerable allAncestors = + from el in greatGrandChildren.AncestorsAndSelf().Distinct() + select el; + +Console.WriteLine(""); +Console.WriteLine("Ancestors and Self"); +Console.WriteLine("----"); +foreach (XElement de in allAncestors) + Console.WriteLine(de.Name); +``` + +```vb +Imports + +Module Module1 + Sub Main() + Dim xmlTree As XElement = _ + + + + content + + + + + content + + + + + Dim greatGrandChildren = From el In xmlTree.Descendants _ + Where el.Name.LocalName.StartsWith("Great") _ + Select el + + Console.WriteLine("Great Grand Children Elements") + Console.WriteLine("----") + + For Each de As XElement In greatGrandChildren + Console.WriteLine(de.Name) + Next + + Dim allAncestors = From el In greatGrandChildren.AncestorsAndSelf.Distinct _ + Select el + + Console.WriteLine("") + Console.WriteLine("Ancestors and Self") + Console.WriteLine("----") + + For Each de As XElement In allAncestors + Console.WriteLine(de.Name) + Next + End Sub +End Module + +``` + + This example produces the following output: + +``` +Great Grand Children Elements +---- +{http://www.adventure-works.com}GreatGrandChild1 +{http://www.adventure-works.com}GreatGrandChild2 + +Ancestors and Self +---- +{http://www.adventure-works.com}GreatGrandChild1 +{http://www.adventure-works.com}GrandChild1 +{http://www.adventure-works.com}Child1 +{http://www.adventure-works.com}Root +{http://www.adventure-works.com}GreatGrandChild2 +{http://www.adventure-works.com}GrandChild2 +{http://www.adventure-works.com}Child2 +``` + ]]> @@ -1009,199 +1009,199 @@ Ancestors and Self Returns a filtered collection of elements that contains every element in the source collection, and the ancestors of every element in the source collection. Only elements that have a matching are included in the collection. An of that contains every element in the source collection, and the ancestors of every element in the source collection. Only elements that have a matching are included in the collection. - , the ancestor will be included multiple times in the result collection. - - This method uses deferred execution. - - - -## Examples - The following example retrieves a collection of the great grandchildren elements. It then uses this axis method to retrieve all self and ancestors of all elements in the collection that match a specified . - -```csharp -XElement xmlTree = new XElement("Root", - new XElement("Child1", - new XElement("GrandChild1", - new XElement("GreatGrandChild1", "content") - ) - ), - new XElement("Child2", - new XElement("GrandChild2", - new XElement("GreatGrandChild2", "content") - ) - ) -); -IEnumerable greatGrandChildren = - from el in xmlTree.Descendants() - where el.Name.LocalName.StartsWith("Great") - select el; - -Console.WriteLine("Great Grand Children Elements"); -Console.WriteLine("----"); -foreach (XElement de in greatGrandChildren) - Console.WriteLine(de.Name); - -IEnumerable allAncestors = - from el in greatGrandChildren.AncestorsAndSelf("GreatGrandChild1") - select el; - -Console.WriteLine(""); -Console.WriteLine("Ancestors and Self"); -Console.WriteLine("----"); -foreach (XElement de in allAncestors) - Console.WriteLine(de.Name); -``` - -```vb -Dim xmlTree As XElement = _ - - - - content - - - - - content - - - - -Dim greatGrandChildren = From el In xmlTree.Descendants _ - Where el.Name.LocalName.StartsWith("Great") _ - Select el - -Console.WriteLine("Great Grand Children Elements") -Console.WriteLine("----") - -For Each de As XElement In greatGrandChildren - Console.WriteLine(de.Name) -Next - -Dim allAncestors = From el In greatGrandChildren.AncestorsAndSelf("GreatGrandChild1") _ - Select el - -Console.WriteLine("") -Console.WriteLine("Ancestors and Self") -Console.WriteLine("----") - -For Each de As XElement In allAncestors - Console.WriteLine(de.Name) -Next - -``` - - This example produces the following output: - -``` -Great Grand Children Elements ----- -GreatGrandChild1 -GreatGrandChild2 - -Ancestors and Self ----- -GreatGrandChild1 -``` - - The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). - -```csharp -XNamespace aw = "http://www.adventure-works.com"; -XElement xmlTree = new XElement(aw + "Root", - new XElement(aw + "Child1", - new XElement(aw + "GrandChild1", - new XElement(aw + "GreatGrandChild1", "content") - ) - ), - new XElement(aw + "Child2", - new XElement(aw + "GrandChild2", - new XElement(aw + "GreatGrandChild2", "content") - ) - ) -); -IEnumerable greatGrandChildren = - from el in xmlTree.Descendants() - where el.Name.LocalName.StartsWith("Great") - select el; - -Console.WriteLine("Great Grand Children Elements"); -Console.WriteLine("----"); -foreach (XElement de in greatGrandChildren) - Console.WriteLine(de.Name); - -IEnumerable allAncestors = - from el in greatGrandChildren.AncestorsAndSelf(aw + "GreatGrandChild1") - select el; - -Console.WriteLine(""); -Console.WriteLine("Ancestors and Self"); -Console.WriteLine("----"); -foreach (XElement de in allAncestors) - Console.WriteLine(de.Name); -``` - -```vb -Imports - -Module Module1 - Sub Main() - Dim xmlTree As XElement = _ - - - - content - - - - - content - - - - - Dim greatGrandChildren = From el In xmlTree.Descendants _ - Where el.Name.LocalName.StartsWith("Great") _ - Select el - - Console.WriteLine("Great Grand Children Elements") - Console.WriteLine("----") - - For Each de As XElement In greatGrandChildren - Console.WriteLine(de.Name) - Next - - Dim allAncestors = From el In greatGrandChildren.AncestorsAndSelf(GetXmlNamespace() + "GreatGrandChild1") _ - Select el - - Console.WriteLine("") - Console.WriteLine("Ancestors and Self") - Console.WriteLine("----") - - For Each de As XElement In allAncestors - Console.WriteLine(de.Name) - Next - End Sub -End Module - -``` - - This example produces the following output: - -``` -Great Grand Children Elements ----- -{http://www.adventure-works.com}GreatGrandChild1 -{http://www.adventure-works.com}GreatGrandChild2 - -Ancestors and Self ----- -{http://www.adventure-works.com}GreatGrandChild1 -``` - + , the ancestor will be included multiple times in the result collection. + + This method uses deferred execution. + + + +## Examples + The following example retrieves a collection of the great grandchildren elements. It then uses this axis method to retrieve all self and ancestors of all elements in the collection that match a specified . + +```csharp +XElement xmlTree = new XElement("Root", + new XElement("Child1", + new XElement("GrandChild1", + new XElement("GreatGrandChild1", "content") + ) + ), + new XElement("Child2", + new XElement("GrandChild2", + new XElement("GreatGrandChild2", "content") + ) + ) +); +IEnumerable greatGrandChildren = + from el in xmlTree.Descendants() + where el.Name.LocalName.StartsWith("Great") + select el; + +Console.WriteLine("Great Grand Children Elements"); +Console.WriteLine("----"); +foreach (XElement de in greatGrandChildren) + Console.WriteLine(de.Name); + +IEnumerable allAncestors = + from el in greatGrandChildren.AncestorsAndSelf("GreatGrandChild1") + select el; + +Console.WriteLine(""); +Console.WriteLine("Ancestors and Self"); +Console.WriteLine("----"); +foreach (XElement de in allAncestors) + Console.WriteLine(de.Name); +``` + +```vb +Dim xmlTree As XElement = _ + + + + content + + + + + content + + + + +Dim greatGrandChildren = From el In xmlTree.Descendants _ + Where el.Name.LocalName.StartsWith("Great") _ + Select el + +Console.WriteLine("Great Grand Children Elements") +Console.WriteLine("----") + +For Each de As XElement In greatGrandChildren + Console.WriteLine(de.Name) +Next + +Dim allAncestors = From el In greatGrandChildren.AncestorsAndSelf("GreatGrandChild1") _ + Select el + +Console.WriteLine("") +Console.WriteLine("Ancestors and Self") +Console.WriteLine("----") + +For Each de As XElement In allAncestors + Console.WriteLine(de.Name) +Next + +``` + + This example produces the following output: + +``` +Great Grand Children Elements +---- +GreatGrandChild1 +GreatGrandChild2 + +Ancestors and Self +---- +GreatGrandChild1 +``` + + The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). + +```csharp +XNamespace aw = "http://www.adventure-works.com"; +XElement xmlTree = new XElement(aw + "Root", + new XElement(aw + "Child1", + new XElement(aw + "GrandChild1", + new XElement(aw + "GreatGrandChild1", "content") + ) + ), + new XElement(aw + "Child2", + new XElement(aw + "GrandChild2", + new XElement(aw + "GreatGrandChild2", "content") + ) + ) +); +IEnumerable greatGrandChildren = + from el in xmlTree.Descendants() + where el.Name.LocalName.StartsWith("Great") + select el; + +Console.WriteLine("Great Grand Children Elements"); +Console.WriteLine("----"); +foreach (XElement de in greatGrandChildren) + Console.WriteLine(de.Name); + +IEnumerable allAncestors = + from el in greatGrandChildren.AncestorsAndSelf(aw + "GreatGrandChild1") + select el; + +Console.WriteLine(""); +Console.WriteLine("Ancestors and Self"); +Console.WriteLine("----"); +foreach (XElement de in allAncestors) + Console.WriteLine(de.Name); +``` + +```vb +Imports + +Module Module1 + Sub Main() + Dim xmlTree As XElement = _ + + + + content + + + + + content + + + + + Dim greatGrandChildren = From el In xmlTree.Descendants _ + Where el.Name.LocalName.StartsWith("Great") _ + Select el + + Console.WriteLine("Great Grand Children Elements") + Console.WriteLine("----") + + For Each de As XElement In greatGrandChildren + Console.WriteLine(de.Name) + Next + + Dim allAncestors = From el In greatGrandChildren.AncestorsAndSelf(GetXmlNamespace() + "GreatGrandChild1") _ + Select el + + Console.WriteLine("") + Console.WriteLine("Ancestors and Self") + Console.WriteLine("----") + + For Each de As XElement In allAncestors + Console.WriteLine(de.Name) + Next + End Sub +End Module + +``` + + This example produces the following output: + +``` +Great Grand Children Elements +---- +{http://www.adventure-works.com}GreatGrandChild1 +{http://www.adventure-works.com}GreatGrandChild2 + +Ancestors and Self +---- +{http://www.adventure-works.com}GreatGrandChild1 +``` + ]]> @@ -1221,13 +1221,13 @@ Ancestors and Self Returns a collection of the attributes of every element in the source collection. - @@ -1288,153 +1288,153 @@ Ancestors and Self Returns a collection of the attributes of every element in the source collection. An of that contains the attributes of every element in the source collection. - attList = - from att in xmlTree.DescendantsAndSelf().Attributes() - select att; - -foreach (XAttribute att in attList) - Console.WriteLine(att); -``` - -```vb -Dim xmlTree As XElement = _ - - - - - -Dim attList = _ - From att In xmlTree.DescendantsAndSelf.Attributes _ - Select att - -Console.WriteLine(xmlTree) -Console.WriteLine("-----") - -For Each att As XAttribute In attList - Console.WriteLine(att) -Next -``` - - This example produces the following output: - -``` - - - - ------ -xmlns:aw="http://www.adventure-works.com" -Att1="content1" -Att2="content2" -Att1="content3" -Att2="content4" -Att1="content5" -Att2="content6" -``` - - The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). Note that the namespace attribute is included in the returned collection. - -```csharp -XNamespace aw = "http://www.adventure-works.com"; -XElement xmlTree = new XElement(aw + "Root", - new XAttribute(XNamespace.Xmlns + "aw", "http://www.adventure-works.com"), - new XAttribute(aw + "Att1", "content1"), - new XAttribute(aw + "Att2", "content2"), - new XElement(aw + "Child1", - new XAttribute(aw + "Att1", "content3"), - new XAttribute(aw + "Att2", "content4") - ), - new XElement(aw + "Child2", - new XAttribute(aw + "Att1", "content5"), - new XAttribute(aw + "Att2", "content6") - ) -); -Console.WriteLine(xmlTree); -Console.WriteLine("-----"); - -IEnumerable attList = - from att in xmlTree.DescendantsAndSelf().Attributes() - select att; - -foreach (XAttribute att in attList) - Console.WriteLine(att); -``` - -```vb -Imports - -Module Module1 - Sub Main() - Dim xmlTree As XElement = _ - - - - - - Dim attList = _ - From att In xmlTree.DescendantsAndSelf.Attributes _ - Select att - - Console.WriteLine(xmlTree) - Console.WriteLine("-----") - - For Each att As XAttribute In attList - Console.WriteLine(att) - Next - End Sub -End Module -``` - - This example produces the following output: - -``` - - - - ------ -xmlns:aw="http://www.adventure-works.com" -aw:Att1="content1" -aw:Att2="content2" -aw:Att1="content3" -aw:Att2="content4" -aw:Att1="content5" -aw:Att2="content6" -``` - + attList = + from att in xmlTree.DescendantsAndSelf().Attributes() + select att; + +foreach (XAttribute att in attList) + Console.WriteLine(att); +``` + +```vb +Dim xmlTree As XElement = _ + + + + + +Dim attList = _ + From att In xmlTree.DescendantsAndSelf.Attributes _ + Select att + +Console.WriteLine(xmlTree) +Console.WriteLine("-----") + +For Each att As XAttribute In attList + Console.WriteLine(att) +Next +``` + + This example produces the following output: + +``` + + + + +----- +xmlns:aw="http://www.adventure-works.com" +Att1="content1" +Att2="content2" +Att1="content3" +Att2="content4" +Att1="content5" +Att2="content6" +``` + + The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). Note that the namespace attribute is included in the returned collection. + +```csharp +XNamespace aw = "http://www.adventure-works.com"; +XElement xmlTree = new XElement(aw + "Root", + new XAttribute(XNamespace.Xmlns + "aw", "http://www.adventure-works.com"), + new XAttribute(aw + "Att1", "content1"), + new XAttribute(aw + "Att2", "content2"), + new XElement(aw + "Child1", + new XAttribute(aw + "Att1", "content3"), + new XAttribute(aw + "Att2", "content4") + ), + new XElement(aw + "Child2", + new XAttribute(aw + "Att1", "content5"), + new XAttribute(aw + "Att2", "content6") + ) +); +Console.WriteLine(xmlTree); +Console.WriteLine("-----"); + +IEnumerable attList = + from att in xmlTree.DescendantsAndSelf().Attributes() + select att; + +foreach (XAttribute att in attList) + Console.WriteLine(att); +``` + +```vb +Imports + +Module Module1 + Sub Main() + Dim xmlTree As XElement = _ + + + + + + Dim attList = _ + From att In xmlTree.DescendantsAndSelf.Attributes _ + Select att + + Console.WriteLine(xmlTree) + Console.WriteLine("-----") + + For Each att As XAttribute In attList + Console.WriteLine(att) + Next + End Sub +End Module +``` + + This example produces the following output: + +``` + + + + +----- +xmlns:aw="http://www.adventure-works.com" +aw:Att1="content1" +aw:Att2="content2" +aw:Att1="content3" +aw:Att2="content4" +aw:Att1="content5" +aw:Att2="content6" +``` + ]]> @@ -1504,64 +1504,64 @@ aw:Att2="content6" Returns a filtered collection of the attributes of every element in the source collection. Only elements that have a matching are included in the collection. An of that contains a filtered collection of the attributes of every element in the source collection. Only elements that have a matching are included in the collection. - attList = from att in xmlTree.Elements().Attributes("Att1") - select att; - -foreach (XAttribute att in attList) - Console.WriteLine(att); -``` - -```vb -Dim xmlTree As XElement = _ - - - - - - - -Dim attList = From att In xmlTree.Elements.Attributes("Att1") _ - Select att - -For Each att As XAttribute In attList - Console.WriteLine(att) -Next - -``` - - This example produces the following output: - -``` -Att1="content3" -Att1="content5" -``` - + attList = from att in xmlTree.Elements().Attributes("Att1") + select att; + +foreach (XAttribute att in attList) + Console.WriteLine(att); +``` + +```vb +Dim xmlTree As XElement = _ + + + + + + + +Dim attList = From att In xmlTree.Elements.Attributes("Att1") _ + Select att + +For Each att As XAttribute In attList + Console.WriteLine(att) +Next + +``` + + This example produces the following output: + +``` +Att1="content3" +Att1="content5" +``` + ]]> @@ -1636,179 +1636,179 @@ Att1="content5" Returns a collection of the descendant nodes of every document and element in the source collection. An of of the descendant nodes of every document and element in the source collection. - and objects. Both of these types derive from , so this method operates on an of that contains the source collection. - - Although Visual Basic has an integrated XML axis for descendant elements, there is no integrated axis for descendant nodes, so Visual Basic users must use this axis method explicitly. - - This method uses deferred execution. - - - -## Examples - The following example retrieves a collection of two elements, and then retrieves a collection of all descendant nodes for every element in the source collection. Note that the attribute of the `GrandChild` element is not surfaced as a node. - -```csharp -XElement xmlTree = XElement.Parse( -@" - aaaText - - - - cccTextddd -"); -IEnumerable nodes = - from node in xmlTree.Elements("Child").DescendantNodes() - select node; - -foreach (XNode node in nodes) -{ - switch (node.NodeType) - { - case XmlNodeType.Element: - Console.WriteLine("Element: {0}", ((XElement)node).Name); - break; - case XmlNodeType.Text: - Console.WriteLine("Text: {0}", ((XText)node).Value); - break; - case XmlNodeType.Comment: - Console.WriteLine("Comment: {0}", ((XComment)node).Value); - break; - case XmlNodeType.ProcessingInstruction: - Console.WriteLine("PI: {0}", ((XProcessingInstruction)node).Data); - break; - } -} -``` - -```vb -Dim xmlTree As XElement = _ - - aaaText - - - - cccTextddd - - -Dim nodes As IEnumerable(Of XNode) = _ - From node In xmlTree..DescendantNodes _ - Select node - -For Each node As XNode In nodes - Select Case node.NodeType - Case XmlNodeType.Element - Console.WriteLine("Element: {0}", DirectCast(node, XElement).Name) - Case XmlNodeType.Text - Console.WriteLine("Text: {0}", DirectCast(node, XText).Value) - Case XmlNodeType.Comment - Console.WriteLine("Comment: {0}", DirectCast(node, XComment).Value) - Case XmlNodeType.ProcessingInstruction - Console.WriteLine("PI: {0}", DirectCast(node, XProcessingInstruction).Data) - End Select -Next -``` - - This example produces the following output: - -``` -Text: aaa -Element: GrandChild -Text: Text -Comment: a comment -PI: type='text/xsl' href='test.xsl' -Text: ccc -Element: GrandChild -Text: Text -Text: ddd -``` - - The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). - -```csharp -XNamespace aw = "http://www.adventure-works.com"; -XElement xmlTree = XElement.Parse( -@" - aaaText - - - - cccTextddd -"); -IEnumerable nodes = - from node in xmlTree.Elements(aw + "Child").DescendantNodes() - select node; - -foreach (XNode node in nodes) -{ - switch (node.NodeType) - { - case XmlNodeType.Element: - Console.WriteLine("Element: {0}", ((XElement)node).Name); - break; - case XmlNodeType.Text: - Console.WriteLine("Text: {0}", ((XText)node).Value); - break; - case XmlNodeType.Comment: - Console.WriteLine("Comment: {0}", ((XComment)node).Value); - break; - case XmlNodeType.ProcessingInstruction: - Console.WriteLine("PI: {0}", ((XProcessingInstruction)node).Data); - break; - } -} -``` - -```vb -Imports - -Module Module1 - Sub Main() - Dim xmlTree As XElement = _ - - aaaText - - - - cccTextddd - - - Dim nodes As IEnumerable(Of XNode) = _ - From node In xmlTree..DescendantNodes _ - Select node - - For Each node As XNode In nodes - Select Case node.NodeType - Case XmlNodeType.Element - Console.WriteLine("Element: {0}", DirectCast(node, XElement).Name) - Case XmlNodeType.Text - Console.WriteLine("Text: {0}", DirectCast(node, XText).Value) - Case XmlNodeType.Comment - Console.WriteLine("Comment: {0}", DirectCast(node, XComment).Value) - Case XmlNodeType.ProcessingInstruction - Console.WriteLine("PI: {0}", DirectCast(node, XProcessingInstruction).Data) - End Select - Next - End Sub -End Module -``` - - This example produces the following output: - -``` -Text: aaa -Element: {http://www.adventure-works.com}GrandChild -Text: Text -Comment: a comment -PI: type='text/xsl' href='test.xsl' -Text: ccc -Element: {http://www.adventure-works.com}GrandChild -Text: Text -Text: ddd -``` - + and objects. Both of these types derive from , so this method operates on an of that contains the source collection. + + Although Visual Basic has an integrated XML axis for descendant elements, there is no integrated axis for descendant nodes, so Visual Basic users must use this axis method explicitly. + + This method uses deferred execution. + + + +## Examples + The following example retrieves a collection of two elements, and then retrieves a collection of all descendant nodes for every element in the source collection. Note that the attribute of the `GrandChild` element is not surfaced as a node. + +```csharp +XElement xmlTree = XElement.Parse( +@" + aaaText + + + + cccTextddd +"); +IEnumerable nodes = + from node in xmlTree.Elements("Child").DescendantNodes() + select node; + +foreach (XNode node in nodes) +{ + switch (node.NodeType) + { + case XmlNodeType.Element: + Console.WriteLine("Element: {0}", ((XElement)node).Name); + break; + case XmlNodeType.Text: + Console.WriteLine("Text: {0}", ((XText)node).Value); + break; + case XmlNodeType.Comment: + Console.WriteLine("Comment: {0}", ((XComment)node).Value); + break; + case XmlNodeType.ProcessingInstruction: + Console.WriteLine("PI: {0}", ((XProcessingInstruction)node).Data); + break; + } +} +``` + +```vb +Dim xmlTree As XElement = _ + + aaaText + + + + cccTextddd + + +Dim nodes As IEnumerable(Of XNode) = _ + From node In xmlTree..DescendantNodes _ + Select node + +For Each node As XNode In nodes + Select Case node.NodeType + Case XmlNodeType.Element + Console.WriteLine("Element: {0}", DirectCast(node, XElement).Name) + Case XmlNodeType.Text + Console.WriteLine("Text: {0}", DirectCast(node, XText).Value) + Case XmlNodeType.Comment + Console.WriteLine("Comment: {0}", DirectCast(node, XComment).Value) + Case XmlNodeType.ProcessingInstruction + Console.WriteLine("PI: {0}", DirectCast(node, XProcessingInstruction).Data) + End Select +Next +``` + + This example produces the following output: + +``` +Text: aaa +Element: GrandChild +Text: Text +Comment: a comment +PI: type='text/xsl' href='test.xsl' +Text: ccc +Element: GrandChild +Text: Text +Text: ddd +``` + + The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). + +```csharp +XNamespace aw = "http://www.adventure-works.com"; +XElement xmlTree = XElement.Parse( +@" + aaaText + + + + cccTextddd +"); +IEnumerable nodes = + from node in xmlTree.Elements(aw + "Child").DescendantNodes() + select node; + +foreach (XNode node in nodes) +{ + switch (node.NodeType) + { + case XmlNodeType.Element: + Console.WriteLine("Element: {0}", ((XElement)node).Name); + break; + case XmlNodeType.Text: + Console.WriteLine("Text: {0}", ((XText)node).Value); + break; + case XmlNodeType.Comment: + Console.WriteLine("Comment: {0}", ((XComment)node).Value); + break; + case XmlNodeType.ProcessingInstruction: + Console.WriteLine("PI: {0}", ((XProcessingInstruction)node).Data); + break; + } +} +``` + +```vb +Imports + +Module Module1 + Sub Main() + Dim xmlTree As XElement = _ + + aaaText + + + + cccTextddd + + + Dim nodes As IEnumerable(Of XNode) = _ + From node In xmlTree..DescendantNodes _ + Select node + + For Each node As XNode In nodes + Select Case node.NodeType + Case XmlNodeType.Element + Console.WriteLine("Element: {0}", DirectCast(node, XElement).Name) + Case XmlNodeType.Text + Console.WriteLine("Text: {0}", DirectCast(node, XText).Value) + Case XmlNodeType.Comment + Console.WriteLine("Comment: {0}", DirectCast(node, XComment).Value) + Case XmlNodeType.ProcessingInstruction + Console.WriteLine("PI: {0}", DirectCast(node, XProcessingInstruction).Data) + End Select + Next + End Sub +End Module +``` + + This example produces the following output: + +``` +Text: aaa +Element: {http://www.adventure-works.com}GrandChild +Text: Text +Comment: a comment +PI: type='text/xsl' href='test.xsl' +Text: ccc +Element: {http://www.adventure-works.com}GrandChild +Text: Text +Text: ddd +``` + ]]> @@ -1874,13 +1874,13 @@ Text: ddd Returns a collection of nodes that contains every element in the source collection, and the descendant nodes of every element in the source collection. An of that contains every element in the source collection, and the descendant nodes of every element in the source collection. - @@ -1903,13 +1903,13 @@ Text: ddd Returns a collection of elements that contains the descendant elements of every element and document in the source collection. - @@ -1988,146 +1988,146 @@ Text: ddd Returns a collection of elements that contains the descendant elements of every element and document in the source collection. An of that contains the descendant elements of every element and document in the source collection. - - - This is some text - - where - - all of the nodes must be concatenated. - - - This is a second sentence. - -"); - -IEnumerable elList = - from el in xmlTree.Elements("Para").Descendants() - select el; - -foreach (XElement el in elList) - Console.WriteLine(el); -``` - -```vb -Dim xmlTree As XElement = _ - - - This is some text - - where - - all of the nodes must be concatenated. - - - - This is a second sentence. - - - -Dim elList = From el In xmlTree..Descendants _ - Select el - -For Each el As XElement In elList - Console.WriteLine(el) -Next -``` - - This example produces the following output: - -``` -This is some text - - where - -where - all of the nodes must be concatenated. -This is a second sentence. -``` - - The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). - -```csharp -XNamespace aw = "http://www.adventure-works.com"; -XElement xmlTree = XElement.Parse( -@" - - This is some text - - where - - all of the nodes must be concatenated. - - - This is a second sentence. - -"); - -IEnumerable elList = - from el in xmlTree.Elements(aw + "Para").Descendants() - select el; - -foreach (XElement el in elList) - Console.WriteLine(el); -``` - -```vb -Imports - -Module Module1 - Sub Main() - Dim xmlTree As XElement = _ - - - This is some text - - where - - all of the nodes must be concatenated. - - - - This is a second sentence. - - - - Dim elList = From el In xmlTree..Descendants _ - Select el - - For Each el As XElement In elList - Console.WriteLine(el) - Next - End Sub -End Module - -``` - - This example produces the following output: - -``` -This is some text - - where - -where - all of the nodes must be concatenated. -This is a second sentence. -``` - + + + This is some text + + where + + all of the nodes must be concatenated. + + + This is a second sentence. + +"); + +IEnumerable elList = + from el in xmlTree.Elements("Para").Descendants() + select el; + +foreach (XElement el in elList) + Console.WriteLine(el); +``` + +```vb +Dim xmlTree As XElement = _ + + + This is some text + + where + + all of the nodes must be concatenated. + + + + This is a second sentence. + + + +Dim elList = From el In xmlTree..Descendants _ + Select el + +For Each el As XElement In elList + Console.WriteLine(el) +Next +``` + + This example produces the following output: + +``` +This is some text + + where + +where + all of the nodes must be concatenated. +This is a second sentence. +``` + + The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). + +```csharp +XNamespace aw = "http://www.adventure-works.com"; +XElement xmlTree = XElement.Parse( +@" + + This is some text + + where + + all of the nodes must be concatenated. + + + This is a second sentence. + +"); + +IEnumerable elList = + from el in xmlTree.Elements(aw + "Para").Descendants() + select el; + +foreach (XElement el in elList) + Console.WriteLine(el); +``` + +```vb +Imports + +Module Module1 + Sub Main() + Dim xmlTree As XElement = _ + + + This is some text + + where + + all of the nodes must be concatenated. + + + + This is a second sentence. + + + + Dim elList = From el In xmlTree..Descendants _ + Select el + + For Each el As XElement In elList + Console.WriteLine(el) + Next + End Sub +End Module + +``` + + This example produces the following output: + +``` +This is some text + + where + +where + all of the nodes must be concatenated. +This is a second sentence. +``` + ]]> @@ -2216,143 +2216,143 @@ End Module Returns a filtered collection of elements that contains the descendant elements of every element and document in the source collection. Only elements that have a matching are included in the collection. An of that contains the descendant elements of every element and document in the source collection. Only elements that have a matching are included in the collection. - - - This is some text - - where - - all of the text nodes must be concatenated. - - - This is a second sentence. - -"); - -string str = - (from el in xmlTree.Elements("Para").Descendants("t") - select (string)el) - .Aggregate(new StringBuilder(), - (sb, i) => sb.Append(i), - sb => sb.ToString()); - -Console.WriteLine(str); -``` - -```vb -Dim xmlTree As XElement = _ - - - This is some text - - where - - all of the text nodes must be concatenated. - - - This is a second sentence. - - - -Dim str As String = _ - ( _ - From el In xmlTree.... _ - Select CStr(el) _ - ) _ - .Aggregate(New StringBuilder(), _ - Function(ByVal sb, ByVal i) sb.Append(i), _ - Function(ByVal sb) sb.ToString()) - -Console.WriteLine(str) -``` - - This example produces the following output: - -``` -This is some text where all of the text nodes must be concatenated. This is a second sentence. -``` - - The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). - -```csharp -XNamespace aw = "http://www.adventure-works.com"; -XElement xmlTree = XElement.Parse( -@" - - This is some text - - where - - all of the text nodes must be concatenated. - - - This is a second sentence. - -"); - -string str = - (from el in xmlTree.Elements(aw + "Para").Descendants(aw + "t") - select (string)el) - .Aggregate(new StringBuilder(), - (sb, i) => sb.Append(i), - sb => sb.ToString()); - -Console.WriteLine(str); -``` - -```vb -Imports - -Module Module1 - Sub Main() - Dim xmlTree As XElement = _ - - - This is some text - - where - - all of the text nodes must be concatenated. - - - This is a second sentence. - - - - Dim str As String = _ - ( _ - From el In xmlTree.... _ - Select CStr(el) _ - ) _ - .Aggregate(New StringBuilder(), _ - Function(sb, i) sb.Append(i), _ - Function(sb) sb.ToString()) - - Console.WriteLine(str) - End Sub -End Module -``` - - This example produces the following output: - -``` -This is some text where all of the text nodes must be concatenated. This is a second sentence. -``` - + + + This is some text + + where + + all of the text nodes must be concatenated. + + + This is a second sentence. + +"); + +string str = + (from el in xmlTree.Elements("Para").Descendants("t") + select (string)el) + .Aggregate(new StringBuilder(), + (sb, i) => sb.Append(i), + sb => sb.ToString()); + +Console.WriteLine(str); +``` + +```vb +Dim xmlTree As XElement = _ + + + This is some text + + where + + all of the text nodes must be concatenated. + + + This is a second sentence. + + + +Dim str As String = _ + ( _ + From el In xmlTree.... _ + Select CStr(el) _ + ) _ + .Aggregate(New StringBuilder(), _ + Function(ByVal sb, ByVal i) sb.Append(i), _ + Function(ByVal sb) sb.ToString()) + +Console.WriteLine(str) +``` + + This example produces the following output: + +``` +This is some text where all of the text nodes must be concatenated. This is a second sentence. +``` + + The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). + +```csharp +XNamespace aw = "http://www.adventure-works.com"; +XElement xmlTree = XElement.Parse( +@" + + This is some text + + where + + all of the text nodes must be concatenated. + + + This is a second sentence. + +"); + +string str = + (from el in xmlTree.Elements(aw + "Para").Descendants(aw + "t") + select (string)el) + .Aggregate(new StringBuilder(), + (sb, i) => sb.Append(i), + sb => sb.ToString()); + +Console.WriteLine(str); +``` + +```vb +Imports + +Module Module1 + Sub Main() + Dim xmlTree As XElement = _ + + + This is some text + + where + + all of the text nodes must be concatenated. + + + This is a second sentence. + + + + Dim str As String = _ + ( _ + From el In xmlTree.... _ + Select CStr(el) _ + ) _ + .Aggregate(New StringBuilder(), _ + Function(sb, i) sb.Append(i), _ + Function(sb) sb.ToString()) + + Console.WriteLine(str) + End Sub +End Module +``` + + This example produces the following output: + +``` +This is some text where all of the text nodes must be concatenated. This is a second sentence. +``` + ]]> @@ -2374,13 +2374,13 @@ This is some text where all of the text nodes must be concatenated. This is a se Returns a collection of every element in the source collection, and all descendant elements for every element in the source collection. - @@ -2446,13 +2446,13 @@ This is some text where all of the text nodes must be concatenated. This is a se Returns a collection of elements that contains every element in the source collection, and the descendent elements of every element in the source collection. An of that contains every element in the source collection, and the descendent elements of every element in the source collection. - @@ -2527,13 +2527,13 @@ This is some text where all of the text nodes must be concatenated. This is a se Returns a filtered collection of elements that contains every element in the source collection, and the descendents of every element in the source collection. Only elements that have a matching are included in the collection. An of that contains every element in the source collection, and the descendents of every element in the source collection. Only elements that have a matching are included in the collection. - @@ -2555,13 +2555,13 @@ This is some text where all of the text nodes must be concatenated. This is a se Returns a collection of the child elements of every element and document in the source collection. - for every element in the source collection. - - This method uses deferred execution. - + for every element in the source collection. + + This method uses deferred execution. + ]]> @@ -2635,153 +2635,153 @@ This is some text where all of the text nodes must be concatenated. This is a se Returns a collection of the child elements of every element and document in the source collection. An of of the child elements of every element or document in the source collection. - for every element in the source collection, there is no integrated elements axis that allows you to retrieve a collection of every child element for every element in the source collection. - - This method uses deferred execution. - - - -## Examples - The following example retrieves a collection of elements with the element name of `Child`. It then uses this axis method to retrieve all child elements of the collection. - -```csharp -XElement xmlTree = new XElement("Root", - new XElement("Child", - new XElement("GrandChild1", 1), - new XElement("GrandChild2", 2) - ), - new XElement("Child", - new XElement("GrandChild3", 3), - new XElement("GrandChild4", 4) - ), - new XElement("Child", - new XElement("GrandChild5", 5), - new XElement("GrandChild6", 6) - ) -); - -IEnumerable allGrandChildren = - from el in xmlTree.Elements("Child").Elements() - select el; - -foreach (XElement el in allGrandChildren) - Console.WriteLine(el); -``` - -```vb -Dim xmlTree As XElement = _ - - - 1 - 2 - - - - 3 - 4 - - - - 5 - 6 - - - -Dim allGrandChildren = From el In xmlTree..Elements _ - Select el - -For Each el As XElement In allGrandChildren - Console.WriteLine(el) -Next - -``` - - This example produces the following output: - -``` -1 -2 -3 -4 -5 -6 -``` - - The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). - -```csharp -XNamespace aw = "http://www.adventure-works.com"; -XElement xmlTree = new XElement(aw + "Root", - new XElement(aw + "Child", - new XElement(aw + "GrandChild1", 1), - new XElement(aw + "GrandChild2", 2) - ), - new XElement(aw + "Child", - new XElement(aw + "GrandChild3", 3), - new XElement(aw + "GrandChild4", 4) - ), - new XElement(aw + "Child", - new XElement(aw + "GrandChild5", 5), - new XElement(aw + "GrandChild6", 6) - ) -); - -IEnumerable allGrandChildren = - from el in xmlTree.Elements(aw + "Child").Elements() - select el; - -foreach (XElement el in allGrandChildren) - Console.WriteLine(el); -``` - -```vb -Imports - -Module Module1 - Sub Main() - Dim xmlTree As XElement = _ - - - 1 - 2 - - - - 3 - 4 - - - - 5 - 6 - - - - Dim allGrandChildren = From el In xmlTree..Elements _ - Select el - - For Each el As XElement In allGrandChildren - Console.WriteLine(el) - Next - End Sub -End Module - -``` - - This example produces the following output: - -``` -1 -2 -3 -4 -5 -6 -``` - + for every element in the source collection, there is no integrated elements axis that allows you to retrieve a collection of every child element for every element in the source collection. + + This method uses deferred execution. + + + +## Examples + The following example retrieves a collection of elements with the element name of `Child`. It then uses this axis method to retrieve all child elements of the collection. + +```csharp +XElement xmlTree = new XElement("Root", + new XElement("Child", + new XElement("GrandChild1", 1), + new XElement("GrandChild2", 2) + ), + new XElement("Child", + new XElement("GrandChild3", 3), + new XElement("GrandChild4", 4) + ), + new XElement("Child", + new XElement("GrandChild5", 5), + new XElement("GrandChild6", 6) + ) +); + +IEnumerable allGrandChildren = + from el in xmlTree.Elements("Child").Elements() + select el; + +foreach (XElement el in allGrandChildren) + Console.WriteLine(el); +``` + +```vb +Dim xmlTree As XElement = _ + + + 1 + 2 + + + + 3 + 4 + + + + 5 + 6 + + + +Dim allGrandChildren = From el In xmlTree..Elements _ + Select el + +For Each el As XElement In allGrandChildren + Console.WriteLine(el) +Next + +``` + + This example produces the following output: + +``` +1 +2 +3 +4 +5 +6 +``` + + The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). + +```csharp +XNamespace aw = "http://www.adventure-works.com"; +XElement xmlTree = new XElement(aw + "Root", + new XElement(aw + "Child", + new XElement(aw + "GrandChild1", 1), + new XElement(aw + "GrandChild2", 2) + ), + new XElement(aw + "Child", + new XElement(aw + "GrandChild3", 3), + new XElement(aw + "GrandChild4", 4) + ), + new XElement(aw + "Child", + new XElement(aw + "GrandChild5", 5), + new XElement(aw + "GrandChild6", 6) + ) +); + +IEnumerable allGrandChildren = + from el in xmlTree.Elements(aw + "Child").Elements() + select el; + +foreach (XElement el in allGrandChildren) + Console.WriteLine(el); +``` + +```vb +Imports + +Module Module1 + Sub Main() + Dim xmlTree As XElement = _ + + + 1 + 2 + + + + 3 + 4 + + + + 5 + 6 + + + + Dim allGrandChildren = From el In xmlTree..Elements _ + Select el + + For Each el As XElement In allGrandChildren + Console.WriteLine(el) + Next + End Sub +End Module + +``` + + This example produces the following output: + +``` +1 +2 +3 +4 +5 +6 +``` + ]]> @@ -2868,145 +2868,145 @@ End Module Returns a filtered collection of the child elements of every element and document in the source collection. Only elements that have a matching are included in the collection. An of of the child elements of every element and document in the source collection. Only elements that have a matching are included in the collection. - allGrandChildren = - from el in xmlTree.Elements("Item").Elements("aaa") - select el; - -foreach (XElement el in allGrandChildren) - Console.WriteLine(el); -``` - -```vb -Dim xmlTree As XElement = _ - - - 1 - 2 - - - - 3 - 4 - - - - 5 - 6 - - - -Dim allGrandChildren = From el In xmlTree.. _ - Select el - -For Each el As XElement In allGrandChildren - Console.WriteLine(el) -Next - -``` - - This example produces the following output: - -``` -1 -4 -``` - - The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). - -```csharp -XNamespace aw = "http://www.adventure-works.com"; -XElement xmlTree = new XElement(aw + "Root", - new XElement(aw + "Item", - new XElement(aw + "aaa", 1), - new XElement(aw + "bbb", 2) - ), - new XElement(aw + "Item", - new XElement(aw + "ccc", 3), - new XElement(aw + "aaa", 4) - ), - new XElement(aw + "Item", - new XElement(aw + "ddd", 5), - new XElement(aw + "eee", 6) - ) -); - -IEnumerable allGrandChildren = - from el in xmlTree.Elements(aw + "Item").Elements(aw + "aaa") - select el; - -foreach (XElement el in allGrandChildren) - Console.WriteLine(el); -``` - -```vb -Imports - -Module Module1 - Sub Main() - Dim xmlTree As XElement = _ - - - 1 - 2 - - - - 3 - 4 - - - - 5 - 6 - - - - Dim allGrandChildren = From el In xmlTree.. _ - Select el - - For Each el As XElement In allGrandChildren - Console.WriteLine(el) - Next - End Sub -End Module - -``` - - This example produces the following output: - -``` -1 -4 -``` - + allGrandChildren = + from el in xmlTree.Elements("Item").Elements("aaa") + select el; + +foreach (XElement el in allGrandChildren) + Console.WriteLine(el); +``` + +```vb +Dim xmlTree As XElement = _ + + + 1 + 2 + + + + 3 + 4 + + + + 5 + 6 + + + +Dim allGrandChildren = From el In xmlTree.. _ + Select el + +For Each el As XElement In allGrandChildren + Console.WriteLine(el) +Next + +``` + + This example produces the following output: + +``` +1 +4 +``` + + The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). + +```csharp +XNamespace aw = "http://www.adventure-works.com"; +XElement xmlTree = new XElement(aw + "Root", + new XElement(aw + "Item", + new XElement(aw + "aaa", 1), + new XElement(aw + "bbb", 2) + ), + new XElement(aw + "Item", + new XElement(aw + "ccc", 3), + new XElement(aw + "aaa", 4) + ), + new XElement(aw + "Item", + new XElement(aw + "ddd", 5), + new XElement(aw + "eee", 6) + ) +); + +IEnumerable allGrandChildren = + from el in xmlTree.Elements(aw + "Item").Elements(aw + "aaa") + select el; + +foreach (XElement el in allGrandChildren) + Console.WriteLine(el); +``` + +```vb +Imports + +Module Module1 + Sub Main() + Dim xmlTree As XElement = _ + + + 1 + 2 + + + + 3 + 4 + + + + 5 + 6 + + + + Dim allGrandChildren = From el In xmlTree.. _ + Select el + + For Each el As XElement In allGrandChildren + Console.WriteLine(el) + Next + End Sub +End Module + +``` + + This example produces the following output: + +``` +1 +4 +``` + ]]> @@ -3076,86 +3076,86 @@ End Module Returns a collection of nodes that contains all nodes in the source collection, sorted in document order. An of that contains all nodes in the source collection, sorted in document order. - inDocOrder = elementList.InDocumentOrder(); - -foreach (XElement el in inDocOrder) - Console.WriteLine(el); -``` - -```vb -Dim xmlTree As XElement = _ - - - 1 - 2 - - - - 3 - 4 - - - - 5 - 6 - - - -Dim elementList() As XElement = _ - { _ - xmlTree...(0), _ - xmlTree...(0), _ - xmlTree...(0) _ - } - -Dim inDocOrder = elementList.InDocumentOrder - -For Each el As XElement In inDocOrder - Console.WriteLine(el) -Next - -``` - - This example produces the following output: - -``` -1 -3 -5 -``` - + inDocOrder = elementList.InDocumentOrder(); + +foreach (XElement el in inDocOrder) + Console.WriteLine(el); +``` + +```vb +Dim xmlTree As XElement = _ + + + 1 + 2 + + + + 3 + 4 + + + + 5 + 6 + + + +Dim elementList() As XElement = _ + { _ + xmlTree...(0), _ + xmlTree...(0), _ + xmlTree...(0) _ + } + +Dim inDocOrder = elementList.InDocumentOrder + +For Each el As XElement In inDocOrder + Console.WriteLine(el) +Next + +``` + + This example produces the following output: + +``` +1 +3 +5 +``` + ]]> @@ -3240,68 +3240,68 @@ Next Returns a collection of the child nodes of every document and element in the source collection. An of of the child nodes of every document and element in the source collection. - aaaTextbbb" + - @"cccTextddd"); -IEnumerable nodes = xmlTree.Elements("Child").Nodes(); - -foreach (XNode node in nodes) -{ - switch (node.NodeType) - { - case XmlNodeType.Element: - Console.WriteLine("Element: {0}", ((XElement)node).Name); - break; - case XmlNodeType.Text: - Console.WriteLine("Text: {0}", ((XText)node).Value); - break; - } -} -``` - -```vb -Dim xmlTree As XElement = _ - - aaaTextbbb - cccTextddd - - -Dim nodes = xmlTree..Nodes() - -' Note that XNode uses XmlNodeType, which is in the System.Xml namespace. -For Each node As XNode In nodes - Select Case node.NodeType - Case XmlNodeType.Element - Console.WriteLine("Element: {0}", DirectCast(node, XElement).Name) - Case XmlNodeType.Text - Console.WriteLine("Text: {0}", DirectCast(node, XText).Value) - End Select -Next - -``` - - This example produces the following output: - -``` -Text: aaa -Element: GrandChild -Text: bbb -Text: ccc -Element: GrandChild -Text: ddd -``` - + aaaTextbbb" + + @"cccTextddd"); +IEnumerable nodes = xmlTree.Elements("Child").Nodes(); + +foreach (XNode node in nodes) +{ + switch (node.NodeType) + { + case XmlNodeType.Element: + Console.WriteLine("Element: {0}", ((XElement)node).Name); + break; + case XmlNodeType.Text: + Console.WriteLine("Text: {0}", ((XText)node).Value); + break; + } +} +``` + +```vb +Dim xmlTree As XElement = _ + + aaaTextbbb + cccTextddd + + +Dim nodes = xmlTree..Nodes() + +' Note that XNode uses XmlNodeType, which is in the System.Xml namespace. +For Each node As XNode In nodes + Select Case node.NodeType + Case XmlNodeType.Element + Console.WriteLine("Element: {0}", DirectCast(node, XElement).Name) + Case XmlNodeType.Text + Console.WriteLine("Text: {0}", DirectCast(node, XText).Value) + End Select +Next + +``` + + This example produces the following output: + +``` +Text: aaa +Element: GrandChild +Text: bbb +Text: ccc +Element: GrandChild +Text: ddd +``` + ]]> @@ -3362,54 +3362,54 @@ Text: ddd An of that contains the source collection. Removes every attribute in the source collection from its parent element. - before disconnecting them from their parents. This is required to avoid issues with mixed imperative/declarative code. For more information, see [Mixed Declarative Code/Imperative Code Bugs (LINQ to XML)](/dotnet/standard/linq/mixed-declarative-imperative-code-bugs). - - - -## Examples - The following example retrieves a collection of attributes, and then calls this method to remove them from their parent elements. - -```csharp -XElement root = new XElement("Root", - new XAttribute("Att1", 1), - new XAttribute("Att2", 2), - new XAttribute("Att3", 3), - new XAttribute("Att4", 4), - new XAttribute("Att5", 5) -); - -IEnumerable atList = - from at in root.Attributes() - where (int)at >= 3 - select at; - -atList.Remove(); - -Console.WriteLine(root); -``` - -```vb -Dim root As XElement = - -Dim atList = From at In root.Attributes _ - Where at.Value >= 3 _ - Select at - -atList.Remove() - -Console.WriteLine(root) - -``` - - This example produces the following output: - -``` - -``` - + before disconnecting them from their parents. This is required to avoid issues with mixed imperative/declarative code. For more information, see [Mixed Declarative Code/Imperative Code Bugs (LINQ to XML)](/dotnet/standard/linq/mixed-declarative-imperative-code-bugs). + + + +## Examples + The following example retrieves a collection of attributes, and then calls this method to remove them from their parent elements. + +```csharp +XElement root = new XElement("Root", + new XAttribute("Att1", 1), + new XAttribute("Att2", 2), + new XAttribute("Att3", 3), + new XAttribute("Att4", 4), + new XAttribute("Att5", 5) +); + +IEnumerable atList = + from at in root.Attributes() + where (int)at >= 3 + select at; + +atList.Remove(); + +Console.WriteLine(root); +``` + +```vb +Dim root As XElement = + +Dim atList = From at In root.Attributes _ + Where at.Value >= 3 _ + Select at + +atList.Remove() + +Console.WriteLine(root) + +``` + + This example produces the following output: + +``` + +``` + ]]> @@ -3479,64 +3479,64 @@ Console.WriteLine(root) An of that contains the source collection. Removes every node in the source collection from its parent node. - ` before disconnecting them from their parents. This is required to avoid issues with mixed imperative/declarative code. For more information, see [Mixed Declarative Code/Imperative Code Bugs (LINQ to XML)](/dotnet/standard/linq/mixed-declarative-imperative-code-bugs). - - - -## Examples - The following example retrieves a collection of elements. It then calls this method to remove the elements from their parent element. - -```csharp -XElement root = new XElement("Root", - new XElement("Data", 1), - new XElement("Data", 2), - new XElement("Data", 3), - new XElement("Data", 4), - new XElement("Data", 5) -); - -IEnumerable elList = - from el in root.Elements() - where (int)el >= 3 - select el; - -elList.Remove(); - -Console.WriteLine(root); -``` - -```vb -Dim root As XElement = _ - - 1 - 2 - 3 - 4 - 5 - - -Dim elList = From el In root.Elements _ - Where el.Value >= 3 _ - Select el - -elList.Remove() - -Console.WriteLine(root) - -``` - - This example produces the following output: - -``` - - 1 - 2 - -``` - + ` before disconnecting them from their parents. This is required to avoid issues with mixed imperative/declarative code. For more information, see [Mixed Declarative Code/Imperative Code Bugs (LINQ to XML)](/dotnet/standard/linq/mixed-declarative-imperative-code-bugs). + + + +## Examples + The following example retrieves a collection of elements. It then calls this method to remove the elements from their parent element. + +```csharp +XElement root = new XElement("Root", + new XElement("Data", 1), + new XElement("Data", 2), + new XElement("Data", 3), + new XElement("Data", 4), + new XElement("Data", 5) +); + +IEnumerable elList = + from el in root.Elements() + where (int)el >= 3 + select el; + +elList.Remove(); + +Console.WriteLine(root); +``` + +```vb +Dim root As XElement = _ + + 1 + 2 + 3 + 4 + 5 + + +Dim elList = From el In root.Elements _ + Where el.Value >= 3 _ + Select el + +elList.Remove() + +Console.WriteLine(root) + +``` + + This example produces the following output: + +``` + + 1 + 2 + +``` + ]]> diff --git a/xml/System.Xml.Linq/XAttribute.xml b/xml/System.Xml.Linq/XAttribute.xml index b9ee1599229..fc0e3985059 100644 --- a/xml/System.Xml.Linq/XAttribute.xml +++ b/xml/System.Xml.Linq/XAttribute.xml @@ -73,7 +73,7 @@ Each contains a list of the attributes for that element. Attributes must have a qualified name that is unique to the element. Attributes are not derived from ; they are not nodes in the XML tree. Instead, they are simply name/value pairs associated with an element. - Attributes are maintained in the XML tree in the order that they were added to the element. When a collection of attributes is returned by , they are returned in the order that they were added to the element, and are not sorted. + Attributes are maintained in the XML tree in the order that they were added to the element. When a collection of attributes is returned by , they are returned in the order that they were added to the element, and are not sorted. Technically, in XML, namespace declarations are not attributes proper. However, this distinction is not normally made by many XML programmers. Instead, because namespace declarations have exactly the same XML syntax as attributes, most XML programmers think of namespaces as attributes. To simplify the LINQ to XML programming interface, namespaces are represented in the XML tree as attributes. Such namespace attributes impact serialization of an XML tree. When serializing, LINQ to XML attempts to serialize with the namespace prefix specified in namespace attributes. You can use the to determine if an attribute is really a namespace declaration. @@ -644,7 +644,7 @@ Att2=new content , they are returned in the order that they were added, and are not sorted. When you request the next attribute through this property, this property returns the attribute that was added after this attribute. + Attributes are maintained in the XML tree in the order that they were added to the element. When a collection of attributes is returned by , they are returned in the order that they were added, and are not sorted. When you request the next attribute through this property, this property returns the attribute that was added after this attribute. If this attribute does not have a parent, or if there is no next attribute, then this property returns `null`. @@ -917,7 +917,7 @@ Console.WriteLine("(bool)BoolValue={0}", bv) Behavior is lax when casting to a from an attribute or element. Even if the attribute or element value is not formatted exactly per the W3C specification, the value is appropriately converted to a . - This conversion operator uses to convert from a . + This conversion operator uses to convert from a . ## Examples The following example creates an attribute with date and time content. It then casts it to to retrieve the value. @@ -1547,7 +1547,7 @@ value=9223372036854775807 When converting to from an attribute or element, allowed values are "0", "1", and any string that produces "true" or "false" after trimming and conversion to lower case. ## Examples - The following example creates an attribute with Boolean content. It then retrieves the value by casting to of . + The following example creates an attribute with Boolean content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -1639,12 +1639,12 @@ Nullable boolean: BoolValue2=False ## Remarks The value space of an attribute or element that contains date and time content is closely related to the dates and times described in ISO 8601. When creating an attribute or element that contains date and time content, the attribute or element values are formatted per the W3C specification. See the W3C specification for more details. - Behavior is lax when casting to a of from an attribute or element. Even if the attribute or element value is not formatted exactly per the W3C specification, the value is appropriately converted to a of . + Behavior is lax when casting to a of from an attribute or element. Even if the attribute or element value is not formatted exactly per the W3C specification, the value is appropriately converted to a of . - This conversion operator uses to convert from a . + This conversion operator uses to convert from a . ## Examples - The following example creates an attribute with a date and time as content. It then retrieves the value by casting to of . + The following example creates an attribute with a date and time as content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -1731,7 +1731,7 @@ Nullable DateTime: value=10/6/2006 12:30:00 PM This conversion operator uses the class to do the conversion. ## Examples - The following example creates an attribute with a date and time as content. It then retrieves the value by casting to of . + The following example creates an attribute with a date and time as content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -1813,7 +1813,7 @@ Nullable DateTimeOffset: value=10/6/2006 12:30:00 PM -07:00 A of that contains the content of this . of . + The following example creates an attribute with decimal content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -1895,7 +1895,7 @@ Nullable decimal: value=79228162514264337593543950335 A of that contains the content of this . of . + The following example creates an attribute with double precision floating point content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -1977,7 +1977,7 @@ Nullable double: value=1.79769313486231E+308 A of that contains the content of this . of . + The following example creates an attribute with guid content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -2059,7 +2059,7 @@ Nullable Guid: value=3c1cc55b-baff-4b7a-9d17-077af3aa5730 A of that contains the content of this . of . + The following example creates an attribute with integer content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -2140,7 +2140,7 @@ Nullable int: value=2147483647 A of that contains the content of this . of . + The following example creates an attribute with long integer content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -2222,7 +2222,7 @@ Nullable long: value=9223372036854775807 A of that contains the content of this . of . + The following example creates an attribute with single precision floating point content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -2308,10 +2308,10 @@ Nullable Single: value=3.402823E+38 ## Remarks The value space of an attribute or element that contains time span content is closely related to duration content as described in ISO 8601. When creating an attribute or element that contains time span content, the attribute or element values are formatted per the W3C specification. Please see the W3C specification for more details. - Behavior is lax when casting to a of from an attribute or element. Even if the attribute or element value is not formatted exactly per the W3C specification, the value is appropriately converted to a of . + Behavior is lax when casting to a of from an attribute or element. Even if the attribute or element value is not formatted exactly per the W3C specification, the value is appropriately converted to a of . ## Examples - The following example creates an attribute with time span content. It then retrieves the value by casting to of . + The following example creates an attribute with time span content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -2393,7 +2393,7 @@ Nullable TimeSpan: value=01:05:30 A of that contains the content of this . of . + The following example creates an attribute with unsigned integer content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -2475,7 +2475,7 @@ Nullable uint: value=4294967295 A of that contains the content of this . of . + The following example creates an attribute with unsigned long integer content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -2973,7 +2973,7 @@ value=1844674407370955161 , they are returned in the order that they were added, and are not sorted. When you request the previous attribute through this property, this property returns the attribute that was added before this attribute. + Attributes are maintained in the XML tree in the order that they were added to the element. When a collection of attributes is returned by , they are returned in the order that they were added, and are not sorted. When you request the previous attribute through this property, this property returns the attribute that was added before this attribute. If this attribute does not have a parent, or if this attribute is the first attribute, then this property returns `null`. @@ -3069,9 +3069,9 @@ Att1="1" ## Remarks You can use this method to modify an XML tree. This method will cause events to occur. - There are many scenarios in which you might want to remove a set of attributes. In LINQ to XML programming, you should not manipulate or modify a set of nodes while you are querying for nodes in that set. In practical terms, this means that you should not iterate over a set of attributes and remove them. Instead, you should materialize them into a using the extension method. Then you can iterate over the list, removing the attributes. For more information, see [Mixed Declarative Code/Imperative Code Bugs (LINQ to XML)](/dotnet/standard/linq/mixed-declarative-imperative-code-bugs). + There are many scenarios in which you might want to remove a set of attributes. In LINQ to XML programming, you should not manipulate or modify a set of nodes while you are querying for nodes in that set. In practical terms, this means that you should not iterate over a set of attributes and remove them. Instead, you should materialize them into a using the extension method. Then you can iterate over the list, removing the attributes. For more information, see [Mixed Declarative Code/Imperative Code Bugs (LINQ to XML)](/dotnet/standard/linq/mixed-declarative-imperative-code-bugs). - Alternatively, if you want to remove a set of attributes, it is recommended that you use the method. This method copies the attributes to a list, then iterates over the list, removing the attributes. + Alternatively, if you want to remove a set of attributes, it is recommended that you use the method. This method copies the attributes to a list, then iterates over the list, removing the attributes. @@ -3340,7 +3340,7 @@ Att2="content2" Setting this property raises the and the events. - If you're getting the value and the attribute might not exist, it is more convenient to use the explicit conversion operators, and assign the attribute to a nullable type such as `string` or of . If the attribute does not exist, then the nullable type is set to `null`. Before using this property, you must make sure that the method does not return `null`. + If you're getting the value and the attribute might not exist, it is more convenient to use the explicit conversion operators, and assign the attribute to a nullable type such as `string` or of . If the attribute does not exist, then the nullable type is set to `null`. Before using this property, you must make sure that the method does not return `null`. ## Examples The following example creates an element with an attribute. It then retrieves the value of the attribute, and then sets it. diff --git a/xml/System.Xml.Linq/XContainer.xml b/xml/System.Xml.Linq/XContainer.xml index fc5ac8fa70c..a590e06a55a 100644 --- a/xml/System.Xml.Linq/XContainer.xml +++ b/xml/System.Xml.Linq/XContainer.xml @@ -54,13 +54,13 @@ Represents a node that can contain other nodes. - are and . - + are and . + ]]> LINQ to XML overview @@ -76,70 +76,70 @@ Adds the specified content as children to this . - . - - For details about the valid content that can be passed to this function, see [Valid Content of XElement and XDocument Objects](/dotnet/standard/linq/valid-content-xelement-xdocument-objects). - - This method will raise the and the events. - - - -## Examples - The following example creates two XML trees, and then uses this method to add the results of a query to one of them. - -```csharp -XElement srcTree = new XElement("Root", - new XElement("Element1", 1), - new XElement("Element2", 2), - new XElement("Element3", 3), - new XElement("Element4", 4), - new XElement("Element5", 5) -); -XElement xmlTree = new XElement("Root", - new XElement("NewElement", "Content") -); -xmlTree.Add( - from el in srcTree.Elements() - where (int)el >= 3 - select el -); -Console.WriteLine(xmlTree); -``` - -```vb -Dim srcTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - -Dim xmlTree As XElement = _ - - Content - -xmlTree.Add( _ - From el In srcTree.Elements _ - Where CInt(el) >= 3 _ - Select el) -Console.WriteLine(xmlTree) -``` - - This example produces the following output: - -```xml - - Content - 3 - 4 - 5 - -``` - + . + + For details about the valid content that can be passed to this function, see [Valid Content of XElement and XDocument Objects](/dotnet/standard/linq/valid-content-xelement-xdocument-objects). + + This method will raise the and the events. + + + +## Examples + The following example creates two XML trees, and then uses this method to add the results of a query to one of them. + +```csharp +XElement srcTree = new XElement("Root", + new XElement("Element1", 1), + new XElement("Element2", 2), + new XElement("Element3", 3), + new XElement("Element4", 4), + new XElement("Element5", 5) +); +XElement xmlTree = new XElement("Root", + new XElement("NewElement", "Content") +); +xmlTree.Add( + from el in srcTree.Elements() + where (int)el >= 3 + select el +); +Console.WriteLine(xmlTree); +``` + +```vb +Dim srcTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + +Dim xmlTree As XElement = _ + + Content + +xmlTree.Add( _ + From el In srcTree.Elements _ + Where CInt(el) >= 3 _ + Select el) +Console.WriteLine(xmlTree) +``` + + This example produces the following output: + +```xml + + Content + 3 + 4 + 5 + +``` + ]]> @@ -193,94 +193,94 @@ Console.WriteLine(xmlTree) A content object containing simple content or a collection of content objects to be added. Adds the specified content as children of this . - . - - For details about the valid content that can be passed to this function, see [Valid Content of XElement and XDocument Objects](/dotnet/standard/linq/valid-content-xelement-xdocument-objects). - - This method will raise the and the events. - - - -## Examples - The following example creates two XML trees, and then uses this method to add an object to one of them. It also adds the results of a LINQ query to the XML tree. - -```csharp -XElement srcTree = new XElement("Root", - new XElement("Element1", 1), - new XElement("Element2", 2), - new XElement("Element3", 3), - new XElement("Element4", 4), - new XElement("Element5", 5) -); -XElement xmlTree = new XElement("Root", - new XElement("Child1", 1), - new XElement("Child2", 2), - new XElement("Child3", 3), - new XElement("Child4", 4), - new XElement("Child5", 5) -); -xmlTree.Add(new XElement("NewChild", "new content")); -xmlTree.Add( - from el in srcTree.Elements() - where (int)el > 3 - select el -); -// Even though Child9 does not exist in srcTree, the following statement will not -// throw an exception, and nothing will be added to xmlTree. -xmlTree.Add(srcTree.Element("Child9")); -Console.WriteLine(xmlTree); -``` - -```vb -Dim srcTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - - -Dim xmlTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - - -xmlTree.Add(New XElement("NewChild", "new content")) -xmlTree.Add( _ - From el In srcTree.Elements() _ - Where CInt(el) > 3 _ - Select el _ -) -' Even though Child9 does not exist in srcTree, the following statement will not -' throw an exception, and nothing will be added to xmlTree. -xmlTree.Add(srcTree.) -Console.WriteLine(xmlTree) - -``` - - This example produces the following output: - -```xml - - 1 - 2 - 3 - 4 - 5 - new content - 4 - 5 - -``` - + . + + For details about the valid content that can be passed to this function, see [Valid Content of XElement and XDocument Objects](/dotnet/standard/linq/valid-content-xelement-xdocument-objects). + + This method will raise the and the events. + + + +## Examples + The following example creates two XML trees, and then uses this method to add an object to one of them. It also adds the results of a LINQ query to the XML tree. + +```csharp +XElement srcTree = new XElement("Root", + new XElement("Element1", 1), + new XElement("Element2", 2), + new XElement("Element3", 3), + new XElement("Element4", 4), + new XElement("Element5", 5) +); +XElement xmlTree = new XElement("Root", + new XElement("Child1", 1), + new XElement("Child2", 2), + new XElement("Child3", 3), + new XElement("Child4", 4), + new XElement("Child5", 5) +); +xmlTree.Add(new XElement("NewChild", "new content")); +xmlTree.Add( + from el in srcTree.Elements() + where (int)el > 3 + select el +); +// Even though Child9 does not exist in srcTree, the following statement will not +// throw an exception, and nothing will be added to xmlTree. +xmlTree.Add(srcTree.Element("Child9")); +Console.WriteLine(xmlTree); +``` + +```vb +Dim srcTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + + +Dim xmlTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + + +xmlTree.Add(New XElement("NewChild", "new content")) +xmlTree.Add( _ + From el In srcTree.Elements() _ + Where CInt(el) > 3 _ + Select el _ +) +' Even though Child9 does not exist in srcTree, the following statement will not +' throw an exception, and nothing will be added to xmlTree. +xmlTree.Add(srcTree.) +Console.WriteLine(xmlTree) + +``` + + This example produces the following output: + +```xml + + 1 + 2 + 3 + 4 + 5 + new content + 4 + 5 + +``` + ]]> @@ -351,93 +351,93 @@ Console.WriteLine(xmlTree) A parameter list of content objects. Adds the specified content as children of this . - . - - For details about the valid content that can be passed to this function, see [Valid Content of XElement and XDocument Objects](/dotnet/standard/linq/valid-content-xelement-xdocument-objects). - - This method will raise the and the events. - - - -## Examples - The following example creates two XML trees, uses this method to add an object to one of them. It also adds the results of a LINQ query to the XML tree. - -```csharp -XElement srcTree = new XElement("Root", - new XElement("Element1", 1), - new XElement("Element2", 2), - new XElement("Element3", 3), - new XElement("Element4", 4), - new XElement("Element5", 5) -); -XElement xmlTree = new XElement("Root", - new XElement("Child1", 1), - new XElement("Child2", 2), - new XElement("Child3", 3), - new XElement("Child4", 4), - new XElement("Child5", 5) -); -xmlTree.Add(new XElement("NewChild", "new content")); -xmlTree.Add( - from el in srcTree.Elements() - where (int)el > 3 - select el -); -// Even though Child9 does not exist in srcTree, the following statement will not -// throw an exception, and nothing will be added to xmlTree -xmlTree.Add(srcTree.Element("Child9")); -Console.WriteLine(xmlTree); -``` - -```vb -Dim srcTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - - -Dim xmlTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - - -xmlTree.Add(New XElement("NewChild", "new content")) -xmlTree.Add( _ - From el In srcTree.Elements() _ - Where CInt(el) > 3 _ - Select el _ -) -' Even though Child9 does not exist in srcTree, the following statement will not -' throw an exception, and nothing will be added to xmlTree -xmlTree.Add(srcTree.) -Console.WriteLine(xmlTree) -``` - - This example produces the following output: - -```xml - - 1 - 2 - 3 - 4 - 5 - new content - 4 - 5 - -``` - + . + + For details about the valid content that can be passed to this function, see [Valid Content of XElement and XDocument Objects](/dotnet/standard/linq/valid-content-xelement-xdocument-objects). + + This method will raise the and the events. + + + +## Examples + The following example creates two XML trees, uses this method to add an object to one of them. It also adds the results of a LINQ query to the XML tree. + +```csharp +XElement srcTree = new XElement("Root", + new XElement("Element1", 1), + new XElement("Element2", 2), + new XElement("Element3", 3), + new XElement("Element4", 4), + new XElement("Element5", 5) +); +XElement xmlTree = new XElement("Root", + new XElement("Child1", 1), + new XElement("Child2", 2), + new XElement("Child3", 3), + new XElement("Child4", 4), + new XElement("Child5", 5) +); +xmlTree.Add(new XElement("NewChild", "new content")); +xmlTree.Add( + from el in srcTree.Elements() + where (int)el > 3 + select el +); +// Even though Child9 does not exist in srcTree, the following statement will not +// throw an exception, and nothing will be added to xmlTree +xmlTree.Add(srcTree.Element("Child9")); +Console.WriteLine(xmlTree); +``` + +```vb +Dim srcTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + + +Dim xmlTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + + +xmlTree.Add(New XElement("NewChild", "new content")) +xmlTree.Add( _ + From el In srcTree.Elements() _ + Where CInt(el) > 3 _ + Select el _ +) +' Even though Child9 does not exist in srcTree, the following statement will not +' throw an exception, and nothing will be added to xmlTree +xmlTree.Add(srcTree.) +Console.WriteLine(xmlTree) +``` + + This example produces the following output: + +```xml + + 1 + 2 + 3 + 4 + 5 + new content + 4 + 5 + +``` + ]]> @@ -455,70 +455,70 @@ Console.WriteLine(xmlTree) Adds the specified content as the first children of this document or element. - . - - For details about the valid content that can be passed to this function, see [Valid Content of XElement and XDocument Objects](/dotnet/standard/linq/valid-content-xelement-xdocument-objects). - - This method will raise the and the events. - - - -## Examples - The following example creates two XML trees, and then uses this method to add the results of a query to one of them. - -```csharp -XElement srcTree = new XElement("Root", - new XElement("Element1", 1), - new XElement("Element2", 2), - new XElement("Element3", 3), - new XElement("Element4", 4), - new XElement("Element5", 5) -); -XElement xmlTree = new XElement("Root", - new XElement("NewElement", "Content") -); -xmlTree.AddFirst( - from el in srcTree.Elements() - where (int)el >= 3 - select el -); -Console.WriteLine(xmlTree); -``` - -```vb -Dim srcTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - -Dim xmlTree As XElement = - Content - -xmlTree.AddFirst( _ - From el In srcTree.Elements _ - Where CInt(el) >= 3 _ - Select el) -Console.WriteLine(xmlTree) - -``` - - This example produces the following output: - -```xml - - 3 - 4 - 5 - Content - -``` - + . + + For details about the valid content that can be passed to this function, see [Valid Content of XElement and XDocument Objects](/dotnet/standard/linq/valid-content-xelement-xdocument-objects). + + This method will raise the and the events. + + + +## Examples + The following example creates two XML trees, and then uses this method to add the results of a query to one of them. + +```csharp +XElement srcTree = new XElement("Root", + new XElement("Element1", 1), + new XElement("Element2", 2), + new XElement("Element3", 3), + new XElement("Element4", 4), + new XElement("Element5", 5) +); +XElement xmlTree = new XElement("Root", + new XElement("NewElement", "Content") +); +xmlTree.AddFirst( + from el in srcTree.Elements() + where (int)el >= 3 + select el +); +Console.WriteLine(xmlTree); +``` + +```vb +Dim srcTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + +Dim xmlTree As XElement = + Content + +xmlTree.AddFirst( _ + From el In srcTree.Elements _ + Where CInt(el) >= 3 _ + Select el) +Console.WriteLine(xmlTree) + +``` + + This example produces the following output: + +```xml + + 3 + 4 + 5 + Content + +``` + ]]> @@ -572,93 +572,93 @@ Console.WriteLine(xmlTree) A content object containing simple content or a collection of content objects to be added. Adds the specified content as the first children of this document or element. - . - - For details about the valid content that can be passed to this function, see [Valid Content of XElement and XDocument Objects](/dotnet/standard/linq/valid-content-xelement-xdocument-objects). - - This method will raise the and the events. - - - -## Examples - The following example creates two XML trees, uses this method to add an object as the first element to one of them. It also adds the results of a LINQ query to the XML tree. - -```csharp -XElement srcTree = new XElement("Root", - new XElement("Element1", 1), - new XElement("Element2", 2), - new XElement("Element3", 3), - new XElement("Element4", 4), - new XElement("Element5", 5) -); -XElement xmlTree = new XElement("Root", - new XElement("Child1", 1), - new XElement("Child2", 2), - new XElement("Child3", 3), - new XElement("Child4", 4), - new XElement("Child5", 5) -); -xmlTree.AddFirst(new XElement("NewChild", "new content")); -xmlTree.AddFirst( - from el in srcTree.Elements() - where (int)el > 3 - select el -); -// Even though Child9 does not exist in srcTree, the following statement will not -// throw an exception, and nothing will be added to xmlTree -xmlTree.AddFirst(srcTree.Element("Child9")); -Console.WriteLine(xmlTree); -``` - -```vb -Dim srcTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - - -Dim xmlTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - - -xmlTree.AddFirst(New XElement("NewChild", "new content")) -xmlTree.AddFirst( _ - From el In srcTree.Elements() _ - Where CInt(el) > 3 _ - Select el _ -) -' Even though Child9 does not exist in srcTree, the following statement will not -' throw an exception, and nothing will be added to xmlTree -xmlTree.AddFirst(srcTree.) -Console.WriteLine(xmlTree) -``` - - This example produces the following output: - -```xml - - 4 - 5 - new content - 1 - 2 - 3 - 4 - 5 - -``` - + . + + For details about the valid content that can be passed to this function, see [Valid Content of XElement and XDocument Objects](/dotnet/standard/linq/valid-content-xelement-xdocument-objects). + + This method will raise the and the events. + + + +## Examples + The following example creates two XML trees, uses this method to add an object as the first element to one of them. It also adds the results of a LINQ query to the XML tree. + +```csharp +XElement srcTree = new XElement("Root", + new XElement("Element1", 1), + new XElement("Element2", 2), + new XElement("Element3", 3), + new XElement("Element4", 4), + new XElement("Element5", 5) +); +XElement xmlTree = new XElement("Root", + new XElement("Child1", 1), + new XElement("Child2", 2), + new XElement("Child3", 3), + new XElement("Child4", 4), + new XElement("Child5", 5) +); +xmlTree.AddFirst(new XElement("NewChild", "new content")); +xmlTree.AddFirst( + from el in srcTree.Elements() + where (int)el > 3 + select el +); +// Even though Child9 does not exist in srcTree, the following statement will not +// throw an exception, and nothing will be added to xmlTree +xmlTree.AddFirst(srcTree.Element("Child9")); +Console.WriteLine(xmlTree); +``` + +```vb +Dim srcTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + + +Dim xmlTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + + +xmlTree.AddFirst(New XElement("NewChild", "new content")) +xmlTree.AddFirst( _ + From el In srcTree.Elements() _ + Where CInt(el) > 3 _ + Select el _ +) +' Even though Child9 does not exist in srcTree, the following statement will not +' throw an exception, and nothing will be added to xmlTree +xmlTree.AddFirst(srcTree.) +Console.WriteLine(xmlTree) +``` + + This example produces the following output: + +```xml + + 4 + 5 + new content + 1 + 2 + 3 + 4 + 5 + +``` + ]]> @@ -729,93 +729,93 @@ Console.WriteLine(xmlTree) A parameter list of content objects. Adds the specified content as the first children of this document or element. - . - - For details about the valid content that can be passed to this function, see [Valid Content of XElement and XDocument Objects](/dotnet/standard/linq/valid-content-xelement-xdocument-objects). - - This method will raise the and the events. - - - -## Examples - The following example creates two XML trees, and uses this method to add an object as the first element to one of them. It also adds the results of a LINQ query to the XML tree. - -```csharp -XElement srcTree = new XElement("Root", - new XElement("Element1", 1), - new XElement("Element2", 2), - new XElement("Element3", 3), - new XElement("Element4", 4), - new XElement("Element5", 5) -); -XElement xmlTree = new XElement("Root", - new XElement("Child1", 1), - new XElement("Child2", 2), - new XElement("Child3", 3), - new XElement("Child4", 4), - new XElement("Child5", 5) -); -xmlTree.AddFirst(new XElement("NewChild", "new content")); -xmlTree.AddFirst( - from el in srcTree.Elements() - where (int)el > 3 - select el -); -// Even though Child9 does not exist in srcTree, the following statement will not -// throw an exception, and nothing will be added to xmlTree. -xmlTree.AddFirst(srcTree.Element("Child9")); -Console.WriteLine(xmlTree); -``` - -```vb -Dim srcTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - - -Dim xmlTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - - -xmlTree.AddFirst(New XElement("NewChild", "new content")) -xmlTree.AddFirst( _ - From el In srcTree.Elements() _ - Where CInt(el) > 3 _ - Select el _ -) -' Even though Child9 does not exist in srcTree, the following statement will not -' throw an exception, and nothing will be added to xmlTree. -xmlTree.AddFirst(srcTree.) -Console.WriteLine(xmlTree) -``` - - This example produces the following output: - -```xml - - 4 - 5 - new content - 1 - 2 - 3 - 4 - 5 - -``` - + . + + For details about the valid content that can be passed to this function, see [Valid Content of XElement and XDocument Objects](/dotnet/standard/linq/valid-content-xelement-xdocument-objects). + + This method will raise the and the events. + + + +## Examples + The following example creates two XML trees, and uses this method to add an object as the first element to one of them. It also adds the results of a LINQ query to the XML tree. + +```csharp +XElement srcTree = new XElement("Root", + new XElement("Element1", 1), + new XElement("Element2", 2), + new XElement("Element3", 3), + new XElement("Element4", 4), + new XElement("Element5", 5) +); +XElement xmlTree = new XElement("Root", + new XElement("Child1", 1), + new XElement("Child2", 2), + new XElement("Child3", 3), + new XElement("Child4", 4), + new XElement("Child5", 5) +); +xmlTree.AddFirst(new XElement("NewChild", "new content")); +xmlTree.AddFirst( + from el in srcTree.Elements() + where (int)el > 3 + select el +); +// Even though Child9 does not exist in srcTree, the following statement will not +// throw an exception, and nothing will be added to xmlTree. +xmlTree.AddFirst(srcTree.Element("Child9")); +Console.WriteLine(xmlTree); +``` + +```vb +Dim srcTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + + +Dim xmlTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + + +xmlTree.AddFirst(New XElement("NewChild", "new content")) +xmlTree.AddFirst( _ + From el In srcTree.Elements() _ + Where CInt(el) > 3 _ + Select el _ +) +' Even though Child9 does not exist in srcTree, the following statement will not +' throw an exception, and nothing will be added to xmlTree. +xmlTree.AddFirst(srcTree.) +Console.WriteLine(xmlTree) +``` + + This example produces the following output: + +```xml + + 4 + 5 + new content + 1 + 2 + 3 + 4 + 5 + +``` + ]]> The parent is . @@ -867,91 +867,91 @@ Console.WriteLine(xmlTree) Creates an that can be used to add nodes to the . An that is ready to have content written to it. - from the XML tree, create a new document, and create a that will write into the new document. Then, you can invoke the XSLT transformation, passing the and to the transform. After the transformation successfully completes, the new XML tree is populated with the results of the transformation. - -```csharp -string xslMarkup = @" - - - - - - - -"; - -XDocument xmlTree = new XDocument( - new XElement("Parent", - new XElement("Child1", "Child1 data"), - new XElement("Child2", "Child2 data") - ) -); - -XDocument newTree = new XDocument(); -using (XmlWriter writer = newTree.CreateWriter()) { - // Load the style sheet. - XslCompiledTransform xslt = new XslCompiledTransform(); - xslt.Load(XmlReader.Create(new StringReader(xslMarkup))); - - // Execute the transform and output the results to a writer. - xslt.Transform(xmlTree.CreateReader(), writer); -} - -Console.WriteLine(newTree); -``` - -```vb -Dim xslMarkup As XDocument = _ - - - - - - - - - - -Dim xmlTree As XElement = _ - - Child1 data - Child2 data - - -Dim newTree As XDocument = New XDocument() - -Using writer As XmlWriter = newTree.CreateWriter() - ' Load the style sheet. - Dim xslt As XslCompiledTransform = _ - New XslCompiledTransform() - xslt.Load(xslMarkup.CreateReader()) - - ' Execute the transform and output the results to a writer. - xslt.Transform(xmlTree.CreateReader(), writer) -End Using - -Console.WriteLine(newTree) -``` - - This example produces the following output: - -```xml - - Child1 data - Child2 data - -``` - + from the XML tree, create a new document, and create a that will write into the new document. Then, you can invoke the XSLT transformation, passing the and to the transform. After the transformation successfully completes, the new XML tree is populated with the results of the transformation. + +```csharp +string xslMarkup = @" + + + + + + + +"; + +XDocument xmlTree = new XDocument( + new XElement("Parent", + new XElement("Child1", "Child1 data"), + new XElement("Child2", "Child2 data") + ) +); + +XDocument newTree = new XDocument(); +using (XmlWriter writer = newTree.CreateWriter()) { + // Load the style sheet. + XslCompiledTransform xslt = new XslCompiledTransform(); + xslt.Load(XmlReader.Create(new StringReader(xslMarkup))); + + // Execute the transform and output the results to a writer. + xslt.Transform(xmlTree.CreateReader(), writer); +} + +Console.WriteLine(newTree); +``` + +```vb +Dim xslMarkup As XDocument = _ + + + + + + + + + + +Dim xmlTree As XElement = _ + + Child1 data + Child2 data + + +Dim newTree As XDocument = New XDocument() + +Using writer As XmlWriter = newTree.CreateWriter() + ' Load the style sheet. + Dim xslt As XslCompiledTransform = _ + New XslCompiledTransform() + xslt.Load(xslMarkup.CreateReader()) + + ' Execute the transform and output the results to a writer. + xslt.Transform(xmlTree.CreateReader(), writer) +End Using + +Console.WriteLine(newTree) +``` + + This example produces the following output: + +```xml + + Child1 data + Child2 data + +``` + ]]> LINQ to XML overview @@ -1006,67 +1006,67 @@ Console.WriteLine(newTree) Returns a collection of the descendant nodes for this document or element, in document order. An of containing the descendant nodes of the , in document order. - axis. - -```csharp -XElement xmlTree = new XElement("Root", - // Attributes are not nodes, so will not be returned by DescendantNodes. - new XAttribute("Att1", "AttributeContent"), - new XElement("Child", - new XElement("GrandChild", "element content") - ) -); -IEnumerable dnas = - from node in xmlTree.DescendantNodes() - select node; -foreach (XNode node in dnas) -{ - if (node is XElement) - Console.WriteLine((node as XElement).Name); - else - Console.WriteLine(node); -} -``` - -```vb -' Attributes are not nodes, so will not be returned by DescendantNodes. -Dim xmlTree As XElement = _ - - - element content - - - -Dim dnas = From node In xmlTree.DescendantNodes _ - Select node - -For Each node In dnas - If TypeOf node Is XElement Then - Console.WriteLine(DirectCast(node, XElement).Name) - Else - Console.WriteLine(node) - End If -Next -``` - - This example produces the following output: - -``` -Child -GrandChild -element content -``` - + axis. + +```csharp +XElement xmlTree = new XElement("Root", + // Attributes are not nodes, so will not be returned by DescendantNodes. + new XAttribute("Att1", "AttributeContent"), + new XElement("Child", + new XElement("GrandChild", "element content") + ) +); +IEnumerable dnas = + from node in xmlTree.DescendantNodes() + select node; +foreach (XNode node in dnas) +{ + if (node is XElement) + Console.WriteLine((node as XElement).Name); + else + Console.WriteLine(node); +} +``` + +```vb +' Attributes are not nodes, so will not be returned by DescendantNodes. +Dim xmlTree As XElement = _ + + + element content + + + +Dim dnas = From node In xmlTree.DescendantNodes _ + Select node + +For Each node In dnas + If TypeOf node Is XElement Then + Console.WriteLine(DirectCast(node, XElement).Name) + Else + Console.WriteLine(node) + End If +Next +``` + + This example produces the following output: + +``` +Child +GrandChild +element content +``` + ]]> @@ -1083,11 +1083,11 @@ element content Returns a collection of the descendant elements for this document or element, in document order. - @@ -1143,56 +1143,56 @@ element content Returns a collection of the descendant elements for this document or element, in document order. An of containing the descendant elements of the . - . See if you need to include the current in the results. - - This method uses deferred execution. - - - -## Examples - The following example creates an XML tree, and then uses this axis method to retrieve the descendants. - -```csharp -XElement xmlTree = new XElement("Root", - new XAttribute("Att1", "AttributeContent"), - new XElement("Child", - new XText("Some text"), - new XElement("GrandChild", "element content") - ) -); -IEnumerable de = - from el in xmlTree.Descendants() - select el; -foreach (XElement el in de) - Console.WriteLine(el.Name); -``` - -```vb -' Attributes are not nodes, so will not be returned by DescendantNodes. -Dim xmlTree As XElement = _ - - Some text - element content - - -Dim de = From el In xmlTree.Descendants _ - Select el - -For Each el In de - Console.WriteLine(el.Name) -Next -``` - - This example produces the following output: - -``` -Child -GrandChild -``` - + . See if you need to include the current in the results. + + This method uses deferred execution. + + + +## Examples + The following example creates an XML tree, and then uses this axis method to retrieve the descendants. + +```csharp +XElement xmlTree = new XElement("Root", + new XAttribute("Att1", "AttributeContent"), + new XElement("Child", + new XText("Some text"), + new XElement("GrandChild", "element content") + ) +); +IEnumerable de = + from el in xmlTree.Descendants() + select el; +foreach (XElement el in de) + Console.WriteLine(el.Name); +``` + +```vb +' Attributes are not nodes, so will not be returned by DescendantNodes. +Dim xmlTree As XElement = _ + + Some text + element content + + +Dim de = From el In xmlTree.Descendants _ + Select el + +For Each el In de + Console.WriteLine(el.Name) +Next +``` + + This example produces the following output: + +``` +Child +GrandChild +``` + ]]> @@ -1254,103 +1254,103 @@ GrandChild Returns a filtered collection of the descendant elements for this document or element, in document order. Only elements that have a matching are included in the collection. An of containing the descendant elements of the that match the specified . - de = - from el in xmlTree.Descendants("Child") - select el; -foreach (XElement el in de) - Console.WriteLine(el.Name); -``` - -```vb -' Attributes are not nodes, so will not be returned by the descendants axis. -Dim xmlTree As XElement = _ - - Some text - element content - - - -Dim de = From el In xmlTree... _ - Select el - -For Each el In de - Console.WriteLine(el.Name) -Next -``` - - This example produces the following output: - -``` -Child -``` - - The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). - -```csharp -// Attributes are not nodes, so will not be returned by DescendantNodes. -XNamespace aw = "http://www.adventure-works.com"; -XElement xmlTree = new XElement(aw + "Root", - new XAttribute(aw + "Att1", "AttributeContent"), - new XElement(aw + "Child", - new XText("Some text"), - new XElement(aw + "GrandChild", "element content") - ) -); -IEnumerable de = - from el in xmlTree.Descendants(aw + "Child") - select el; -foreach (XElement el in de) - Console.WriteLine(el.Name); -``` - -```vb -Imports - -Module Module1 - Sub Main() - ' Attributes are not nodes, so will not be returned by the descendants axis. - Dim xmlTree As XElement = _ - - Some text - element content - - - - Dim de = From el In xmlTree... _ - Select el - - For Each el In de - Console.WriteLine(el.Name) - Next - End Sub -End Module -``` - - This example produces the following output: - -``` -{http://www.adventure-works.com}Child -``` - + de = + from el in xmlTree.Descendants("Child") + select el; +foreach (XElement el in de) + Console.WriteLine(el.Name); +``` + +```vb +' Attributes are not nodes, so will not be returned by the descendants axis. +Dim xmlTree As XElement = _ + + Some text + element content + + + +Dim de = From el In xmlTree... _ + Select el + +For Each el In de + Console.WriteLine(el.Name) +Next +``` + + This example produces the following output: + +``` +Child +``` + + The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). + +```csharp +// Attributes are not nodes, so will not be returned by DescendantNodes. +XNamespace aw = "http://www.adventure-works.com"; +XElement xmlTree = new XElement(aw + "Root", + new XAttribute(aw + "Att1", "AttributeContent"), + new XElement(aw + "Child", + new XText("Some text"), + new XElement(aw + "GrandChild", "element content") + ) +); +IEnumerable de = + from el in xmlTree.Descendants(aw + "Child") + select el; +foreach (XElement el in de) + Console.WriteLine(el.Name); +``` + +```vb +Imports + +Module Module1 + Sub Main() + ' Attributes are not nodes, so will not be returned by the descendants axis. + Dim xmlTree As XElement = _ + + Some text + element content + + + + Dim de = From el In xmlTree... _ + Select el + + For Each el In de + Console.WriteLine(el.Name) + Next + End Sub +End Module +``` + + This example produces the following output: + +``` +{http://www.adventure-works.com}Child +``` + ]]> @@ -1404,159 +1404,159 @@ End Module Gets the first (in document order) child element with the specified . A that matches the specified , or . - , , and so on) accept `null` as a valid argument. This allows you to use a convenient idiom: you can call this method as part of functional construction, and the element is added to the XML tree being constructed if and only if the element exists in the source tree. The following example shows this idiom. - - In contrast to , this method is not an axis method. It does not use deferred execution; it simply returns an element when called. - - - -## Examples - The following example shows two uses of this method. In one case, the method finds the element in `srcTree`. In the second case, the method does not find the element in the source tree, no element is added to `xmlTree`, and no exception is thrown. - - Note that the Visual Basic example uses the child XML property. It is also allowable to use the method directly in Visual Basic. - -```csharp -XElement srcTree = new XElement("Root", - new XElement("Element1", 1), - new XElement("Element2", 2), - new XElement("Element3", 3), - new XElement("Element4", 4), - new XElement("Element5", 5) -); -XElement xmlTree = new XElement("Root", - new XElement("Child1", 1), - new XElement("Child2", 2), - new XElement("Child3", 3), - new XElement("Child4", 4), - new XElement("Child5", 5), - srcTree.Element("Element3"), - // Even though Element9 does not exist in srcTree, the following line - // will not throw an exception. - srcTree.Element("Element9") -); -Console.WriteLine(xmlTree); -``` - -```vb -Dim srcTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - - -Dim xmlTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - <%= srcTree. %> - <%= srcTree. %> - - -' Even though Element9 does not exist in srcTree, adding it to the tree -' will not throw an exception. - -Console.WriteLine(xmlTree) -``` - - This example produces the following output: - -```xml - - 1 - 2 - 3 - 4 - 5 - 3 - -``` - - The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). - -```csharp -XNamespace aw = "http://www.adventure-works.com"; -XElement srcTree = new XElement(aw + "Root", - new XAttribute(XNamespace.Xmlns + "aw", "http://www.adventure-works.com"), - new XElement(aw + "Element1", 1), - new XElement(aw + "Element2", 2), - new XElement(aw + "Element3", 3), - new XElement(aw + "Element4", 4), - new XElement(aw + "Element5", 5) -); -XElement xmlTree = new XElement(aw + "Root", - new XAttribute(XNamespace.Xmlns + "aw", "http://www.adventure-works.com"), - new XElement(aw + "Child1", 1), - new XElement(aw + "Child2", 2), - new XElement(aw + "Child3", 3), - new XElement(aw + "Child4", 4), - new XElement(aw + "Child5", 5), - srcTree.Element(aw + "Element3"), - // Even though Element9 does not exist in srcTree, the following line - // will not throw an exception. - srcTree.Element(aw + "Element9") -); -Console.WriteLine(xmlTree); -``` - -```vb -Imports - -Module Module1 - Sub Main() - Dim srcTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - - - Dim xmlTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - <%= srcTree. %> - <%= srcTree. %> - - - ' Even though Element9 does not exist in srcTree, adding it to the tree - ' will not throw an exception. - - Console.WriteLine(xmlTree) - End Sub -End Module -``` - - This example produces the following output: - -```xml - - 1 - 2 - 3 - 4 - 5 - 3 - -``` - + , , and so on) accept `null` as a valid argument. This allows you to use a convenient idiom: you can call this method as part of functional construction, and the element is added to the XML tree being constructed if and only if the element exists in the source tree. The following example shows this idiom. + + In contrast to , this method is not an axis method. It does not use deferred execution; it simply returns an element when called. + + + +## Examples + The following example shows two uses of this method. In one case, the method finds the element in `srcTree`. In the second case, the method does not find the element in the source tree, no element is added to `xmlTree`, and no exception is thrown. + + Note that the Visual Basic example uses the child XML property. It is also allowable to use the method directly in Visual Basic. + +```csharp +XElement srcTree = new XElement("Root", + new XElement("Element1", 1), + new XElement("Element2", 2), + new XElement("Element3", 3), + new XElement("Element4", 4), + new XElement("Element5", 5) +); +XElement xmlTree = new XElement("Root", + new XElement("Child1", 1), + new XElement("Child2", 2), + new XElement("Child3", 3), + new XElement("Child4", 4), + new XElement("Child5", 5), + srcTree.Element("Element3"), + // Even though Element9 does not exist in srcTree, the following line + // will not throw an exception. + srcTree.Element("Element9") +); +Console.WriteLine(xmlTree); +``` + +```vb +Dim srcTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + + +Dim xmlTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + <%= srcTree. %> + <%= srcTree. %> + + +' Even though Element9 does not exist in srcTree, adding it to the tree +' will not throw an exception. + +Console.WriteLine(xmlTree) +``` + + This example produces the following output: + +```xml + + 1 + 2 + 3 + 4 + 5 + 3 + +``` + + The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). + +```csharp +XNamespace aw = "http://www.adventure-works.com"; +XElement srcTree = new XElement(aw + "Root", + new XAttribute(XNamespace.Xmlns + "aw", "http://www.adventure-works.com"), + new XElement(aw + "Element1", 1), + new XElement(aw + "Element2", 2), + new XElement(aw + "Element3", 3), + new XElement(aw + "Element4", 4), + new XElement(aw + "Element5", 5) +); +XElement xmlTree = new XElement(aw + "Root", + new XAttribute(XNamespace.Xmlns + "aw", "http://www.adventure-works.com"), + new XElement(aw + "Child1", 1), + new XElement(aw + "Child2", 2), + new XElement(aw + "Child3", 3), + new XElement(aw + "Child4", 4), + new XElement(aw + "Child5", 5), + srcTree.Element(aw + "Element3"), + // Even though Element9 does not exist in srcTree, the following line + // will not throw an exception. + srcTree.Element(aw + "Element9") +); +Console.WriteLine(xmlTree); +``` + +```vb +Imports + +Module Module1 + Sub Main() + Dim srcTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + + + Dim xmlTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + <%= srcTree. %> + <%= srcTree. %> + + + ' Even though Element9 does not exist in srcTree, adding it to the tree + ' will not throw an exception. + + Console.WriteLine(xmlTree) + End Sub +End Module +``` + + This example produces the following output: + +```xml + + 1 + 2 + 3 + 4 + 5 + 3 + +``` + ]]> @@ -1572,11 +1572,11 @@ End Module Returns a collection of the child elements of this element or document, in document order. - @@ -1633,112 +1633,112 @@ End Module Returns a collection of the child elements of this element or document, in document order. An of containing the child elements of this , in document order. - elements = - from el in xmlTree.Elements() - where (int)el <= 3 - select el; -foreach (XElement el in elements) - Console.WriteLine(el); -``` - -```vb -Dim xmlTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - - -Dim elements = From el In xmlTree.Elements _ - Where el.Value <= 3 _ - Select el - -For Each el In elements - Console.WriteLine(el) -Next -``` - - This example produces the following output: - -``` -1 -2 -3 -``` - - The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). - -```csharp -XNamespace aw = "http://www.adventure-works.com"; -XElement xmlTree = new XElement(aw + "Root", - new XAttribute(XNamespace.Xmlns + "aw", "http://www.adventure-works.com"), - new XElement(aw + "Child1", 1), - new XElement(aw + "Child2", 2), - new XElement(aw + "Child3", 3), - new XElement(aw + "Child4", 4), - new XElement(aw + "Child5", 5) -); -IEnumerable elements = - from el in xmlTree.Elements() - where (int)el <= 3 - select el; -foreach (XElement el in elements) - Console.WriteLine(el); -``` - -```vb -Imports - -Module Module1 - Sub Main() - Dim xmlTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - - - Dim elements = From el In xmlTree.Elements _ - Where el.Value <= 3 _ - Select el - - For Each el In elements - Console.WriteLine(el) - Next - End Sub -End Module -``` - - This example produces the following output: - -``` -1 -2 -3 -``` - + elements = + from el in xmlTree.Elements() + where (int)el <= 3 + select el; +foreach (XElement el in elements) + Console.WriteLine(el); +``` + +```vb +Dim xmlTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + + +Dim elements = From el In xmlTree.Elements _ + Where el.Value <= 3 _ + Select el + +For Each el In elements + Console.WriteLine(el) +Next +``` + + This example produces the following output: + +``` +1 +2 +3 +``` + + The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). + +```csharp +XNamespace aw = "http://www.adventure-works.com"; +XElement xmlTree = new XElement(aw + "Root", + new XAttribute(XNamespace.Xmlns + "aw", "http://www.adventure-works.com"), + new XElement(aw + "Child1", 1), + new XElement(aw + "Child2", 2), + new XElement(aw + "Child3", 3), + new XElement(aw + "Child4", 4), + new XElement(aw + "Child5", 5) +); +IEnumerable elements = + from el in xmlTree.Elements() + where (int)el <= 3 + select el; +foreach (XElement el in elements) + Console.WriteLine(el); +``` + +```vb +Imports + +Module Module1 + Sub Main() + Dim xmlTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + + + Dim elements = From el In xmlTree.Elements _ + Where el.Value <= 3 _ + Select el + + For Each el In elements + Console.WriteLine(el) + Next + End Sub +End Module +``` + + This example produces the following output: + +``` +1 +2 +3 +``` + ]]> @@ -1800,108 +1800,108 @@ End Module Returns a filtered collection of the child elements of this element or document, in document order. Only elements that have a matching are included in the collection. An of containing the children of the that have a matching , in document order. - elements = - from el in xmlTree.Elements("Type2") - select el; -foreach (XElement el in elements) - Console.WriteLine(el); -``` - -```vb -Dim xmlTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - - -Dim elements = From el In xmlTree. _ - Select el - -For Each el In elements - Console.WriteLine(el) -Next -``` - - This example produces the following output: - -``` -3 -4 -5 -``` - - The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). - -```csharp -XNamespace aw = "http://www.adventure-works.com"; -XElement xmlTree = new XElement(aw + "Root", - new XAttribute(XNamespace.Xmlns + "aw", "http://www.adventure-works.com"), - new XElement(aw + "Type1", 1), - new XElement(aw + "Type1", 2), - new XElement(aw + "Type2", 3), - new XElement(aw + "Type2", 4), - new XElement(aw + "Type2", 5) -); -IEnumerable elements = - from el in xmlTree.Elements(aw + "Type2") - select el; -foreach (XElement el in elements) - Console.WriteLine(el); -``` - -```vb -Imports - -Module Module1 - Sub Main() - Dim xmlTree As XElement = _ - - 1 - 2 - 3 - 4 - 5 - - - Dim elements = From el In xmlTree. _ - Select el - - For Each el In elements - Console.WriteLine(el) - Next - End Sub -End Module -``` - - This example produces the following output: - -``` -3 -4 -5 -``` - + elements = + from el in xmlTree.Elements("Type2") + select el; +foreach (XElement el in elements) + Console.WriteLine(el); +``` + +```vb +Dim xmlTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + + +Dim elements = From el In xmlTree. _ + Select el + +For Each el In elements + Console.WriteLine(el) +Next +``` + + This example produces the following output: + +``` +3 +4 +5 +``` + + The following is the same example, but in this case the XML is in a namespace. For more information, see [Work with XML Namespaces](/dotnet/standard/linq/namespaces-overview). + +```csharp +XNamespace aw = "http://www.adventure-works.com"; +XElement xmlTree = new XElement(aw + "Root", + new XAttribute(XNamespace.Xmlns + "aw", "http://www.adventure-works.com"), + new XElement(aw + "Type1", 1), + new XElement(aw + "Type1", 2), + new XElement(aw + "Type2", 3), + new XElement(aw + "Type2", 4), + new XElement(aw + "Type2", 5) +); +IEnumerable elements = + from el in xmlTree.Elements(aw + "Type2") + select el; +foreach (XElement el in elements) + Console.WriteLine(el); +``` + +```vb +Imports + +Module Module1 + Sub Main() + Dim xmlTree As XElement = _ + + 1 + 2 + 3 + 4 + 5 + + + Dim elements = From el In xmlTree. _ + Select el + + For Each el In elements + Console.WriteLine(el) + Next + End Sub +End Module +``` + + This example produces the following output: + +``` +3 +4 +5 +``` + ]]> @@ -1958,43 +1958,43 @@ End Module Gets the first child node of this node. An containing the first child node of the . - - 1 - 2 - 3 - 4 - 5 - - -Dim firstNode As XNode = xmlTree.FirstNode -Console.WriteLine(firstNode) -``` - - This example produces the following output: - -```xml -1 -``` - + + 1 + 2 + 3 + 4 + 5 + + +Dim firstNode As XNode = xmlTree.FirstNode +Console.WriteLine(firstNode) +``` + + This example produces the following output: + +```xml +1 +``` + ]]> @@ -2050,43 +2050,43 @@ Console.WriteLine(firstNode) Gets the last child node of this node. An containing the last child node of the . - - 1 - 2 - 3 - 4 - 5 - - -Dim lastNode As XNode = xmlTree.LastNode -Console.WriteLine(lastNode) -``` - - This example produces the following output: - -```xml -5 -``` - + + 1 + 2 + 3 + 4 + 5 + + +Dim lastNode As XNode = xmlTree.LastNode +Console.WriteLine(lastNode) +``` + + This example produces the following output: + +```xml +5 +``` + ]]> @@ -2147,142 +2147,142 @@ Console.WriteLine(lastNode) Returns a collection of the child nodes of this element or document, in document order. An of containing the contents of this , in document order. - nodes = - from nd in xmlTree.Nodes() - select nd; -foreach (XNode node in nodes) - Console.WriteLine(node); -``` - -```vb -Dim xmlTree As XElement = _ - - 1 - 2 - - 3 - 4mixed content5 - - -Dim nodes = From nd In xmlTree.Nodes() _ - Select nd - -For Each node In nodes - Console.WriteLine(node) -Next -``` - - This example produces the following output: - -``` -1 -2 - -3 -4 -mixed content -5 -``` - - The following example creates an XML tree that contains a variety of types of nodes. It then enumerates through portions of the tree, printing the node types. - -```csharp -XDocument xmlTree = new XDocument( - new XComment("a comment"), - new XProcessingInstruction("xml-stylesheet", "type=\"text/xsl\" href=\"hello.xsl\""), - new XElement("Root", - new XAttribute("Att", "attContent"), - new XElement("Child1", - new XCData("CDATA content") - ), - new XElement("Child2", - new XText("Text content") - ) - ) -); - -foreach (XNode node in xmlTree.Nodes()) -{ - Console.WriteLine(node.NodeType); - if (node.NodeType == XmlNodeType.Element) - { - foreach (XAttribute att in ((XElement)node).Attributes()) - Console.WriteLine(att.NodeType); - foreach (XNode node2 in ((XElement)node).Nodes()) - { - Console.WriteLine(node2.NodeType); - if (node2.NodeType == XmlNodeType.Element) - foreach (XNode node3 in ((XElement)node2).Nodes()) - Console.WriteLine(node3.NodeType); - } - } -} -``` - -```vb -Dim xmlTree As XDocument = _ - - - - - - Text content - - -' Note that XNode uses XmlNodeType, which is in the System.Xml namespace -For Each node In xmlTree.Nodes - Console.WriteLine(node.NodeType.ToString()) - If node.NodeType = XmlNodeType.Element Then - For Each att In DirectCast(node, XElement).Attributes - Console.WriteLine(att.NodeType.ToString()) - Next - For Each node2 In DirectCast (node, XElement).Nodes() - Console.WriteLine(node2.NodeType.ToString()) - If node2.NodeType = XmlNodeType.Element Then - For Each node3 In DirectCast (node2, XElement).Nodes - Console.WriteLine(node3.NodeType.ToString()) - Next - End If - Next - End If -Next -``` - - This example produces the following output: - -``` -Comment -ProcessingInstruction -Element -Attribute -Element -CDATA -Element -Text -``` - + nodes = + from nd in xmlTree.Nodes() + select nd; +foreach (XNode node in nodes) + Console.WriteLine(node); +``` + +```vb +Dim xmlTree As XElement = _ + + 1 + 2 + + 3 + 4mixed content5 + + +Dim nodes = From nd In xmlTree.Nodes() _ + Select nd + +For Each node In nodes + Console.WriteLine(node) +Next +``` + + This example produces the following output: + +``` +1 +2 + +3 +4 +mixed content +5 +``` + + The following example creates an XML tree that contains a variety of types of nodes. It then enumerates through portions of the tree, printing the node types. + +```csharp +XDocument xmlTree = new XDocument( + new XComment("a comment"), + new XProcessingInstruction("xml-stylesheet", "type=\"text/xsl\" href=\"hello.xsl\""), + new XElement("Root", + new XAttribute("Att", "attContent"), + new XElement("Child1", + new XCData("CDATA content") + ), + new XElement("Child2", + new XText("Text content") + ) + ) +); + +foreach (XNode node in xmlTree.Nodes()) +{ + Console.WriteLine(node.NodeType); + if (node.NodeType == XmlNodeType.Element) + { + foreach (XAttribute att in ((XElement)node).Attributes()) + Console.WriteLine(att.NodeType); + foreach (XNode node2 in ((XElement)node).Nodes()) + { + Console.WriteLine(node2.NodeType); + if (node2.NodeType == XmlNodeType.Element) + foreach (XNode node3 in ((XElement)node2).Nodes()) + Console.WriteLine(node3.NodeType); + } + } +} +``` + +```vb +Dim xmlTree As XDocument = _ + + + + + + Text content + + +' Note that XNode uses XmlNodeType, which is in the System.Xml namespace +For Each node In xmlTree.Nodes + Console.WriteLine(node.NodeType.ToString()) + If node.NodeType = XmlNodeType.Element Then + For Each att In DirectCast(node, XElement).Attributes + Console.WriteLine(att.NodeType.ToString()) + Next + For Each node2 In DirectCast (node, XElement).Nodes() + Console.WriteLine(node2.NodeType.ToString()) + If node2.NodeType = XmlNodeType.Element Then + For Each node3 In DirectCast (node2, XElement).Nodes + Console.WriteLine(node3.NodeType.ToString()) + Next + End If + Next + End If +Next +``` + + This example produces the following output: + +``` +Comment +ProcessingInstruction +Element +Attribute +Element +CDATA +Element +Text +``` + ]]> @@ -2332,54 +2332,54 @@ Text Removes the child nodes from this document or element. - . - - The method has related functionality. It removes the child nodes of every node in a collection. - - This method will raise the and the events. - - - -## Examples - The following example creates an XML tree that contains some child nodes. It then calls this method to remove the child nodes. - -```csharp -XElement xmlTree = new XElement("Root", - new XElement("Child1", 1), - new XElement("Child2", 2), - new XComment("a comment"), - new XElement("Child3", 3), - new XElement("Child4", 4), - new XText("mixed content"), - new XElement("Child5", 5) -); -xmlTree.RemoveNodes(); -Console.WriteLine(xmlTree); -``` - -```vb -Dim xmltree As XElement = _ - - 1 - 2 - - 3 - 4mixed content5 - - -xmltree.RemoveNodes() -Console.WriteLine(xmltree) -``` - - This example produces the following output: - -```xml - -``` - + . + + The method has related functionality. It removes the child nodes of every node in a collection. + + This method will raise the and the events. + + + +## Examples + The following example creates an XML tree that contains some child nodes. It then calls this method to remove the child nodes. + +```csharp +XElement xmlTree = new XElement("Root", + new XElement("Child1", 1), + new XElement("Child2", 2), + new XComment("a comment"), + new XElement("Child3", 3), + new XElement("Child4", 4), + new XText("mixed content"), + new XElement("Child5", 5) +); +xmlTree.RemoveNodes(); +Console.WriteLine(xmlTree); +``` + +```vb +Dim xmltree As XElement = _ + + 1 + 2 + + 3 + 4mixed content5 + + +xmltree.RemoveNodes() +Console.WriteLine(xmltree) +``` + + This example produces the following output: + +```xml + +``` + ]]> @@ -2396,62 +2396,62 @@ Console.WriteLine(xmltree) Replaces the children nodes of this document or element with the specified content. - and the events. - - This method has snapshot semantics. It first creates a copy of the new content. It then removes all children nodes of this node. Finally, it adds the new content as children nodes. This means that you can replace children nodes using a query on the children nodes themselves. - - - -## Examples - The following example creates two XML trees, and then uses this method to replace the contents of one of them with the results of a query. - -```csharp -XElement root = new XElement("Root", - new XElement("Child", 1), - new XElement("Child", 2), - new XElement("Child", 3), - new XElement("Child", 4), - new XElement("Child", 5) -); -root.ReplaceNodes( - from el in root.Elements() - where (int)el >= 3 - select el -); -Console.WriteLine(root); -``` - -```vb -Dim root As XElement = _ - - 1 - 2 - 3 - 4 - 5 - -root.ReplaceNodes( _ - From el In root.Elements _ - Where el.Value >= 3 _ - Select el) -Console.WriteLine(root) -``` - - This example produces the following output: - -```xml - - 3 - 4 - 5 - -``` - + and the events. + + This method has snapshot semantics. It first creates a copy of the new content. It then removes all children nodes of this node. Finally, it adds the new content as children nodes. This means that you can replace children nodes using a query on the children nodes themselves. + + + +## Examples + The following example creates two XML trees, and then uses this method to replace the contents of one of them with the results of a query. + +```csharp +XElement root = new XElement("Root", + new XElement("Child", 1), + new XElement("Child", 2), + new XElement("Child", 3), + new XElement("Child", 4), + new XElement("Child", 5) +); +root.ReplaceNodes( + from el in root.Elements() + where (int)el >= 3 + select el +); +Console.WriteLine(root); +``` + +```vb +Dim root As XElement = _ + + 1 + 2 + 3 + 4 + 5 + +root.ReplaceNodes( _ + From el In root.Elements _ + Where el.Value >= 3 _ + Select el) +Console.WriteLine(root) +``` + + This example produces the following output: + +```xml + + 3 + 4 + 5 + +``` + ]]> @@ -2504,64 +2504,64 @@ Console.WriteLine(root) A content object containing simple content or a collection of content objects that replace the children nodes. Replaces the children nodes of this document or element with the specified content. - and the events. - - This method has snapshot semantics. It first creates a copy of the new content. It then removes all children nodes of this node. Finally, it adds the new content as children nodes. This means that you can replace children nodes using a query on the children nodes themselves. - - - -## Examples - The following example creates an XML tree that contains children nodes. It then replaces all of the children nodes with a single element. - - To see an example of replacing the children nodes with the results of a LINQ query, see . - -```csharp -XElement root = new XElement("Root", - new XElement("Child", 1), - new XElement("Child", 2), - new XElement("Child", 3), - new XElement("Child", 4), - new XElement("Child", 5) -); -root.ReplaceNodes( - from el in root.Elements() - where (int)el >= 3 - select el -); -Console.WriteLine(root); -``` - -```vb -Dim root As XElement = _ - - 1 - 2 - 3 - 4 - 5 - -root.ReplaceNodes( _ - From el In root.Elements _ - Where el.Value >= 3 _ - Select el) -Console.WriteLine(root) -``` - - This example produces the following output: - -```xml - - 3 - 4 - 5 - -``` - + and the events. + + This method has snapshot semantics. It first creates a copy of the new content. It then removes all children nodes of this node. Finally, it adds the new content as children nodes. This means that you can replace children nodes using a query on the children nodes themselves. + + + +## Examples + The following example creates an XML tree that contains children nodes. It then replaces all of the children nodes with a single element. + + To see an example of replacing the children nodes with the results of a LINQ query, see . + +```csharp +XElement root = new XElement("Root", + new XElement("Child", 1), + new XElement("Child", 2), + new XElement("Child", 3), + new XElement("Child", 4), + new XElement("Child", 5) +); +root.ReplaceNodes( + from el in root.Elements() + where (int)el >= 3 + select el +); +Console.WriteLine(root); +``` + +```vb +Dim root As XElement = _ + + 1 + 2 + 3 + 4 + 5 + +root.ReplaceNodes( _ + From el In root.Elements _ + Where el.Value >= 3 _ + Select el) +Console.WriteLine(root) +``` + + This example produces the following output: + +```xml + + 3 + 4 + 5 + +``` + ]]> @@ -2631,62 +2631,62 @@ Console.WriteLine(root) A parameter list of content objects. Replaces the children nodes of this document or element with the specified content. - and the events. - - This method has snapshot semantics. It first creates a copy of the new content. It then removes all children nodes of this node. Finally, it adds the new content as children nodes. This means that you can replace children nodes using a query on the children nodes themselves. - - - -## Examples - The following example creates a dictionary and an XML tree. It then queries the dictionary, projects the results to an of , and replaces the contents of the XML tree with the results of the query. - -```csharp -XElement root = new XElement("Root", - new XElement("Child", 1), - new XElement("Child", 2), - new XElement("Child", 3), - new XElement("Child", 4), - new XElement("Child", 5) -); -root.ReplaceNodes( - from el in root.Elements() - where (int)el >= 3 - select el -); -Console.WriteLine(root); -``` - -```vb -Dim root As XElement = _ - - 1 - 2 - 3 - 4 - 5 - -root.ReplaceNodes( _ - From el In root.Elements _ - Where el.Value >= 3 _ - Select el) -Console.WriteLine(root) -``` - - This example produces the following output: - -```xml - - 3 - 4 - 5 - -``` - + and the events. + + This method has snapshot semantics. It first creates a copy of the new content. It then removes all children nodes of this node. Finally, it adds the new content as children nodes. This means that you can replace children nodes using a query on the children nodes themselves. + + + +## Examples + The following example creates a dictionary and an XML tree. It then queries the dictionary, projects the results to an of , and replaces the contents of the XML tree with the results of the query. + +```csharp +XElement root = new XElement("Root", + new XElement("Child", 1), + new XElement("Child", 2), + new XElement("Child", 3), + new XElement("Child", 4), + new XElement("Child", 5) +); +root.ReplaceNodes( + from el in root.Elements() + where (int)el >= 3 + select el +); +Console.WriteLine(root); +``` + +```vb +Dim root As XElement = _ + + 1 + 2 + 3 + 4 + 5 + +root.ReplaceNodes( _ + From el In root.Elements _ + Where el.Value >= 3 _ + Select el) +Console.WriteLine(root) +``` + + This example produces the following output: + +```xml + + 3 + 4 + 5 + +``` + ]]> diff --git a/xml/System.Xml.Linq/XDeclaration.xml b/xml/System.Xml.Linq/XDeclaration.xml index 1ffa78749e0..b4224038a9e 100644 --- a/xml/System.Xml.Linq/XDeclaration.xml +++ b/xml/System.Xml.Linq/XDeclaration.xml @@ -284,7 +284,7 @@ Console.WriteLine(File.ReadAllText("Root.xml")) is a valid value. + Any value returned by is a valid value. If you read an encoded document, then this property will be set to the code page name. diff --git a/xml/System.Xml.Linq/XDocument.xml b/xml/System.Xml.Linq/XDocument.xml index 29d65926e39..d6f65a9c185 100644 --- a/xml/System.Xml.Linq/XDocument.xml +++ b/xml/System.Xml.Linq/XDocument.xml @@ -920,7 +920,7 @@ Console.WriteLine(doc) ## Remarks Using one of the overloads of this method, you can load an from a file, a , or an . - To create an from a string that contains XML, use . + To create an from a string that contains XML, use . ]]> @@ -984,15 +984,15 @@ Console.WriteLine(doc) overload that takes as a parameter. + If you want to control load options, use the overload that takes as a parameter. - The loading functionality of LINQ to XML is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + The loading functionality of LINQ to XML is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. If you have to modify , follow these steps: -1. Create an by calling one of the overloads that take as a parameter. +1. Create an by calling one of the overloads that take as a parameter. -2. Pass the to one of the overloads of that takes as a parameter. +2. Pass the to one of the overloads of that takes as a parameter. ]]> @@ -1052,7 +1052,7 @@ Console.WriteLine(doc) . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. @@ -1149,9 +1149,9 @@ Console.WriteLine(doc) ## Remarks This method uses an underlying to read the XML into an XML tree. - Use to create an from a string that contains XML. + Use to create an from a string that contains XML. - LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. @@ -1275,7 +1275,7 @@ Console.WriteLine(doc) ## Remarks One possible use for this method is to create a copy of a DOM document in a LINQ to XML tree. To do this, you create an from a DOM document, and then use the to create an . - LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. @@ -1388,13 +1388,13 @@ End Using . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + The loading functionality of LINQ to XML is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. If you have to modify , follow these steps: -1. Create an by calling one of the overloads that takes as a parameter. +1. Create an by calling one of the overloads that takes as a parameter. -2. Pass the to one of the overloads of that takes as a parameter. +2. Pass the to one of the overloads of that takes as a parameter. ]]> @@ -1458,7 +1458,7 @@ End Using For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). - Use to create an from a string that contains XML. + Use to create an from a string that contains XML. Setting is not valid when loading from a . @@ -1466,7 +1466,7 @@ End Using The line information is accurate immediately after loading the XML document. If you modify the XML tree after loading the document, the line information may become meaningless. - LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. @@ -1608,13 +1608,13 @@ Count of white space nodes (preserving whitespace): 3 For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). - Use to create an from a string that contains XML. + Use to create an from a string that contains XML. There is a performance penalty if you set the and the flags. The base URI and the line information are accurate immediately after loading the XML document. If you modify the XML tree after loading the document, the base URI and line information may become meaningless. - LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. @@ -1709,7 +1709,7 @@ nodes if preserving whitespace: 82 ## Remarks By creating an from a DOM document, and then using the to create an , this method can be used to create a copy of a DOM document in a LINQ to XML tree. - Use to create an from a string that contains XML. + Use to create an from a string that contains XML. Setting is not valid when loading from a . The will be configured to either read whitespace or not. The LINQ to XML tree will be populated with the whitespace nodes that the reader surfaces. This will be the behavior regardless of whether is set or not. @@ -1721,7 +1721,7 @@ nodes if preserving whitespace: 82 The line information is accurate immediately after loading the XML document. If you modify the XML tree after loading the document, the line information may become meaningless. - LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. @@ -2165,11 +2165,11 @@ Console.WriteLine(doc) that takes as a parameter. + This method does not preserve white space. If you want to preserve white space in the XML tree, use the overload of that takes as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). - LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. @@ -2281,7 +2281,7 @@ Console.WriteLine(doc) The line information is accurate immediately after loading the XML document. If you modify the XML tree after loading the document, the line information may become meaningless. - LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. @@ -2506,7 +2506,7 @@ Pubs ## Remarks The serialized XML will be indented. All insignificant white space will be removed, and additional white space will be added so that the XML will be properly indented. The behavior of this method is that insignificant white space will not be preserved. - If you want to control white space, use the overload of that takes as a parameter. Use the option to save unindented XML. This will cause the writer to write all white spaces exactly as represented in the XML tree. + If you want to control white space, use the overload of that takes as a parameter. Use the option to save unindented XML. This will cause the writer to write all white spaces exactly as represented in the XML tree. Use option if you want to remove duplicate namespace declarations. @@ -2563,7 +2563,7 @@ Pubs ## Remarks The serialized XML will be indented. All insignificant white space will be removed, and additional white space will be added so that the XML will be properly indented. The behavior of this method is that insignificant white space will not be preserved. - If you want to control white space, use the overload of that takes as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). + If you want to control white space, use the overload of that takes as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). @@ -2660,7 +2660,7 @@ Console.WriteLine(sb.ToString()) ## Remarks The serialized XML will be indented. All insignificant white space will be removed, and additional white space will be added so that the XML will be properly indented. The behavior of this method is that insignificant white space will not be preserved. - If you want to control white space, use the overload of that takes as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). + If you want to control white space, use the overload of that takes as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). @@ -2912,7 +2912,7 @@ Console.WriteLine(sb.ToString()) ## Remarks If you want to save unindented XML, specify the flag for `options`. This will cause the writer to write all white space exactly as represented in the XML tree. - If you want to save indented XML, do not specify the flag for `options`. This will remove all extraneous insignificant white space, and add appropriate insignificant white space so that the XML is properly indented. This is the default behavior, and the behavior of the overloads of the methods that do not take `options` as a parameter. + If you want to save indented XML, do not specify the flag for `options`. This will remove all extraneous insignificant white space, and add appropriate insignificant white space so that the XML is properly indented. This is the default behavior, and the behavior of the overloads of the methods that do not take `options` as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). @@ -3028,7 +3028,7 @@ End Using ## Remarks If you want to save unindented XML, specify the flag for `options`. This will cause the writer to write all white space exactly as represented in the XML tree. - If you want to save indented XML, do not specify the flag for `options`. This will remove all extraneous insignificant white space, and add appropriate insignificant white space so that the XML is properly indented. This is the default behavior, and the behavior of the overloads of the methods that do not take `options` as a parameter. + If you want to save indented XML, do not specify the flag for `options`. This will remove all extraneous insignificant white space, and add appropriate insignificant white space so that the XML is properly indented. This is the default behavior, and the behavior of the overloads of the methods that do not take `options` as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). diff --git a/xml/System.Xml.Linq/XDocumentType.xml b/xml/System.Xml.Linq/XDocumentType.xml index 5184ded3a1d..90c347d50df 100644 --- a/xml/System.Xml.Linq/XDocumentType.xml +++ b/xml/System.Xml.Linq/XDocumentType.xml @@ -73,7 +73,7 @@ LINQ to XML will not validate a document against a DTD, but you can use a validating to perform DTD validation if necessary. - To validate an LINQ to XML tree against an XML schema, use the method. + To validate an LINQ to XML tree against an XML schema, use the method. When a document contains entity references that are defined in a DTD, the references are expanded upon creation of the XML tree. However, when you serialize or save the XML tree, the content of the expanded entities is preserved; the entity references are not. diff --git a/xml/System.Xml.Linq/XElement.xml b/xml/System.Xml.Linq/XElement.xml index 3a3016d6e20..d9362523133 100644 --- a/xml/System.Xml.Linq/XElement.xml +++ b/xml/System.Xml.Linq/XElement.xml @@ -84,7 +84,7 @@ ## Remarks This class represents an XML element, the fundamental XML construct. See [XElement Class Overview](/dotnet/csharp/programming-guide/concepts/linq/xelement-class-overview) for other usage information. - An element has an , optionally one or more attributes, and can optionally contain content (for more information, see ). + An element has an , optionally one or more attributes, and can optionally contain content (for more information, see ). An can contain the following types of content: @@ -346,7 +346,7 @@ Console.WriteLine(xmlTree2) ## Examples - The following example creates an XML tree, creates a clone of the tree, and then calls , which tests whether the two XML trees are equal. + The following example creates an XML tree, creates a clone of the tree, and then calls , which tests whether the two XML trees are equal. ```csharp XElement xmlTree = new XElement("Root", @@ -2979,7 +2979,7 @@ Att3="3" ## Remarks You can use one of the overloads of this method to load an from a file, a , or an . - To create an from a string that contains XML, use . + To create an from a string that contains XML, use . ]]> @@ -3041,15 +3041,15 @@ Att3="3" overload that takes as a parameter. + If you want to control load options, use the overload that takes as a parameter. - LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. If you have to modify , following these steps: -1. Create an by calling one of the overloads that take as a parameter. +1. Create an by calling one of the overloads that take as a parameter. -2. Pass the to one of the 's overloads that takes as a parameter. +2. Pass the to one of the 's overloads that takes as a parameter. ]]> @@ -3111,7 +3111,7 @@ Att3="3" ## Remarks This method reads the raw XML into the XML tree. It discards all insignificant white space in the file. - LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. @@ -3208,7 +3208,7 @@ Console.WriteLine(xmlTree) ## Remarks This method reads the raw XML into the XML tree. It discards all insignificant white space in the file. - LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. @@ -3305,7 +3305,7 @@ Root ## Remarks By creating an from a DOM document, and then using the to create an , this method can be used to create a copy of a DOM document in a LINQ to XML tree. - LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. @@ -3414,13 +3414,13 @@ End Using . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. If you have to modify , following these steps: -1. Create an by calling one of the overloads that take as a parameter. +1. Create an by calling one of the overloads that take as a parameter. -2. Pass the to one of the 's overloads that takes as a parameter. +2. Pass the to one of the 's overloads that takes as a parameter. ]]> @@ -3484,7 +3484,7 @@ End Using For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). - Use to create an from a string that contains XML. + Use to create an from a string that contains XML. Setting will have no effect when loading from a . @@ -3492,7 +3492,7 @@ End Using The line information is accurate immediately after loading the XML document. If you modify the XML tree after loading the document, the line information may become meaningless. - LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. @@ -3689,13 +3689,13 @@ Root 1 2 For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). - Use to create an from a string that contains XML. + Use to create an from a string that contains XML. There is a performance penalty if you set the and the flags. The base URI and the line information are accurate immediately after loading the XML document. If you modify the XML tree after loading the document, the base URI and line information may become meaningless. - LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. @@ -3897,7 +3897,7 @@ PurchaseOrder 2 2 ## Remarks By creating an from a DOM document, and then using the to create an , this method can be used to create a copy of a DOM document in a LINQ to XML tree. - Use to create an from a string that contains XML. + Use to create an from a string that contains XML. Setting is not valid when loading from a . The will be configured to either read whitespace or not. The LINQ to XML tree will be populated with the whitespace nodes that the reader surfaces. This will be the behavior regardless of whether is set or not. @@ -3909,7 +3909,7 @@ PurchaseOrder 2 2 The line information is accurate immediately after loading the XML document. If you modify the XML tree after loading the document, the line information may become meaningless. - LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. @@ -4486,7 +4486,7 @@ Console.WriteLine("(bool)BoolValue2={0}", bool2) Behavior is lax when casting to a from an attribute or element. Even if the attribute or element value is not formatted exactly per the W3C specification, the value is appropriately converted to a . - This conversion operator uses to convert from a . + This conversion operator uses to convert from a . ## Examples The following example creates an element with date and time content. It then casts it to to retrieve the value. @@ -5111,10 +5111,10 @@ value=9223372036854775807 of from an attribute or element, allowed values are "0", "1", and any string that produces "true" or "false" after trimming and conversion to lower case. + When converting to of from an attribute or element, allowed values are "0", "1", and any string that produces "true" or "false" after trimming and conversion to lower case. ## Examples - The following example creates an element with boolean content. It then retrieves the value by casting to of . + The following example creates an element with boolean content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -5209,12 +5209,12 @@ Nullable Boolean: value2=False ## Remarks The value space of an attribute or element that contains date and time content is closely related to the dates and times described in ISO 8601. When creating an attribute or element that contains date and time content, the attribute or element values are formatted per the W3C specification. See the W3C specification for more details. - The behavior is lax when casting to a of from an attribute or element. Even if the attribute or element value is not formatted exactly per the W3C specification, the value is appropriately converted to a of . + The behavior is lax when casting to a of from an attribute or element. Even if the attribute or element value is not formatted exactly per the W3C specification, the value is appropriately converted to a of . - This conversion operator uses to convert from a . + This conversion operator uses to convert from a . ## Examples - The following example creates an element with a date and time as content. It then retrieves the value by casting to of . + The following example creates an element with a date and time as content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -5303,7 +5303,7 @@ Nullable DateTime: value=10/6/2006 12:30:00 PM This conversion operator uses the class to do the conversion. ## Examples - The following example creates an element with date and time content. It then casts to of to retrieve the value. + The following example creates an element with date and time content. It then casts to of to retrieve the value. ```csharp XElement root = new XElement("Root", @@ -5396,7 +5396,7 @@ dt=10/6/2006 12:30:00 PM -07:00 of . + The following example creates an element with decimal content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -5482,7 +5482,7 @@ Nullable decimal: value=79228162514264337593543950335 of . + The following example creates an element with double precision floating point content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -5569,7 +5569,7 @@ Nullable double: value=1.79769313486231E+308 of . + The following example creates an element with guid content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -5655,7 +5655,7 @@ Nullable Guid: value=3c1cc55b-baff-4b7a-9d17-077af3aa5730 of . + The following example creates an element with unsigned integer content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -5741,7 +5741,7 @@ Nullable integer: value=2147483647 of . + The following example creates an element with long integer content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -5827,7 +5827,7 @@ Nullable ulong: value=9223372036854775807 of . + The following example creates an element with single precision floating point content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -5915,10 +5915,10 @@ Nullable Single: value=3.402823E+38 ## Remarks The value space of an attribute or element that contains time span content is closely related to duration content as described in ISO 8601. When creating an attribute or element that contains time span content, the attribute or element values are formatted per the W3C specification. Please see the W3C specification for more details. - Behavior is lax when casting to a of from an attribute or element. Even if the attribute or element value is not formatted exactly per the W3C specification, the value is appropriately converted to a of . + Behavior is lax when casting to a of from an attribute or element. Even if the attribute or element value is not formatted exactly per the W3C specification, the value is appropriately converted to a of . ## Examples - The following example creates an element with time span content. It then retrieves the value by casting to of . + The following example creates an element with time span content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -6004,7 +6004,7 @@ Nullable TimeSpan: value=01:05:30 of . + The following example creates an element with unsigned integer content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -6090,7 +6090,7 @@ Nullable uint: value=4294967295 of . + The following example creates an element with unsigned long integer content. It then retrieves the value by casting to of . ```csharp XElement root = new XElement("Root", @@ -6602,9 +6602,9 @@ value=18446744073709551615 method that takes as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). + This method does not preserve white space. If you want to preserve white space in the XML tree, use the overload of the method that takes as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). - LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. @@ -6700,7 +6700,7 @@ Console.WriteLine(xmlTree) The line information is accurate immediately after loading the XML document. If you modify the XML tree after loading the document, the line information may become meaningless. - LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. + LINQ to XML's loading functionality is built upon . Therefore, you might catch any exceptions that are thrown by the overload methods and the methods that read and parse the document. @@ -7742,7 +7742,7 @@ Console.WriteLine(root) ## Remarks The serialized XML will be indented. All insignificant white space will be removed, and additional white space will be added so that the XML will be properly indented. The behavior of this method is that insignificant white space will not be preserved. - If you want to control white space, use the overload of that takes as a parameter. Use the option to save unindented XML. This will cause the writer to write all white spaces exactly as represented in the XML tree. + If you want to control white space, use the overload of that takes as a parameter. Use the option to save unindented XML. This will cause the writer to write all white spaces exactly as represented in the XML tree. Use the option if you want to remove duplicate namespace declarations. @@ -7799,7 +7799,7 @@ Console.WriteLine(root) ## Remarks The serialized XML will be indented. All insignificant white space will be removed, and additional white space will be added so that the XML will be properly indented. The behavior of this method is that white space will not be preserved. - If you want to control white space, use the overload of that allows you to specify as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). + If you want to control white space, use the overload of that allows you to specify as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). @@ -7883,7 +7883,7 @@ End Using ## Remarks The serialized XML will be indented. All insignificant white space will be removed, and additional white space will be added so that the XML will be properly indented. The behavior of this method is that insignificant white space nodes in the XML tree will not be preserved. - If you want to control white space, use the overload of that allows you to specify as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). + If you want to control white space, use the overload of that allows you to specify as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). @@ -8118,7 +8118,7 @@ Console.WriteLine(sb.ToString()) ## Remarks If you want to save unindented XML, specify the flag for `options`. This will cause the writer to write all white space exactly as represented in the XML tree. - If you want to save indented XML, do not specify the flag for `options`. This will remove all extraneous insignificant white space, and add appropriate insignificant white space so that the XML is properly indented. This is the default behavior, and the behavior of the overloads of the methods that do not take `options` as a parameter. + If you want to save indented XML, do not specify the flag for `options`. This will remove all extraneous insignificant white space, and add appropriate insignificant white space so that the XML is properly indented. This is the default behavior, and the behavior of the overloads of the methods that do not take `options` as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). @@ -8226,7 +8226,7 @@ End Using ## Remarks If you want to save unindented XML, specify the flag for `options`. This will cause the writer to write all white space exactly as represented in the XML tree. - If you want to save indented XML, do not specify the flag for `options`. This will remove all extraneous insignificant white space, and add appropriate insignificant white space so that the XML is properly indented. This is the default behavior, and the behavior of the overloads of the methods that do not take `options` as a parameter. + If you want to save indented XML, do not specify the flag for `options`. This will remove all extraneous insignificant white space, and add appropriate insignificant white space so that the XML is properly indented. This is the default behavior, and the behavior of the overloads of the methods that do not take `options` as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). @@ -8987,7 +8987,7 @@ Console.WriteLine(root) Setting this property will raise the and the events. - If you want to get the value of an element but you are not sure that it exists, it is more convenient to use the explicit conversion operators, and assign the element to a nullable type such as `string` or of . If the element does not exist, the nullable type is set to `null`. By contrast, if you want to use this property, you must make sure that the method does not return `null` before you access this property. + If you want to get the value of an element but you are not sure that it exists, it is more convenient to use the explicit conversion operators, and assign the element to a nullable type such as `string` or of . If the element does not exist, the nullable type is set to `null`. By contrast, if you want to use this property, you must make sure that the method does not return `null` before you access this property. diff --git a/xml/System.Xml.Linq/XName.xml b/xml/System.Xml.Linq/XName.xml index 086f0fa1c0f..36cf27f20aa 100644 --- a/xml/System.Xml.Linq/XName.xml +++ b/xml/System.Xml.Linq/XName.xml @@ -415,7 +415,7 @@ End Module . You can use in hashing algorithms, or in data structures such as a hash table. + This method serves as a hash function for . You can use in hashing algorithms, or in data structures such as a hash table. ]]> @@ -1123,7 +1123,7 @@ False , passing an . This causes the method to be called. + The following example calls , passing an . This causes the method to be called. ```csharp XNamespace ns = "http://www.adventure-works.com"; diff --git a/xml/System.Xml.Linq/XNamespace.xml b/xml/System.Xml.Linq/XNamespace.xml index 111ef2ca716..267106991bb 100644 --- a/xml/System.Xml.Linq/XNamespace.xml +++ b/xml/System.Xml.Linq/XNamespace.xml @@ -282,7 +282,7 @@ http://www.adventure-works.com . You can use in hashing algorithms and data structures like a hash table. + This method serves as a hash function for . You can use in hashing algorithms and data structures like a hash table. ]]> diff --git a/xml/System.Xml.Linq/XNode.xml b/xml/System.Xml.Linq/XNode.xml index 2c88dc99ec8..b6a005a7e95 100644 --- a/xml/System.Xml.Linq/XNode.xml +++ b/xml/System.Xml.Linq/XNode.xml @@ -105,7 +105,7 @@ Objects of classes that derive from can contai This method will raise the and the events. ## Examples - The following example uses a LINQ query to create an of , which it then passes to this method. This adds the results of a query to the tree in the desired location. + The following example uses a LINQ query to create an of , which it then passes to this method. This adds the results of a query to the tree in the desired location. ```csharp XElement srcTree = new XElement("Root", @@ -352,7 +352,7 @@ Console.WriteLine(xmlTree) This method will raise the and the events. ## Examples - The following example uses a LINQ query to create an of , which it then passes to this method. This adds the results of a query to the tree in the desired location. + The following example uses a LINQ query to create an of , which it then passes to this method. This adds the results of a query to the tree in the desired location. ```csharp XElement srcTree = new XElement("Root", @@ -441,10 +441,10 @@ Console.WriteLine(xmlTree) This method will raise the and events. - The stores its child notes as a singly-linked list of objects. This means that the method must traverse the list of direct child nodes under the parent container. Therefore, using this method might affect your performance. + The stores its child notes as a singly-linked list of objects. This means that the method must traverse the list of direct child nodes under the parent container. Therefore, using this method might affect your performance. ## Examples - The following example uses a LINQ query to create an of , which it then passes to this method. This adds the results of a query to the tree in the desired location. + The following example uses a LINQ query to create an of , which it then passes to this method. This adds the results of a query to the tree in the desired location. ```csharp XElement srcTree = new XElement("Root", @@ -569,7 +569,7 @@ Console.WriteLine(xmlTree) This method will raise the and the events. - The stores its child nodes as a singly-linked list of objects. This means that the method must traverse the list of direct child nodes under the parent container. Therefore, using this method might affect your performance. + The stores its child nodes as a singly-linked list of objects. This means that the method must traverse the list of direct child nodes under the parent container. Therefore, using this method might affect your performance. ## Examples The following example uses this method to add an element into the tree. @@ -692,10 +692,10 @@ Console.WriteLine(xmlTree) This method will raise the and the events. - The stores its child nodes as a singly-linked list of objects. This means that the method must traverse the list of direct child nodes under the parent container. Therefore, using this function might affect your performance. + The stores its child nodes as a singly-linked list of objects. This means that the method must traverse the list of direct child nodes under the parent container. Therefore, using this function might affect your performance. ## Examples - The following example uses a LINQ query to create an of , which it then passes to this method. This adds the results of a query to the tree in the desired location. + The following example uses a LINQ query to create an of , which it then passes to this method. This adds the results of a query to the tree in the desired location. ```csharp XElement srcTree = new XElement("Root", @@ -1041,7 +1041,7 @@ Child stores its child nodes as a singly-linked list of objects. This means that the method must traverse the ancestors of the two nodes being compared until it finds the common parent. Then it must traverse the list of the common parent's child nodes to determine the order of the two nodes being compared. Therefore, using this method might affect your performance. + The stores its child nodes as a singly-linked list of objects. This means that the method must traverse the ancestors of the two nodes being compared until it finds the common parent. Then it must traverse the list of the common parent's child nodes to determine the order of the two nodes being compared. Therefore, using this method might affect your performance. ## Examples The following example uses this method. @@ -1164,20 +1164,20 @@ el1 is before el2 . For example, you can create an from a LINQ to XML tree, and then pass that reader to . + You typically use this method when you have to supply another component with an . For example, you can create an from a LINQ to XML tree, and then pass that reader to . - All of the readers returned by are normalizing readers. They always perform line break normalization and full normalization of attributes. In contrast, the returned by is not a normalizing reader. It does not transform any white space. It also returns attributes in the order that they were added, not in attribute name order. + All of the readers returned by are normalizing readers. They always perform line break normalization and full normalization of attributes. In contrast, the returned by is not a normalizing reader. It does not transform any white space. It also returns attributes in the order that they were added, not in attribute name order. LINQ to XML does not keep information about whether attributes are default attributes. will always return false regardless of whether the attribute was populated from a default value or not. - The `PUBLIC` and `SYSTEM` pseudo attributes on are not available through the method. They are only available through the method that takes the qualified name of the attribute as a parameter. If you have to retrieve the `PUBLIC` or `SYSTEM` attributes, you should use the method. + The `PUBLIC` and `SYSTEM` pseudo attributes on are not available through the method. They are only available through the method that takes the qualified name of the attribute as a parameter. If you have to retrieve the `PUBLIC` or `SYSTEM` attributes, you should use the method. - Base64 and BinHex data are not supported. If you attempt to retrieve these types of data (for example, by calling ), the reader will throw . + Base64 and BinHex data are not supported. If you attempt to retrieve these types of data (for example, by calling ), the reader will throw . The `xml` declaration is not surfaced by the reader. While reading, you will not encounter a node of type . ## Examples - The following example creates an XML tree, creates an by using the method, and creates an by using the reader. + The following example creates an XML tree, creates an by using the method, and creates an by using the reader. ```csharp XDocument xmlTree = new XDocument( @@ -1510,10 +1510,10 @@ True extension method. The recommended approach is to use that extension method instead of using this property directly. + This property is primarily used internally for implementing the extension method. The recommended approach is to use that extension method instead of using this property directly. ## Examples - The following example creates an XML tree with some elements. It then creates a of that contains some elements from the XML tree at random. It sorts the list, using this property to retrieve a , which implements the and interfaces. + The following example creates an XML tree with some elements. It then creates a of that contains some elements from the XML tree at random. It sorts the list, using this property to retrieve a , which implements the and interfaces. ```csharp XElement xmlTree = new XElement("Root", @@ -2077,7 +2077,7 @@ Child2 , which implements the and interfaces. It creates a dictionary that uses this property. + The following example uses this property to retrieve an , which implements the and interfaces. It creates a dictionary that uses this property. ```csharp XElement xmlTree = new XElement("Root", @@ -2177,7 +2177,7 @@ Child 3 Information stores its child nodes as a singly-linked list of objects. This means that the method must traverse the ancestors of the two nodes being compared until it finds the common parent. Then it must traverse the list of the common parent's child nodes to determine the order of the two nodes being compared. Therefore, using this method might affect your performance. + The stores its child nodes as a singly-linked list of objects. This means that the method must traverse the ancestors of the two nodes being compared until it finds the common parent. Then it must traverse the list of the common parent's child nodes to determine the order of the two nodes being compared. Therefore, using this method might affect your performance. ## Examples The following example uses this method. @@ -2280,7 +2280,7 @@ Child5 is after Child3 stores its child nodes as a singly-linked list of objects. This means that the method must traverse the ancestors of the two nodes being compared until it finds the common parent. Then it must traverse the list of the common parent's child nodes to determine the order of the two nodes being compared. Therefore, using this method might affect your performance. + The stores its child nodes as a singly-linked list of objects. This means that the method must traverse the ancestors of the two nodes being compared until it finds the common parent. Then it must traverse the list of the common parent's child nodes to determine the order of the two nodes being compared. Therefore, using this method might affect your performance. ## Examples The following example uses this method. @@ -2875,11 +2875,11 @@ NodeType: Element Child1 ## Remarks You can use this method to write a method that returns a collection of nodes, yielding each node as the node is read from the reader. This method enables you to process arbitrarily large XML files with a very small memory footprint. - The reader that you pass to this method might throw exceptions. does not catch all exceptions thrown by the reader; the unhandled exceptions bubble up to the code that called . In particular, your code should be prepared to handle . + The reader that you pass to this method might throw exceptions. does not catch all exceptions thrown by the reader; the unhandled exceptions bubble up to the code that called . In particular, your code should be prepared to handle . For an example of how to stream a more complex document, see [How to stream XML fragments with access to header information](/dotnet/standard/linq/stream-xml-fragments-access-header-information). - Certain standard query operators, such as , iterate their source, collect all of the data, sort it, and then finally yield the first item in the sequence. If you use a query operator that materializes its source before yielding the first item, you will not retain a small memory footprint. + Certain standard query operators, such as , iterate their source, collect all of the data, sort it, and then finally yield the first item in the sequence. If you use a query operator that materializes its source before yielding the first item, you will not retain a small memory footprint. For an example of using LINQ to XML to transform extremely large XML documents while maintaining a small memory footprint, see [How to perform streaming transform of large XML documents](/dotnet/standard/linq/perform-streaming-transform-large-xml-documents). @@ -2889,7 +2889,7 @@ This example uses the following XML file, named *Source.xml*: :::code language="xml" source="~/snippets/csharp/System.Xml.Linq/XNode/ReadFrom/Source.xml"::: -The following example creates a custom axis method that uses and then queries the custom axis by using a LINQ query: +The following example creates a custom axis method that uses and then queries the custom axis by using a LINQ query: :::code language="csharp" source="~/snippets/csharp/System.Xml.Linq/XNode/ReadFrom/Program.cs"::: :::code language="vb" source="~/snippets/visualbasic/api/system.xml.linq/xnode/readfrom/Program.vb"::: @@ -2997,13 +2997,13 @@ ccc by using the extension method. Then, you can iterate over the list to remove the nodes. For more information, see [Mixed Declarative Code/Imperative Code Bugs (LINQ to XML)](/dotnet/standard/linq/mixed-declarative-imperative-code-bugs). + In LINQ to XML programming, you should not manipulate or modify a set of nodes while you are querying for nodes in that set. In practical terms, this means that you should not iterate over a set of nodes and remove them. Instead, you should materialize them into a by using the extension method. Then, you can iterate over the list to remove the nodes. For more information, see [Mixed Declarative Code/Imperative Code Bugs (LINQ to XML)](/dotnet/standard/linq/mixed-declarative-imperative-code-bugs). - Alternatively, if you want to remove a set of nodes, it is recommended that you use the method. This method copies the nodes to a list, and then iterates over the list to remove the nodes. + Alternatively, if you want to remove a set of nodes, it is recommended that you use the method. This method copies the nodes to a list, and then iterates over the list to remove the nodes. This method will raise the and the events. - The stores its child nodes as a singly-linked list of objects. This means that the method must traverse the list of direct child nodes under the parent container. Therefore, using this method might affect your performance. + The stores its child nodes as a singly-linked list of objects. This means that the method must traverse the list of direct child nodes under the parent container. Therefore, using this method might affect your performance. ## Examples The following example removes a node from its parent. @@ -3069,7 +3069,7 @@ Console.WriteLine(xmlTree) This method will raise the and the events. - The stores its child nodes as a singly-linked list of objects. This means that the method must traverse the list of direct child nodes under the parent container. Therefore, using this method might affect your performance. + The stores its child nodes as a singly-linked list of objects. This means that the method must traverse the list of direct child nodes under the parent container. Therefore, using this method might affect your performance. ## Examples The following example uses this method to replace the contents of a node with different content. @@ -3171,7 +3171,7 @@ Console.WriteLine(xmlTree) ## Remarks This method first removes this node from its parent, and then adds the specified content to this node's parent, in the place of this node. - The stores its child nodes as a singly-linked list of objects. This means that the method must traverse the list of direct child nodes under the parent container. Therefore, using this method might affect your performance. + The stores its child nodes as a singly-linked list of objects. This means that the method must traverse the list of direct child nodes under the parent container. Therefore, using this method might affect your performance. For details about the valid content that can be passed to this method, see [Valid Content of XElement and XDocument Objects](/dotnet/standard/linq/valid-content-xelement-xdocument-objects). @@ -3294,7 +3294,7 @@ Console.WriteLine(xmlTree) ## Remarks This method first removes this node from its parent, and then adds the specified content to this node's parent, in the place of this node. - The stores its child nodes as a singly-linked list of objects. This means that the method must traverse the list of direct child nodes under the parent container. Therefore, using this method might affect your performance. + The stores its child nodes as a singly-linked list of objects. This means that the method must traverse the list of direct child nodes under the parent container. Therefore, using this method might affect your performance. For details about the valid content that can be passed to this method, see [Valid Content of XElement and XDocument Objects](/dotnet/standard/linq/valid-content-xelement-xdocument-objects). diff --git a/xml/System.Xml.Linq/XNodeDocumentOrderComparer.xml b/xml/System.Xml.Linq/XNodeDocumentOrderComparer.xml index fa40d3e3721..17134859dd7 100644 --- a/xml/System.Xml.Linq/XNodeDocumentOrderComparer.xml +++ b/xml/System.Xml.Linq/XNodeDocumentOrderComparer.xml @@ -56,13 +56,13 @@ Contains functionality to compare nodes for their document order. This class cannot be inherited. - `. - - We recommend that instead of using this class directly, you use the method. This class is used internally by that method. - + `. + + We recommend that instead of using this class directly, you use the method. This class is used internally by that method. + ]]> LINQ to XML overview @@ -111,44 +111,44 @@ Initializes a new instance of the class. - method. This class is used internally by that method. - - - -## Examples - The following example uses of this class to compare the document order for two nodes. - -```csharp -XElement xmlTree = new XElement("Root", - new XText("Text content."), - new XElement("Child1", "child1 content"), - new XElement("Child2", "child2 content"), - new XElement("Child3", "child3 content"), - new XText("More text content."), - new XElement("Child4", "child4 content"), - new XElement("Child5", "child5 content") -); -XElement child3 = xmlTree.Element("Child3"); -XElement child5 = xmlTree.Element("Child5"); -XNodeDocumentOrderComparer documentOrderComparer = new XNodeDocumentOrderComparer(); -int val = documentOrderComparer.Compare(child3, child5); -if (val == 0) - Console.WriteLine("Child3 is same as Child5"); -else if (val < 0) - Console.WriteLine("Child3 is before Child5"); -else - Console.WriteLine("Child3 is after Child5"); -``` - - This example produces the following output: - -``` -Child3 is before Child5 -``` - + method. This class is used internally by that method. + + + +## Examples + The following example uses of this class to compare the document order for two nodes. + +```csharp +XElement xmlTree = new XElement("Root", + new XText("Text content."), + new XElement("Child1", "child1 content"), + new XElement("Child2", "child2 content"), + new XElement("Child3", "child3 content"), + new XText("More text content."), + new XElement("Child4", "child4 content"), + new XElement("Child5", "child5 content") +); +XElement child3 = xmlTree.Element("Child3"); +XElement child5 = xmlTree.Element("Child5"); +XNodeDocumentOrderComparer documentOrderComparer = new XNodeDocumentOrderComparer(); +int val = documentOrderComparer.Compare(child3, child5); +if (val == 0) + Console.WriteLine("Child3 is same as Child5"); +else if (val < 0) + Console.WriteLine("Child3 is before Child5"); +else + Console.WriteLine("Child3 is after Child5"); +``` + + This example produces the following output: + +``` +Child3 is before Child5 +``` + ]]> LINQ to XML overview @@ -205,44 +205,44 @@ Child3 is before Child5 Compares two nodes to determine their relative document order. An that contains 0 if the nodes are equal; -1 if is before ; 1 if is after . - method. This class is used internally by that method. - - - -## Examples - The following example uses this class to compare document order for two nodes. - -```csharp -XElement xmlTree = new XElement("Root", - new XText("Text content."), - new XElement("Child1", "child1 content"), - new XElement("Child2", "child2 content"), - new XElement("Child3", "child3 content"), - new XText("More text content."), - new XElement("Child4", "child4 content"), - new XElement("Child5", "child5 content") -); -XElement child3 = xmlTree.Element("Child3"); -XElement child5 = xmlTree.Element("Child5"); -XNodeDocumentOrderComparer documentOrderComparer = new XNodeDocumentOrderComparer(); -int val = documentOrderComparer.Compare(child3, child5); -if (val == 0) - Console.WriteLine("Child3 is same as Child5"); -else if (val < 0) - Console.WriteLine("Child3 is before Child5"); -else - Console.WriteLine("Child3 is after Child5"); -``` - - This example produces the following output: - -``` -Child3 is before Child5 -``` - + method. This class is used internally by that method. + + + +## Examples + The following example uses this class to compare document order for two nodes. + +```csharp +XElement xmlTree = new XElement("Root", + new XText("Text content."), + new XElement("Child1", "child1 content"), + new XElement("Child2", "child2 content"), + new XElement("Child3", "child3 content"), + new XText("More text content."), + new XElement("Child4", "child4 content"), + new XElement("Child5", "child5 content") +); +XElement child3 = xmlTree.Element("Child3"); +XElement child5 = xmlTree.Element("Child5"); +XNodeDocumentOrderComparer documentOrderComparer = new XNodeDocumentOrderComparer(); +int val = documentOrderComparer.Compare(child3, child5); +if (val == 0) + Console.WriteLine("Child3 is same as Child5"); +else if (val < 0) + Console.WriteLine("Child3 is before Child5"); +else + Console.WriteLine("Child3 is after Child5"); +``` + + This example produces the following output: + +``` +Child3 is before Child5 +``` + ]]> The two nodes do not share a common ancestor. @@ -299,11 +299,11 @@ Child3 is before Child5 Compares two nodes to determine their relative document order. An that contains 0 if the nodes are equal; -1 if is before ; 1 if is after . - method. This class is used internally by that method. - + method. This class is used internally by that method. + ]]> The two nodes do not share a common ancestor. diff --git a/xml/System.Xml.Linq/XNodeEqualityComparer.xml b/xml/System.Xml.Linq/XNodeEqualityComparer.xml index 4a185b72528..d925ec5bc6d 100644 --- a/xml/System.Xml.Linq/XNodeEqualityComparer.xml +++ b/xml/System.Xml.Linq/XNodeEqualityComparer.xml @@ -59,7 +59,7 @@ and . Classes that require identity (such as ) require an instance of a class that implements one of these interfaces. + The purpose of this class is to implement and . Classes that require identity (such as ) require an instance of a class that implements one of these interfaces. ]]> @@ -304,7 +304,7 @@ False implementation of is based on the referential identity of the node. This method computes a deep hash code based on the value of the node and all descendants. The hash code reflects all attributes and all descendent nodes. + The implementation of is based on the referential identity of the node. This method computes a deep hash code based on the value of the node and all descendants. The hash code reflects all attributes and all descendent nodes. @@ -463,7 +463,7 @@ HashCode: AD26516B implementation of is based on the referential identity of the node. This method computes a deep hash code based on the value of the node, its attributes, and its descendants. + The implementation of is based on the referential identity of the node. This method computes a deep hash code based on the value of the node, its attributes, and its descendants. ]]> diff --git a/xml/System.Xml.Linq/XObject.xml b/xml/System.Xml.Linq/XObject.xml index e81549be74e..824fb600437 100644 --- a/xml/System.Xml.Linq/XObject.xml +++ b/xml/System.Xml.Linq/XObject.xml @@ -117,7 +117,7 @@ . Also, if you import an XML Namespace into your VB project and call AddAnnotation with the SaveOptions.OmitDuplicateNamespaces enumeration value, then only one element will contain the XML Namespace attribute instead of every element. For more information, see [Removing duplicate namespaces in XML Literals](https://devblogs.microsoft.com/vbteam/removing-duplicate-namespaces-in-xml-literals-shyam-namboodiripad/). + Note that annotations are not part of the infoset; they are not persisted, or displayed by . Also, if you import an XML Namespace into your VB project and call AddAnnotation with the SaveOptions.OmitDuplicateNamespaces enumeration value, then only one element will contain the XML Namespace attribute instead of every element. For more information, see [Removing duplicate namespaces in XML Literals](https://devblogs.microsoft.com/vbteam/removing-duplicate-namespaces-in-xml-literals-shyam-namboodiripad/). @@ -762,7 +762,7 @@ def ## Remarks Using LINQ to XML, you can deserialize XML in a number of fashions. You can parse it from a string, load it from a file, or read it from a or an . In all of these cases, LINQ to XML uses one or another of the concrete subclasses of . - Sometimes the has the base URI, and sometimes it does not. For instance, when loading from a file, the knows the base URI, but when reading from an that was created because of calling the method, there is no possibility of the reporting a base URI; the XML was in a string. + Sometimes the has the base URI, and sometimes it does not. For instance, when loading from a file, the knows the base URI, but when reading from an that was created because of calling the method, there is no possibility of the reporting a base URI; the XML was in a string. If, when parsing or loading the XML, you specify , LINQ to XML will request the base URI for each node as the returns the node. If the reader has the base URI, LINQ to XML will save the information with the LINQ to XML node. This property returns that information. If the underlying does not have the base URI, then this property will return an empty string. diff --git a/xml/System.Xml.Linq/XStreamingElement.xml b/xml/System.Xml.Linq/XStreamingElement.xml index e91123f8204..34a9b6b6a8a 100644 --- a/xml/System.Xml.Linq/XStreamingElement.xml +++ b/xml/System.Xml.Linq/XStreamingElement.xml @@ -63,7 +63,7 @@ Another scenario is that you have a large XML tree that has been loaded into memory, and you want to create a transformed version of the document. If you create a new document using , then you will have two large XML trees in memory upon completion of the transformation. However, if you create the new XML tree using , then your working set will be effectively cut in half. - Note that when debugging a program that uses , displaying the value of an object causes its method to be called. This causes the XML to be serialized. If the semantics of your streaming element query are such that the streaming element can only be streamed once, this may cause undesirable behavior in your debugging experience. + Note that when debugging a program that uses , displaying the value of an object causes its method to be called. This causes the XML to be serialized. If the semantics of your streaming element query are such that the streaming element can only be streamed once, this may cause undesirable behavior in your debugging experience. @@ -248,7 +248,7 @@ End Module Sometimes you have to transform large XML files, and write your application so that the memory footprint of the application is predictable. If you try to populate an XML tree with a very large XML file, your memory usage will be proportional to the size of the file (that is, excessive). Therefore, you should use a streaming technique instead. - Certain standard query operators, such as , iterate their source, collect all of the data, sort it, and then finally yield the first item in the sequence. Note that if you use a query operator that materializes its source before yielding the first item, you will not retain a small memory footprint for your application. + Certain standard query operators, such as , iterate their source, collect all of the data, sort it, and then finally yield the first item in the sequence. Note that if you use a query operator that materializes its source before yielding the first item, you will not retain a small memory footprint for your application. Even if you use the technique described in , if you try to assemble an XML tree that contains the transformed document, memory usage may be too great. @@ -1244,7 +1244,7 @@ NewRoot ## Remarks The serialized XML will be indented. All insignificant white space will be removed, and additional white space will be added so that the XML will be properly indented. The behavior of this method is that insignificant white space will not be preserved. - If you want to control white space, use the overload of that takes as a parameter. Use the option to save unindented XML. This will cause the writer to write all white spaces exactly as represented in the XML tree. + If you want to control white space, use the overload of that takes as a parameter. Use the option to save unindented XML. This will cause the writer to write all white spaces exactly as represented in the XML tree. Use option if you want to remove duplicate namespace declarations. @@ -1307,7 +1307,7 @@ NewRoot ## Remarks The serialized XML will be indented. All insignificant white space will be removed, and additional white space will be added so that the XML will be properly indented. The behavior of this method is that insignificant white space nodes in the XML tree will not be preserved. - If you want to control white space, use one of the overloads of that take as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). + If you want to control white space, use one of the overloads of that take as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). @@ -1424,7 +1424,7 @@ Console.WriteLine(sb.ToString()) ## Remarks The serialized XML will be indented. All insignificant white space will be removed, and additional white space will be added so that the XML will be properly indented. The behavior of this method is that insignificant white space nodes in the XML tree will not be preserved. - If you want to control white space, use one of the overloads of that take as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). + If you want to control white space, use one of the overloads of that take as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). @@ -1704,7 +1704,7 @@ Console.WriteLine(sb.ToString()) ## Remarks If you want to save unindented XML, specify the flag for `options`. This will cause the writer to write all white space exactly as represented in the XML tree. - If you want to save indented XML, do not specify the flag for `options`. This will remove all extraneous insignificant white space, and add appropriate insignificant white space so that the XML is properly indented. This is the default behavior, and the behavior of the overloads of the methods that do not take `options` as a parameter. + If you want to save indented XML, do not specify the flag for `options`. This will remove all extraneous insignificant white space, and add appropriate insignificant white space so that the XML is properly indented. This is the default behavior, and the behavior of the overloads of the methods that do not take `options` as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). @@ -1827,7 +1827,7 @@ Console.WriteLine(sb.ToString()) ## Remarks If you want to save unindented XML, specify the flag for `options`. This will cause the writer to write all white space exactly as represented in the XML tree. - If you want to save indented XML, do not specify the flag for `options`. This will remove all extraneous insignificant white space, and add appropriate insignificant white space so that the XML is properly indented. This is the default behavior, and the behavior of the overloads of the methods that do not take `options` as a parameter. + If you want to save indented XML, do not specify the flag for `options`. This will remove all extraneous insignificant white space, and add appropriate insignificant white space so that the XML is properly indented. This is the default behavior, and the behavior of the overloads of the methods that do not take `options` as a parameter. For more information, see [Preserve white space while loading or parsing XML](/dotnet/standard/linq/preserve-white-space-loading-parsing-xml) and [Preserve white space while serializing](/dotnet/standard/linq/preserve-white-space-serializing). @@ -1909,7 +1909,7 @@ Console.WriteLine(File.ReadAllText("Test2.xml")) , displaying the value of an object causes its method to be called. This causes the XML to be serialized. If the semantics of your streaming element query are such that the streaming element can only be streamed once, this may cause undesirable behavior in your debugging experience. + Note that when debugging a program that uses , displaying the value of an object causes its method to be called. This causes the XML to be serialized. If the semantics of your streaming element query are such that the streaming element can only be streamed once, this may cause undesirable behavior in your debugging experience. ]]> @@ -1967,12 +1967,12 @@ Console.WriteLine(File.ReadAllText("Test2.xml")) , displaying the value of an object causes its method to be called. This causes the XML to be serialized. If the semantics of your streaming element query are such that the streaming element can only be streamed once, this may cause undesirable behavior in your debugging experience. + Note that when debugging a program that uses , displaying the value of an object causes its method to be called. This causes the XML to be serialized. If the semantics of your streaming element query are such that the streaming element can only be streamed once, this may cause undesirable behavior in your debugging experience. ## Examples - The following example shows two uses of . The first use preserves white space. The second one serializes the with formatting. + The following example shows two uses of . The first use preserves white space. The second one serializes the with formatting. ```csharp XElement srcTree = new XElement("Root", @@ -2084,12 +2084,12 @@ Console.WriteLine(dstTree.ToString()) , displaying the value of an object causes its method to be called. This causes the XML to be serialized. If the semantics of your streaming element query are such that the streaming element can only be streamed once, this may cause undesirable behavior in your debugging experience. + Note that when debugging a program that uses , displaying the value of an object causes its method to be called. This causes the XML to be serialized. If the semantics of your streaming element query are such that the streaming element can only be streamed once, this may cause undesirable behavior in your debugging experience. ## Examples - The following example shows two uses of . The first use preserves white space. The second one serializes the with formatting. + The following example shows two uses of . The first use preserves white space. The second one serializes the with formatting. ```csharp XElement srcTree = new XElement("Root", diff --git a/xml/System.Xml.Schema/Extensions.xml b/xml/System.Xml.Schema/Extensions.xml index bc156d1d39e..1b76b94a940 100644 --- a/xml/System.Xml.Schema/Extensions.xml +++ b/xml/System.Xml.Schema/Extensions.xml @@ -214,7 +214,7 @@ custOrd did not validate You use the property to get a partial validation type (). You can use it to revalidate an attribute without validating an entire document. - For an example of this property, see . + For an example of this property, see . ]]> @@ -277,7 +277,7 @@ custOrd did not validate You use the property to get a partial validation type (). You can use it to revalidate a sub-tree with an element at its root without validating an entire document. - For an example of this property, see . + For an example of this property, see . @@ -743,9 +743,9 @@ doc2 did not validate 1. Validate that a document conforms to a schema. -2. Add the post-schema-validation infoset (PSVI) by calling the extension method. +2. Add the post-schema-validation infoset (PSVI) by calling the extension method. -3. Call the extension method to retrieve an object that implements . From the retrieved object, you can get an . +3. Call the extension method to retrieve an object that implements . From the retrieved object, you can get an . - If you get an for an , the type will be . @@ -970,9 +970,9 @@ lang did not validate There are two steps to populating the XML tree with the PSVI. -1. First, an annotation is added to all nodes in the tree to enable you to call or on an element or attribute in the tree. +1. First, an annotation is added to all nodes in the tree to enable you to call or on an element or attribute in the tree. -2. Second, default elements and attributes defined in the XSD are added to the XML tree. By calling one of the methods, you can determine if a specific element or attribute was added from the XSD as a default element or attribute. +2. Second, default elements and attributes defined in the XSD are added to the XML tree. By calling one of the methods, you can determine if a specific element or attribute was added from the XSD as a default element or attribute. @@ -1384,9 +1384,9 @@ Invalid Element /Root/Child1/GrandChild3 1. Validate that a document conforms to a schema. -2. Add the post-schema-validation infoset (PSVI) by calling the extension method. +2. Add the post-schema-validation infoset (PSVI) by calling the extension method. -3. Call the extension method to retrieve an object that implements . From the retrieved object, you can get an . +3. Call the extension method to retrieve an object that implements . From the retrieved object, you can get an . - If you get an for an , the type will be . @@ -1609,7 +1609,7 @@ child1 did not validate ## Remarks You can use this method to validate that an conforms to a schema. You typically use this method when you have modified an attribute, and you want to make sure that it still conforms to its schema. You could validate the entire document, but it takes less processing time to validate just the attribute. - If `addSchemaInfo` is `true`, this method populates the attribute with the post-schema-validation infoset (PSVI). After you have populated the XML tree with the PSVI, you can call on the validated attribute. This is useful if you are writing code that relies on data returned by . + If `addSchemaInfo` is `true`, this method populates the attribute with the post-schema-validation infoset (PSVI). After you have populated the XML tree with the PSVI, you can call on the validated attribute. This is useful if you are writing code that relies on data returned by . If you pass `null` for `validationEventHandler`, then this method raises an exception upon validation errors. Validation warnings will not raise an exception. @@ -1617,9 +1617,9 @@ child1 did not validate 1. Validate that a document conforms to a schema. -2. Add the post-schema-validation infoset (PSVI) by calling the extension method. +2. Add the post-schema-validation infoset (PSVI) by calling the extension method. -3. Call the extension method to retrieve an object that implements . From the retrieved object, you can get an . +3. Call the extension method to retrieve an object that implements . From the retrieved object, you can get an . - If you get an for an , the type will be . @@ -1904,9 +1904,9 @@ Invalid Attribute /Root/@Lang There are two aspects of populating the XML tree with the PSVI. - First, an annotation is added to all nodes in the tree such that you can now call on an element or attribute in the tree. + First, an annotation is added to all nodes in the tree such that you can now call on an element or attribute in the tree. - Second, default elements and attributes defined in the XSD are added to the XML tree. By calling one of the methods, you can determine if a specific element or attribute was added from the XSD as a default element or attribute. + Second, default elements and attributes defined in the XSD are added to the XML tree. By calling one of the methods, you can determine if a specific element or attribute was added from the XSD as a default element or attribute. If you pass `null` for `validationEventHandler`, then this method raises an exception upon validation errors. Validation warnings will not raise an exception. @@ -1914,9 +1914,9 @@ Invalid Attribute /Root/@Lang 1. Validate that a document conforms to a schema. -2. Add the post-schema-validation infoset (PSVI) by calling the extension method. +2. Add the post-schema-validation infoset (PSVI) by calling the extension method. -3. Call the extension method to retrieve an object that implements . From the retrieved object, you can get an . +3. Call the extension method to retrieve an object that implements . From the retrieved object, you can get an . - If you get an for an , the type will be . diff --git a/xml/System.Xml.Schema/ValidationEventArgs.xml b/xml/System.Xml.Schema/ValidationEventArgs.xml index ed59f381cf2..016a5daa3b4 100644 --- a/xml/System.Xml.Schema/ValidationEventArgs.xml +++ b/xml/System.Xml.Schema/ValidationEventArgs.xml @@ -59,7 +59,7 @@ method for the class. + For an example, see the method for the class. ]]> @@ -205,7 +205,7 @@ ## Examples The following example validates an XML file and generates the appropriate error or warning. - + :::code language="csharp" source="~/snippets/csharp/System.Xml.Schema/ValidationEventArgs/Severity/severity.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/ValidationEventArgs.Severity/VB/severity.vb" id="Snippet1"::: diff --git a/xml/System.Xml.Schema/XmlAtomicValue.xml b/xml/System.Xml.Schema/XmlAtomicValue.xml index 764c278006d..8266cfff54a 100644 --- a/xml/System.Xml.Schema/XmlAtomicValue.xml +++ b/xml/System.Xml.Schema/XmlAtomicValue.xml @@ -389,7 +389,7 @@ method attempts to convert the value of the validated XML element or attribute to the .NET type specified. + The method attempts to convert the value of the validated XML element or attribute to the .NET type specified. The object is used to resolve namespace prefixes related to type conversions. For example, when converting an `xs:QName` to an `xs:string`. diff --git a/xml/System.Xml.Schema/XmlSchema.xml b/xml/System.Xml.Schema/XmlSchema.xml index 6d6ce9ceea5..9951c0f13ea 100644 --- a/xml/System.Xml.Schema/XmlSchema.xml +++ b/xml/System.Xml.Schema/XmlSchema.xml @@ -400,7 +400,7 @@ ## Remarks > [!IMPORTANT] -> The method is obsolete in the Microsoft .NET Framework version 2.0 and has been replaced by the method. +> The method is obsolete in the Microsoft .NET Framework version 2.0 and has been replaced by the method. ]]> @@ -469,7 +469,7 @@ ## Remarks > [!IMPORTANT] -> The method is obsolete in the Microsoft .NET Framework version 2.0 and has been replaced by the method. +> The method is obsolete in the Microsoft .NET Framework version 2.0 and has been replaced by the method. ]]> @@ -541,10 +541,10 @@ If the SOM references other namespaces through the `import` or `include` elements, the `XmlResolver` is used to resolve these references. If the resolver is set to `null`, this indicates that the user does not care about resolving `import` or `include` elements. In this case, the references are not resolved. The resolver is not cached after the `Compile` method completes. > [!IMPORTANT] -> The method is obsolete in the Microsoft .NET Framework version 2.0 and has been replaced by the method. +> The method is obsolete in the Microsoft .NET Framework version 2.0 and has been replaced by the method. > [!IMPORTANT] -> The method uses the class to resolve external schemas referenced in include, import, or redefine elements by default. You can disable resolution of external schemas by passing null as the parameter. +> The method uses the class to resolve external schemas referenced in include, import, or redefine elements by default. You can disable resolution of external schemas by passing null as the parameter. ]]> @@ -926,7 +926,7 @@ method expects only and its derived types (, , and ) as parameters. The following example illustrates adding an included schema to the collection of an existing object. + The method expects only and its derived types (, , and ) as parameters. The following example illustrates adding an included schema to the collection of an existing object. ```vb Dim schema As XmlSchema = New XmlSchema() diff --git a/xml/System.Xml.Schema/XmlSchemaCollection.xml b/xml/System.Xml.Schema/XmlSchemaCollection.xml index 013f742dbd2..f707249f8ca 100644 --- a/xml/System.Xml.Schema/XmlSchemaCollection.xml +++ b/xml/System.Xml.Schema/XmlSchemaCollection.xml @@ -78,11 +78,11 @@ method, at which time the schema is associated with a namespace Uniform Resource Identifier (URI). For XML Schemas, this will typically be the `targetNamespace` property of the schema. + Schemas are loaded using the method, at which time the schema is associated with a namespace Uniform Resource Identifier (URI). For XML Schemas, this will typically be the `targetNamespace` property of the schema. Although this class stores both XML Schemas and XDR schemas, any method and property that takes or returns an applies to XML Schemas only. - This version of the product supports the World Wide Web Consortium (W3C) XML Schema recommendation located at [XML Schema Part 1: Structures](https://www.w3.org/TR/xmlschema-1/) and [XML Schema Part 2: Datatypes](https://www.w3.org/TR/xmlschema-2/). An XML Schema must reference the W3C Schema namespace `http://www.w3.org/2001/XMLSchema` in its schema element. See the method for an example. + This version of the product supports the World Wide Web Consortium (W3C) XML Schema recommendation located at [XML Schema Part 1: Structures](https://www.w3.org/TR/xmlschema-1/) and [XML Schema Part 2: Datatypes](https://www.w3.org/TR/xmlschema-2/). An XML Schema must reference the W3C Schema namespace `http://www.w3.org/2001/XMLSchema` in its schema element. See the method for an example. `XmlSchemaCollection` can be used by for efficient data validation. diff --git a/xml/System.Xml.Schema/XmlSchemaDatatype.xml b/xml/System.Xml.Schema/XmlSchemaDatatype.xml index 81027f68b19..9da6a128d00 100644 --- a/xml/System.Xml.Schema/XmlSchemaDatatype.xml +++ b/xml/System.Xml.Schema/XmlSchemaDatatype.xml @@ -348,9 +348,9 @@ method validates the `string` specified against a built-in or user-defined simple type. For example, if this represents the type xs:date, then an instance of is returned. + The method validates the `string` specified against a built-in or user-defined simple type. For example, if this represents the type xs:date, then an instance of is returned. - The following are the steps performed during the method's validation process. + The following are the steps performed during the method's validation process. 1. Convert the value specified as a `string` to its corresponding Common Language Runtime (CLR) type. @@ -363,7 +363,7 @@ ## Examples - The following example retrieves the `LotteryNumber` simple type from the example.xsd file as an and then validates the `string` value of `5` using the method. + The following example retrieves the `LotteryNumber` simple type from the example.xsd file as an and then validates the `string` value of `5` using the method. :::code language="csharp" source="~/snippets/csharp/System.Xml.Schema/XmlSchemaDatatype/Overview/datatype.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/Classic Webdata XmlSchemaDatatype Example/VB/datatype.vb" id="Snippet1"::: @@ -414,9 +414,9 @@ method validates the specified string against a built-in or user-defined simple type. For example, if this represents the type xs:date, then an instance of is returned. +The method validates the specified string against a built-in or user-defined simple type. For example, if this represents the type xs:date, then an instance of is returned. -The following are the steps performed during the method's validation process. +The following are the steps performed during the method's validation process. 1. Convert the specified string to its corresponding Common Language Runtime (CLR) type. diff --git a/xml/System.Xml.Schema/XmlSchemaInference.xml b/xml/System.Xml.Schema/XmlSchemaInference.xml index 81fa841ead1..8c8e592e2bb 100644 --- a/xml/System.Xml.Schema/XmlSchemaInference.xml +++ b/xml/System.Xml.Schema/XmlSchemaInference.xml @@ -171,15 +171,15 @@ method infers one or more W3C XML Schema Definition Language (XSD) schemas from the XML instance document contained in the object specified. If the XML document contains elements and attributes from multiple namespaces, then multiple schemas are generated: one for each namespace used in the document. The primary schema is the schema that can validate the entire XML document, and its target namespace is the same as the namespace of the document element of the XML document. + The method infers one or more W3C XML Schema Definition Language (XSD) schemas from the XML instance document contained in the object specified. If the XML document contains elements and attributes from multiple namespaces, then multiple schemas are generated: one for each namespace used in the document. The primary schema is the schema that can validate the entire XML document, and its target namespace is the same as the namespace of the document element of the XML document. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. -- The method ignores any `xsi:type`, `xsi:schemaLocation`, or `xsi:noNamespaceSchemaLocation` attributes in the XML document. +- The method ignores any `xsi:type`, `xsi:schemaLocation`, or `xsi:noNamespaceSchemaLocation` attributes in the XML document. - If the object is typed, the type information it contains is ignored. -- If the object is positioned on an element that is not the root element of the XML document, a schema is inferred for only that element. If the object is not positioned on an element, the method is called on the parameter until an element is encountered (for example, when is ). At this point, the inference process starts from that element. If no element is encountered until the end of the document, an is thrown. +- If the object is positioned on an element that is not the root element of the XML document, a schema is inferred for only that element. If the object is not positioned on an element, the method is called on the parameter until an element is encountered (for example, when is ). At this point, the inference process starts from that element. If no element is encountered until the end of the document, an is thrown. @@ -251,15 +251,15 @@ method infers one or more W3C XML Schema Definition Language (XSD) schemas from the XML instance document contained in the object specified. If the XML document contains elements and attributes from multiple namespaces, multiple schemas are generated: one for each namespace used in the document. The primary schema is the schema that can validate the entire XML document, and its target namespace is the same as the namespace of the document element of the XML document. + The method infers one or more W3C XML Schema Definition Language (XSD) schemas from the XML instance document contained in the object specified. If the XML document contains elements and attributes from multiple namespaces, multiple schemas are generated: one for each namespace used in the document. The primary schema is the schema that can validate the entire XML document, and its target namespace is the same as the namespace of the document element of the XML document. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. -- The method ignores any `xsi:type`, `xsi:schemaLocation`, or `xsi:noNamespaceSchemaLocation` attributes in the XML document. +- The method ignores any `xsi:type`, `xsi:schemaLocation`, or `xsi:noNamespaceSchemaLocation` attributes in the XML document. - If the object is typed, the type information it contains is ignored. -- If the object is positioned on an element that is not the root element of the XML document, a schema is inferred for only that element. If the object is not positioned on an element, the method is called on the parameter until an element is encountered (for example, when is ). At this point, the inference process starts from that element. If no element is encountered until the end of the document, an is thrown. +- If the object is positioned on an element that is not the root element of the XML document, a schema is inferred for only that element. If the object is not positioned on an element, the method is called on the parameter until an element is encountered (for example, when is ). At this point, the inference process starts from that element. If no element is encountered until the end of the document, an is thrown. - If an object is passed as a parameter and the element upon which the object is positioned is defined in one of the schemas in the , the inferred schema is used to refine an existing schema in the parameter with the same target namespace; otherwise, a new schema is inferred for the namespace. @@ -276,7 +276,7 @@ :::code language="xml" source="~/snippets/xml/VS_Snippets_Data/XmlSchemaInferenceExamples/XML/item2.xml" id="Snippet14"::: - The following example code infers a schema from the first XML document contained in `reader`, and then refines the inferred schema with the changes found in the second XML document contained in `reader1`. The example code uses the first overloaded method to infer the schema, and the second overloaded method to refine the existing schema in the object. + The following example code infers a schema from the first XML document contained in `reader`, and then refines the inferred schema with the changes found in the second XML document contained in `reader1`. The example code uses the first overloaded method to infer the schema, and the second overloaded method to refine the existing schema in the object. :::code language="csharp" source="~/snippets/csharp/System.Xml.Schema/XmlSchemaInference/Overview/XmlSchemaInferenceExamples.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlSchemaInferenceExamples/VB/XmlSchemaInferenceExamples.vb" id="Snippet4"::: diff --git a/xml/System.Xml.Schema/XmlSchemaInfo.xml b/xml/System.Xml.Schema/XmlSchemaInfo.xml index cde9a42964a..6b11c103c51 100644 --- a/xml/System.Xml.Schema/XmlSchemaInfo.xml +++ b/xml/System.Xml.Schema/XmlSchemaInfo.xml @@ -114,7 +114,7 @@ constructor, see the class reference topic. + For an example of the constructor, see the class reference topic. ]]> diff --git a/xml/System.Xml.Schema/XmlSchemaObjectCollection.xml b/xml/System.Xml.Schema/XmlSchemaObjectCollection.xml index 8ac03868c0f..ce39ed5110f 100644 --- a/xml/System.Xml.Schema/XmlSchemaObjectCollection.xml +++ b/xml/System.Xml.Schema/XmlSchemaObjectCollection.xml @@ -215,7 +215,7 @@ If `Count` is less than the capacity, this method is an 0(1) operation. If the capacity needs to be increased to accommodate the new element, this method becomes an 0(n) operation, where n is `Count`. - The method expects only and its derived types (, , and ) as parameters. The following example illustrates adding an included schema to the collection of an existing object. + The method expects only and its derived types (, , and ) as parameters. The following example illustrates adding an included schema to the collection of an existing object. ```vb Dim schema As XmlSchema = New XmlSchema() @@ -341,7 +341,7 @@ schema.Includes.Add(include); ## Remarks The specified array must be of a compatible type. - This method uses to copy the elements. + This method uses to copy the elements. ]]> @@ -799,9 +799,9 @@ schema.Includes.Add(include); . That is, this method is an O(`n`) operation, where `n` is . + This method performs a linear search; therefore, the average execution time is proportional to . That is, this method is an O(`n`) operation, where `n` is . - This method determines equality by calling . + This method determines equality by calling . The elements that follow the removed element move up to occupy the vacated spot. diff --git a/xml/System.Xml.Schema/XmlSchemaObjectTable.xml b/xml/System.Xml.Schema/XmlSchemaObjectTable.xml index 2f5570f9f9d..66a023f19dc 100644 --- a/xml/System.Xml.Schema/XmlSchemaObjectTable.xml +++ b/xml/System.Xml.Schema/XmlSchemaObjectTable.xml @@ -99,11 +99,11 @@ if the qualified name specified exists in the collection; otherwise, . - returns `false` if a `null` value is supplied because there is not a qualified name for a null name. - + returns `false` if a `null` value is supplied because there is not a qualified name for a null name. + ]]> diff --git a/xml/System.Xml.Schema/XmlSchemaSet.xml b/xml/System.Xml.Schema/XmlSchemaSet.xml index 986f78f143d..5fe6a4fce2b 100644 --- a/xml/System.Xml.Schema/XmlSchemaSet.xml +++ b/xml/System.Xml.Schema/XmlSchemaSet.xml @@ -206,9 +206,9 @@ object already exists in the , the method does nothing. + If the object already exists in the , the method does nothing. - The functionality of this method is identical to that of the method. + The functionality of this method is identical to that of the method. ]]> @@ -299,7 +299,7 @@ foreach(XmlSchema schema in schemaSet.Schemas()) ## Examples - The following code example illustrates adding schemas to an , then adding the to a new using the method. + The following code example illustrates adding schemas to an , then adding the to a new using the method. ```vb Dim schemaSet1 As XmlSchemaSet = New XmlSchemaSet @@ -389,20 +389,20 @@ schemaSet2.Add(schemaSet1); 2. References to internal and external schema components are resolved. Any imported or included schemas that are successfully retrieved are also added to the . Imported schemas are added as separate objects, and included schemas are made a part of the including . - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. - Adding a schema to the with the same target namespace and schema location URL as a schema already contained within the will return the original schema object. - When a new schema is successfully added to an , the property of the is set to `false`. -- Any include or import elements encountered in an XML schema are resolved when the method is called. Failure to resolve include and import elements results in a schema validation warning and if no has been specified for the object, these warning will not be reported. +- Any include or import elements encountered in an XML schema are resolved when the method is called. Failure to resolve include and import elements results in a schema validation warning and if no has been specified for the object, these warning will not be reported. - If a schema with the same target namespace as a schema that already exists in the is added to the , both schemas are added. > [!NOTE] > This behavior differs from the obsolete object. -- The method of the has the ability to use the target namespace defined in a schema, rather than requiring the target namespace be specified as a parameter when the method is called. Specifying `null` in the `targetNamespace` parameter of the method instructs the to use the target namespace defined in the schema, as illustrated in the following code example. +- The method of the has the ability to use the target namespace defined in a schema, rather than requiring the target namespace be specified as a parameter when the method is called. Specifying `null` in the `targetNamespace` parameter of the method instructs the to use the target namespace defined in the schema, as illustrated in the following code example. ```vb Dim schemaSet As XmlSchemaSet = New XmlSchemaSet() @@ -424,9 +424,9 @@ foreach(XmlSchema schema in schemaSet.Schemas("http://www.contoso.com/books")) } ``` - In the code example above, `null` is specified as the `targetNamespace` parameter to the method. As a result, the `targetNamespace` defined in the books.xml file is used. In this case, the result of calling the method would be identical if `http://www.contoso.com/books` had been specified as the `targetNamespace` parameter. + In the code example above, `null` is specified as the `targetNamespace` parameter to the method. As a result, the `targetNamespace` defined in the books.xml file is used. In this case, the result of calling the method would be identical if `http://www.contoso.com/books` had been specified as the `targetNamespace` parameter. -- W3C XML Schema allows schemas without a target namespace to be included in schemas with a target namespace defined. In this case, the schema without a target namespace defined is coerced into the target namespace of the including schema. The included schema is treated as if it had that target namespace defined. Similarly, schemas without a target namespace can be added to the and coerced into the target namespace specified by the method, as illustrated in the following example. +- W3C XML Schema allows schemas without a target namespace to be included in schemas with a target namespace defined. In this case, the schema without a target namespace defined is coerced into the target namespace of the including schema. The included schema is treated as if it had that target namespace defined. Similarly, schemas without a target namespace can be added to the and coerced into the target namespace specified by the method, as illustrated in the following example. ```xml @@ -545,7 +545,7 @@ schemaSet.Add("http://www.contoso.com/books", "http://www.contoso.com/books.xsd" 2. References to internal and external schema components are resolved. Any imported or included schemas that are successfully retrieved are also added to the . Imported schemas are added as separate objects, and included schemas are made a part of the including . - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. - Successfully retrieved schemas imported or included by the schemas contained in the are also added to the . @@ -553,13 +553,13 @@ schemaSet.Add("http://www.contoso.com/books", "http://www.contoso.com/books.xsd" - If the is positioned over a sequence of XML nodes, only the first node in the sequence is added. -- If the schema was created from a method call, the value of the property is ignored, because inline schema processing is not applied for W3C XML Schema documents. +- If the schema was created from a method call, the value of the property is ignored, because inline schema processing is not applied for W3C XML Schema documents. - The property of the is not used to resolve references to namespaces or schema locations in include and import elements. Instead, the property of the is used. -- The method of the has the ability to use the target namespace defined in a schema, rather than requiring the target namespace be specified as a parameter when the method is called. Specifying `null` or to the method instructs the to use the target namespace defined in the schema. For an example of this behavior, see the method. +- The method of the has the ability to use the target namespace defined in a schema, rather than requiring the target namespace be specified as a parameter when the method is called. Specifying `null` or to the method instructs the to use the target namespace defined in the schema. For an example of this behavior, see the method. - The remaining functionality of this method is identical to that of the method. + The remaining functionality of this method is identical to that of the method. @@ -684,10 +684,10 @@ schemaSet.Add("http://www.contoso.com/books", new XmlTextReader("books.xsd"); ## Remarks This method is called automatically when validation is needed and the has not been previously compiled - for example, when an is used as an input to create an object in the property of an object. If the is already in the compiled state, this method will not recompile the schemas. If this method executes successfully, the property is set to `true`. - Schemas that have been previously compiled by an are not recompiled. However, schemas that were compiled using the method of the will be recompiled. + Schemas that have been previously compiled by an are not recompiled. However, schemas that were compiled using the method of the will be recompiled. > [!NOTE] -> You need to call the method if you have changed a schema (or one of its includes/imports) after adding it to the . The method will check the schema for structural validity according to the rules of W3C XML Schema. However, it will not perform a full validation check. It will also resolve references to internal and external schema components. Any imported or included schemas that are successfully retrieved are also added to the . Imported schemas are added as separate objects while included schemas are made part of the including . If the call to reprocess is successful, the property is set to false. +> You need to call the method if you have changed a schema (or one of its includes/imports) after adding it to the . The method will check the schema for structural validity according to the rules of W3C XML Schema. However, it will not perform a full validation check. It will also resolve references to internal and external schema components. Any imported or included schemas that are successfully retrieved are also added to the . Imported schemas are added as separate objects while included schemas are made part of the including . If the call to reprocess is successful, the property is set to false. @@ -768,7 +768,7 @@ schemaSet.Compile(); are detected by the method; for example, imported schemas. As a result, if a schema for the `http://www.contoso.com/retail` namespace that imports a schema for the `http://www.contoso.com/books` namespace is added to the , calling with `http://www.contoso.com/books` as a parameter, it returns `true`. + Schemas that are indirectly added to the are detected by the method; for example, imported schemas. As a result, if a schema for the `http://www.contoso.com/retail` namespace that imports a schema for the `http://www.contoso.com/books` namespace is added to the , calling with `http://www.contoso.com/books` as a parameter, it returns `true`. ]]> @@ -1135,7 +1135,7 @@ schemaSet.CopyTo(schemas, 0); ## Examples - For an example of the property, see the method. + For an example of the property, see the method. ]]> @@ -1255,7 +1255,7 @@ schemaSet.CopyTo(schemas, 0); ## Examples - The following example illustrates adding multiple schemas to an , then removing one of the schemas using the method. + The following example illustrates adding multiple schemas to an , then removing one of the schemas using the method. ```vb Dim schemaSet As XmlSchemaSet = New XmlSchemaSet() @@ -1342,9 +1342,9 @@ foreach (XmlSchema schema in schemaSet.Schemas()) method removes the specified schema and all the schemas it imports from the , as long as there are no dependencies on the schema or its imported schemas. If there are dependencies on the schema or its imported schemas in the , nothing is removed and returns `false`. If `false` is returned and a is defined, a warning is sent to the event handler describing the dependencies. + The method removes the specified schema and all the schemas it imports from the , as long as there are no dependencies on the schema or its imported schemas. If there are dependencies on the schema or its imported schemas in the , nothing is removed and returns `false`. If `false` is returned and a is defined, a warning is sent to the event handler describing the dependencies. - If the specified schema imports other schemas and the specified schema was previously removed with the method, the method will not remove the imported schemas and will return `false`. For example, if `parentSchema` imports `childSchema1` and `childSchema2` the following code will only remove `parentSchema`, but not the imported `childSchema1` and `childSchema2` schemas: + If the specified schema imports other schemas and the specified schema was previously removed with the method, the method will not remove the imported schemas and will return `false`. For example, if `parentSchema` imports `childSchema1` and `childSchema2` the following code will only remove `parentSchema`, but not the imported `childSchema1` and `childSchema2` schemas: ```csharp XmlSchemaSet ss = new XmlSchemaSet(); @@ -1368,12 +1368,12 @@ ss.RemoveRecursive(xs); ss.Compile(); ``` - The method has no effect on the state of the property. + The method has no effect on the state of the property. ## Examples - The following code example illustrates adding multiple schemas to an , then removing one of the schemas and all the schemas it imports using the method. + The following code example illustrates adding multiple schemas to an , then removing one of the schemas and all the schemas it imports using the method. ```vb Dim schemaSet As XmlSchemaSet = New XmlSchemaSet() @@ -1458,17 +1458,17 @@ foreach (XmlSchema schema in schemaSet.Schemas()) method is called. If the call to is successful, the property is set to `false`. + Reprocessing a schema performs all the preprocessing steps performed on a schema when the method is called. If the call to is successful, the property is set to `false`. The Reprocess method should be used after a schema in the has been modified, after the has performed compilation. > [!NOTE] -> You need to call the method if you have changed a schema (or one of its includes/imports) after adding it to the . The method will check the schema for structural validity according to the rules of W3C XML Schema. However, it will not perform a full validation check. It will also resolve references to internal and external schema components. Any imported or included schemas that are successfully retrieved are also added to the . Imported schemas are added as separate objects while included schemas are made part of the including . If the call to reprocess is successful, the property is set to false. +> You need to call the method if you have changed a schema (or one of its includes/imports) after adding it to the . The method will check the schema for structural validity according to the rules of W3C XML Schema. However, it will not perform a full validation check. It will also resolve references to internal and external schema components. Any imported or included schemas that are successfully retrieved are also added to the . Imported schemas are added as separate objects while included schemas are made part of the including . If the call to reprocess is successful, the property is set to false. ## Examples - The following example illustrates reprocessing a schema added to the . After the is compiled using the method, and the schema added to the is modified, the property will be set to `true`, even though a schema in the has been modified. Calling the method performs all the preprocessing performed by the method and sets the property to `false`. + The following example illustrates reprocessing a schema added to the . After the is compiled using the method, and the schema added to the is modified, the property will be set to `true`, even though a schema in the has been modified. Calling the method performs all the preprocessing performed by the method and sets the property to `false`. ```vb Dim schemaSet As XmlSchemaSet = New XmlSchemaSet() @@ -1559,7 +1559,7 @@ schemaSet.Reprocess(schema); This method returns schemas that were added indirectly to the because they were imported. > [!NOTE] -> The method is the equivalent of the method of the obsolete . +> The method is the equivalent of the method of the obsolete . @@ -1652,7 +1652,7 @@ foreach (XmlSchema schema in schemaSet.Schemas()) This method returns schemas that were added indirectly to the because they were imported. > [!NOTE] -> The method is the equivalent of the method of the obsolete . +> The method is the equivalent of the method of the obsolete . @@ -1726,7 +1726,7 @@ foreach (XmlSchema schema in schemaSet.Schemas("http://www.contoso.com/books")) or methods of the are called. + Sets an event handler for receiving information about schema validation errors when the or methods of the are called. If an event handler is not defined, an is thrown on any validation errors where the is . Exceptions are not thrown for validation errors with an of . @@ -1799,7 +1799,7 @@ foreach (XmlSchema schema in schemaSet.Schemas("http://www.contoso.com/books")) of an is used to resolve namespaces or locations referenced in include and import elements of a schema, any time a schema is added using the or methods. + The of an is used to resolve namespaces or locations referenced in include and import elements of a schema, any time a schema is added using the or methods. > [!IMPORTANT] > External namespaces or locations referenced in include, import, and redefine elements of a schema are resolved with respect to the base URI of the schema that includes or imports them. For example, if the base URI of the including or importing schema is empty or `null`, the external locations are resolved with respect to the current directory. The class is used to resolve external schemas by default. To disable resolution of include, import, and redefine elements of a schema, set the property to `null`. diff --git a/xml/System.Xml.Schema/XmlSchemaType.xml b/xml/System.Xml.Schema/XmlSchemaType.xml index e449e4daee8..b075139e68c 100644 --- a/xml/System.Xml.Schema/XmlSchemaType.xml +++ b/xml/System.Xml.Schema/XmlSchemaType.xml @@ -805,7 +805,7 @@ method. + The following is an example of the method. ```csharp XmlSchemaType xsdInteger = XmlSchemaType.GetBuiltInSimpleType(XmlTypeCode.Integer); diff --git a/xml/System.Xml.Schema/XmlSchemaValidator.xml b/xml/System.Xml.Schema/XmlSchemaValidator.xml index 1e05654b4e5..3cc6b5af9b1 100644 --- a/xml/System.Xml.Schema/XmlSchemaValidator.xml +++ b/xml/System.Xml.Schema/XmlSchemaValidator.xml @@ -135,11 +135,11 @@ constructor. + The following are important notes to consider when using the constructor. - The contents of the parameter are copied into an internal object when the or the validation options are set. As a result, changes to the input object during validation do not affect the outcome of validation. -- If the parameter specified is not compiled, its method is called. +- If the parameter specified is not compiled, its method is called. - The parameter is especially important for validating `xs:QName` types. The class does not copy the in-scope namespaces from the object but instead holds a reference to it. This allows new namespaces to be added to the object during the validation process. @@ -149,7 +149,7 @@ ## Examples - For an example of the constructor, see the class reference topic. + For an example of the constructor, see the class reference topic. ]]> @@ -206,13 +206,13 @@ method. + The following are important notes to consider when using the method. -- The method can be used to simulate the effect of encountering an inline XML schema in the XML document being validated. +- The method can be used to simulate the effect of encountering an inline XML schema in the XML document being validated. - The target namespace of the parameter cannot match that of any element or attribute already encountered by the object. -- If the validation option is not set, the method does nothing. +- If the validation option is not set, the method does nothing. ]]> @@ -266,7 +266,7 @@ method ends validation and checks identity constraints for the entire XML document if the validation option is set. + The method ends validation and checks identity constraints for the entire XML document if the validation option is set. ]]> @@ -318,11 +318,11 @@ method. + The following are important notes to consider when using the method. -- If the method is called immediately after the method, all the attributes that could appear in the XML document are returned. +- If the method is called immediately after the method, all the attributes that could appear in the XML document are returned. -- If the method is called after one or more calls to the method, the attributes that haven't yet been validated for the current element are returned. +- If the method is called after one or more calls to the method, the attributes that haven't yet been validated for the current element are returned. ]]> @@ -372,11 +372,11 @@ method are instances of the and classes. + The valid particles that can be returned by the method are instances of the and classes. When the compositor for the content model is an `xs:sequence`, only the next particle in the sequence is returned. If the compositor for the content model is an `xs:all` or an `xs:choice`, then all valid particles that could follow in the current element context are returned. - For example, in the XML Schema Definition Language (XSD) schema and XML document that follow, after validating the `book` element, the `book` element is the current element context. The method returns an array containing a single object representing the `title` element. When the validation context is the `title` element, the method returns an empty array. If the method is called after the `title` element has been validated but before the `description` element has been validated, it returns an array containing a single object representing the `description` element. If the method is called after the `description` element has been validated then it returns an array containing a single object representing the wildcard. + For example, in the XML Schema Definition Language (XSD) schema and XML document that follow, after validating the `book` element, the `book` element is the current element context. The method returns an array containing a single object representing the `title` element. When the validation context is the `title` element, the method returns an empty array. If the method is called after the `title` element has been validated but before the `description` element has been validated, it returns an array containing a single object representing the `description` element. If the method is called after the `description` element has been validated then it returns an array containing a single object representing the wildcard. ```vb Dim reader As XmlReader = XmlReader.Create("input.xml") @@ -563,7 +563,7 @@ validator.ValidateEndElement(null); method must be called after validating all the attributes for the current element with the method. The method should be used to determine what default attributes are to be inserted into the XML document being validated. + The method must be called after validating all the attributes for the current element with the method. The method should be used to determine what default attributes are to be inserted into the XML document being validated. ]]> @@ -623,7 +623,7 @@ validator.ValidateEndElement(null); method is only valid if called immediately after the construction of an object or after a call to . + The method is only valid if called immediately after the construction of an object or after a call to . @@ -692,12 +692,12 @@ validator.ValidateEndElement(null); method that takes an as a parameter initializes an object to its starting state for partial validation. + The method that takes an as a parameter initializes an object to its starting state for partial validation. ## Examples - In the following example, an is initialized for partial validation using the method. The `orderNumber` schema element is passed by selecting the schema element by in the collection returned by the property of the object. The object then validates this specific element. + In the following example, an is initialized for partial validation using the method. The `orderNumber` schema element is passed by selecting the schema element by in the collection returned by the property of the object. The object then validates this specific element. ```vb Dim schemaSet As XmlSchemaSet = New XmlSchemaSet() @@ -857,9 +857,9 @@ validator.ValidateEndElement(null); method. + The following are important notes to consider when using the method. -- The method skips validation of the current element content and prepares the object to validate content in the parent element's context; it is equivalent to skipping validation for all the children of the current element and then calling the method. +- The method skips validation of the current element content and prepares the object to validate content in the parent element's context; it is equivalent to skipping validation for all the children of the current element and then calling the method. - If the current element content is successfully skipped, the object's (if specified) property is set to . @@ -1011,11 +1011,11 @@ validator.ValidateEndElement(null); method. + The following are important notes to consider when using the method. -- The method must be called after validating all the attributes for the current element with the method. +- The method must be called after validating all the attributes for the current element with the method. -- If an object was passed to the method, the method validates the attribute against the object. +- If an object was passed to the method, the method validates the attribute against the object. - If the attribute is successfully validated in the current element context, the object's (if specified) , , , and properties are set with the results of the validation. @@ -1109,11 +1109,11 @@ validator.ValidateEndElement(null); method. + The following are important notes to consider when using the method. -- The method must be called after validating all the attributes for the current element with the method. +- The method must be called after validating all the attributes for the current element with the method. -- If an object was passed to the method, the method validates the attribute against the object. +- If an object was passed to the method, the method validates the attribute against the object. - If the attribute is successfully validated in the current element context, the object's (if specified) , , , and properties are set with the results of the validation. @@ -1215,7 +1215,7 @@ validator.ValidateEndElement(null); method. + The following are important notes to consider when using the method. - If the element name is successfully validated in the current context, the object's (if specified) , , , and properties are set with the results of the validation. @@ -1317,13 +1317,13 @@ validator.ValidateEndElement(null); method. + The following are important notes to consider when using the method. - If the element name is successfully validated in the current context, the object's (if specified) , , , and properties are set with the results of the validation. - If the element name or any of its attributes are invalid in the current context, the property is set to ; otherwise the property is set to . -- If the value was not passed as a parameter to the constructor, `xsi:SchemaLocation` and `xsi:NoNamespaceSchemaLocation` attribute values are ignored. +- If the value was not passed as a parameter to the constructor, `xsi:SchemaLocation` and `xsi:NoNamespaceSchemaLocation` attribute values are ignored. ]]> @@ -1397,15 +1397,15 @@ validator.ValidateEndElement(null); method. + The following are important notes to consider when using the method. -- For elements with simple content, the method verifies that the text content of the element is valid according to its data type and returns the parsed typed value. The text content of the element is obtained from the results of previous calls to . +- For elements with simple content, the method verifies that the text content of the element is valid according to its data type and returns the parsed typed value. The text content of the element is obtained from the results of previous calls to . -- For elements with complex content, the method verifies if the content of the current element is complete. +- For elements with complex content, the method verifies if the content of the current element is complete. -- If the element has a default value, the value returned from the method is the default value for the element. +- If the element has a default value, the value returned from the method is the default value for the element. -- If the object was constructed with the value as a parameter, the method checks the identity constraint rules (if any) that apply to the element. +- If the object was constructed with the value as a parameter, the method checks the identity constraint rules (if any) that apply to the element. - If the element is successfully validated in the current context, the object's (if specified) , , and properties are set with the results of the validation. @@ -1474,17 +1474,17 @@ validator.ValidateEndElement(null); ## Remarks > [!IMPORTANT] -> If you are validating against the `xs:key`, `xs:keyref`, or `xs:unique` identity constraints, do not use the method overload. Instead, call the method and pass it the value of the element. Then call the method overload, which takes as an argument, to verify that the text content of the element is valid according to its data type. +> If you are validating against the `xs:key`, `xs:keyref`, or `xs:unique` identity constraints, do not use the method overload. Instead, call the method and pass it the value of the element. Then call the method overload, which takes as an argument, to verify that the text content of the element is valid according to its data type. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. -- For elements with simple content, the method verifies that the text content of the element is valid according to its data type and returns the parsed typed value. The text content of the element is obtained from the typed content passed as a parameter. +- For elements with simple content, the method verifies that the text content of the element is valid according to its data type and returns the parsed typed value. The text content of the element is obtained from the typed content passed as a parameter. -- If calls to the method have been previously made, an is thrown. +- If calls to the method have been previously made, an is thrown. - If the element has complex content an is thrown. -- If the object was constructed with the value as a parameter, the method checks the identity constraint rules (if any) that apply to the element. +- If the object was constructed with the value as a parameter, the method checks the identity constraint rules (if any) that apply to the element. - If the element is successfully validated in the current context, the object's (if specified) , , and properties are set with the results of the validation. @@ -1558,11 +1558,11 @@ validator.ValidateEndElement(null); method. + The following are important notes to consider when using the method. -- The method should always be called before . +- The method should always be called before . -- The method must be called before proceeding with validation of an element's content. +- The method must be called before proceeding with validation of an element's content. - If all the required attributes in the element context are present, the object's (if specified) property is set to . @@ -1645,9 +1645,9 @@ validator.ValidateEndElement(null); method. + The following are important notes to consider when using the method. -- If the element has simple content, the text `string` specified is concatenated on each call to the method until the method is called. When the method is called, all the text is validated. +- If the element has simple content, the text `string` specified is concatenated on each call to the method until the method is called. When the method is called, all the text is validated. - If the element has complex content, no text concatenation occurs. @@ -1703,9 +1703,9 @@ validator.ValidateEndElement(null); method. + The following are important notes to consider when using the method. -- If the element has simple content, the text `string` specified is concatenated on each call to the method until the method is called. When the method is called, all the text is validated. +- If the element has simple content, the text `string` specified is concatenated on each call to the method until the method is called. When the method is called, all the text is validated. - If the element has complex content, no text concatenation occurs. diff --git a/xml/System.Xml.Serialization.Advanced/SchemaImporterExtension.xml b/xml/System.Xml.Serialization.Advanced/SchemaImporterExtension.xml index d49f11895d2..1d48a567669 100644 --- a/xml/System.Xml.Serialization.Advanced/SchemaImporterExtension.xml +++ b/xml/System.Xml.Serialization.Advanced/SchemaImporterExtension.xml @@ -17,38 +17,38 @@ Allows you to customize the code generated from a Web Services Description Language (WSDL) document when using automated query tools. - class allows you to modify the code generated when using any of these tools. For example, you may have an existing class that processes book orders on a system and you have an existing XSD document that supplies your orders. Using the class, you can enable one of the tools to generate code that uses your class. - - In order to control the generation of the code, you must use the classes found in the namespace. For more information, see [Using the CodeDOM](/dotnet/framework/reflection-and-codedom/using-the-codedom) and [CodeDOM Quick Reference](https://msdn.microsoft.com/library/c77b8bfd-0a32-4e36-b59a-4f687f32c524(v=vs.100).aspx). - - The steps to enabling the WSDL.exe tool (which in turn is used by other tools such as the Add Web Reference dialog box) to use your extension are: - -1. Create an implementation of the class. - -2. Use the method to write code for the code generator. The method contains parameters that allow you to examine the intercepted XSD type and create CodeDOM objects that are used to generate the new CLR code. - -3. If required, use the method to handle \ elements found in the XSD document. - -4. If required, use the method to examine default values found in the XSD document and return a different default value. - -5. Compile your extension into a library. - -6. Sign the assembly. - -7. Install the assembly in the Global Assembly Cache (GAC). - -8. Modify the machine.config file to include the extension. - - - -## Examples - See the [SchemaImporterExtension Technology Sample](/dotnet/standard/serialization/schemaimporterextension-technology-sample). Note that this example does not include a signed assembly. Instead, it demonstrates how to use the with a command window. - + class allows you to modify the code generated when using any of these tools. For example, you may have an existing class that processes book orders on a system and you have an existing XSD document that supplies your orders. Using the class, you can enable one of the tools to generate code that uses your class. + + In order to control the generation of the code, you must use the classes found in the namespace. For more information, see [Using the CodeDOM](/dotnet/framework/reflection-and-codedom/using-the-codedom) and [CodeDOM Quick Reference](https://msdn.microsoft.com/library/c77b8bfd-0a32-4e36-b59a-4f687f32c524(v=vs.100).aspx). + + The steps to enabling the WSDL.exe tool (which in turn is used by other tools such as the Add Web Reference dialog box) to use your extension are: + +1. Create an implementation of the class. + +2. Use the method to write code for the code generator. The method contains parameters that allow you to examine the intercepted XSD type and create CodeDOM objects that are used to generate the new CLR code. + +3. If required, use the method to handle \ elements found in the XSD document. + +4. If required, use the method to examine default values found in the XSD document and return a different default value. + +5. Compile your extension into a library. + +6. Sign the assembly. + +7. Install the assembly in the Global Assembly Cache (GAC). + +8. Modify the machine.config file to include the extension. + + + +## Examples + See the [SchemaImporterExtension Technology Sample](/dotnet/standard/serialization/schemaimporterextension-technology-sample). Note that this example does not include a signed assembly. Instead, it demonstrates how to use the with a command window. + ]]> @@ -116,11 +116,11 @@ Handles the importation of the <xsd:any> elements in the schema. The name of the CLR type that the element maps to. - namespace. For more information, see [Using the CodeDOM](/dotnet/framework/reflection-and-codedom/using-the-codedom) and [CodeDOM Quick Reference](https://msdn.microsoft.com/library/c77b8bfd-0a32-4e36-b59a-4f687f32c524(v=vs.100).aspx). - + namespace. For more information, see [Using the CodeDOM](/dotnet/framework/reflection-and-codedom/using-the-codedom) and [CodeDOM Quick Reference](https://msdn.microsoft.com/library/c77b8bfd-0a32-4e36-b59a-4f687f32c524(v=vs.100).aspx). + ]]> @@ -151,11 +151,11 @@ Allows you to specify the default value for the XSD type being imported. A setting the new default value. - namespace. For more information, see [Using the CodeDOM](/dotnet/framework/reflection-and-codedom/using-the-codedom) and [CodeDOM Quick Reference](https://msdn.microsoft.com/library/c77b8bfd-0a32-4e36-b59a-4f687f32c524(v=vs.100).aspx). - + namespace. For more information, see [Using the CodeDOM](/dotnet/framework/reflection-and-codedom/using-the-codedom) and [CodeDOM Quick Reference](https://msdn.microsoft.com/library/c77b8bfd-0a32-4e36-b59a-4f687f32c524(v=vs.100).aspx). + ]]> @@ -168,14 +168,14 @@ Allows you to manipulate the code generated by examining the imported schema and specifying the CLR type that it maps to. - method. The code checks the namespace and name. When the right values are found, it adds the name of a custom assembly ("Order.dll") that must be referenced in the generated code. It then adds a new namespace ("Microsoft.Samples") that is generated in the code. - + method. The code checks the namespace and name. When the right values are found, it adds the name of a custom assembly ("Order.dll") that must be referenced in the generated code. It then adds a new namespace ("Microsoft.Samples") that is generated in the code. + :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization.Advanced/SchemaImporterExtension/ImportSchemaType/SchemaImporterExtensionExample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization.Advanced/SchemaImporterExtension/ImportSchemaType/SchemaImporterExtensionExample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization.Advanced/SchemaImporterExtension/ImportSchemaType/SchemaImporterExtensionExample.vb" id="Snippet1"::: + ]]> @@ -218,14 +218,14 @@ Allows you to manipulate the code generated by examining the imported schema and specifying the CLR type that it maps to. The name of the CLR type that this maps to. - method. The code checks the namespace and name. When the right values are found, it adds the name of a custom assembly ("Order.dll") that must be referenced in the generated code. It then adds a new namespace ("Microsoft.Samples") that is generated in the code. - + method. The code checks the namespace and name. When the right values are found, it adds the name of a custom assembly ("Order.dll") that must be referenced in the generated code. It then adds a new namespace ("Microsoft.Samples") that is generated in the code. + :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization.Advanced/SchemaImporterExtension/ImportSchemaType/SchemaImporterExtensionExample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization.Advanced/SchemaImporterExtension/ImportSchemaType/SchemaImporterExtensionExample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization.Advanced/SchemaImporterExtension/ImportSchemaType/SchemaImporterExtensionExample.vb" id="Snippet1"::: + ]]> @@ -270,19 +270,19 @@ Allows you to manipulate the code generated by examining the imported schema and specifying the CLR type that it maps to. The name of the CLR type that this maps to. - namespace. For more information, see [Using the CodeDOM](/dotnet/framework/reflection-and-codedom/using-the-codedom) and [CodeDOM Quick Reference](https://msdn.microsoft.com/library/c77b8bfd-0a32-4e36-b59a-4f687f32c524(v=vs.100).aspx). - - - -## Examples - The example below shows a simple implementation of the method. The code checks the namespace and name. When the right values are found, it adds the name of a custom assembly ("Order.dll") that must be referenced in the generated code. It then adds a new namespace ("Microsoft.Samples") that is generated in the code. - + namespace. For more information, see [Using the CodeDOM](/dotnet/framework/reflection-and-codedom/using-the-codedom) and [CodeDOM Quick Reference](https://msdn.microsoft.com/library/c77b8bfd-0a32-4e36-b59a-4f687f32c524(v=vs.100).aspx). + + + +## Examples + The example below shows a simple implementation of the method. The code checks the namespace and name. When the right values are found, it adds the name of a custom assembly ("Order.dll") that must be referenced in the generated code. It then adds a new namespace ("Microsoft.Samples") that is generated in the code. + :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization.Advanced/SchemaImporterExtension/ImportSchemaType/SchemaImporterExtensionExample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization.Advanced/SchemaImporterExtension/ImportSchemaType/SchemaImporterExtensionExample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization.Advanced/SchemaImporterExtension/ImportSchemaType/SchemaImporterExtensionExample.vb" id="Snippet1"::: + ]]> diff --git a/xml/System.Xml.Serialization/CodeIdentifier.xml b/xml/System.Xml.Serialization/CodeIdentifier.xml index 2cb0a1da54a..9302c4dd759 100644 --- a/xml/System.Xml.Serialization/CodeIdentifier.xml +++ b/xml/System.Xml.Serialization/CodeIdentifier.xml @@ -162,7 +162,7 @@ method converts the initial character from an upper-case to lower-case letter, if necessary. + The method converts the initial character from an upper-case to lower-case letter, if necessary. You do not need to call this method directly. @@ -218,7 +218,7 @@ method converts the initial character from a lower-case to upper-case letter, if necessary. + The method converts the initial character from a lower-case to upper-case letter, if necessary. You do not need to call this method directly. @@ -274,7 +274,7 @@ method removes any characters that cannot appear in a code identifier. It returns the string "Item" if no characters are valid. It prefixes the string "Item" to an input that begins with an invalid start character, for example, a digit, or a currency symbol. + The method removes any characters that cannot appear in a code identifier. It returns the string "Item" if no characters are valid. It prefixes the string "Item" to an input that begins with an invalid start character, for example, a digit, or a currency symbol. You do not need to call this method directly. diff --git a/xml/System.Xml.Serialization/CodeIdentifiers.xml b/xml/System.Xml.Serialization/CodeIdentifiers.xml index 34e52b91f1c..c9e4b6d84eb 100644 --- a/xml/System.Xml.Serialization/CodeIdentifiers.xml +++ b/xml/System.Xml.Serialization/CodeIdentifiers.xml @@ -224,7 +224,7 @@ method, the method does not prevent naming collisions. + Unlike the method, the method does not prevent naming collisions. If you want to control the names of code entities that are bound to XML Schema or Web service definitions, use the associated attributes rather than creating an instance of the class. For a complete list, see [Attributes That Control XML Serialization](/dotnet/standard/serialization/attributes-that-control-xml-serialization). @@ -343,7 +343,7 @@ instance's scope, a new, unique string is generated and used in its place. The new string is generated by appending to the input name. The original name is not unique if it was passed previously to the , , or method, or if it was generated by a previous call to the method. In each case, if the new identifier is not unique, it is first passed to the method to create a new unique identifier. + If the identifier parameter value is not unique within the instance's scope, a new, unique string is generated and used in its place. The new string is generated by appending to the input name. The original name is not unique if it was passed previously to the , , or method, or if it was generated by a previous call to the method. In each case, if the new identifier is not unique, it is first passed to the method to create a new unique identifier. If you want to control the names of code entities that are bound to XML Schema or Web service definitions, use the associated attributes rather than creating an instance of the class. For a complete list, see [Attributes That Control XML Serialization](/dotnet/standard/serialization/attributes-that-control-xml-serialization). @@ -395,7 +395,7 @@ method, are not removed. + Reserved names, as added through the method, are not removed. If you want to control the names of code entities that are bound to XML Schema or Web service definitions, use the associated attributes rather than creating an instance of the class. For a complete list, see [Attributes That Control XML Serialization](/dotnet/standard/serialization/attributes-that-control-xml-serialization). @@ -452,7 +452,7 @@ , , or method, or if it was generated by the method. + The input name is not unique if it was passed previously to the , , or method, or if it was generated by the method. If you want to control the names of code entities that are bound to XML Schema or Web service definitions, use the associated attributes rather than creating an instance of the class. For a complete list, see [Attributes That Control XML Serialization](/dotnet/standard/serialization/attributes-that-control-xml-serialization). @@ -562,7 +562,7 @@ , , or method, or if it was generated by the method. If the name is not unique, a new string is generated by appending to the original string. + The input name is not unique if it was passed previously to the , , or method, or if it was generated by the method. If the name is not unique, a new string is generated by appending to the original string. If you want to control the names of code entities that are bound to XML Schema or Web service definitions, use the associated attributes rather than creating an instance of the class. For a complete list, see [Attributes That Control XML Serialization](/dotnet/standard/serialization/attributes-that-control-xml-serialization). diff --git a/xml/System.Xml.Serialization/IXmlSerializable.xml b/xml/System.Xml.Serialization/IXmlSerializable.xml index f19ffe5d502..cb4b5997987 100644 --- a/xml/System.Xml.Serialization/IXmlSerializable.xml +++ b/xml/System.Xml.Serialization/IXmlSerializable.xml @@ -69,7 +69,7 @@ . For example, you can chunk data into bytes instead of buffering large data sets, and also avoid the inflation that occurs when the data is encoded using Base64 encoding. To control the serialization, implement the and methods to control the and classes used to read and write the XML. For an example of this, see [How to: Chunk Serialized Data](/dotnet/standard/serialization/how-to-chunk-serialized-data). + There are two reasons to implement this interface. The first is to control how your object is serialized or deserialized by the . For example, you can chunk data into bytes instead of buffering large data sets, and also avoid the inflation that occurs when the data is encoded using Base64 encoding. To control the serialization, implement the and methods to control the and classes used to read and write the XML. For an example of this, see [How to: Chunk Serialized Data](/dotnet/standard/serialization/how-to-chunk-serialized-data). The second reason is to be able to control the schema. To enable this, you must apply the to the serializable type, and specify the name of the static member that returns the schema. See the for an example. @@ -150,7 +150,7 @@ If providing schema information is necessary, you should use the attribute. The `GetSchema` method should still return `null` (or `Nothing`). - Some .NET types as well as legacy custom types implementing the `IXmlSerializable` interface may be using `GetSchema` instead of `XmlSchemaProvider`. In this case, the method returns an accurate XML schema that describes the XML representation of the object generated by the method. + Some .NET types as well as legacy custom types implementing the `IXmlSerializable` interface may be using `GetSchema` instead of `XmlSchemaProvider`. In this case, the method returns an accurate XML schema that describes the XML representation of the object generated by the method. ]]> @@ -210,16 +210,16 @@ method must reconstitute your object using the information that was written by the method. + The method must reconstitute your object using the information that was written by the method. - When this method is called, the reader is positioned on the start tag that wraps the information for your type. That is, directly on the start tag that indicates the beginning of a serialized object. When this method returns, it must have read the entire element from beginning to end, including all of its contents. Unlike the method, the framework does not handle the wrapper element automatically. Your implementation must do so. Failing to observe these positioning rules may cause code to generate unexpected runtime exceptions or corrupt data. + When this method is called, the reader is positioned on the start tag that wraps the information for your type. That is, directly on the start tag that indicates the beginning of a serialized object. When this method returns, it must have read the entire element from beginning to end, including all of its contents. Unlike the method, the framework does not handle the wrapper element automatically. Your implementation must do so. Failing to observe these positioning rules may cause code to generate unexpected runtime exceptions or corrupt data. When implementing this method, you should consider the possibility that a malicious user might provide a well-formed but invalid XML representation in order to disable or otherwise alter the behavior of your application. ## Examples - The following example illustrates an implementation of the method. + The following example illustrates an implementation of the method. :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/IXmlSerializable/Overview/person.cs" id="Snippet2"::: @@ -285,16 +285,16 @@ implementation you provide should write out the XML representation of the object. The framework writes a wrapper element and positions the XML writer after its start. Your implementation may write its contents, including child elements. The framework then closes the wrapper element. + The implementation you provide should write out the XML representation of the object. The framework writes a wrapper element and positions the XML writer after its start. Your implementation may write its contents, including child elements. The framework then closes the wrapper element. - Write sufficient information to the stream to allow the method to reconstitute your object. + Write sufficient information to the stream to allow the method to reconstitute your object. For example, if your object state includes an array variable, be sure to write the length of the array, or use a parent element to contain the elements that describe the array values, so that you know how many values to read when the object is reconstituted. ## Examples - The following example illustrates an implementation of the method. + The following example illustrates an implementation of the method. :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/IXmlSerializable/Overview/person.cs" id="Snippet1"::: diff --git a/xml/System.Xml.Serialization/SoapAttributeAttribute.xml b/xml/System.Xml.Serialization/SoapAttributeAttribute.xml index 6e3cfefb3ab..ee34c87735e 100644 --- a/xml/System.Xml.Serialization/SoapAttributeAttribute.xml +++ b/xml/System.Xml.Serialization/SoapAttributeAttribute.xml @@ -61,7 +61,7 @@ ## Remarks The class belongs to a family of attributes that controls how the serializes, or deserializes, an object as encoded SOAP XML. The resulting XML conforms to section 5 of the World Wide Web Consortium document, [Simple Object Access Protocol (SOAP) 1.1](https://www.w3.org/TR/2000/NOTE-SOAP-20000508/). For a complete list of similar attributes, see [Attributes That Control Encoded SOAP Serialization](/dotnet/standard/serialization/attributes-that-control-encoded-soap-serialization). - To serialize an object as an encoded SOAP message, you must construct the using an created with the method of the class. + To serialize an object as an encoded SOAP message, you must construct the using an created with the method of the class. Apply the to a public field to specify that the serializes the field as an XML attribute. You can specify an alternative name of the attribute by setting the property. Set the if the attribute must be given a specific XML Schema definition language (XSD) data type. If the attribute belongs to a specific XML namespace, set the property. diff --git a/xml/System.Xml.Serialization/SoapAttributeOverrides.xml b/xml/System.Xml.Serialization/SoapAttributeOverrides.xml index 73226f024f4..bf18001ec99 100644 --- a/xml/System.Xml.Serialization/SoapAttributeOverrides.xml +++ b/xml/System.Xml.Serialization/SoapAttributeOverrides.xml @@ -57,7 +57,7 @@ ## Remarks The class enables an to override the default way of serializing a set of objects. Overriding serialization in this way has two uses: first, you can control and augment the serialization of objects found in a DLL, even if you do not have access to the source; second, you can create one set of serializable classes, but serialize the objects in multiple ways. For example, instead of serializing members of a class instance as XML elements, you can serialize them as XML attributes, resulting in a more efficient document to transport. - After you create a , you create an using the method of the class. Pass the resulting object as an argument to the constructor. The resulting uses the data contained by the to override attributes that control how objects are serialized. To accomplish this, the contains a collection of the object types that are overridden, as well as a associated with each overridden object type. Each contains an appropriate set of attribute objects that control how each field, property, or class is serialized. + After you create a , you create an using the method of the class. Pass the resulting object as an argument to the constructor. The resulting uses the data contained by the to override attributes that control how objects are serialized. To accomplish this, the contains a collection of the object types that are overridden, as well as a associated with each overridden object type. Each contains an appropriate set of attribute objects that control how each field, property, or class is serialized. The process for creating and using a is as follows: @@ -69,11 +69,11 @@ 4. Create a . -5. Add the to the using the method. If the object being overridden is a , you need only specify the type of the overridden object. But if you are overriding a field or property, you must also specify the name of the overridden member. +5. Add the to the using the method. If the object being overridden is a , you need only specify the type of the overridden object. But if you are overriding a field or property, you must also specify the name of the overridden member. -6. Create an using the method of the class. +6. Create an using the method of the class. -7. When constructing the , pass the to the constructor. +7. When constructing the , pass the to the constructor. 8. Use the resulting to serialize or deserialize the class objects. @@ -208,7 +208,7 @@ contains a union of attribute objects that cause the to override its default serialization behavior for a set of objects. You choose the attribute objects to place in the , depending on the particular behaviors you want to override. For example, the serializes a class member as an XML element by default. If you want the member to be serialized as an XML attribute instead, you would create a , assign it to the property of a , and add the to the . Use the method to add the to the . + The contains a union of attribute objects that cause the to override its default serialization behavior for a set of objects. You choose the attribute objects to place in the , depending on the particular behaviors you want to override. For example, the serializes a class member as an XML element by default. If you want the member to be serialized as an XML attribute instead, you would create a , assign it to the property of a , and add the to the . Use the method to add the to the . Use this overload to add a that contains a . Because the overrides the serialization of a class, you need not specify a member of the class to override, only the type of the class. @@ -282,7 +282,7 @@ contains a union of attribute objects that cause the to override its default serialization behavior for a set of objects. You choose the attribute objects to place in the , depending on the particular behaviors you want to override. For example, the serializes a class member as an XML element by default. If you want the member to be serialized as a SOAP attribute instead, you would create a , assign it to the property of a , and add the to the . Use the method to add the to the . + The contains a union of attribute objects that cause the to override its default serialization behavior for a set of objects. You choose the attribute objects to place in the , depending on the particular behaviors you want to override. For example, the serializes a class member as an XML element by default. If you want the member to be serialized as a SOAP attribute instead, you would create a , assign it to the property of a , and add the to the . Use the method to add the to the . Use this method when the contains either a , , , or . diff --git a/xml/System.Xml.Serialization/SoapAttributes.xml b/xml/System.Xml.Serialization/SoapAttributes.xml index 129f1e89216..71fe4255b82 100644 --- a/xml/System.Xml.Serialization/SoapAttributes.xml +++ b/xml/System.Xml.Serialization/SoapAttributes.xml @@ -536,7 +536,7 @@ ## Remarks By default, all public fields and public read/write properties are serialized by the . That is, the value of each public field or property is persisted as an XML element or XML attribute in an XML document. - To override the default serialization of a field or property, create a , and set its property to `true`. Use the method to add the object to a and specify the type of the object that contains the field or property to ignore and the name of the field or property to ignore. + To override the default serialization of a field or property, create a , and set its property to `true`. Use the method to add the object to a and specify the type of the object that contains the field or property to ignore and the name of the field or property to ignore. If a is applied to a field or property, the field or property is ignored. However you can override that behavior by creating a , setting its property to `false`, and adding it to a , specifying the type of the object that contains the field or property and the name of the field or property. diff --git a/xml/System.Xml.Serialization/SoapElementAttribute.xml b/xml/System.Xml.Serialization/SoapElementAttribute.xml index 4a3560f9269..ab59840ec11 100644 --- a/xml/System.Xml.Serialization/SoapElementAttribute.xml +++ b/xml/System.Xml.Serialization/SoapElementAttribute.xml @@ -61,7 +61,7 @@ ## Remarks The class belongs to a family of attributes that controls how the serializes or deserializes an object as encoded SOAP XML. The resulting XML conforms to section 5 of the World Wide Web Consortium document, [Simple Object Access Protocol (SOAP) 1.1](https://www.w3.org/TR/2000/NOTE-SOAP-20000508/). For a complete list of similar attributes, see [Attributes That Control Encoded SOAP Serialization](/dotnet/standard/serialization/attributes-that-control-encoded-soap-serialization). - To serialize an object as an encoded SOAP message, you must construct the using an created with the method of the class. + To serialize an object as an encoded SOAP message, you must construct the using an created with the method of the class. Apply the to a public field to direct the to serialize the field as an encoded SOAP XML element. diff --git a/xml/System.Xml.Serialization/SoapEnumAttribute.xml b/xml/System.Xml.Serialization/SoapEnumAttribute.xml index eb178d9571b..f51a61cc56a 100644 --- a/xml/System.Xml.Serialization/SoapEnumAttribute.xml +++ b/xml/System.Xml.Serialization/SoapEnumAttribute.xml @@ -61,13 +61,13 @@ ## Remarks The class belongs to a family of attributes that controls how the serializes or deserializes an object as encoded SOAP XML. The resulting XML conforms to section 5 of the World Wide Web Consortium document [Simple Object Access Protocol (SOAP) 1.1](https://www.w3.org/TR/2000/NOTE-SOAP-20000508/). For a complete list of similar attributes, see [Attributes That Control Encoded SOAP Serialization](/dotnet/standard/serialization/attributes-that-control-encoded-soap-serialization). - To serialize an object as an encoded SOAP message, you must construct the using an created with the method of the class. + To serialize an object as an encoded SOAP message, you must construct the using an created with the method of the class. Use the to change the enumeration that the generates or recognizes (when it serializes or deserializes a class, respectively). For example, if an enumeration contains a member named `One`, but you prefer that the XML output be named `Single`, apply the to the enumeration member and set the property to "Single". You can override the property value of a by creating an instance of the class and assigning it to the property of a . For details, see the class overview. - To serialize an object as an encoded SOAP message, you must construct the using an created with the method of the class. + To serialize an object as an encoded SOAP message, you must construct the using an created with the method of the class. > [!NOTE] > You can use the word `SoapEnum` in your code instead of the longer . @@ -141,7 +141,7 @@ to override an existing enumeration. Create a new , set its properties and assign the object to the property of a . For each member of the enumeration, you must create a new and add it to the . For more details, see the class overview. + Use the to override an existing enumeration. Create a new , set its properties and assign the object to the property of a . For each member of the enumeration, you must create a new and add it to the . For more details, see the class overview. > [!NOTE] > You can use the word `SoapEnum` in your code instead of the longer . diff --git a/xml/System.Xml.Serialization/SoapIgnoreAttribute.xml b/xml/System.Xml.Serialization/SoapIgnoreAttribute.xml index 60ff9f62225..4b1bc42dbdd 100644 --- a/xml/System.Xml.Serialization/SoapIgnoreAttribute.xml +++ b/xml/System.Xml.Serialization/SoapIgnoreAttribute.xml @@ -57,7 +57,7 @@ ## Remarks The class belongs to a family of attributes that controls how the serializes or deserializes an object as encoded SOAP XML. The resulting XML conforms to section 5 of the World Wide Web Consortium document, [Simple Object Access Protocol (SOAP) 1.1](https://www.w3.org/TR/2000/NOTE-SOAP-20000508/). For a complete list of similar attributes, see [Attributes That Control Encoded SOAP Serialization](/dotnet/standard/serialization/attributes-that-control-encoded-soap-serialization). - To serialize an object as an encoded SOAP message, you must construct the using an created with the method of the class. + To serialize an object as an encoded SOAP message, you must construct the using an created with the method of the class. Apply the to any class member that you want the to ignore when an instance of the class is serialized. For example, you may do this when the member is used to contain metadata about the object being serialized. diff --git a/xml/System.Xml.Serialization/SoapIncludeAttribute.xml b/xml/System.Xml.Serialization/SoapIncludeAttribute.xml index 3e54b90f499..a56ae8fa197 100644 --- a/xml/System.Xml.Serialization/SoapIncludeAttribute.xml +++ b/xml/System.Xml.Serialization/SoapIncludeAttribute.xml @@ -65,7 +65,7 @@ ## Remarks The class belongs to a family of attributes that controls how the serializes, or deserializes, an object as encoded SOAP XML. The resulting XML conforms to section 5 of the World Wide Web Consortium document, [Simple Object Access Protocol (SOAP) 1.1](https://www.w3.org/TR/2000/NOTE-SOAP-20000508/). For a complete list of similar attributes, see [Attributes That Control Encoded SOAP Serialization](/dotnet/standard/serialization/attributes-that-control-encoded-soap-serialization). - To serialize an object as an encoded SOAP message, you must construct the using an created with the method of the class. + To serialize an object as an encoded SOAP message, you must construct the using an created with the method of the class. When applying the , specify the of the derived class. When the serializes objects that include both the base and the derived classes, it can then recognize both object types. diff --git a/xml/System.Xml.Serialization/SoapReflectionImporter.xml b/xml/System.Xml.Serialization/SoapReflectionImporter.xml index 518c5815238..243b8ffc5a7 100644 --- a/xml/System.Xml.Serialization/SoapReflectionImporter.xml +++ b/xml/System.Xml.Serialization/SoapReflectionImporter.xml @@ -354,7 +354,7 @@ method is called while initializing a Web service or client, or reflecting a Web service. You do not need to call it directly. + The method is called while initializing a Web service or client, or reflecting a Web service. You do not need to call it directly. The following list describes possible values for the `members` parameter: @@ -452,7 +452,7 @@ method is called while initializing a Web service or client, or reflecting a Web service. You do not need to call it directly. + The method is called while initializing a Web service or client, or reflecting a Web service. You do not need to call it directly. The following list describes possible values for the `members` parameter: @@ -553,7 +553,7 @@ method is called while initializing a Web service or client, or reflecting a Web service. You do not need to call it directly. + The method is called while initializing a Web service or client, or reflecting a Web service. You do not need to call it directly. The following list describes possible values for the `members` parameter: @@ -651,7 +651,7 @@ method is called while initializing a Web service or client, or reflecting a Web service. You do not need to call it directly. + The method is called while initializing a Web service or client, or reflecting a Web service. You do not need to call it directly. The following list describes possible values for the `members` parameter: @@ -736,7 +736,7 @@ ## Remarks The XML Schema element is serialized using SOAP encoding. - You do not need to call the method directly. + You do not need to call the method directly. ]]> @@ -807,7 +807,7 @@ ## Remarks The XML Schema element is serialized using SOAP encoding. - You do not need to call the method directly. + You do not need to call the method directly. ]]> @@ -865,7 +865,7 @@ method directly. + You do not need to call the method directly. ]]> diff --git a/xml/System.Xml.Serialization/SoapSchemaImporter.xml b/xml/System.Xml.Serialization/SoapSchemaImporter.xml index a5b5b947ffa..1e3275b877c 100644 --- a/xml/System.Xml.Serialization/SoapSchemaImporter.xml +++ b/xml/System.Xml.Serialization/SoapSchemaImporter.xml @@ -238,7 +238,7 @@ method of the class is used by the [Web Services Description Language Tool (Wsdl.exe)](https://msdn.microsoft.com/library/b9210348-8bc2-4367-8c91-d1a04b403e88) while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe. + The method of the class is used by the [Web Services Description Language Tool (Wsdl.exe)](https://msdn.microsoft.com/library/b9210348-8bc2-4367-8c91-d1a04b403e88) while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe. The class is used only when a WSDL document specifies SOAP encoding, as described in Section 5 of the SOAP 1.1 specification. @@ -288,9 +288,9 @@ method of the class is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe. + The method of the class is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe. - The class is used only when a WSDL document specifies SOAP encoding, as described in Section 5 of the SOAP 1.1 specification. This signature of the method is used when a WSDL message is wrapped within a single part element. + The class is used only when a WSDL document specifies SOAP encoding, as described in Section 5 of the SOAP 1.1 specification. This signature of the method is used when a WSDL message is wrapped within a single part element. ]]> @@ -335,9 +335,9 @@ method of the class is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe. + The method of the class is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe. - The class is used only when a WSDL document specifies SOAP encoding, as described in Section 5 of the SOAP 1.1 specification. The parameter values to the method are taken from a message definition in a WSDL document, including the part elements the message element contains. + The class is used only when a WSDL document specifies SOAP encoding, as described in Section 5 of the SOAP 1.1 specification. The parameter values to the method are taken from a message definition in a WSDL document, including the part elements the message element contains. ]]> @@ -385,9 +385,9 @@ method of the class is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe. + The method of the class is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe. - The class is used only when a WSDL document specifies SOAP encoding, as described in Section 5 of the SOAP 1.1 specification. The parameter values to the method are taken from a message definition in a WSDL document, including the part elements the message element contains. + The class is used only when a WSDL document specifies SOAP encoding, as described in Section 5 of the SOAP 1.1 specification. The parameter values to the method are taken from a message definition in a WSDL document, including the part elements the message element contains. ]]> @@ -434,9 +434,9 @@ method of the class is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe. + The method of the class is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe. - The class is used only when a WSDL document specifies SOAP encoding, as described in Section 5 of the SOAP 1.1 specification. The parameter values to the method are taken from a message definition in a WSDL document, including the part elements the message element contains. + The class is used only when a WSDL document specifies SOAP encoding, as described in Section 5 of the SOAP 1.1 specification. The parameter values to the method are taken from a message definition in a WSDL document, including the part elements the message element contains. ]]> diff --git a/xml/System.Xml.Serialization/SoapTypeAttribute.xml b/xml/System.Xml.Serialization/SoapTypeAttribute.xml index a3367f59128..aed8290b59a 100644 --- a/xml/System.Xml.Serialization/SoapTypeAttribute.xml +++ b/xml/System.Xml.Serialization/SoapTypeAttribute.xml @@ -61,7 +61,7 @@ ## Remarks The class belongs to a family of attributes that controls how the serializes or deserializes an object as encoded SOAP XML. The resulting XML conforms to section 5 of the World Wide Web Consortium document, [Simple Object Access Protocol (SOAP) 1.1](https://www.w3.org/TR/2000/NOTE-SOAP-20000508/). For a complete list of similar attributes, see [Attributes That Control Encoded SOAP Serialization](/dotnet/standard/serialization/attributes-that-control-encoded-soap-serialization). - To serialize an object as an encoded SOAP message, construct the using an created with the method of the class. + To serialize an object as an encoded SOAP message, construct the using an created with the method of the class. The can only be applied to class declarations. diff --git a/xml/System.Xml.Serialization/UnreferencedObjectEventArgs.xml b/xml/System.Xml.Serialization/UnreferencedObjectEventArgs.xml index 366c56799da..0247c9b2b7f 100644 --- a/xml/System.Xml.Serialization/UnreferencedObjectEventArgs.xml +++ b/xml/System.Xml.Serialization/UnreferencedObjectEventArgs.xml @@ -57,7 +57,7 @@ ## Remarks For more information about the class, see the event of the . - The event occurs only when you call the method. + The event occurs only when you call the method. For more information about handling events, see [Events Overview](/dotnet/desktop/winforms/events-overview-windows-forms) diff --git a/xml/System.Xml.Serialization/UnreferencedObjectEventHandler.xml b/xml/System.Xml.Serialization/UnreferencedObjectEventHandler.xml index 38073ad1b66..46a089782fa 100644 --- a/xml/System.Xml.Serialization/UnreferencedObjectEventHandler.xml +++ b/xml/System.Xml.Serialization/UnreferencedObjectEventHandler.xml @@ -67,7 +67,7 @@ ## Remarks When you create an delegate, you identify the method that handles the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see [Handling and Raising Events](/dotnet/standard/events/) - The event occurs only when you call the method. + The event occurs only when you call the method. diff --git a/xml/System.Xml.Serialization/XmlAnyAttributeAttribute.xml b/xml/System.Xml.Serialization/XmlAnyAttributeAttribute.xml index 4ee4c37315d..7d15a0425fb 100644 --- a/xml/System.Xml.Serialization/XmlAnyAttributeAttribute.xml +++ b/xml/System.Xml.Serialization/XmlAnyAttributeAttribute.xml @@ -81,7 +81,7 @@ ## Remarks Use the to contain arbitrary data (as XML attributes) that is sent as part of an XML document, such as, metadata sent as part of the document. - Apply the to a field that returns an array of or objects. When the method of the class is called, all XML attributes that do not have a corresponding member in the class being deserialized are collected in the array. After deserialization, you can iterate through the collection of items to process the data. + Apply the to a field that returns an array of or objects. When the method of the class is called, all XML attributes that do not have a corresponding member in the class being deserialized are collected in the array. After deserialization, you can iterate through the collection of items to process the data. The and events of the do not occur if you apply the to a member of a class. diff --git a/xml/System.Xml.Serialization/XmlAnyElementAttribute.xml b/xml/System.Xml.Serialization/XmlAnyElementAttribute.xml index 30f52da1f2d..59334a15735 100644 --- a/xml/System.Xml.Serialization/XmlAnyElementAttribute.xml +++ b/xml/System.Xml.Serialization/XmlAnyElementAttribute.xml @@ -87,7 +87,7 @@ Apply the to a field that returns an array of or objects. Such a field can be used in two ways, depending on whether an object is being serialized or deserialized. When serialized, the object is generated as XML elements or nodes, even though they have no corresponding member (or members) in the object being serialized. If you specify a property value when applying the attribute, all or objects inserted into the array must have the same element name and default namespace, or an exception is thrown. If you set the property value, you must set the property as well, and the or objects must also have the same name and namespace values. If no value is specified, the or objects can have any element name. - When you call the method of the class, all elements that do not have a corresponding member in the object being deserialized are collected in the array. After deserialization, iterate through the collection of items to process the data. If you specify a value, the array contains only XML elements with that name. If you do not specify a value, the array contains all elements that have no corresponding member in the class. If a class contains more than one field to which the attribute is applied, use the , or and properties to differentiate between the contents of the arrays. If such a class (with multiple fields) also contains one field that has no differentiating property values set (in other words, and ) during deserialization, this array contains any unknown XML elements that are not already contained in the other arrays. If a class contains more than one field that does not have a differentiating , or and value set, the behavior during deserialization is unspecified. + When you call the method of the class, all elements that do not have a corresponding member in the object being deserialized are collected in the array. After deserialization, iterate through the collection of items to process the data. If you specify a value, the array contains only XML elements with that name. If you do not specify a value, the array contains all elements that have no corresponding member in the class. If a class contains more than one field to which the attribute is applied, use the , or and properties to differentiate between the contents of the arrays. If such a class (with multiple fields) also contains one field that has no differentiating property values set (in other words, and ) during deserialization, this array contains any unknown XML elements that are not already contained in the other arrays. If a class contains more than one field that does not have a differentiating , or and value set, the behavior during deserialization is unspecified. You can also apply the to a field that returns a single object. If you do so, you must use the properties and methods of the class to recursively iterate through the unknown elements. @@ -353,7 +353,7 @@ ## Remarks If you specify a property value when applying the attribute, all or objects inserted into the array must have the same element name and default namespace, or an exception is thrown. If you set the property value, you must set the property as well, and the or objects must also have the same name and namespace values. If no value is specified, the or objects can have any element name. - When you call the method of the class, all attributes that do not have a corresponding member in the object being deserialized are collected in the array. If you specify a value, the array contains only XML elements with that name. If you do not specify a value, the array contains all elements that have no corresponding member in the class. If a class contains more than one field to which the attribute is applied, use the and properties to differentiate between the contents of the arrays. If such a class (with multiple fields) also contains one field that has no differentiating property values set (that is, and ) during deserialization, the array contains any XML elements that are not already contained in the other arrays. If you add more than one field that does not have a differentiating or value set, the last field in the class contains all unknown elements that are not already contained in the other arrays, and any other fields are set to `null`. + When you call the method of the class, all attributes that do not have a corresponding member in the object being deserialized are collected in the array. If you specify a value, the array contains only XML elements with that name. If you do not specify a value, the array contains all elements that have no corresponding member in the class. If a class contains more than one field to which the attribute is applied, use the and properties to differentiate between the contents of the arrays. If such a class (with multiple fields) also contains one field that has no differentiating property values set (that is, and ) during deserialization, the array contains any XML elements that are not already contained in the other arrays. If you add more than one field that does not have a differentiating or value set, the last field in the class contains all unknown elements that are not already contained in the other arrays, and any other fields are set to `null`. You can apply multiple instances of the to a class member, but each instance must have a distinct property value. Or, if the same property is set for each instance, a distinct property value must be set for each instance. diff --git a/xml/System.Xml.Serialization/XmlAnyElementAttributes.xml b/xml/System.Xml.Serialization/XmlAnyElementAttributes.xml index 07d9dbb4d98..29514869148 100644 --- a/xml/System.Xml.Serialization/XmlAnyElementAttributes.xml +++ b/xml/System.Xml.Serialization/XmlAnyElementAttributes.xml @@ -84,7 +84,7 @@ 1. Create an . -2. Create the set of objects, and add each object to the collection using the method. +2. Create the set of objects, and add each object to the collection using the method. 3. Create an . @@ -92,7 +92,7 @@ 5. Create an . -6. Add the to the using the method. +6. Add the to the using the method. 7. Create an instance of the using the . diff --git a/xml/System.Xml.Serialization/XmlArrayAttribute.xml b/xml/System.Xml.Serialization/XmlArrayAttribute.xml index dfaf592fb89..d87c097bae2 100644 --- a/xml/System.Xml.Serialization/XmlArrayAttribute.xml +++ b/xml/System.Xml.Serialization/XmlArrayAttribute.xml @@ -70,7 +70,7 @@ You can apply the to a public field or read/write property that returns an array of objects. You can also apply it to collections and fields that return an or any field that returns an object that implements the interface. - When you apply the to a class member, the method of the class generates a nested sequence of XML elements from that member. An XML schema document (an .xsd file), indicates such an array as a `complexType`. For example, if the class to be serialized represents a purchase order, you can generate an array of purchased items by applying the to a public field that returns an array of objects that represent order items. + When you apply the to a class member, the method of the class generates a nested sequence of XML elements from that member. An XML schema document (an .xsd file), indicates such an array as a `complexType`. For example, if the class to be serialized represents a purchase order, you can generate an array of purchased items by applying the to a public field that returns an array of objects that represent order items. If no attributes are applied to a public field or property that returns an array of complex or primitive type objects, the generates a nested sequence of XML elements by default. To more precisely control what XML elements are generated, apply an and an to the field or property. For example, by default, the name of the generated XML element is derived from the member identifier You can change the name of the generated XML element by setting the property. diff --git a/xml/System.Xml.Serialization/XmlArrayItemAttributes.xml b/xml/System.Xml.Serialization/XmlArrayItemAttributes.xml index d06f60a67cd..94132a1b79a 100644 --- a/xml/System.Xml.Serialization/XmlArrayItemAttributes.xml +++ b/xml/System.Xml.Serialization/XmlArrayItemAttributes.xml @@ -82,7 +82,7 @@ An instance of this class is returned by the property of the class. The class is used when overriding the set of objects that can be inserted into an array to which the has been applied. - For each new type you want the field or property to accept, create an and use the to add the object to the collection returned by the property. the to an , that specifies the type of the object that contains the field or property, and the name of the field or property. Construct an with the before calling the or method. + For each new type you want the field or property to accept, create an and use the to add the object to the collection returned by the property. the to an , that specifies the type of the object that contains the field or property, and the name of the field or property. Construct an with the before calling the or method. ]]> @@ -597,7 +597,7 @@ . + The implementation of this is the same as the . ]]> diff --git a/xml/System.Xml.Serialization/XmlAttributeEventArgs.xml b/xml/System.Xml.Serialization/XmlAttributeEventArgs.xml index 2549bc80ed0..c5aef5c131f 100644 --- a/xml/System.Xml.Serialization/XmlAttributeEventArgs.xml +++ b/xml/System.Xml.Serialization/XmlAttributeEventArgs.xml @@ -57,7 +57,7 @@ ## Remarks For more information about handling events, see [Events Overview](/dotnet/desktop/winforms/events-overview-windows-forms). - The event occurs only when you call the method. + The event occurs only when you call the method. @@ -371,7 +371,7 @@ method when the method encounters an unknown attribute. + The following example prints the value returned by the method when the method encounters an unknown attribute. :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/XmlAttributeEventArgs/ObjectBeingDeserialized/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization/XmlAttributeEventArgs/ObjectBeingDeserialized/source.vb" id="Snippet1"::: diff --git a/xml/System.Xml.Serialization/XmlAttributeEventHandler.xml b/xml/System.Xml.Serialization/XmlAttributeEventHandler.xml index cdcc8ab749b..ec4cf8ada22 100644 --- a/xml/System.Xml.Serialization/XmlAttributeEventHandler.xml +++ b/xml/System.Xml.Serialization/XmlAttributeEventHandler.xml @@ -67,7 +67,7 @@ ## Remarks When you create an delegate, you identify the method that handles the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see [Handling and Raising Events](/dotnet/standard/events/). - The event occurs only when an object is being deserialized with the method. + The event occurs only when an object is being deserialized with the method. diff --git a/xml/System.Xml.Serialization/XmlAttributeOverrides.xml b/xml/System.Xml.Serialization/XmlAttributeOverrides.xml index 75d4c107048..1daf027af3e 100644 --- a/xml/System.Xml.Serialization/XmlAttributeOverrides.xml +++ b/xml/System.Xml.Serialization/XmlAttributeOverrides.xml @@ -64,7 +64,7 @@ ## Remarks The enables the to override the default way of serializing a set of objects. Overriding serialization in this way has two uses: first, you can control and augment the serialization of objects found in a DLL--even if you do not have access to the source; second, you can create one set of serializable classes, but serialize the objects in multiple ways. For example, instead of serializing members of a class instance as XML elements, you can serialize them as XML attributes, resulting in a more efficient document to transport. - After you create an object, you pass it as an argument to the constructor. The resulting uses the data contained by the to override attributes that control how objects are serialized. To accomplish this, the contains a collection of the object types that are overridden, as well as an object associated with each overridden object type. The object itself contains an appropriate set of attribute objects that control how each field, property, or class is serialized. + After you create an object, you pass it as an argument to the constructor. The resulting uses the data contained by the to override attributes that control how objects are serialized. To accomplish this, the contains a collection of the object types that are overridden, as well as an object associated with each overridden object type. The object itself contains an appropriate set of attribute objects that control how each field, property, or class is serialized. The process for creating and using an object is as follows: @@ -76,9 +76,9 @@ 4. Create an object. -5. Using the method, add the object to the object. If the object being overridden is an or , you need only to specify the type of the overridden object. But if you are overriding a field or property, you must also specify the name of the overridden member. +5. Using the method, add the object to the object. If the object being overridden is an or , you need only to specify the type of the overridden object. But if you are overriding a field or property, you must also specify the name of the overridden member. -6. When constructing the , pass the to the constructor. +6. When constructing the , pass the to the constructor. 7. Use the resulting to serialize or deserialize the derived class objects. @@ -214,7 +214,7 @@ ## Examples - The following example serializes a class named `Band`, which is derived from a class named `Orchestra`. The example creates an object, and assigns it to the property of an object. The example then calls the method to add the object to the object. + The following example serializes a class named `Band`, which is derived from a class named `Orchestra`. The example creates an object, and assigns it to the property of an object. The example then calls the method to add the object to the object. :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/XmlAttributeOverrides/Add/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization/XmlAttributeOverrides/Add/source.vb" id="Snippet1"::: diff --git a/xml/System.Xml.Serialization/XmlAttributes.xml b/xml/System.Xml.Serialization/XmlAttributes.xml index 5ca9616fb90..47d48ef0396 100644 --- a/xml/System.Xml.Serialization/XmlAttributes.xml +++ b/xml/System.Xml.Serialization/XmlAttributes.xml @@ -472,7 +472,7 @@ property allows you to specify the derived types that can be inserted into an array returned by a public field or public read/write property. For each new type you want the field or property to accept, create an object and it to the ) returned by the property. (The new type must be derived from the type already accepted by the field or property.) the object to an object and specify the type of the object that contains the field or property, and the name of the field or property. Construct an with the object before calling or method. + The property allows you to specify the derived types that can be inserted into an array returned by a public field or public read/write property. For each new type you want the field or property to accept, create an object and it to the ) returned by the property. (The new type must be derived from the type already accepted by the field or property.) the object to an object and specify the type of the object that contains the field or property, and the name of the field or property. Construct an with the object before calling or method. ## Examples The following example serializes a class that contains a field named `Members` that returns an array of objects. Two objects are created to allow the field to accept objects that derive from the base class named `Member`. Each object is added to the through the property. @@ -544,7 +544,7 @@ ## Remarks By default, if no attribute is applied to a public field or public read/write property, it is serialized as an XML element. You can also instruct the to generate an XML attribute by applying an to the field or property. - The property allows you to override the default serialization, as well as the serialization controlled by applying an to the member. To do this, create an and set its properties (such as ). Assign the new object to the property of an object. Add the object to an object and specify the type of the object that contains the field or property, and the name of the field or property. Lastly, create an using the object and call the or method. + The property allows you to override the default serialization, as well as the serialization controlled by applying an to the member. To do this, create an and set its properties (such as ). Assign the new object to the property of an object. Add the object to an object and specify the type of the object that contains the field or property, and the name of the field or property. Lastly, create an using the object and call the or method. ## Examples The following example serializes a class named `Group` that contains a property named `GroupName`; the `GroupName` property is serialized as an XML attribute. The example creates an and an object to override the default serialization of the field. The example then creates an to specifically override the property, and the object is set to the property The object is added to the object with the name of the overridden member specified. Finally, an is constructed and returned using the object. @@ -757,7 +757,7 @@ to an by calling the method. By default, an object is created and assigned to the property. + For each overridden member that is serialized as an XML element, you must add a new to an by calling the method. By default, an object is created and assigned to the property. ## Examples The following example serializes the `Transportation` class, which contains a single field named `Vehicles` that returns an . The example applies two attributes to the `Vehicles` field. The example creates two objects and adds them to the collection of an object. To allow the array to accept different object types, the object is added to the object. @@ -899,7 +899,7 @@ ## Remarks By default, all public fields and public read/write properties are serialized by the . That is, the value of each public field or property is persisted as an XML element or XML attribute in an XML-document instance. - To override the default serialization of a field or property, create an object, and set its property to `true`. the object to an object and specify the type of the object that contains the field or property to ignore, and the name of the field or property to ignore. + To override the default serialization of a field or property, create an object, and set its property to `true`. the object to an object and specify the type of the object that contains the field or property to ignore, and the name of the field or property to ignore. If an is applied to a field or property, the field or property is ignored. However you can override that behavior by creating an object, setting its property to `false`, adding it to an object specifying the type of the object that contains the field or property, and the name of the field or property. diff --git a/xml/System.Xml.Serialization/XmlElementAttributes.xml b/xml/System.Xml.Serialization/XmlElementAttributes.xml index 9ae2c68549d..2df0b948f18 100644 --- a/xml/System.Xml.Serialization/XmlElementAttributes.xml +++ b/xml/System.Xml.Serialization/XmlElementAttributes.xml @@ -198,7 +198,7 @@ objects and calls the method to add them to an . The example then adds the to an , which is used to create an that can serialize an instance of the `Transportation` class. + The following example creates two objects and calls the method to add them to an . The example then adds the to an , which is used to create an that can serialize an instance of the `Transportation` class. :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/XmlElementAttributes/Add/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization/XmlElementAttributes/Add/source.vb" id="Snippet1"::: diff --git a/xml/System.Xml.Serialization/XmlElementEventArgs.xml b/xml/System.Xml.Serialization/XmlElementEventArgs.xml index c57068d760d..3f44f2f53a5 100644 --- a/xml/System.Xml.Serialization/XmlElementEventArgs.xml +++ b/xml/System.Xml.Serialization/XmlElementEventArgs.xml @@ -57,7 +57,7 @@ ## Remarks For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/) and [Handling and Raising Events](/dotnet/standard/events/). - The event occurs only when you call the method. + The event occurs only when you call the method. diff --git a/xml/System.Xml.Serialization/XmlElementEventHandler.xml b/xml/System.Xml.Serialization/XmlElementEventHandler.xml index 2e747483acb..79a98036de0 100644 --- a/xml/System.Xml.Serialization/XmlElementEventHandler.xml +++ b/xml/System.Xml.Serialization/XmlElementEventHandler.xml @@ -67,7 +67,7 @@ ## Remarks When you create an delegate, you identify the method that handles the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see [Handling and Raising Events](/dotnet/standard/events/). - The event occurs only when you call the method. + The event occurs only when you call the method. diff --git a/xml/System.Xml.Serialization/XmlEnumAttribute.xml b/xml/System.Xml.Serialization/XmlEnumAttribute.xml index bed56f0566f..e1c5c976a84 100644 --- a/xml/System.Xml.Serialization/XmlEnumAttribute.xml +++ b/xml/System.Xml.Serialization/XmlEnumAttribute.xml @@ -175,7 +175,7 @@ to override an existing enumeration. + You can use the to override an existing enumeration. > [!NOTE] > You can use the word `XmlEnum` in your code instead of the longer . diff --git a/xml/System.Xml.Serialization/XmlIgnoreAttribute.xml b/xml/System.Xml.Serialization/XmlIgnoreAttribute.xml index c112d9964d6..bbd2512b790 100644 --- a/xml/System.Xml.Serialization/XmlIgnoreAttribute.xml +++ b/xml/System.Xml.Serialization/XmlIgnoreAttribute.xml @@ -77,7 +77,7 @@ ## Remarks The belongs to a family of attributes that controls how the serializes or deserializes an object. If you apply the to any member of a class, the ignores the member when serializing or deserializing an instance of the class. For a complete list of similar attributes, see [Attributes That Control XML Serialization](/dotnet/standard/serialization/attributes-that-control-xml-serialization). - You can override the behavior caused by the by creating an object, and setting its property to `false`. You must the object to an instance of the class. Lastly, you must use the object to construct an instance of the class before you call the or methods. + You can override the behavior caused by the by creating an object, and setting its property to `false`. You must the object to an instance of the class. Lastly, you must use the object to construct an instance of the class before you call the or methods. The [XML Schema Definition Tool (Xsd.exe)](/dotnet/standard/serialization/xml-schema-definition-tool-xsd-exe) occasionally generates the when creating classes from a schema file (.xsd). This behavior occurs because value types cannot be set to `null`, but all XML data types can be. Therefore, the tool creates two fields when it encounters an XML type that maps to a value type: one to hold the value and another special field that takes the form of `fieldnameSpecified`, where the `fieldname` is replaced by the name of the field or property. Notice, however, that this special field is generated only when the schema specifies that the element has no minimum occurrence (minOccurs = "0") and that the element has no default value. The sets and checks this special field to determine whether a value has been set for the field or property. Because the special field must not be serialized, the tool applies the to it. diff --git a/xml/System.Xml.Serialization/XmlIncludeAttribute.xml b/xml/System.Xml.Serialization/XmlIncludeAttribute.xml index fc029994132..04a6e704fe3 100644 --- a/xml/System.Xml.Serialization/XmlIncludeAttribute.xml +++ b/xml/System.Xml.Serialization/XmlIncludeAttribute.xml @@ -70,7 +70,7 @@ when you call the or method of the class. + Use the when you call the or method of the class. When applying the , specify the of the derived class. When the serializes objects that include both the base and the derived class, it can then recognize both object types. diff --git a/xml/System.Xml.Serialization/XmlMappingAccess.xml b/xml/System.Xml.Serialization/XmlMappingAccess.xml index 2c04e72a26e..1c445a9c0ca 100644 --- a/xml/System.Xml.Serialization/XmlMappingAccess.xml +++ b/xml/System.Xml.Serialization/XmlMappingAccess.xml @@ -54,11 +54,11 @@ Specifies whether a mapping is read, write, or both. - when generating code for serialization and deserialization methods. The value specifies whether the schema importer generates write methods for mappings with write access, and read methods for mappings with read access. This minimizes the generation of serialization code. - + when generating code for serialization and deserialization methods. The value specifies whether the schema importer generates write methods for mappings with write access, and read methods for mappings with read access. This minimizes the generation of serialization code. + ]]> diff --git a/xml/System.Xml.Serialization/XmlNamespaceDeclarationsAttribute.xml b/xml/System.Xml.Serialization/XmlNamespaceDeclarationsAttribute.xml index fd3a8cd11eb..a7bd3fe4719 100644 --- a/xml/System.Xml.Serialization/XmlNamespaceDeclarationsAttribute.xml +++ b/xml/System.Xml.Serialization/XmlNamespaceDeclarationsAttribute.xml @@ -76,133 +76,133 @@ Specifies that the target property, parameter, return value, or class member contains prefixes associated with namespaces that are used within an XML document. - attribute can only be applied once in a class to a field or property that returns an object. - - The allows you to store the prefixes, and the associated namespaces, used in an XML document. For example, one common usage of the attribute is to store XPath data, as it is defined by the World Wide Web Consortium document named [XML Language (XPath) Version 1.0](https://www.w3.org/TR/1999/REC-xpath-19991116/). In brief, an XPath is a string that contains many namespace prefixes and local names, along with some other syntax. - - The XPath language allows for the association of a prefix with a path, and using the prefix within the XML document. For example, the following XML document named "select" contains a prefix ("cal") associated with a specific URI (`http://www.cohowinery.com/calendar/`). The element contains an attribute named "path" that contains the XPath. - -``` - -' Visual Basic -Imports System -Imports System.IO -Imports System.Xml.Serialization - _ -Public Class SelectPath - _ - Public xpath As String - _ - public xmlns As XmlSerializerNamespaces -End Class -Public Class Test - Public Shared Sub Main() - Dim mySelect As SelectPath = New SelectPath() - mySelect.xpath = "myNS:ref/@common:y" - mySelect.xmlns = New XmlSerializerNamespaces() - mySelect.xmlns.Add("MyNS", "myNS.tempuri.org") - mySelect.xmlns.Add("common", "common.tempuri.org") - Dim ser As XmlSerializer = New XmlSerializer(mySelect.GetType) - ser.Serialize(Console.Out, mySelect) - End Sub -End Class -'Output: -' -' +``` + + The schema for this might be: + +``` + + + + + + + +``` + + Without the , the association between the prefix and the namespace is lost. + + To retain the association between the prefix and the namespace URI, add a member that returns an object and apply the attribute to the member, as shown in the following C# and Visual Basic code: + +``` +// C# +public class Select { + [XmlAttribute] public string path; + [XmlNamespaceDeclarations] public XmlSerializerNamespaces xmlns; +} +' Visual Basic +Public Class Select + Public path As String + Public xmlns As XmlSerializerNamespaces +End Class +``` + + When serialized, the schema for the generated XML document contains the XML Schema definition (XSD) element named `appinfo`. The element further contains a metadata element named `keepNamespaceDeclarations`, set to the name of the member that contains the namespace declarations. The following XML fragment shows the schema: + +``` + + + + + xmlns + + + + + + + +``` + + On deserialization, the `xmlns` field contains an object that contains all namespace prefix definitions. + + On serialization, the user can add prefix-namespace pairs to the object using the method. This is shown in the following C# and Visual Basic code: + +``` +// C# +using System; +using System.IO; +using System.Xml.Serialization; +[XmlRoot("select")] +public class Select { + [XmlAttribute] + public string xpath; + [XmlNamespaceDeclarations] + public XmlSerializerNamespaces xmlns; +} +public class Test { + public static void Main(string[] args) { + Select mySelect = new Select(); + mySelect.xpath = "myNS:ref/@common:y"; + mySelect.xmlns = new XmlSerializerNamespaces(); + mySelect.xmlns.Add("MyNS", "myNS.tempuri.org"); + mySelect.xmlns.Add("common", "common.tempuri.org"); + XmlSerializer ser = new XmlSerializer(typeof(Select)); + ser.Serialize(Console.Out, mySelect); + } +} +// Output: +// +// +``` + + Also note that the member to which the attribute is applied contains only the prefix-namespace pairs that belong to the XML element defined by the class. For example, in the following XML document, only the prefix pair "cal" is captured, but not the "x" prefix. To get that data, add a member with the to the class that represents the `root` element. + +``` + + + + +``` + ]]> @@ -256,11 +256,11 @@ End Class Initializes a new instance of the class. - can only be applied to a target that returns an object. - + can only be applied to a target that returns an object. + ]]> diff --git a/xml/System.Xml.Serialization/XmlNodeEventArgs.xml b/xml/System.Xml.Serialization/XmlNodeEventArgs.xml index 22ff8c054e4..54cad1a6d6a 100644 --- a/xml/System.Xml.Serialization/XmlNodeEventArgs.xml +++ b/xml/System.Xml.Serialization/XmlNodeEventArgs.xml @@ -57,12 +57,12 @@ ## Remarks For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). - The event can occur only when you call the method. + The event can occur only when you call the method. ## Examples - The following example uses the event of the to print various properties of an unknown XML node that is encountered when calling the class's method. + The following example uses the event of the to print various properties of an unknown XML node that is encountered when calling the class's method. :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/XmlNodeEventArgs/Overview/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization/XmlNodeEventArgs/Overview/source.vb" id="Snippet1"::: @@ -234,7 +234,7 @@ ## Examples - The following example prints the of an unknown XML node that is encountered when calling the class's method. + The following example prints the of an unknown XML node that is encountered when calling the class's method. :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/XmlNodeEventArgs/LocalName/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization/XmlNodeEventArgs/LocalName/source.vb" id="Snippet1"::: @@ -466,7 +466,7 @@ method when the method encounters an unknown XML node. + The following example prints the value returned by the method when the method encounters an unknown XML node. :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/XmlNodeEventArgs/ObjectBeingDeserialized/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization/XmlNodeEventArgs/ObjectBeingDeserialized/source.vb" id="Snippet1"::: diff --git a/xml/System.Xml.Serialization/XmlNodeEventHandler.xml b/xml/System.Xml.Serialization/XmlNodeEventHandler.xml index a52a6edd5bf..0555ca5f9e6 100644 --- a/xml/System.Xml.Serialization/XmlNodeEventHandler.xml +++ b/xml/System.Xml.Serialization/XmlNodeEventHandler.xml @@ -67,7 +67,7 @@ ## Remarks When you create an delegate, you identify the method that handles the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see [Handling and Raising Events](/dotnet/standard/events/). - The event occurs only when you call the method. + The event occurs only when you call the method. diff --git a/xml/System.Xml.Serialization/XmlReflectionImporter.xml b/xml/System.Xml.Serialization/XmlReflectionImporter.xml index 8d513f6095e..c8dafe6a009 100644 --- a/xml/System.Xml.Serialization/XmlReflectionImporter.xml +++ b/xml/System.Xml.Serialization/XmlReflectionImporter.xml @@ -419,7 +419,7 @@ method is called while initializing a Web service or client, or reflecting a Web service. It is not necessary to call it directly. + The method is called while initializing a Web service or client, or reflecting a Web service. It is not necessary to call it directly. The array parameter can consist of any one of the following: @@ -778,7 +778,7 @@ method directly. + It is not necessary to call the method directly. ]]> @@ -859,7 +859,7 @@ method directly. + It is not necessary to call the method directly. ]]> @@ -940,7 +940,7 @@ method directly. + It is not necessary to call the method directly. ]]> @@ -1026,7 +1026,7 @@ method directly. + It is not necessary to call the method directly. ]]> @@ -1092,7 +1092,7 @@ method directly. + It is not necessary to call the method directly. ]]> diff --git a/xml/System.Xml.Serialization/XmlSchemaExporter.xml b/xml/System.Xml.Serialization/XmlSchemaExporter.xml index 79a76b40d4f..5f6b2495a71 100644 --- a/xml/System.Xml.Serialization/XmlSchemaExporter.xml +++ b/xml/System.Xml.Serialization/XmlSchemaExporter.xml @@ -314,7 +314,7 @@ method adds an XML schema element declaration to the that uses the same namespace as the part. A literal message definition normally contains a single part. + For each SOAP message part, the method adds an XML schema element declaration to the that uses the same namespace as the part. A literal message definition normally contains a single part. Use the class instead. diff --git a/xml/System.Xml.Serialization/XmlSchemaImporter.xml b/xml/System.Xml.Serialization/XmlSchemaImporter.xml index 133918dfaf7..87145b10d04 100644 --- a/xml/System.Xml.Serialization/XmlSchemaImporter.xml +++ b/xml/System.Xml.Serialization/XmlSchemaImporter.xml @@ -403,9 +403,9 @@ method is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe or Xsd.exe. + The method is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe or Xsd.exe. - The class is used only when a WSDL document specifies literal use. The method is used when a WSDL message has a single part element but the part has not been identified as a wrapper element. + The class is used only when a WSDL document specifies literal use. The method is used when a WSDL message has a single part element but the part has not been identified as a wrapper element. ]]> @@ -493,7 +493,7 @@ method is used by the Xsd.exe tool to generate classes from an XML Schema Definition (XSD) document. Instead of calling this method directly, use Xsd.exe. + This overload of the method is used by the Xsd.exe tool to generate classes from an XML Schema Definition (XSD) document. Instead of calling this method directly, use Xsd.exe. ]]> @@ -570,7 +570,7 @@ method is used by the Xsd.exe tool to generate classes from an XML Schema Definition (XSD) document. It also is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe or Xsd.exe. + This overload of the method is used by the Xsd.exe tool to generate classes from an XML Schema Definition (XSD) document. It also is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe or Xsd.exe. ]]> @@ -644,7 +644,7 @@ method of the class is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe or Xsd.exe. + The method of the class is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe or Xsd.exe. The class is used only when a WSDL document specifies literal use. This overload is used when a WSDL message is wrapped within a single part element. @@ -714,7 +714,7 @@ method is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe or Xsd.exe. + The method is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe or Xsd.exe. The class is used only when a WSDL document specifies literal use. The value of the `names` parameter contains the qualified names of the parts elements under a message definition in a WSDL document. @@ -863,7 +863,7 @@ method is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe or Xsd.exe. + The method is used by the Wsdl.exe tool while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of calling this method directly, use Wsdl.exe or Xsd.exe. The class is used only when a WSDL document specifies literal use. The value of the `names` parameter contains the qualified names of the parts elements under a message definition in a WSDL document. @@ -1143,7 +1143,7 @@ method is used by the Xsd.exe tool while generating classes XML Schema Definition (XSD) document. Instead of calling this method directly, use Xsd.exe. + The method is used by the Xsd.exe tool while generating classes XML Schema Definition (XSD) document. Instead of calling this method directly, use Xsd.exe. This method does not account for the XML schema element's type. diff --git a/xml/System.Xml.Serialization/XmlSchemas.xml b/xml/System.Xml.Serialization/XmlSchemas.xml index dca0c067ae6..6b65cf4657b 100644 --- a/xml/System.Xml.Serialization/XmlSchemas.xml +++ b/xml/System.Xml.Serialization/XmlSchemas.xml @@ -369,7 +369,7 @@ method is called: + The following list identifies situations in which the method is called: - By the class while creating objects from classes that are identified as Web services. @@ -377,7 +377,7 @@ - By the Xsd.exe tool while generating XML schemas from types found in assemblies. - Instead of calling the method directly, use the previously mentioned classes or tools. + Instead of calling the method directly, use the previously mentioned classes or tools. ]]> @@ -805,7 +805,7 @@ object by invoking the method. + You can compile the schemas referenced in a object by invoking the method. ]]> @@ -862,7 +862,7 @@ ## Remarks The `IsDataSet` attribute comes from the namespace `urn:schemas-microsoft-com:xml-msdata`. - The method is called by the .NET Framework's XML serialization infrastructure and does not need to be called directly. + The method is called by the .NET Framework's XML serialization infrastructure and does not need to be called directly. ]]> diff --git a/xml/System.Xml.Serialization/XmlSerializationReader.xml b/xml/System.Xml.Serialization/XmlSerializationReader.xml index 678cf571a5f..1e11ed18493 100644 --- a/xml/System.Xml.Serialization/XmlSerializationReader.xml +++ b/xml/System.Xml.Serialization/XmlSerializationReader.xml @@ -64,7 +64,7 @@ ## Remarks During initialization, the .NET Framework XML serialization infrastructure dynamically generates and compiles a temporary class for deserialization that is derived from the abstract class. is also implemented within the .NET Framework for deserialization of XML documents into and objects. - You should not derive classes from . Instead, call one of the methods. + You should not derive classes from . Instead, call one of the methods. ]]> @@ -420,7 +420,7 @@ ## Remarks The method is used by generated classes and should not be directly invoked. - The method is used when the `checkDeserializerAdvances` attribute of the `` configuration element is set to `true`. For more information, see [<xmlSerializer> Element](/dotnet/standard/serialization/xmlserializer-element). + The method is used when the `checkDeserializerAdvances` attribute of the `` configuration element is set to `true`. For more information, see [<xmlSerializer> Element](/dotnet/standard/serialization/xmlserializer-element). ]]> @@ -1230,7 +1230,7 @@ method writes valid XML from invalid sources. For example, the property of the class can contain spaces, which are invalid as XML. The reads the encoded XML and restores it to the original value. However, the method of the class cannot read such encoded XML. In that case, set the property to `false` to disable the encoding of the XML. + The method writes valid XML from invalid sources. For example, the property of the class can contain spaces, which are invalid as XML. The reads the encoded XML and restores it to the original value. However, the method of the class cannot read such encoded XML. In that case, set the property to `false` to disable the encoding of the XML. ]]> @@ -1407,9 +1407,9 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET XML serialization infrastructure. - The method implements the delegate for deserialization of SOAP-encoded XML data. + The method implements the delegate for deserialization of SOAP-encoded XML data. - While deserializing XML documents into .NET objects, the .NET XML serialization infrastructure dynamically creates an instance of the method for SOAP-encoded arrays whose data types map to .NET reference types. The method then is called by to fill in the objects in the array. + While deserializing XML documents into .NET objects, the .NET XML serialization infrastructure dynamically creates an instance of the method for SOAP-encoded arrays whose data types map to .NET reference types. The method then is called by to fill in the objects in the array. SOAP encoding is described in Section 5 of the SOAP 1.1 specification. @@ -1469,7 +1469,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method applies to the `arrayType` attribute that is used with SOAP encoding and specified with the namespace "". + The method applies to the `arrayType` attribute that is used with SOAP encoding and specified with the namespace "". ]]> @@ -1695,7 +1695,7 @@ During initialization, the .NET Framework XML serialization infrastructure dynamically generates and compiles a temporary class for deserialization that is derived from . During this process, the .NET Framework generates read methods that implement the delegate. It does so for certain mappings between .NET types and XML data types that are serialized through SOAP-encoded XML and are not root elements. Next, as necessary, a read method is called during deserialization. - The abstract method is where the temporary derived class creates an instance of and initializes read callback methods. + The abstract method is where the temporary derived class creates an instance of and initializes read callback methods. You should not directly create an instance of . @@ -1751,7 +1751,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is abstract. + The method is abstract. ]]> @@ -2128,7 +2128,7 @@ ## Remarks The method is used by generated classes and should not be directly invoked. - The uses an instance of the class to count when a read operation occurs. The count is incremented each time the reader calls an appropriate method, for example the method or the method. + The uses an instance of the class to count when a read operation occurs. The count is incremented each time the reader calls an appropriate method, for example the method or the method. ]]> @@ -2439,7 +2439,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method obtains the XML Schema data type by reading the `xsi:type` attribute of the `multiRef` element. The prefix `xsi` refers to the instance of the XML Schema namespace. + The method obtains the XML Schema data type by reading the `xsi:type` attribute of the `multiRef` element. The prefix `xsi` refers to the instance of the XML Schema namespace. SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. @@ -2512,7 +2512,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - This signature of the method obtains the XML Schema data type of the `multiRef` element from the method parameters rather than by reading the `xsi:type` attribute. The prefix `xsi` refers to the instance of the XML Schema namespace. + This signature of the method obtains the XML Schema data type of the `multiRef` element from the method parameters rather than by reading the `xsi:type` attribute. The prefix `xsi` refers to the instance of the XML Schema namespace. SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. @@ -3427,7 +3427,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -3639,7 +3639,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -3768,7 +3768,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -3824,7 +3824,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -3880,7 +3880,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -3965,7 +3965,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -4025,7 +4025,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -4081,7 +4081,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -4202,9 +4202,9 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. - converts 4-digit hexadecimal UCS-2 codes into Unicode. + converts 4-digit hexadecimal UCS-2 codes into Unicode. ]]> @@ -4267,9 +4267,9 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. - converts 4-digit hexadecimal UCS-2 codes into Unicode. + converts 4-digit hexadecimal UCS-2 codes into Unicode. ]]> @@ -4332,9 +4332,9 @@ ## Remarks The protected members of are only intended for use by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. - converts 4-digit hexadecimal UCS-2 codes into Unicode. + converts 4-digit hexadecimal UCS-2 codes into Unicode. ]]> @@ -4397,9 +4397,9 @@ ## Remarks The protected members of are intended for use by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. - converts 4-digit hexadecimal UCS-2 codes into Unicode. + converts 4-digit hexadecimal UCS-2 codes into Unicode. ]]> @@ -4463,7 +4463,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - If a prefix is present, the method looks up the associated namespace for the current XML document and places the value in the object. + If a prefix is present, the method looks up the associated namespace for the current XML document and places the value in the object. ]]> @@ -4544,7 +4544,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - Add a handler method to the method to handle unknown attributes while the is executing its method. + Add a handler method to the method to handle unknown attributes while the is executing its method. ]]> @@ -4901,7 +4901,7 @@ SOAP encoding, as specified in Section 5 of the SOAP 1.1 specification, allows for elements referenced multiple times in a SOAP message (or optionally, just once) to be referred by an `href` attribute in the main message. An event occurs when such an element appears, but there is no `href` reference to it. - Add a handler method to to provide custom handling for unreferenced objects while the executes its method. + Add a handler method to to provide custom handling for unreferenced objects while the executes its method. ]]> diff --git a/xml/System.Xml.Serialization/XmlSerializationWriter.xml b/xml/System.Xml.Serialization/XmlSerializationWriter.xml index 9de88b62e58..0c39cb4e0d9 100644 --- a/xml/System.Xml.Serialization/XmlSerializationWriter.xml +++ b/xml/System.Xml.Serialization/XmlSerializationWriter.xml @@ -63,7 +63,7 @@ ## Remarks During initialization, the .NET Framework XML serialization infrastructure dynamically generates and compiles a temporary class for serialization that is derived from the abstract class. is also implemented within the .NET Framework for serialization of and objects into XML documents. - You should not derive classes from . Instead, call the method. + You should not derive classes from . Instead, call the method. ]]> @@ -747,7 +747,7 @@ method writes valid XML from invalid sources. For example, the property of the class can contain spaces, which are invalid as XML. The method reads the encoded XML and restores it to the original value. However, the method of the cannot read such encoded XML. In that case, set the property to `false` to disable the encoding of the XML. + The method writes valid XML from invalid sources. For example, the property of the class can contain spaces, which are invalid as XML. The method reads the encoded XML and restores it to the original value. However, the method of the cannot read such encoded XML. In that case, set the property to `false` to disable the encoding of the XML. ]]> @@ -803,7 +803,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - Rather than return a string as other similar "from" methods, the static method returns the original `byte[]` object to improve performance and conserve memory. + Rather than return a string as other similar "from" methods, the static method returns the original `byte[]` object to improve performance and conserve memory. ]]> @@ -866,7 +866,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -922,7 +922,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -978,7 +978,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -1063,7 +1063,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -1141,7 +1141,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -1256,7 +1256,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -1377,7 +1377,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -1440,7 +1440,7 @@ ## Remarks The protected members of the class are intended for use by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -1503,7 +1503,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -1566,7 +1566,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -1747,7 +1747,7 @@ During initialization, the .NET Framework XML serialization infrastructure dynamically generates and compiles a temporary class for serialization that is derived from . During this process, the .NET Framework generates write methods that implement the delegate. It does so for certain mappings between .NET types and XML data types that are serialized using SOAP-encoded XML and are not root elements. Then, as necessary, a write method is called during serialization. - The abstract method is where the temporary derived class creates an instance of and initializes write callback methods. + The abstract method is where the temporary derived class creates an instance of and initializes write callback methods. You should not directly create an instance of . @@ -1864,7 +1864,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is static. + The method is static. ]]> @@ -1916,7 +1916,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element and to be referenced any number of times by substitute elements. The method helps keep track of the objects that can be serialized as `multiRef` elements. + SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element and to be referenced any number of times by substitute elements. The method helps keep track of the objects that can be serialized as `multiRef` elements. SOAP encoding is described in Section 5 of the SOAP 1.1 specification. @@ -2324,7 +2324,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is called only when writing SOAP-encoded XML, as described in Section 5 of the SOAP 1.1 specification. + The method is called only when writing SOAP-encoded XML, as described in Section 5 of the SOAP 1.1 specification. ]]> @@ -2397,7 +2397,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - The method is called only when writing literal XML that can be defined in an XML Schema document. + The method is called only when writing literal XML that can be defined in an XML Schema document. ]]> @@ -3967,7 +3967,7 @@ When set to `true`, the `nil` attribute from the XML Schema instance namespace (abbreviated `xsi`) indicates a null value. - The method is called only when writing SOAP-encoded XML, as described in Section 5 of the SOAP 1.1 specification. + The method is called only when writing SOAP-encoded XML, as described in Section 5 of the SOAP 1.1 specification. ]]> @@ -4036,7 +4036,7 @@ When set to `true`, the `nil` attribute from the XML Schema instance namespace (abbreviated `xsi`) indicates a null value. - The method is called only when writing literal XML that can be defined in an XML Schema document. + The method is called only when writing literal XML that can be defined in an XML Schema document. ]]> @@ -4107,7 +4107,7 @@ When set to `true`, the `nil` attribute from the XML Schema instance namespace (abbreviated `xsi`) indicates a null value. - The method is called only when writing SOAP-encoded XML, as described in Section 5 of the SOAP 1.1 specification. + The method is called only when writing SOAP-encoded XML, as described in Section 5 of the SOAP 1.1 specification. ]]> @@ -4188,7 +4188,7 @@ When set to `true`, the `nil` attribute from the XML Schema instance namespace (abbreviated `xsi`) indicates a null value. - The method is called only when writing SOAP-encoded XML, as described in Section 5 of the SOAP 1.1 specification. + The method is called only when writing SOAP-encoded XML, as described in Section 5 of the SOAP 1.1 specification. ]]> @@ -4259,7 +4259,7 @@ When set to `true`, the `nil` attribute from the XML Schema instance namespace (abbreviated `xsi`) indicates a null value. - The method is called only when writing SOAP-encoded XML, as described in Section 5 of the SOAP 1.1 specification. + The method is called only when writing SOAP-encoded XML, as described in Section 5 of the SOAP 1.1 specification. ]]> @@ -4328,7 +4328,7 @@ When set to `true`, the `nil` attribute from the XML Schema instance namespace (abbreviated `xsi`) indicates a null value. - The method is called only when writing literal XML that can be defined in an XML Schema document. + The method is called only when writing literal XML that can be defined in an XML Schema document. ]]> @@ -4407,7 +4407,7 @@ When set to `true`, the `nil` attribute from the XML Schema instance namespace (abbreviated `xsi`) indicates a null value. - The method is called only when writing literal XML that can be defined in an XML Schema document. + The method is called only when writing literal XML that can be defined in an XML Schema document. ]]> @@ -4476,7 +4476,7 @@ When set to `true`, the `nil` attribute from the XML Schema instance namespace (abbreviated `xsi`) indicates a null value. - The method is called only when writing literal XML that can be defined in an XML Schema document. + The method is called only when writing literal XML that can be defined in an XML Schema document. ]]> @@ -4550,7 +4550,7 @@ When set to `true`, the `nil` attribute from the XML Schema instance namespace (abbreviated `xsi`) indicates a null value. - The method is called only when writing SOAP-encoded XML, as described in Section 5 of the SOAP 1.1 specification. + The method is called only when writing SOAP-encoded XML, as described in Section 5 of the SOAP 1.1 specification. ]]> @@ -4610,7 +4610,7 @@ When set to `true`, the `nil` attribute from the XML Schema instance namespace (abbreviated `xsi`) indicates a null value. - The method is called only when writing SOAP-encoded XML, as described in Section 5 of the SOAP 1.1 specification. + The method is called only when writing SOAP-encoded XML, as described in Section 5 of the SOAP 1.1 specification. ]]> @@ -4684,7 +4684,7 @@ When set to `true`, the `nil` attribute from the XML Schema instance namespace (abbreviated `xsi`) indicates a null value. - The method is called only when writing literal XML that can be defined in an XML Schema document. + The method is called only when writing literal XML that can be defined in an XML Schema document. ]]> @@ -4744,7 +4744,7 @@ When set to `true`, the `nil` attribute from the XML Schema instance namespace (abbreviated `xsi`) indicates a null value. - The method is called only when writing literal XML that can be defined in an XML Schema document. + The method is called only when writing literal XML that can be defined in an XML Schema document. ]]> diff --git a/xml/System.Xml.Serialization/XmlSerializer.xml b/xml/System.Xml.Serialization/XmlSerializer.xml index a334591d728..653312038bf 100644 --- a/xml/System.Xml.Serialization/XmlSerializer.xml +++ b/xml/System.Xml.Serialization/XmlSerializer.xml @@ -200,7 +200,7 @@ The following example contains two main classes: `PurchaseOrder` and `Test`. The ## Examples - The following example constructs an that serializes an object named `Widget`. The example sets various properties of the object before calling the method. + The following example constructs an that serializes an object named `Widget`. The example sets various properties of the object before calling the method. :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/XmlSerializer/.ctor/source5.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization/XmlSerializer/.ctor/source5.vb" id="Snippet1"::: @@ -360,7 +360,7 @@ The following example contains two main classes: `PurchaseOrder` and `Test`. The that serializes an object named `Widget`. The example sets various properties of the object before calling the method. + The following example constructs an that serializes an object named `Widget`. The example sets various properties of the object before calling the method. :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/XmlSerializer/.ctor/source1.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization/XmlSerializer/.ctor/source1.vb" id="Snippet1"::: @@ -943,7 +943,7 @@ The following example contains two main classes: `PurchaseOrder` and `Test`. The method to check whether an XML document can be deserialized. + The following example calls the method to check whether an XML document can be deserialized. :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/XmlSerializer/CanDeserialize/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization/XmlSerializer/CanDeserialize/source.vb" id="Snippet1"::: @@ -1136,7 +1136,7 @@ The following example contains two main classes: `PurchaseOrder` and `Test`. The - > [!NOTE] -> The cannot deserialize the following: arrays of and arrays of . +> The cannot deserialize the following: arrays of and arrays of . ## Examples The following example deserializes an object using a object. @@ -1226,10 +1226,10 @@ The following example contains two main classes: `PurchaseOrder` and `Test`. The Classes that inherit from include and . If you are using a to deserialize an object, you must construct the with an appropriate . The encoding specified by the XML document is ignored. > [!NOTE] -> To use the encoding specified by the XML document, use the overload that takes an instead. The automatically detects and uses the encoding specified by the XML document. +> To use the encoding specified by the XML document, use the overload that takes an instead. The automatically detects and uses the encoding specified by the XML document. > [!NOTE] -> The cannot deserialize the following: arrays of and arrays of . +> The cannot deserialize the following: arrays of and arrays of . @@ -1375,7 +1375,7 @@ The following example contains two main classes: `PurchaseOrder` and `Test`. The The automatically detects and uses the encoding specified by the XML document. > [!NOTE] -> The cannot deserialize the following: arrays of and arrays of . +> The cannot deserialize the following: arrays of and arrays of . @@ -1474,7 +1474,7 @@ The following example contains two main classes: `PurchaseOrder` and `Test`. The Set the `encodingStyle` parameter to "" for SOAP version 1.1 encoding; otherwise, set it to "" for SOAP version 1.2 encoding. - **Note** The cannot deserialize the following: arrays of and arrays of . + **Note** The cannot deserialize the following: arrays of and arrays of . ]]> @@ -1922,11 +1922,11 @@ The following example contains two main classes: `PurchaseOrder` and `Test`. The ## Remarks -The method allows you to efficiently create an array of objects for processing an array of objects. However, it's recommended for callers to cache the returned serializers when there are repeated calls to this method. +The method allows you to efficiently create an array of objects for processing an array of objects. However, it's recommended for callers to cache the returned serializers when there are repeated calls to this method. ## Examples -The following example uses the method to return an array of objects. The code includes three class definitions that are each used to create an array of objects. +The following example uses the method to return an array of objects. The code includes three class definitions that are each used to create an array of objects. :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/XmlSerializer/FromTypes/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization/XmlSerializer/FromTypes/source.vb" id="Snippet1"::: @@ -1952,7 +1952,7 @@ The following example uses the when it serializes or deserializes objects of the specified types. Use the to return the name of such an assembly. + The [XML Serializer Generator Tool (Sgen.exe)](/dotnet/standard/serialization/xml-serializer-generator-tool-sgen-exe) creates an XML serialization assembly for types in a specified assembly to improve the run-time performance of an when it serializes or deserializes objects of the specified types. Use the to return the name of such an assembly. If you are distributing such an assembly as part of a client application that calls a Web service, you can apply the to the client type to specify the location and name of the assembly. @@ -2048,7 +2048,7 @@ The following example uses the when it serializes or deserializes objects of the specified types. Use the to return the name of such an assembly. + The [XML Serializer Generator Tool (Sgen.exe)](/dotnet/standard/serialization/xml-serializer-generator-tool-sgen-exe) creates an XML serialization assembly for types in a specified assembly to improve the run-time performance of an when it serializes or deserializes objects of the specified types. Use the to return the name of such an assembly. If you are distributing such an assembly as part of a client application that calls a Web service, you can apply the to the client type to specify the location and name of the assembly. @@ -2111,7 +2111,7 @@ The following example uses the when it serializes or deserializes objects of the specified types. Use the to return the name of such an assembly. + The [XML Serializer Generator Tool (Sgen.exe)](/dotnet/standard/serialization/xml-serializer-generator-tool-sgen-exe) creates an XML serialization assembly for types in a specified assembly to improve the run-time performance of an when it serializes or deserializes objects of the specified types. Use the to return the name of such an assembly. If you are distributing such an assembly as part of a client application that calls a Web service, you can apply the to the client type to specify the location and name of the assembly. @@ -2178,7 +2178,7 @@ The following example uses the when it serializes or deserializes objects of the specified types. Use the to return the name of such an assembly. + The [XML Serializer Generator Tool (Sgen.exe)](/dotnet/standard/serialization/xml-serializer-generator-tool-sgen-exe) creates an XML serialization assembly for types in a specified assembly to improve the run-time performance of an when it serializes or deserializes objects of the specified types. Use the to return the name of such an assembly. If you are distributing such an assembly as part of a client application that calls a Web service, you can apply the to the client type to specify the location and name of the assembly. @@ -2270,7 +2270,7 @@ The following example uses the method converts the public fields and read/write properties of an object into XML. It does not convert methods, indexers, private fields, or read-only properties. + The method converts the public fields and read/write properties of an object into XML. It does not convert methods, indexers, private fields, or read-only properties. In the `stream` parameter, specify an object that derives from the abstract class. Classes that derive from include: @@ -2281,7 +2281,7 @@ The following example uses the > [!NOTE] -> The cannot serialize the following: arrays of and arrays of . +> The cannot serialize the following: arrays of and arrays of . ## Examples The following example serializes an object using a object. @@ -2376,7 +2376,7 @@ The following example uses the method converts the public fields and read/write properties of an object into XML. It does not convert methods, indexers, private fields, or read-only properties. + The method converts the public fields and read/write properties of an object into XML. It does not convert methods, indexers, private fields, or read-only properties. In the `textWriter` parameter, specify an object that derives from the abstract class. Classes that derive from include: @@ -2387,7 +2387,7 @@ The following example uses the > [!NOTE] -> The cannot serialize the following: arrays of and arrays of . +> The cannot serialize the following: arrays of and arrays of . @@ -2541,12 +2541,12 @@ The following example uses the method converts the public fields and read/write properties of an object into XML. It does not convert methods, indexers, private fields, or read-only properties. + The method converts the public fields and read/write properties of an object into XML. It does not convert methods, indexers, private fields, or read-only properties. In the `xmlWriter` parameter, specify an object that derives from the abstract class. The derives from the . > [!NOTE] -> The cannot serialize the following: arrays of and arrays of . +> The cannot serialize the following: arrays of and arrays of . @@ -2641,7 +2641,7 @@ The following example uses the method is invoked, the public fields and read/write properties of an object are converted into XML. Methods, indexers, private fields, and read-only properties are not serialized. + When the method is invoked, the public fields and read/write properties of an object are converted into XML. Methods, indexers, private fields, and read-only properties are not serialized. Use the `stream` parameter to specify an object that derives from the abstract class, which is designed to write to streams. Classes that derive from the class include: @@ -2656,7 +2656,7 @@ The following example uses the > [!NOTE] -> The cannot serialize the following: arrays of and arrays of . +> The cannot serialize the following: arrays of and arrays of . @@ -2750,7 +2750,7 @@ The following example uses the method is invoked the public fields and read/write properties of an object are converted into XML. Methods, indexers, private fields, and read-only properties are not serialized. + When the method is invoked the public fields and read/write properties of an object are converted into XML. Methods, indexers, private fields, and read-only properties are not serialized. Use the `textWriter` parameter to specify an object that derives from the abstract class. Classes that derive from class include: @@ -2759,7 +2759,7 @@ The following example uses the > [!NOTE] -> The cannot serialize the following: arrays of and arrays of . +> The cannot serialize the following: arrays of and arrays of . ## Examples The following example serializes an object with a . The example also creates an object and adds two namespaces to the object. The class that defines the serialized object is also attributed with attributes to specify the namespace for each element. @@ -2855,12 +2855,12 @@ The following example uses the method is invoked, the public fields and read/write properties of an object are converted into XML. Methods, indexers, private fields, and read-only properties are not serialized. + When the method is invoked, the public fields and read/write properties of an object are converted into XML. Methods, indexers, private fields, and read-only properties are not serialized. Use the `xmlWriter` parameter to specify an object that derives from the abstract class, which is designed to write XML documents. The derives from the . > [!NOTE] -> The cannot serialize the following: arrays of and arrays of . +> The cannot serialize the following: arrays of and arrays of . ## Examples The following example serializes an object with an . The example also creates an and adds two namespaces to the object. Several instances of the class are applied to the class members to specify the namespace for each element. @@ -2957,14 +2957,14 @@ The following example uses the method is invoked, the public fields and read/write properties of an object are converted into XML. Methods, indexers, private fields, and read-only properties are not serialized. + When the method is invoked, the public fields and read/write properties of an object are converted into XML. Methods, indexers, private fields, and read-only properties are not serialized. Use the `xmlWriter` parameter to specify an object that derives from the abstract class, which is designed to write XML documents. The derives from the . Set the `encodingStyle` parameter to "http://schemas.xmlsoap.org/soap/encoding/" for SOAP version 1.1 encoding; otherwise, set it to "http://www.w3.org/2001/12/soap-encoding" for SOAP version 1.2 encoding. > [!NOTE] -> The cannot serialize the following: arrays of and arrays of . +> The cannot serialize the following: arrays of and arrays of . ]]> @@ -3103,7 +3103,7 @@ The following example uses the method, the ignores XML attributes of unknown types. However, you can use this event to handle such node types. + By default, after calling the method, the ignores XML attributes of unknown types. However, you can use this event to handle such node types. If the instance of the class being deserialized contains a field that returns an array of objects and an has been applied to the field, the event does not occur. Instead, all unknown XML attributes are collected into the array. @@ -3174,7 +3174,7 @@ The following example uses the method, the ignores XML attributes of unknown types. However, you can use this event to handle such node types. + By default, after calling the method, the ignores XML attributes of unknown types. However, you can use this event to handle such node types. > [!NOTE] > If the is applied to a field that returns an array of objects, all unknown elements are collected in the array. In that case, the event does not occur. @@ -3255,7 +3255,7 @@ The following example uses the method, the ignores XML nodes of unknown types. However, you can use this event to handle such node types. + By default, after calling the method, the ignores XML nodes of unknown types. However, you can use this event to handle such node types. diff --git a/xml/System.Xml.Serialization/XmlSerializerFactory.xml b/xml/System.Xml.Serialization/XmlSerializerFactory.xml index 3268813a679..12ac748e5b9 100644 --- a/xml/System.Xml.Serialization/XmlSerializerFactory.xml +++ b/xml/System.Xml.Serialization/XmlSerializerFactory.xml @@ -360,7 +360,7 @@ to create an instance of the class. + Calling this overload is similar to calling the to create an instance of the class. ]]> @@ -433,7 +433,7 @@ to create an instance of the class. + Calling this overload is similar to calling the to create an instance of the class. ]]> @@ -506,7 +506,7 @@ to create an instance of the class. + Calling this overload is similar to calling the to create an instance of the class. ]]> @@ -602,7 +602,7 @@ to create an instance of the class. + Calling this overload is similar to calling the to create an instance of the class. ]]> @@ -750,7 +750,7 @@ to create an instance of the class. + Calling this overload is similar to calling the to create an instance of the class. ]]> diff --git a/xml/System.Xml.Serialization/XmlSerializerNamespaces.xml b/xml/System.Xml.Serialization/XmlSerializerNamespaces.xml index cbac88c6b85..219d0201942 100644 --- a/xml/System.Xml.Serialization/XmlSerializerNamespaces.xml +++ b/xml/System.Xml.Serialization/XmlSerializerNamespaces.xml @@ -85,7 +85,7 @@ 1. Create an instance. -2. each prefix and namespace pair that you want to the instance. +2. each prefix and namespace pair that you want to the instance. 3. Apply the appropriate.NET attribute to each property or class that the serializes into an XML document. The available attributes are: @@ -103,7 +103,7 @@ 1. Set the `Namespace` property of each attribute to one of the namespace values from the object. -2. Pass the to the method of the . +2. Pass the to the method of the . > [!NOTE] > The creation of an empty namespace and prefix pair is not supported. That is, you cannot create a pair using the following code: @@ -121,7 +121,7 @@ ns.Add("", "") ## Examples - The following example creates an object, and adds two prefix and namespace pairs to it. The example then passes the to the method, which serializes a `Books` object into an XML document. Using the object, the method qualifies each XML element and attribute with one of the two namespaces. + The following example creates an object, and adds two prefix and namespace pairs to it. The example then passes the to the method, which serializes a `Books` object into an XML document. Using the object, the method qualifies each XML element and attribute with one of the two namespaces. :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/XmlSerializerNamespaces/Overview/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization/XmlSerializerNamespaces/Overview/source.vb" id="Snippet1"::: @@ -377,14 +377,14 @@ ns.Add("", "") to qualify the element and attribute names in an XML document, you must the prefix and namespace pairs to an object. + If you want the to qualify the element and attribute names in an XML document, you must the prefix and namespace pairs to an object. Any namespaces that you add must conform to the W3C [Namespaces in XML](https://www.w3.org/TR/REC-xml-names/) specification. ## Examples - The following example creates an object, and adds three prefix and namespace pairs to it by calling the method. + The following example creates an object, and adds three prefix and namespace pairs to it by calling the method. :::code language="csharp" source="~/snippets/csharp/System.Xml.Serialization/XmlSerializerNamespaces/Add/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/System.Xml.Serialization/XmlSerializerNamespaces/Add/source.vb" id="Snippet1"::: diff --git a/xml/System.Xml.Serialization/XmlTextAttribute.xml b/xml/System.Xml.Serialization/XmlTextAttribute.xml index 8275d542ba4..c9cdb613b22 100644 --- a/xml/System.Xml.Serialization/XmlTextAttribute.xml +++ b/xml/System.Xml.Serialization/XmlTextAttribute.xml @@ -79,7 +79,7 @@ belongs to a family of attributes that controls how the serializes and deserializes an object (through its and methods). For a complete list of similar attributes, see [Attributes That Control XML Serialization](/dotnet/standard/serialization/attributes-that-control-xml-serialization). + The belongs to a family of attributes that controls how the serializes and deserializes an object (through its and methods). For a complete list of similar attributes, see [Attributes That Control XML Serialization](/dotnet/standard/serialization/attributes-that-control-xml-serialization). Only one instance of the class can be applied in a class. diff --git a/xml/System.Xml.Serialization/XmlTypeMapping.xml b/xml/System.Xml.Serialization/XmlTypeMapping.xml index 718a77d7de9..9084886ef23 100644 --- a/xml/System.Xml.Serialization/XmlTypeMapping.xml +++ b/xml/System.Xml.Serialization/XmlTypeMapping.xml @@ -59,7 +59,7 @@ class is used to serialize an object as encoded SOAP XML. The resulting XML conforms to section 5 of the [World Wide Web Consortium](https://www.w3.org) document, "Simple Object Access Protocol (SOAP) 1.1". Create an by calling the method of the class. Use the to construct an instance of the class. To control the serialization, use one of the attributes listed in [Attributes That Control Encoded SOAP Serialization](/dotnet/standard/serialization/attributes-that-control-encoded-soap-serialization). + The class is used to serialize an object as encoded SOAP XML. The resulting XML conforms to section 5 of the [World Wide Web Consortium](https://www.w3.org) document, "Simple Object Access Protocol (SOAP) 1.1". Create an by calling the method of the class. Use the to construct an instance of the class. To control the serialization, use one of the attributes listed in [Attributes That Control Encoded SOAP Serialization](/dotnet/standard/serialization/attributes-that-control-encoded-soap-serialization). diff --git a/xml/System.Xml.XPath/Extensions.xml b/xml/System.Xml.XPath/Extensions.xml index d3a18a62fc6..0734b83175a 100644 --- a/xml/System.Xml.XPath/Extensions.xml +++ b/xml/System.Xml.XPath/Extensions.xml @@ -83,7 +83,7 @@ Namespace declarations are reported from left to right. In contrast, for , namespaces are reported from right to left. This is conformant behavior because namespace declarations are not ordered in the XPath data model. - The method is not supported for navigators that are returned by this method. + The method is not supported for navigators that are returned by this method. You can use this method to perform an XSLT transformation. You can create an XML tree, create an from the XML tree, create a new document, and create a that will write into the new document. Then, you can invoke the XSLT transformation, passing the and to the transformation. After the transformation successfully completes, the new XML tree is populated with the results of the transformation. @@ -152,7 +152,7 @@ Namespace declarations are reported from left to right. In contrast, for namespaces are reported from right to left. This is conformant behavior because namespace declarations are not ordered in the XPath data model. - The method is not supported for navigators that are returned by this method. + The method is not supported for navigators that are returned by this method. You can use this method to perform an XSLT transformation. You can create an XML tree, create an from the XML tree, create a new document, and create a that will write into the new document. Then, you can invoke the XSLT transformation, passing the and to the transform. After the transformation successfully completes, the new XML tree is populated with the results of the transformation. @@ -272,7 +272,7 @@ This example produces the following output: Namespace declarations are reported from left to right. In contrast, for namespaces are reported from right to left. This is conformant behavior because namespace declarations are not ordered in the XPath data model. - The method is not supported for navigators that are returned by this method. + The method is not supported for navigators that are returned by this method. If you use an with this method to create the , you will get better performance when evaluating XPath expressions. @@ -363,7 +363,7 @@ This example produces the following output: ## Examples - The following example creates a small XML tree with an attribute, then uses the method to retrieve the attribute. + The following example creates a small XML tree with an attribute, then uses the method to retrieve the attribute. ```csharp @@ -577,7 +577,7 @@ aw:Att="attdata" to select a single element. + The following example creates a small XML tree and uses to select a single element. ```csharp @@ -812,7 +812,7 @@ Console.WriteLine(child1) ## Examples - The following example creates a small XML tree and uses to select a set of elements. + The following example creates a small XML tree and uses to select a set of elements. ```csharp diff --git a/xml/System.Xml.XPath/IXPathNavigable.xml b/xml/System.Xml.XPath/IXPathNavigable.xml index 2196000febf..25a1afaab19 100644 --- a/xml/System.Xml.XPath/IXPathNavigable.xml +++ b/xml/System.Xml.XPath/IXPathNavigable.xml @@ -106,16 +106,16 @@ Returns a new object. An object. - method is called from an object, the object is initially positioned on the node from which the method was called. If the method is called from an object or an object, the object is positioned on the root of the document. - - - -## Examples - For examples of the method, see the , , or classes. - + method is called from an object, the object is initially positioned on the node from which the method was called. If the method is called from an object or an object, the object is positioned on the root of the document. + + + +## Examples + For examples of the method, see the , , or classes. + ]]> diff --git a/xml/System.Xml.XPath/XPathDocument.xml b/xml/System.Xml.XPath/XPathDocument.xml index e27f5574ffd..e35dc274ba1 100644 --- a/xml/System.Xml.XPath/XPathDocument.xml +++ b/xml/System.Xml.XPath/XPathDocument.xml @@ -180,7 +180,7 @@ constructor that accepts an object as a parameter. + To preserve white space, use the constructor that accepts an object as a parameter. ]]> @@ -238,15 +238,15 @@ object can be used to load a whole XML document or part of an XML document into an . To load part of an XML document into an , position the object on the top XML node to load data from. When you create an by using the constructor, data is loaded from the current top node through all its siblings. Afterwards, the is positioned on the outer scope of the top XML node. Alternatively, you can use the method to load the into a particular element in the XML document. + An object can be used to load a whole XML document or part of an XML document into an . To load part of an XML document into an , position the object on the top XML node to load data from. When you create an by using the constructor, data is loaded from the current top node through all its siblings. Afterwards, the is positioned on the outer scope of the top XML node. Alternatively, you can use the method to load the into a particular element in the XML document. - The following are important notes to consider when you use the constructor. + The following are important notes to consider when you use the constructor. - An object with the appropriate associated object settings can be used to resolve entities or other references in XML data. - If the object is positioned on a leaf node that is not valid for the root level of a document - for example, a white space or attribute node - the object continues to read until it is positioned on a node that can be used for the root. The begins loading at this point. -- To preserve white space, use the constructor that accepts an object as a parameter. +- To preserve white space, use the constructor that accepts an object as a parameter. ]]> @@ -369,7 +369,7 @@ - The object passed as a parameter specifies whether to preserve white space. preserves only significant white space; preserves all white space. By default, the object is set to . -- The functionality of the constructor is identical to that of the constructor, except for the white space handling options described. +- The functionality of the constructor is identical to that of the constructor, except for the white space handling options described. ]]> @@ -427,7 +427,7 @@ - The object passed as a parameter specifies whether to preserve white space. preserves only significant white space; preserves all white space. By default, the object is set to . -- The functionality of the constructor is identical to that of the constructor, except for the white space handling options described. +- The functionality of the constructor is identical to that of the constructor, except for the white space handling options described. ]]> diff --git a/xml/System.Xml.XPath/XPathExpression.xml b/xml/System.Xml.XPath/XPathExpression.xml index edeb139409b..330034ed537 100644 --- a/xml/System.Xml.XPath/XPathExpression.xml +++ b/xml/System.Xml.XPath/XPathExpression.xml @@ -69,7 +69,7 @@ method of the class. It is a parameter to the , , , and methods of the class. + This class is returned as the result of the method of the class. It is a parameter to the , , , and methods of the class. @@ -193,7 +193,7 @@ method enables users to sort objects by their data type instead of by string or number. The object provides an implementation of the method that supports sorting on user-defined classes. + The method enables users to sort objects by their data type instead of by string or number. The object provides an implementation of the method that supports sorting on user-defined classes. In the following example, the books are sorted by ISBN number, where `isbn` is an object that implements the interface. @@ -209,13 +209,13 @@ ISBN isbn = new ISBN(); expression.AddSort("@ISBN", (IComparer)isbn); ``` - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. - The order in which the sorts are added provides the sort key order. -- If the or the sort key requires namespace resolution, you must use the method to provide an for namespace resolution. +- If the or the sort key requires namespace resolution, you must use the method to provide an for namespace resolution. -- If the does not include a prefix, it is assumed that the namespace Uniform Resource Identifier (URI) is the empty namespace. If your XML includes a default namespace, you must still use the method and provide an that contains a prefix and namespace URI to handle the default namespace. +- If the does not include a prefix, it is assumed that the namespace Uniform Resource Identifier (URI) is the empty namespace. If your XML includes a default namespace, you must still use the method and provide an that contains a prefix and namespace URI to handle the default namespace. ]]> @@ -287,9 +287,9 @@ expression.AddSort("@ISBN", (IComparer)isbn); - The order in which the sorts are added provides the sort key order. -- If the or the sort key requires namespace resolution, you must use the method to provide an for namespace resolution. +- If the or the sort key requires namespace resolution, you must use the method to provide an for namespace resolution. -- If the does not include a prefix, it is assumed that the namespace Uniform Resource Identifier (URI) is the empty namespace. If your XML includes a default namespace, you must still use the method and provide an that contains a prefix and namespace URI to handle the default namespace. +- If the does not include a prefix, it is assumed that the namespace Uniform Resource Identifier (URI) is the empty namespace. If your XML includes a default namespace, you must still use the method and provide an that contains a prefix and namespace URI to handle the default namespace. @@ -393,7 +393,7 @@ expression.AddSort("@ISBN", (IComparer)isbn); method returns a clone of this object with the same state as this object. + When overridden in a derived class, the method returns a clone of this object with the same state as this object. ]]> @@ -480,7 +480,7 @@ expression.AddSort("@ISBN", (IComparer)isbn); ## Examples - The following example shows how to use the XPath return type to determine how to process the XPath expression. The example uses the method to return the new objects. + The following example shows how to use the XPath return type to determine how to process the XPath expression. The example uses the method to return the new objects. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Data/XPathExpression.ReturnType/CPP/returntype.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathExpression/Overview/returntype.cs" id="Snippet1"::: @@ -600,7 +600,7 @@ expression.AddSort("@ISBN", (IComparer)isbn); > If a user-defined function with an invalid number of arguments (or an unimplemented user-defined function) is specified in the XPath expression, an exception occurs only at run-time. User-defined functions are not checked at compile time and exceptions resulting from user-defined functions occur only if execution evaluates the expression. > [!NOTE] -> It is not possible to compile a with a custom context in one step by passing an , which implements , as an argument to this method. To use a with a custom context, you must call the method after compiling the expression. +> It is not possible to compile a with a custom context in one step by passing an , which implements , as an argument to this method. To use a with a custom context, you must call the method after compiling the expression. ]]> @@ -807,20 +807,20 @@ expression.AddSort("@ISBN", (IComparer)isbn); interface, such as the class. The stores prefix and namespace Uniform Resource Identifier (URI) mappings. If the requires namespace resolution, the prefix and namespace URI pair must be added to an object, such as the class, which implements the interface, and the method must be called to specify the interface object to use for namespace resolution. + Namespace resolution is supported using classes that implement the interface, such as the class. The stores prefix and namespace Uniform Resource Identifier (URI) mappings. If the requires namespace resolution, the prefix and namespace URI pair must be added to an object, such as the class, which implements the interface, and the method must be called to specify the interface object to use for namespace resolution. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. -- If the does not include a prefix, it is assumed that the namespace URI is the empty namespace. If your XML includes a default namespace, you must still use the method and provide an object that contains a prefix and namespace URI to handle the default namespace. +- If the does not include a prefix, it is assumed that the namespace URI is the empty namespace. If your XML includes a default namespace, you must still use the method and provide an object that contains a prefix and namespace URI to handle the default namespace. -- You can also supply an interface object for namespace resolution to the method when you create your object. +- You can also supply an interface object for namespace resolution to the method when you create your object. -- accepts as a namespace resolver, so you can implement a custom context and use functions and variables based on and . The XPath expression will execute them. For more information, see [User Defined Functions and Variables](/dotnet/standard/data/xml/user-defined-functions-and-variables). +- accepts as a namespace resolver, so you can implement a custom context and use functions and variables based on and . The XPath expression will execute them. For more information, see [User Defined Functions and Variables](/dotnet/standard/data/xml/user-defined-functions-and-variables). ## Examples - The following example shows how to use the XPath return type to determine how to process the XPath expression, and how to use the method to provide an object for namespace resolution. + The following example shows how to use the XPath return type to determine how to process the XPath expression, and how to use the method to provide an object for namespace resolution. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Data/XPathExpression.ReturnType/CPP/returntype.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathExpression/Overview/returntype.cs" id="Snippet1"::: @@ -918,20 +918,20 @@ expression.AddSort("@ISBN", (IComparer)isbn); class which stores prefix and namespace Uniform Resource Identifier (URI) mappings. If the requires namespace resolution, the prefix and namespace URI pair must be added to the object and the method must be called to specify the object to use for namespace resolution. + Namespace resolution is supported using the class which stores prefix and namespace Uniform Resource Identifier (URI) mappings. If the requires namespace resolution, the prefix and namespace URI pair must be added to the object and the method must be called to specify the object to use for namespace resolution. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. -- If the does not include a prefix, it is assumed that the namespace URI is the empty namespace. If your XML includes a default namespace, you must still use the method and provide an object that contains a prefix and namespace URI to handle the default namespace. +- If the does not include a prefix, it is assumed that the namespace URI is the empty namespace. If your XML includes a default namespace, you must still use the method and provide an object that contains a prefix and namespace URI to handle the default namespace. -- You can also supply an object for namespace resolution to the method when you create your object. +- You can also supply an object for namespace resolution to the method when you create your object. -- accepts as a namespace resolver, so you can implement a custom context and use functions and variables based on and . The XPath expression will execute them. For more information, see [User Defined Functions and Variables](/dotnet/standard/data/xml/user-defined-functions-and-variables). +- accepts as a namespace resolver, so you can implement a custom context and use functions and variables based on and . The XPath expression will execute them. For more information, see [User Defined Functions and Variables](/dotnet/standard/data/xml/user-defined-functions-and-variables). ## Examples - The following example shows how to use the XPath return type to determine how to process the XPath expression, and how to use the method to provide an object for namespace resolution. + The following example shows how to use the XPath return type to determine how to process the XPath expression, and how to use the method to provide an object for namespace resolution. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Data/XPathExpression.ReturnType/CPP/returntype.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathExpression/Overview/returntype.cs" id="Snippet1"::: diff --git a/xml/System.Xml.XPath/XPathItem.xml b/xml/System.Xml.XPath/XPathItem.xml index c1cdff52ee1..26b998c62ec 100644 --- a/xml/System.Xml.XPath/XPathItem.xml +++ b/xml/System.Xml.XPath/XPathItem.xml @@ -362,7 +362,7 @@ method attempts to convert the value of the item to the specified .NET type. + When overridden in a derived class, the method attempts to convert the value of the item to the specified .NET type. ]]> @@ -432,7 +432,7 @@ method attempts to convert the value of the item to the specified .NET type. + When overridden in a derived class, the method attempts to convert the value of the item to the specified .NET type. The object is used to resolve namespace prefixes related to type conversions. For example, when converting an `xs:QName` to an `xs:string`. diff --git a/xml/System.Xml.XPath/XPathNamespaceScope.xml b/xml/System.Xml.XPath/XPathNamespaceScope.xml index 8cb8c16b51d..1601d3f135e 100644 --- a/xml/System.Xml.XPath/XPathNamespaceScope.xml +++ b/xml/System.Xml.XPath/XPathNamespaceScope.xml @@ -62,7 +62,7 @@ enumeration can be passed to the and methods of the class to specify the type of namespace node to move to. + The enumeration can be passed to the and methods of the class to specify the type of namespace node to move to. ]]> diff --git a/xml/System.Xml.XPath/XPathNavigator.xml b/xml/System.Xml.XPath/XPathNavigator.xml index c2cc5a88454..bf77a0f0772 100644 --- a/xml/System.Xml.XPath/XPathNavigator.xml +++ b/xml/System.Xml.XPath/XPathNavigator.xml @@ -271,20 +271,20 @@ ## Remarks Appending child nodes adds the new nodes to the end of the list of child nodes for the current node. For example, when three child nodes exist for an element, the first appended node becomes the fourth child node. If no child nodes exist, then a new child node is created. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. -- The new child node is not inserted until the method of the object is called. +- The new child node is not inserted until the method of the object is called. -- The method is valid only when the is positioned on the root node or an element node. +- The method is valid only when the is positioned on the root node or an element node. -- The method does not affect the position of the . +- The method does not affect the position of the . You can write more than one node to the writer. All nodes are appended to the end of the list of child nodes of the current node. ## Examples - In the following example, a new `pages` child element is appended to the list of child elements of the first `book` element in the `contosoBooks.xml` file using the object returned from the method. + In the following example, a new `pages` child element is appended to the list of child elements of the first `book` element in the `contosoBooks.xml` file using the object returned from the method. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet1"::: @@ -379,11 +379,11 @@ To create a new element node, include all XML syntax in the XML string parameter. The string for a new `book` node is `AppendChild("")`. The string for appending the text "book" to the current node's text node is `AppendChild("book")`. If the XML string contains multiple nodes, all nodes are added. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. -- The method is valid only when the is positioned on the root node or an element node. +- The method is valid only when the is positioned on the root node or an element node. -- The method does not affect the position of the . +- The method does not affect the position of the . @@ -483,13 +483,13 @@ ## Remarks Appending a child node adds the new node to the end of the list of child nodes for the current node. For example, when three child nodes exist for an element, the appended node becomes the fourth child node. If no child nodes exist, then a new child node is created. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. - If the object is positioned over a sequence of XML nodes, all the nodes in the sequence are added. -- The method is valid only when the is positioned on the root node or an element node. +- The method is valid only when the is positioned on the root node or an element node. -- The method does not affect the position of the . +- The method does not affect the position of the . ## Examples In the following example, a new `pages` child element is appended to the list of child elements of the first `book` element in the `contosoBooks.xml` file using the object specified. The `http://www.contoso.com/books` namespace is specified so that the new child element is appended using the same namespace as the XML document. @@ -588,13 +588,13 @@ ## Remarks Appending a child node adds the new node to the end of the list of child nodes for the current node. For example, when three child nodes exist for an element, the appended node becomes the fourth child node. If no child nodes exist, then a new child node is created. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. - If the object is positioned over a sequence of XML nodes, all the nodes in the sequence are added. -- The method is valid only when the is positioned on the root node or an element node. +- The method is valid only when the is positioned on the root node or an element node. -- The method does not affect the position of the . +- The method does not affect the position of the . @@ -707,7 +707,7 @@ ## Remarks Appending a child node adds the new node to the end of the list of child nodes for the current node. For example, when three child nodes exist for an element node, the appended node becomes the fourth child node. If no child nodes exist, then a new child node is created. - Namespace prefix and URI values can be obtained by using the method or the method. For example, the following syntax appends a child element by using the in-scope namespace `xmlns:bk=http://www.contoso.com/books`: + Namespace prefix and URI values can be obtained by using the method or the method. For example, the following syntax appends a child element by using the in-scope namespace `xmlns:bk=http://www.contoso.com/books`: ```csharp navigator.AppendChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navigator.Prefix), String.Empty) @@ -715,13 +715,13 @@ navigator.AppendChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navig This creates the new child `` element. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. - If the namespace prefix specified is `null` or , then the prefix for the namespace URI of the new element is obtained from the current namespaces in-scope. If there is no namespace prefix assigned to the specified namespace URI at the current scope, then a namespace prefix is automatically generated. -- The method is valid only when the is positioned on the root node or an element node. +- The method is valid only when the is positioned on the root node or an element node. -- The method does not affect the position of the . +- The method does not affect the position of the . @@ -976,9 +976,9 @@ navigator.AppendChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navig ## Remarks -- The method verifies that the XML data contained in the conforms to a global type or declaration in the schema or schemas provided in the . +- The method verifies that the XML data contained in the conforms to a global type or declaration in the schema or schemas provided in the . -- The method does not perform infoset augmentation. This means that schema defaults are not applied, text values are not converted to atomic values, and no new type information is associated with information items. +- The method does not perform infoset augmentation. This means that schema defaults are not applied, text values are not converted to atomic values, and no new type information is associated with information items. - Schema `xsi:schemaLocation` or `xsi:noNamespaceSchemaLocation` hints in the XML data of are ignored. @@ -1041,7 +1041,7 @@ navigator.AppendChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navig method is especially useful in conjunction with the . An is used to iterate over a selected node set, and contains a property which returns an positioned on the context node of the . However, the returned by the property cannot be used to move away from the node set. Instead, you clone the returned and use the cloned navigator to do any additional moves. + The method is especially useful in conjunction with the . An is used to iterate over a selected node set, and contains a property which returns an positioned on the context node of the . However, the returned by the property cannot be used to move away from the node set. Instead, you clone the returned and use the cloned navigator to do any additional moves. The cloned is not affected by subsequent changes to the original . @@ -1149,7 +1149,7 @@ navigator.AppendChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navig ||The two objects are positioned on the same node.| ||The node positions cannot be determined relative to each other in the document order, or `null` is specified as the parameter. This could occur if the two nodes reside in different trees.| - The method's behavior is dependent on the the is currently positioned on. When comparing nodes in the XML document, the following rules apply: + The method's behavior is dependent on the the is currently positioned on. When comparing nodes in the XML document, the following rules apply: - nodes: These nodes are returned in document order from the source document. @@ -1163,7 +1163,7 @@ navigator.AppendChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navig This method has no effect on the state of the . > [!NOTE] -> Use the method rather than the method when possible. +> Use the method rather than the method when possible. ]]> @@ -1231,7 +1231,7 @@ navigator.AppendChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navig - String: a sequence of UCS characters - Expressions that return a node set can be used in the and methods. Expressions that return a Boolean, number, or string can be used in the method. The rules on valid expressions for the method are specific to that method. + Expressions that return a node set can be used in the and methods. Expressions that return a Boolean, number, or string can be used in the method. The rules on valid expressions for the method are specific to that method. ]]> @@ -1302,7 +1302,7 @@ navigator.AppendChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navig or method. For example, the following syntax creates an attribute by using the in-scope namespace `xmlns:bk="http://www.contoso.com/books"`: + Namespace prefix and URI values can be obtained using the or method. For example, the following syntax creates an attribute by using the in-scope namespace `xmlns:bk="http://www.contoso.com/books"`: ```csharp editor.CreateAttribute(navigator.Prefix, "attributeName", LookupNamespace(navigator.Prefix), "text") @@ -1310,13 +1310,13 @@ editor.CreateAttribute(navigator.Prefix, "attributeName", LookupNamespace(naviga This creates the new attribute `` on the current element. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. -- If the namespace prefix specified is or `null`, the prefix for the namespace URI of the new attribute is obtained from the current namespaces in-scope. If there is no namespace prefix assigned to the specified namespace URI at the current scope, a namespace prefix is automatically generated. For example to create a new attribute on an element in the default namespace of the `contosoBooks.xml` file, (`xmlns="http://www.contoso.com/books"`), you specify `null` or for both the namespace prefix and namespace URI parameters. Specifying `http://www.contoso.com/books` as the namespace URI parameter will cause the method to auto generate a namespace prefix for the new attribute. +- If the namespace prefix specified is or `null`, the prefix for the namespace URI of the new attribute is obtained from the current namespaces in-scope. If there is no namespace prefix assigned to the specified namespace URI at the current scope, a namespace prefix is automatically generated. For example to create a new attribute on an element in the default namespace of the `contosoBooks.xml` file, (`xmlns="http://www.contoso.com/books"`), you specify `null` or for both the namespace prefix and namespace URI parameters. Specifying `http://www.contoso.com/books` as the namespace URI parameter will cause the method to auto generate a namespace prefix for the new attribute. - If the new attribute created is a namespace node that conflicts with a namespace declaration on the element, either because the namespace prefix chosen is used by another namespace declaration at the same scope, or because the prefix chosen is the same as that of the element but is bound to a different namespace URI, an exception is thrown. -- The method does not affect the position of the . +- The method does not affect the position of the . ## Examples In the following example, a new `discount` attribute is created on the `price` child element of the first `book` element in the `contosoBooks.xml` file. @@ -1408,24 +1408,24 @@ editor.CreateAttribute(navigator.Prefix, "attributeName", LookupNamespace(naviga method. + The following are important notes to consider when using the method. - When the is positioned on an element, the new attributes created by the method are placed at the end of the attribute list of the current element. -- The new attributes are not inserted until the method of the object is called. +- The new attributes are not inserted until the method of the object is called. -- If the namespace prefix specified is or `null`, the prefix for the namespace URI of the new attribute is obtained from the current namespaces in-scope. If there is no namespace prefix assigned to the specified namespace URI at the current scope, a namespace prefix is automatically generated. For example to create a new attribute on an element in the default namespace of the `contosoBooks.xml` file, (`xmlns="http://www.contoso.com/books"`), you specify `null` or for both the namespace prefix and namespace URI parameters. Specifying `http://www.contoso.com/books` as the namespace URI parameter will cause the method to auto generate a namespace prefix for the new attribute. +- If the namespace prefix specified is or `null`, the prefix for the namespace URI of the new attribute is obtained from the current namespaces in-scope. If there is no namespace prefix assigned to the specified namespace URI at the current scope, a namespace prefix is automatically generated. For example to create a new attribute on an element in the default namespace of the `contosoBooks.xml` file, (`xmlns="http://www.contoso.com/books"`), you specify `null` or for both the namespace prefix and namespace URI parameters. Specifying `http://www.contoso.com/books` as the namespace URI parameter will cause the method to auto generate a namespace prefix for the new attribute. - If the new attribute created is a namespace node that conflicts with a namespace declaration on the element, either because the namespace prefix chosen is used by another namespace declaration at the same scope, or because the prefix chosen is the same as that of the element but is bound to a different namespace URI, an exception is thrown. - The object returned may only be used to create attributes. Calling other object methods that do not create attributes throws an exception. -- The method does not affect the position of the . +- The method does not affect the position of the . ## Examples - In the following example, new `discount` and `currency` attributes are created on the `price` child element of the first `book` element in the `contosoBooks.xml` file using the object returned from the method. + In the following example, new `discount` and `currency` attributes are created on the `price` child element of the first `book` element in the `contosoBooks.xml` file using the object returned from the method. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet8"::: @@ -1523,7 +1523,7 @@ editor.CreateAttribute(navigator.Prefix, "attributeName", LookupNamespace(naviga method. + This method is equivalent to the method. ]]> @@ -1578,12 +1578,12 @@ editor.CreateAttribute(navigator.Prefix, "attributeName", LookupNamespace(naviga method deletes a range of sibling nodes from the current node the is positioned on (inclusive) to the node specified by the parameter (inclusive). The is then positioned on its parent node. + The method deletes a range of sibling nodes from the current node the is positioned on (inclusive) to the node specified by the parameter (inclusive). The is then positioned on its parent node. ## Examples - In the following example, the first and second `book` elements of the `contosoBooks.xml` file are deleted using the method. + In the following example, the first and second `book` elements of the `contosoBooks.xml` file are deleted using the method. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet52"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet52"::: @@ -1683,12 +1683,12 @@ editor.CreateAttribute(navigator.Prefix, "attributeName", LookupNamespace(naviga - If the deleted node is a text node that is the content of a simple typed element, the element loses its type information. This means that when positioned on the element the , and properties have the values `null`, and respectively. -- Deleted nodes are still accessible to objects positioned over them prior to deletion. However methods that attempt to move away from the deleted sub-tree fail. For example, the and methods always fail when the is positioned over the top most deleted node. This is because the deleted node is no longer connected to the XML document. Similarly the method always fails if the is positioned on the bottom-most deleted node. +- Deleted nodes are still accessible to objects positioned over them prior to deletion. However methods that attempt to move away from the deleted sub-tree fail. For example, the and methods always fail when the is positioned over the top most deleted node. This is because the deleted node is no longer connected to the XML document. Similarly the method always fails if the is positioned on the bottom-most deleted node. ## Examples - In the following example the `price` element of the first `book` element of the `contosoBooks.xml` file is deleted using the method. The position of the object after the `price` element is deleted is on the parent `book` element. + In the following example the `price` element of the first `book` element of the `contosoBooks.xml` file is deleted using the method. The position of the object after the `price` element is deleted is on the parent `book` element. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet9"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet9"::: @@ -2147,7 +2147,7 @@ nav.Evaluate(expr); - The `context` argument is `null`. -- has not been called on the . +- has not been called on the . Because the position() and last() functions work on the current node, you should not use the property to move away from the selected node set. This could invalidate the state of the . @@ -2255,7 +2255,7 @@ nav.Evaluate(expr); must be positioned on an element node before calling the method. + The must be positioned on an element node before calling the method. This method has no effect on the state of the . @@ -2322,7 +2322,7 @@ nav.Evaluate(expr); is specified as the `name` parameter, the method returns the default `xmlns` namespace. + Namespaces `xml` and `xmlns` always return a value. If is specified as the `name` parameter, the method returns the default `xmlns` namespace. For a definition of namespace nodes, see section 5.4 of the W3C [XML Path Language (XPath)](https://www.w3.org/TR/xpath/all/#data-model) recommendation. @@ -2672,18 +2672,18 @@ nav.Evaluate(expr); method. + The following are important notes to consider when using the method. -- The new sibling node is not inserted until the method of the object is called. +- The new sibling node is not inserted until the method of the object is called. -- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. +- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. -- The method does not affect the position of the . +- The method does not affect the position of the . ## Examples - In the following example a new `pages` element is inserted after the `price` child element of the first `book` element in the `contosoBooks.xml` file using the object returned by the method. + In the following example a new `pages` element is inserted after the `price` child element of the first `book` element in the `contosoBooks.xml` file using the object returned by the method. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet14"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet14"::: @@ -2776,11 +2776,11 @@ nav.Evaluate(expr); ## Remarks To create a new element node, include all XML syntax in the XML string parameter. The string for a new `book` node is `InsertAfter("")`. The string for inserting the text "book" after the current node's text node is `InsertAfter("book")`. If the XML string contains multiple nodes, all nodes are added. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. -- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. +- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. -- The method does not affect the position of the . +- The method does not affect the position of the . @@ -2878,13 +2878,13 @@ nav.Evaluate(expr); method. + The following are important notes to consider when using the method. - If the object is positioned over a sequence of XML nodes, all the nodes in the sequence are added. -- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. +- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. -- The method does not affect the position of the . +- The method does not affect the position of the . @@ -2983,13 +2983,13 @@ nav.Evaluate(expr); method. + The following are important notes to consider when using the method. - If the object is positioned over a sequence of XML nodes, all the nodes in the sequence are added. -- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. +- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. -- The method does not affect the position of the . +- The method does not affect the position of the . @@ -3093,18 +3093,18 @@ nav.Evaluate(expr); method. + The following are important notes to consider when using the method. -- The new sibling node is not inserted until the method of the object is called. +- The new sibling node is not inserted until the method of the object is called. -- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. +- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. -- The method does not affect the position of the . +- The method does not affect the position of the . ## Examples - In the following example a new `pages` element is inserted before the `price` child element of the first `book` element in the `contosoBooks.xml` file using the object returned by the method. + In the following example a new `pages` element is inserted before the `price` child element of the first `book` element in the `contosoBooks.xml` file using the object returned by the method. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet18"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet18"::: @@ -3197,11 +3197,11 @@ nav.Evaluate(expr); ## Remarks To create a new element node, include all XML syntax in the XML string parameter. The string for a new `book` node is `InsertBefore("")`. The string for inserting the text "book" before the current node's text node is `InsertBefore("book")`. If the XML string contains multiple nodes, all nodes are added. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. -- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. +- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. -- The method does not affect the position of the . +- The method does not affect the position of the . @@ -3299,13 +3299,13 @@ nav.Evaluate(expr); method. + The following are important notes to consider when using the method. - If the object is positioned over a sequence of XML nodes, all the nodes in the sequence are added. -- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. +- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. -- The method does not affect the position of the . +- The method does not affect the position of the . @@ -3404,13 +3404,13 @@ nav.Evaluate(expr); method. + The following are important notes to consider when using the method. - If the object is positioned over a sequence of XML nodes, all the nodes in the sequence are added. -- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. +- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. -- The method does not affect the position of the . +- The method does not affect the position of the . @@ -3521,7 +3521,7 @@ nav.Evaluate(expr); or method. For example, the following syntax inserts a sibling element by using the in-scope namespace `xmlns:bk="http://www.contoso.com/books"`: + Namespace prefix and URI values can be obtained using the or method. For example, the following syntax inserts a sibling element by using the in-scope namespace `xmlns:bk="http://www.contoso.com/books"`: ```csharp navigator.InsertElementAfter(navigator.Prefix, "pages", LookupNamespaceURI(navigator.Prefix), String.Empty) @@ -3529,13 +3529,13 @@ navigator.InsertElementAfter(navigator.Prefix, "pages", LookupNamespaceURI(navig This creates the new sibling `` element. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. - If the namespace prefix specified is `null` or , then the prefix for the namespace URI of the new element is obtained from the current namespaces in-scope. If there is no namespace prefix assigned to the specified namespace URI at the current scope, then a namespace prefix is automatically generated. -- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. +- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. -- The method does not affect the position of the . +- The method does not affect the position of the . @@ -3645,7 +3645,7 @@ navigator.InsertElementAfter(navigator.Prefix, "pages", LookupNamespaceURI(navig or method. For example, the following syntax inserts a sibling element by using the in-scope namespace `xmlns:bk="http://www.contoso.com/books"`: + Namespace prefix and URI values can be obtained using the or method. For example, the following syntax inserts a sibling element by using the in-scope namespace `xmlns:bk="http://www.contoso.com/books"`: ```csharp navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navigator.Prefix), String.Empty) @@ -3653,13 +3653,13 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi This creates the new sibling `` element. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. - If the namespace prefix specified is `null` or , then the prefix for the namespace URI of the new element is obtained from the current namespaces in-scope. If there is no namespace prefix assigned to the specified namespace URI at the current scope, then a namespace prefix is automatically generated. -- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. +- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. -- The method does not affect the position of the . +- The method does not affect the position of the . @@ -3770,7 +3770,7 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi `widget` - If the current is positioned on the `item` node, and the specified is positioned on the `name` node, returns `true`. + If the current is positioned on the `item` node, and the specified is positioned on the `name` node, returns `true`. This method always returns `false` under the following conditions: @@ -3939,7 +3939,7 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi method assumes that the specified shares the same implementation and is points at the same document instance as the current . + The method assumes that the specified shares the same implementation and is points at the same document instance as the current . This method always returns `false` under the following conditions: @@ -4119,12 +4119,12 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi If is specified as the `prefix` parameter, the currently assigned default namespace URI is returned. If no default namespace URI is explicitly assigned, and is specified as the `prefix` parameter, the blank prefix is associated with elements that are not in any namespace, and is returned. > [!NOTE] -> The prefix to namespace URI mappings can change from node to node in an XML document. As a result, the value of the method may not be consistent from one node to the next. +> The prefix to namespace URI mappings can change from node to node in an XML document. As a result, the value of the method may not be consistent from one node to the next. ## Examples - For an example of the method, see the or methods. + For an example of the method, see the or methods. ]]> @@ -4190,10 +4190,10 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi method returns the first prefix that matches the namespace URI specified. Multiple prefixes referring to the same namespace URI are not ordered in any particular way, so a particular prefix may not be returned each time when more than one is assigned. + The method returns the first prefix that matches the namespace URI specified. Multiple prefixes referring to the same namespace URI are not ordered in any particular way, so a particular prefix may not be returned each time when more than one is assigned. > [!NOTE] -> Namespace URI to prefix mappings can change from node to node in an XML document. As a result, the value of the method may not be consistent from one node to the next. +> Namespace URI to prefix mappings can change from node to node in an XML document. As a result, the value of the method may not be consistent from one node to the next. ]]> @@ -4265,7 +4265,7 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi ## Examples - For an example of the method, see the method. + For an example of the method, see the method. ]]> @@ -4325,7 +4325,7 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi . This method is identical to the method, except that a object containing the compiled XPath expression is specified, rather than an XPath expression . + This method has no effect on the state of the . This method is identical to the method, except that a object containing the compiled XPath expression is specified, rather than an XPath expression . @@ -4492,9 +4492,9 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi ## Remarks If the is not currently positioned on an element, this method returns `false`. - After a successful call to , the , and properties reflect the values of the attribute. When the is positioned on an attribute, the methods , , and are not applicable. These methods always return `false` and do not change the position of the navigator. Rather, you can call to move to the next attribute node. + After a successful call to , the , and properties reflect the values of the attribute. When the is positioned on an attribute, the methods , , and are not applicable. These methods always return `false` and do not change the position of the navigator. Rather, you can call to move to the next attribute node. - Once positioned on an attribute, you can call to move to the owner element. + Once positioned on an attribute, you can call to move to the owner element. ]]> @@ -4563,7 +4563,7 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi method depends on the of the current node, and the of the child node to move to. + The return value of the method depends on the of the current node, and the of the child node to move to. The following table shows the different nodes, and the child nodes they can move to. @@ -4630,7 +4630,7 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi method, see the method. + For an example of the method, see the method. ]]> @@ -4743,14 +4743,14 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi ## Remarks If the is not currently positioned on an element, this method returns `false` and the position of the does not change. - After a successful call to , the , and properties reflect the values of the attribute. When the is positioned on an attribute, the methods , , and are not applicable. These methods always return `false` and do not change the position of the . Rather, you can call to move to the next attribute node. + After a successful call to , the , and properties reflect the values of the attribute. When the is positioned on an attribute, the methods , , and are not applicable. These methods always return `false` and do not change the position of the . Rather, you can call to move to the next attribute node. - After the is positioned on an attribute, you can call to move to the owner element. + After the is positioned on an attribute, you can call to move to the owner element. ## Examples - The following example uses the and methods to display all the attributes for each book in the `books.xml` file. + The following example uses the and methods to display all the attributes for each book in the `books.xml` file. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet49"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet49"::: @@ -4848,7 +4848,7 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi ## Examples - For an example of the method, see the method. + For an example of the method, see the method. ]]> @@ -4922,13 +4922,13 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi class returns namespace nodes in reverse document order. Therefore, essentially moves to the last namespace node in the current scope. + The class returns namespace nodes in reverse document order. Therefore, essentially moves to the last namespace node in the current scope. After the has been moved to the namespace node, the property reflects the name of the namespace. - When the is positioned on a namespace node, the methods , , and are not applicable. These methods always return `false` and do not change the position of the . Rather, you can call to move to the next namespace node. + When the is positioned on a namespace node, the methods , , and are not applicable. These methods always return `false` and do not change the position of the . Rather, you can call to move to the next namespace node. - After the is positioned on an namespace node, call to move back to the element node. + After the is positioned on an namespace node, call to move back to the element node. For a definition of namespace nodes, see section 5.4 of the W3C [XML Path Language (XPath)](https://www.w3.org/TR/xpath/all/#data-model) recommendation. @@ -4991,9 +4991,9 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi class returns namespace nodes in reverse document order. Therefore, essentially moves to the last namespace node in the current scope. + The class returns namespace nodes in reverse document order. Therefore, essentially moves to the last namespace node in the current scope. - Using the following XML fragment as an example, if the is positioned on the `data` node, behaves in the following manner. + Using the following XML fragment as an example, if the is positioned on the `data` node, behaves in the following manner. - `MoveToFirstNamespace(XPathNamespaceScope.All)` moves to one of the following namespace nodes: `xmlns:c='C'`, `xmlns:a='A2'`, `xmlns=''`, `xmlns:b='B'`, or `xmlns:xml='http://www.w3.org/XML/1998/namespace'`. @@ -5011,9 +5011,9 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi If the is not currently positioned on an element, this method returns `false` and the position of the does not change. After the has been moved to the namespace node, the property reflects the name of the namespace. - When the is positioned on a namespace node, the methods , , and are not applicable. These methods always return `false` and do not change the position of the . Rather, you can call to move to the next namespace node. + When the is positioned on a namespace node, the methods , , and are not applicable. These methods always return `false` and do not change the position of the . Rather, you can call to move to the next namespace node. - After the is positioned on an namespace node, call to move back to the element node. + After the is positioned on an namespace node, call to move back to the element node. For a definition of namespace nodes, see section 5.4 of the W3C [XML Path Language (XPath)](https://www.w3.org/TR/xpath/all/#data-model) recommendation. @@ -5091,9 +5091,9 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi ## Remarks -- The method does not move to attribute or namespace nodes. If the parameter value is or , the method returns `false` and the position of the is unchanged. +- The method does not move to attribute or namespace nodes. If the parameter value is or , the method returns `false` and the position of the is unchanged. -- If the method returns `false`, the position of the is unchanged. +- If the method returns `false`, the position of the is unchanged. @@ -5197,7 +5197,7 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi method returns `false`, the position of the is unchanged. + If the method returns `false`, the position of the is unchanged. @@ -5297,20 +5297,20 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi ## Remarks -- The method does not move to attribute or namespace nodes. If the parameter value is or , the method returns `false` and the position of the is unchanged. +- The method does not move to attribute or namespace nodes. If the parameter value is or , the method returns `false` and the position of the is unchanged. - If the boundary passed as a parameter is not positioned after the position of the current it is ignored. - If boundary passed as a parameter is `null` the next following node with the specified is located in document order. -- The methods cannot be used to move to attribute or namespace nodes. If the boundary passed as a parameter is positioned over an attribute or namespace node, it is equivalent to the boundary parameter having been positioned on the first child node of its parent element. This ensures that the parent element of the attribute or namespace node that the boundary parameter is positioned on can be matched by this method. +- The methods cannot be used to move to attribute or namespace nodes. If the boundary passed as a parameter is positioned over an attribute or namespace node, it is equivalent to the boundary parameter having been positioned on the first child node of its parent element. This ensures that the parent element of the attribute or namespace node that the boundary parameter is positioned on can be matched by this method. -- If the method returns `false`, the position of the is unchanged. +- If the method returns `false`, the position of the is unchanged. ## Examples - In the following example, the is moved from the root of the `contosoBooks.xml` file to the following `price` element. A clone of the object is made using the method. The cloned , positioned on the `price` element, will be used as a boundary. Changes in the position of the cloned do not affect the original . The original is moved back to the root of the `contosoBooks.xml` file using the method. The title and first and last name of the author are retrieved using the method and an of . The method will return true until the `price` element boundary is reached. + In the following example, the is moved from the root of the `contosoBooks.xml` file to the following `price` element. A clone of the object is made using the method. The cloned , positioned on the `price` element, will be used as a boundary. Changes in the position of the cloned do not affect the original . The original is moved back to the root of the `contosoBooks.xml` file using the method. The title and first and last name of the author are retrieved using the method and an of . The method will return true until the `price` element boundary is reached. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet27"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet27"::: @@ -5418,14 +5418,14 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi - If the boundary parameter is `null`, the following element with the local name and namespace URI specified is located in document order. -- The methods cannot be used to move to attribute or namespace nodes. If the boundary passed as a parameter is positioned over an attribute or namespace node, it is equivalent to the boundary parameter having been positioned on the first child node of its parent element. This ensures that the parent element of the attribute or namespace node that the boundary parameter is positioned on can be matched by this method. +- The methods cannot be used to move to attribute or namespace nodes. If the boundary passed as a parameter is positioned over an attribute or namespace node, it is equivalent to the boundary parameter having been positioned on the first child node of its parent element. This ensures that the parent element of the attribute or namespace node that the boundary parameter is positioned on can be matched by this method. -- If the method returns `false`, the position of the is unchanged. +- If the method returns `false`, the position of the is unchanged. ## Examples - In the following example, the is moved from the root of the `contosoBooks.xml` file to the following `book` element. A clone of the object is made using the method and is moved from the `book` element to the following `first-name` element. The cloned , positioned on the `first-name` element, will be used as a boundary. Changes in the position of the cloned do not affect the original . The original then attempts to move to the following `price` element using the method with the boundary passed as a parameter. This move fails because the following `price` element is beyond the boundary. The original then attempts to move to the following `title` element which is before the boundary using the same method and succeeds. + In the following example, the is moved from the root of the `contosoBooks.xml` file to the following `book` element. A clone of the object is made using the method and is moved from the `book` element to the following `first-name` element. The cloned , positioned on the `first-name` element, will be used as a boundary. Changes in the position of the cloned do not affect the original . The original then attempts to move to the following `price` element using the method with the boundary passed as a parameter. This move fails because the following `price` element is beyond the boundary. The original then attempts to move to the following `title` element which is before the boundary using the same method and succeeds. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet28"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet28"::: @@ -5585,9 +5585,9 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi ## Remarks After the has been moved to the namespace node, the property reflects the name of the namespace. - When the is positioned on a namespace node, the methods , , and are not applicable. These methods always return `false` and do not change the position of the . Rather, you can call to move to the next namespace node. + When the is positioned on a namespace node, the methods , , and are not applicable. These methods always return `false` and do not change the position of the . Rather, you can call to move to the next namespace node. - After the is positioned on a namespace node, you can call to move back to the element node. + After the is positioned on a namespace node, you can call to move back to the element node. For a definition of namespace nodes, see section 5.4 of the W3C [XML Path Language (XPath)](https://www.w3.org/TR/xpath/all/#data-model) recommendation. @@ -5749,7 +5749,7 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi method depends on the of the current node and the of the next sibling node to move to. + The return value of the method depends on the of the current node and the of the next sibling node to move to. The following table shows the different nodes and the sibling nodes they can move to. @@ -5868,14 +5868,14 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi ## Remarks If the is not currently positioned on an attribute, this method returns `false` and the position of the does not change. - When the is positioned on an attribute, the methods , , and methods are not applicable. These methods always return `false` and do not change the position of the . + When the is positioned on an attribute, the methods , , and methods are not applicable. These methods always return `false` and do not change the position of the . - After the is positioned on an attribute, you can call to move to the owner element. + After the is positioned on an attribute, you can call to move to the owner element. ## Examples - The following example uses the and methods to display all the attributes for each book in the `books.xml` file. + The following example uses the and methods to display all the attributes for each book in the `books.xml` file. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet49"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet49"::: @@ -5983,13 +5983,13 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi class returns namespace nodes in reverse document order. Therefore, essentially moves to the namespace node above the one in the current scope. + The class returns namespace nodes in reverse document order. Therefore, essentially moves to the namespace node above the one in the current scope. If the is not currently positioned on a namespace node, this method returns `false` and the position of the does not change. - When the is positioned on a namespace node, the methods , , and are not applicable. These methods always return `false` and do not change the position of the . + When the is positioned on a namespace node, the methods , , and are not applicable. These methods always return `false` and do not change the position of the . - After the is positioned on an namespace node, call to move back to the element node. + After the is positioned on an namespace node, call to move back to the element node. For a definition of namespace nodes, see section 5.4 of the W3C [XML Path Language (XPath)](https://www.w3.org/TR/xpath/all/#data-model) recommendation. @@ -6056,9 +6056,9 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi If the is not currently positioned on a namespace node, this method returns `false` and the position of the does not change. - When the is positioned on a namespace node, the methods , , and are not applicable. These methods always return `false` and do not change the position of the . + When the is positioned on a namespace node, the methods , , and are not applicable. These methods always return `false` and do not change the position of the . - After the is positioned on an namespace node, call to move back to the element node. + After the is positioned on an namespace node, call to move back to the element node. For a definition of namespace nodes, see section 5.4 of the W3C [XML Path Language (XPath)](https://www.w3.org/TR/xpath/all/#data-model) recommendation. @@ -6118,7 +6118,7 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi method depends on the of the current node, and the of the parent node to move to. + The return value of the method depends on the of the current node, and the of the parent node to move to. The following table shows the different nodes, and the parent nodes they can move to. @@ -6137,7 +6137,7 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi ## Examples - For an example of the method, see the method. + For an example of the method, see the method. ]]> @@ -6249,7 +6249,7 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi ## Examples - For an example of the method, see the method. + For an example of the method, see the method. ]]> @@ -6563,7 +6563,7 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi property allows objects to be compared on the basis of position rather than reference to the object. The and methods implemented by this class are based on the position of the objects passed as parameters. The method implemented by this class uses the properties of the node such as its local name and namespace URI to create a hash code for the node. + The property allows objects to be compared on the basis of position rather than reference to the object. The and methods implemented by this class are based on the position of the objects passed as parameters. The method implemented by this class uses the properties of the node such as its local name and namespace URI to create a hash code for the node. @@ -6944,18 +6944,18 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi ## Remarks Prepending a child node adds the new node to the beginning of the list of child nodes for the current node. For example, when three child nodes exist for an element, the prepended node becomes the first child node. If no child nodes exist, then a new child node is created. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. -- The new child node is not inserted until the method of the object is called. +- The new child node is not inserted until the method of the object is called. -- The method is valid only when the is positioned on an element node. +- The method is valid only when the is positioned on an element node. -- The method does not affect the position of the . +- The method does not affect the position of the . ## Examples - In the following example, a new `pages` child element is prepended to the beginning of the list of child elements of the first `book` element in the `contosoBooks.xml` file using the object returned from the method. + In the following example, a new `pages` child element is prepended to the beginning of the list of child elements of the first `book` element in the `contosoBooks.xml` file using the object returned from the method. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet30"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet30"::: @@ -7050,11 +7050,11 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi To create a new element node, include all XML syntax in the XML string parameter. The string for a new `book` node is `PrependChild("")`. The string for appending the text "book" to the current node's text node is `PrependChild("book")`. If the XML string contains multiple nodes, all nodes are added. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. -- The method is valid only when the is positioned on an element node. +- The method is valid only when the is positioned on an element node. -- The method does not affect the position of the . +- The method does not affect the position of the . @@ -7154,13 +7154,13 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi ## Remarks Prepending a child node adds the new node to the beginning of the list of child nodes for the current node. For example, when three child nodes exist for an element, the prepended node becomes the first child node. If no child nodes exist, then a new child node is created. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. - If the object is positioned over a sequence of XML nodes, all the nodes in the sequence are added. -- The method is valid only when the is positioned on an element node. +- The method is valid only when the is positioned on an element node. -- The method does not affect the position of the . +- The method does not affect the position of the . @@ -7261,13 +7261,13 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi ## Remarks Prepending a child node adds the new node to the beginning of the list of child nodes for the current node. For example, when three child nodes exist for an element, the prepended node becomes the first child node. If no child nodes exist, then a new child node is created. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. - If the object is positioned over a sequence of XML nodes, all the nodes in the sequence are added. -- The method is valid only when the is positioned on an element node. +- The method is valid only when the is positioned on an element node. -- The method does not affect the position of the . +- The method does not affect the position of the . @@ -7380,7 +7380,7 @@ navigator.InsertElementBefore(navigator.Prefix, "pages", LookupNamespaceURI(navi ## Remarks Prepending a child node adds the new node to the beginning of the list of child nodes for the current node. For example, when three child nodes exist for an element, the prepended node becomes the first child node. If no child nodes exist, then a new child node is created. - Namespace prefix and URI values can be obtained by using the or method. For example, the following syntax prepends a child element by using the in-scope namespace `xmlns:bk="http://www.contoso.com/books"`: + Namespace prefix and URI values can be obtained by using the or method. For example, the following syntax prepends a child element by using the in-scope namespace `xmlns:bk="http://www.contoso.com/books"`: ```csharp navigator.PrependChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navigator.Prefix), String.Empty) @@ -7388,13 +7388,13 @@ navigator.PrependChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navi This creates the new child `` element. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. - If the namespace prefix specified is `null` or , then the prefix for the namespace URI of the new element is obtained from the current namespaces in-scope. If there is no namespace prefix assigned to the specified namespace URI at the current scope, then a namespace prefix is automatically generated. -- The method is valid only when the is positioned on an element node. +- The method is valid only when the is positioned on an element node. -- The method does not affect the position of the . +- The method does not affect the position of the . @@ -7488,7 +7488,7 @@ navigator.PrependChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navi object is created with the current node and its child nodes, the object's property is set to . When the object's method is called for the first time, the is moved to the current node of the . The new object continues to read until the end of the XML tree is reached. At this point, the method returns `false` and the object's property is set to . + When the object is created with the current node and its child nodes, the object's property is set to . When the object's method is called for the first time, the is moved to the current node of the . The new object continues to read until the end of the XML tree is reached. At this point, the method returns `false` and the object's property is set to . > [!NOTE] > Changing the position of the object does not affect the position of the . @@ -7496,7 +7496,7 @@ navigator.PrependChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navi Namespace declarations for the in-scope namespaces of the current node are not inserted into the XML stream provided to the object. > [!NOTE] -> This behavior differs from the method. +> This behavior differs from the method. This method creates the object with specific reader settings, and the module that uses this method has no control over those settings. For example, the reader returned by this method prohibits processing Data Type Definitions (DTDs). If the reader attempts to read a file that uses a DTD, it will throw an error, . The message for the exception will be `Unexpected DTD declaration`. @@ -7505,7 +7505,7 @@ navigator.PrependChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navi ## Examples - The following example illustrates using the method on the first `book` element of the `contosoBooks.xml` file. + The following example illustrates using the method on the first `book` element of the `contosoBooks.xml` file. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet35"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet35"::: @@ -7596,15 +7596,15 @@ navigator.PrependChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navi method replaces a range of sibling nodes from the current node the is positioned on (inclusive) to the node specified by the parameter (inclusive). + The method replaces a range of sibling nodes from the current node the is positioned on (inclusive) to the node specified by the parameter (inclusive). > [!NOTE] -> The replacement range is not inserted until the method of the object is called. +> The replacement range is not inserted until the method of the object is called. ## Examples - In the following example, the first and second `book` elements of the `contosoBooks.xml` file are replaced with a new empty `book` element using the method. + In the following example, the first and second `book` elements of the `contosoBooks.xml` file are replaced with a new empty `book` element using the method. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet53"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet53"::: @@ -7705,15 +7705,15 @@ navigator.PrependChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navi is positioned on the new node on completion of the method and returns `true`. The is not positioned on the new node after completion of the method when the XML input is in which case the is either positioned on the next sibling node or the parent node if there is no next sibling node to the replaced node and the returns `false`. + The is positioned on the new node on completion of the method and returns `true`. The is not positioned on the new node after completion of the method when the XML input is in which case the is either positioned on the next sibling node or the parent node if there is no next sibling node to the replaced node and the returns `false`. -- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. +- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. -- If the XML data string is not well-formed than an exception is thrown and the result of this method is equivalent to calling on the current node. +- If the XML data string is not well-formed than an exception is thrown and the result of this method is equivalent to calling on the current node. - If the XML string contains multiple nodes, all nodes are added and the is positioned on the first node in the series of nodes. -- The method is not equivalent to the method. +- The method is not equivalent to the method. @@ -7811,15 +7811,15 @@ navigator.PrependChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navi is positioned on the new node on completion of the method and returns `true`. The is not positioned on the new node after completion of the method when the XML input is in which case the is either positioned on the next sibling node or the parent node if there is no next sibling node to the replaced node and the returns `false`. + The is positioned on the new node on completion of the method and returns `true`. The is not positioned on the new node after completion of the method when the XML input is in which case the is either positioned on the next sibling node or the parent node if there is no next sibling node to the replaced node and the returns `false`. -- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. +- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. -- If the XML data string is not well-formed than an exception is thrown and the result of this method is equivalent to calling on the current node. +- If the XML data string is not well-formed than an exception is thrown and the result of this method is equivalent to calling on the current node. - If the XML string contains multiple nodes, all nodes are added and the is positioned on the first node in the series of nodes. -- The method is not equivalent to the method. +- The method is not equivalent to the method. @@ -7918,15 +7918,15 @@ navigator.PrependChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navi is positioned on the new node on completion of the method and returns `true`. The is not positioned on the new node after completion of the method when the XML input is in which case the is either positioned on the next sibling node or the parent node if there is no next sibling node to the replaced node and the returns `false`. + The is positioned on the new node on completion of the method and returns `true`. The is not positioned on the new node after completion of the method when the XML input is in which case the is either positioned on the next sibling node or the parent node if there is no next sibling node to the replaced node and the returns `false`. -- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. +- The method is valid only when the is positioned on an element, text, processing instruction, or comment node. -- If the XML data string is not well-formed than an exception is thrown and the result of this method is equivalent to calling on the current node. +- If the XML data string is not well-formed than an exception is thrown and the result of this method is equivalent to calling on the current node. - If the XML string contains multiple nodes, all nodes are added and the is positioned on the first node in the series of nodes. -- The method is not equivalent to the method. +- The method is not equivalent to the method. @@ -8093,7 +8093,7 @@ navigator.PrependChildElement(navigator.Prefix, "pages", LookupNamespaceURI(navi when this method is called. After calling this method, the returned represents the set of selected nodes. Use method of the to iterate over the selected node set. + The context for the selection is the position of the when this method is called. After calling this method, the returned represents the set of selected nodes. Use method of the to iterate over the selected node set. The following C# code iterates over the selected set of nodes. @@ -8105,20 +8105,20 @@ while (iterator.MoveNext()) } ``` - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. - You can still use any of the object's navigation methods to move within the . The navigation methods are independent of the selected nodes in the . -- Future calls to the method return a new object that points to the selected set of nodes that matches the new call. The two objects are completely independent of each other. +- Future calls to the method return a new object that points to the selected set of nodes that matches the new call. The two objects are completely independent of each other. -- If the XPath expression requires namespace resolution, use the overload, which takes an as its argument. +- If the XPath expression requires namespace resolution, use the overload, which takes an as its argument. - This method has no effect on the state of the . ## Examples - The following example uses the method to select a node set. + The following example uses the method to select a node set. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet39"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet39"::: @@ -8216,7 +8216,7 @@ while (iterator.MoveNext()) when you called this method. After you call this method, the returned represents the set of selected nodes. Use on the to iterate over the selected node set. + The context for the selection is the position of the when you called this method. After you call this method, the returned represents the set of selected nodes. Use on the to iterate over the selected node set. The following C# code iterates over the selected set of nodes. @@ -8228,13 +8228,13 @@ while (ni.MoveNext()) } ``` - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. - You can still use any of the object's navigation methods to move within the . The navigation methods are independent of the selected nodes in the . -- Future calls to the method return a new object that points to the selected set of nodes that matches the new call. The two objects are completely independent of each other. +- Future calls to the method return a new object that points to the selected set of nodes that matches the new call. The two objects are completely independent of each other. -- If the requires namespace resolution, the prefix and namespace URI pair must be added to an , and the method must be called to specify the to use for namespace resolution. +- If the requires namespace resolution, the prefix and namespace URI pair must be added to an , and the method must be called to specify the to use for namespace resolution. For example, suppose the document contains the following XML nodes. @@ -8257,7 +8257,7 @@ XPathNodeIterator ni = nav.Select(expr); ``` > [!NOTE] -> If the does not include a prefix, it is assumed that the namespace URI is the empty namespace. If your XML includes a default namespace, you must still use the method and provide an that contains a prefix and namespace URI to handle the default namespace. +> If the does not include a prefix, it is assumed that the namespace URI is the empty namespace. If your XML includes a default namespace, you must still use the method and provide an that contains a prefix and namespace URI to handle the default namespace. For example, suppose you have the following XML. @@ -8285,7 +8285,7 @@ XPathNodeIterator ni = nav.Select(expr); ## Examples - The following example uses the method to select a node set. + The following example uses the method to select a node set. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet40"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet40"::: @@ -8392,7 +8392,7 @@ XPathNodeIterator ni = nav.Select(expr); method with the object specified to resolve namespace prefixes in the XPath expression. + The following example illustrates selecting a node set using the method with the object specified to resolve namespace prefixes in the XPath expression. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet41"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet41"::: @@ -8496,12 +8496,12 @@ XPathNodeIterator ni = nav.Select(expr); method has no effect on the state of the . + The method has no effect on the state of the . ## Examples - For an example of selecting ancestor nodes, see . + For an example of selecting ancestor nodes, see . ]]> @@ -8567,7 +8567,7 @@ XPathNodeIterator ni = nav.Select(expr); ## Remarks If is specified as the `name` parameter, all ancestor nodes that belong to the specified namespace URI are selected. If is specified as the `namespaceURI` parameter, all ancestor nodes with the specified local name that belong to no namespace are selected. If is specified as both the local name and namespace URI, all ancestor nodes that belong to no namespace are selected. - The method has no effect on the state of the . + The method has no effect on the state of the . @@ -8677,12 +8677,12 @@ XPathNodeIterator ni = nav.Select(expr); method has no effect on the state of the . + The method has no effect on the state of the . ## Examples - For an example of selecting ancestor, child and descendant nodes, see . + For an example of selecting ancestor, child and descendant nodes, see . ]]> @@ -8746,12 +8746,12 @@ XPathNodeIterator ni = nav.Select(expr); ## Remarks If is specified as the `name` parameter, all child nodes that belong to the specified namespace URI are selected. If is specified as the `namespaceURI` parameter, all child nodes with the specified local name that belong to no namespace are selected. If both the local name and namespace URI parameters are , all child nodes that belong to no namespace are selected. - The method has no effect on the state of the . + The method has no effect on the state of the . ## Examples - For an example of selecting ancestor, child and descendant nodes, see . + For an example of selecting ancestor, child and descendant nodes, see . ]]> @@ -8825,12 +8825,12 @@ XPathNodeIterator ni = nav.Select(expr); method has no effect on the state of the . + The method has no effect on the state of the . ## Examples - For an example of selecting ancestor, child and descendant nodes, see . + For an example of selecting ancestor, child and descendant nodes, see . ]]> @@ -8899,12 +8899,12 @@ XPathNodeIterator ni = nav.Select(expr); A descendant is a child or a child of a child and so on; thus the selected nodes will never contain attribute or namespace nodes. - The method has no effect on the state of the . + The method has no effect on the state of the . ## Examples - For an example of selecting ancestor, child, and descendant nodes, see . + For an example of selecting ancestor, child, and descendant nodes, see . ]]> @@ -8981,7 +8981,7 @@ XPathNodeIterator ni = nav.Select(expr); method selects the first node that matches the XPath query in the object. + The method selects the first node that matches the XPath query in the object. @@ -9085,7 +9085,7 @@ XPathNodeIterator ni = nav.Select(expr); method selects the first node that matches the compiled XPath query contained in the object in the . + The method selects the first node that matches the compiled XPath query contained in the object in the . @@ -9192,7 +9192,7 @@ XPathNodeIterator ni = nav.Select(expr); method selects the first node that matches the XPath query specified. The method uses the object to resolve namespace prefixes. + The method selects the first node that matches the XPath query specified. The method uses the object to resolve namespace prefixes. > [!NOTE] > In XPath all namespaces must be prefixed in a query. If an XML document uses a default namespace, you must still add a namespace prefix to the object. @@ -9291,14 +9291,14 @@ XPathNodeIterator ni = nav.Select(expr); object is created as the result of a schema validating object, the value specified to the method is verified against the XML Schema Definition Language (XSD) schema for the XML document. If the value specified is invalid according to the schema for the XML document, an is thrown. + When an object is created as the result of a schema validating object, the value specified to the method is verified against the XML Schema Definition Language (XSD) schema for the XML document. If the value specified is invalid according to the schema for the XML document, an is thrown. - The method is valid only when the is positioned on an element or attribute node. + The method is valid only when the is positioned on an element or attribute node. ## Examples - In the following example, the method is used to update all `price` elements in the `contosoBooks.xml` file using the object to resolve namespace prefixes in the XPath expression. + In the following example, the method is used to update all `price` elements in the `contosoBooks.xml` file using the object to resolve namespace prefixes in the XPath expression. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet46"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet46"::: @@ -9392,14 +9392,14 @@ XPathNodeIterator ni = nav.Select(expr); ## Remarks -- If the is positioned on an element node with complex content (child elements), calling the method replaces the child elements with a text node containing the new string value. +- If the is positioned on an element node with complex content (child elements), calling the method replaces the child elements with a text node containing the new string value. -- The method cannot update the root node or namespace nodes. +- The method cannot update the root node or namespace nodes. ## Examples - In the following example, the method is used to update all `price` elements in the `contosoBooks.xml` file using the object to resolve namespace prefixes in the XPath expression. + In the following example, the method is used to update all `price` elements in the `contosoBooks.xml` file using the object to resolve namespace prefixes in the XPath expression. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet47"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet47"::: @@ -9500,7 +9500,7 @@ XPathNodeIterator ni = nav.Select(expr); ## Remarks This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. - For a description of this member, see . + For a description of this member, see . ]]> @@ -9554,7 +9554,7 @@ XPathNodeIterator ni = nav.Select(expr); method depends on the of the node. + The content returned by the method depends on the of the node. |XPathNodeType|Property Value| |-------------------|--------------------| @@ -9691,7 +9691,7 @@ XPathNodeIterator ni = nav.Select(expr); property can be used by implementations which provide a "virtualized" XML view over a store, to provide access to underlying objects. For example, if an object is used to provide a virtual XML view over a Common Language Runtime (CLR) object graph, you may wish to perform XPath queries using the method and then access the CLR objects underlying the selected nodes. The property would expose these underlying objects. + The property can be used by implementations which provide a "virtualized" XML view over a store, to provide access to underlying objects. For example, if an object is used to provide a virtual XML view over a Common Language Runtime (CLR) object graph, you may wish to perform XPath queries using the method and then access the CLR objects underlying the selected nodes. The property would expose these underlying objects. In many cases, this value will be `null`, and the object returned by the property will always be implementation specific. @@ -9794,7 +9794,7 @@ XPathNodeIterator ni = nav.Select(expr); method attempts to convert the value of the current node to the .NET type, specified according to the XPath 2.0 rules for casting the current node's type. + The method attempts to convert the value of the current node to the .NET type, specified according to the XPath 2.0 rules for casting the current node's type. The object is used to resolve namespace prefixes related to type conversions. For example, when converting an `xs:QName` to an `xs:string`. @@ -10176,7 +10176,7 @@ XPathNodeIterator ni = nav.Select(expr); If a node has no type, this is equivalent to the type annotation on the node being `xdt:untypedAtomic`. In this case, the property returns a string for the node. For more information, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). ## Examples - In the following example, the `contosoBooks.xml` XML file and `contosoBooks.xsd` XML Schema definition language (XSD) schema are used to create an object. The typed value of the `price` element is displayed using the property and then returned as a string using the method. + In the following example, the `contosoBooks.xml` XML file and `contosoBooks.xsd` XML Schema definition language (XSD) schema are used to create an object. The typed value of the `price` element is displayed using the property and then returned as a string using the method. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/CanEdit/xpathnavigatorproperties.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorProperties/VB/xpathnavigatorproperties.vb" id="Snippet6"::: @@ -10301,7 +10301,7 @@ XPathNodeIterator ni = nav.Select(expr); ## Remarks Namespace declarations for the in-scope namespaces of the current node are inserted into the XML streamed to the object specified. - For example, if the method is called on the first `book` element of the `books.xml` file, the `http://www.contoso.com/books` namespace declaration made at the top of the XML document will appear in the XML streamed to the object specified as shown in the following example. + For example, if the method is called on the first `book` element of the `books.xml` file, the `http://www.contoso.com/books` namespace declaration made at the top of the XML document will appear in the XML streamed to the object specified as shown in the following example. ```xml @@ -10316,12 +10316,12 @@ XPathNodeIterator ni = nav.Select(expr); ``` > [!NOTE] -> The method does not affect the position of the . +> The method does not affect the position of the . ## Examples - The following example illustrates using the method on the first `book` element of the `contosoBooks.xml` file. + The following example illustrates using the method on the first `book` element of the `contosoBooks.xml` file. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet48"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet48"::: diff --git a/xml/System.Xml.XPath/XPathNodeIterator.xml b/xml/System.Xml.XPath/XPathNodeIterator.xml index 9350ed4a1e6..61d908aac78 100644 --- a/xml/System.Xml.XPath/XPathNodeIterator.xml +++ b/xml/System.Xml.XPath/XPathNodeIterator.xml @@ -87,28 +87,28 @@ object returned by the class is not positioned on the first node in a selected set of nodes. A call to the method of the class must be made to position the object on the first node in the selected set of nodes. + An object returned by the class is not positioned on the first node in a selected set of nodes. A call to the method of the class must be made to position the object on the first node in the selected set of nodes. When using the , if you edit the current node or any of its ancestors, your current position is lost. If you want to edit a number of nodes that you have selected, create a array, copy all of the nodes from the into the array, then iterate through the array and modify the nodes. There are two ways to iterate over an collection by using the class. - One way is to use the method and then call to get the current instance, as in the following example: + One way is to use the method and then call to get the current instance, as in the following example: :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet55"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet55"::: - Another way is to use a `foreach` loop to call the method and use the returned interface to enumerate the nodes, as in the following example: + Another way is to use a `foreach` loop to call the method and use the returned interface to enumerate the nodes, as in the following example: :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet56"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet56"::: - You should either use and or use . Combining these two approaches can cause unexpected results. For example, if the method is called first, and then the method is called in the `foreach` loop, the `foreach` loop will not start enumerating the results from the beginning of the collection, but from the position after the method. + You should either use and or use . Combining these two approaches can cause unexpected results. For example, if the method is called first, and then the method is called in the `foreach` loop, the `foreach` loop will not start enumerating the results from the beginning of the collection, but from the position after the method. ## Examples - The following example uses the method of the class to select a node set using the class. + The following example uses the method of the class to select a node set using the class. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet39"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet39"::: @@ -258,7 +258,7 @@ object is positioned at the same node in the node set if calls have been made to the method. The cloned object is not affected by subsequent changes to this object. + The cloned object is positioned at the same node in the node set if calls have been made to the method. The cloned object is not affected by subsequent changes to this object. ]]> @@ -374,16 +374,16 @@ ## Remarks You can use the properties of the returned object to obtain information on the current node. However, the returned object should not be modified. The returned object cannot be moved away from the selected node set. - Alternatively, you can clone the object using the method of the class. The cloned object can then be moved away from the selected node set. This method of cloning the object might affect the performance of the XPath query. + Alternatively, you can clone the object using the method of the class. The cloned object can then be moved away from the selected node set. This method of cloning the object might affect the performance of the XPath query. - If the , , and methods result in no nodes being selected, the property might not be pointing to the context node. + If the , , and methods result in no nodes being selected, the property might not be pointing to the context node. To test whether nodes have been selected, use the property as shown in the following example. ## Examples - The following example gets all book titles authored by Herman Melville using the property of the object and the method of the class. + The following example gets all book titles authored by Herman Melville using the property of the object and the method of the class. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet6"::: @@ -538,17 +538,17 @@ There are two ways to iterate over an collection by using the class. - One way is to use the method and then call to get the current instance, as in the following example: + One way is to use the method and then call to get the current instance, as in the following example: :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet55"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet55"::: - Another way is to use a `foreach` loop to call the method and use the returned interface to enumerate the nodes, as in the following example: + Another way is to use a `foreach` loop to call the method and use the returned interface to enumerate the nodes, as in the following example: :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet56"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet56"::: - You should either use the method and or use the method. Combining these two approaches can cause unexpected results. For example, if the method is called first, and then the method is called in the `foreach` loop, the `foreach` loop will not start enumerating the results from the beginning of the collection, but from the position after the method. + You should either use the method and or use the method. Combining these two approaches can cause unexpected results. For example, if the method is called first, and then the method is called in the `foreach` loop, the `foreach` loop will not start enumerating the results from the beginning of the collection, but from the position after the method. ]]> @@ -604,26 +604,26 @@ object is positioned on the first node in the selected node set only after the initial call to the method. The node set is created in document order. Therefore, calling the method moves to the next node in document order. + The object is positioned on the first node in the selected node set only after the initial call to the method. The node set is created in document order. Therefore, calling the method moves to the next node in document order. There are two ways to iterate over an collection by using the class. - One way is to use the method and then call to get the current instance, as in the following example: + One way is to use the method and then call to get the current instance, as in the following example: :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet55"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet55"::: - Another way is to use a `foreach` loop to call the method and use the returned interface to enumerate the nodes, as in the following example: + Another way is to use a `foreach` loop to call the method and use the returned interface to enumerate the nodes, as in the following example: :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet56"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet56"::: - You should either use the method and or use the method. Combining these two approaches can cause unexpected results. For example, if the method is called first, and then the method is called in the `foreach` loop, the `foreach` loop will not start enumerating the results from the beginning of the collection, but from the position after the method. + You should either use the method and or use the method. Combining these two approaches can cause unexpected results. For example, if the method is called first, and then the method is called in the `foreach` loop, the `foreach` loop will not start enumerating the results from the beginning of the collection, but from the position after the method. ## Examples - The following example uses the method of the class to select a node set using the class. + The following example uses the method of the class to select a node set using the class. :::code language="csharp" source="~/snippets/csharp/System.Xml.XPath/XPathNavigator/AppendChild/xpathnavigatormethods.cs" id="Snippet39"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XPathNavigatorMethods/VB/xpathnavigatormethods.vb" id="Snippet39"::: diff --git a/xml/System.Xml.Xsl.Runtime/AncestorDocOrderIterator.xml b/xml/System.Xml.Xsl.Runtime/AncestorDocOrderIterator.xml index 5d430b1492d..b7e49e5efc7 100644 --- a/xml/System.Xml.Xsl.Runtime/AncestorDocOrderIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/AncestorDocOrderIterator.xml @@ -98,7 +98,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -134,7 +134,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the iterator was set to the next ancestor node in document order, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/AncestorIterator.xml b/xml/System.Xml.Xsl.Runtime/AncestorIterator.xml index bb4425cfe26..60bd5700cc3 100644 --- a/xml/System.Xml.Xsl.Runtime/AncestorIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/AncestorIterator.xml @@ -98,7 +98,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -134,7 +134,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the next ancestor node exists, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/AttributeContentIterator.xml b/xml/System.Xml.Xsl.Runtime/AttributeContentIterator.xml index ce4c6892b13..9a48db88997 100644 --- a/xml/System.Xml.Xsl.Runtime/AttributeContentIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/AttributeContentIterator.xml @@ -30,7 +30,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -100,7 +100,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -136,7 +136,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the next attribute or child content node exists, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/AttributeIterator.xml b/xml/System.Xml.Xsl.Runtime/AttributeIterator.xml index c125100507e..65ddaf5106e 100644 --- a/xml/System.Xml.Xsl.Runtime/AttributeIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/AttributeIterator.xml @@ -30,7 +30,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -100,7 +100,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -136,7 +136,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the next attribute node exists, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/ContentIterator.xml b/xml/System.Xml.Xsl.Runtime/ContentIterator.xml index 2a3030fce5f..91d37329aad 100644 --- a/xml/System.Xml.Xsl.Runtime/ContentIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/ContentIterator.xml @@ -30,7 +30,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -100,7 +100,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -136,7 +136,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the next child content node exists, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/ContentMergeIterator.xml b/xml/System.Xml.Xsl.Runtime/ContentMergeIterator.xml index 0566a57f26e..266758ff760 100644 --- a/xml/System.Xml.Xsl.Runtime/ContentMergeIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/ContentMergeIterator.xml @@ -105,7 +105,7 @@ property changes when the method sets the property to the next node and returns ; otherwise, the property remains unchanged. + The property changes when the method sets the property to the next node and returns ; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/DescendantIterator.xml b/xml/System.Xml.Xsl.Runtime/DescendantIterator.xml index 182ed708c67..3e6c9fcd528 100644 --- a/xml/System.Xml.Xsl.Runtime/DescendantIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/DescendantIterator.xml @@ -106,7 +106,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -142,7 +142,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the next descendant node exists, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/DescendantMergeIterator.xml b/xml/System.Xml.Xsl.Runtime/DescendantMergeIterator.xml index 3946251ae90..7b7d9a60f61 100644 --- a/xml/System.Xml.Xsl.Runtime/DescendantMergeIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/DescendantMergeIterator.xml @@ -96,7 +96,7 @@ property gets modified when method sets the property to the next node and returns ; otherwise, the property remains unchanged. + The property gets modified when method sets the property to the next node and returns ; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/DifferenceIterator.xml b/xml/System.Xml.Xsl.Runtime/DifferenceIterator.xml index 30fbff34709..ea24c13b6e9 100644 --- a/xml/System.Xml.Xsl.Runtime/DifferenceIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/DifferenceIterator.xml @@ -93,7 +93,7 @@ property is modified when the method sets the property to the next node and returns ; otherwise, the property remains unchanged. + The property is modified when the method sets the property to the next node and returns ; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/ElementContentIterator.xml b/xml/System.Xml.Xsl.Runtime/ElementContentIterator.xml index cdd85ccebe6..2b8936c05ba 100644 --- a/xml/System.Xml.Xsl.Runtime/ElementContentIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/ElementContentIterator.xml @@ -97,7 +97,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -133,7 +133,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the iterator was set to the next child element with the matching name, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/FollowingSiblingIterator.xml b/xml/System.Xml.Xsl.Runtime/FollowingSiblingIterator.xml index 9e9e2959ef4..80e4e3aa184 100644 --- a/xml/System.Xml.Xsl.Runtime/FollowingSiblingIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/FollowingSiblingIterator.xml @@ -30,7 +30,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -102,7 +102,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -138,7 +138,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the next sibling content node exists, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/FollowingSiblingMergeIterator.xml b/xml/System.Xml.Xsl.Runtime/FollowingSiblingMergeIterator.xml index cde634064af..8d8f7125f12 100644 --- a/xml/System.Xml.Xsl.Runtime/FollowingSiblingMergeIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/FollowingSiblingMergeIterator.xml @@ -87,7 +87,7 @@ property gets modified when the method sets the property to the next node and returns ; otherwise, the property remains unchanged. + The property gets modified when the method sets the property to the next node and returns ; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/IdIterator.xml b/xml/System.Xml.Xsl.Runtime/IdIterator.xml index 8a8bc53989b..b43504840d5 100644 --- a/xml/System.Xml.Xsl.Runtime/IdIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/IdIterator.xml @@ -96,7 +96,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -132,7 +132,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the next node exists, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/IntersectIterator.xml b/xml/System.Xml.Xsl.Runtime/IntersectIterator.xml index 9507a734ac5..801de320f97 100644 --- a/xml/System.Xml.Xsl.Runtime/IntersectIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/IntersectIterator.xml @@ -93,7 +93,7 @@ property gets modified when the method sets the property to the next node and returns ; otherwise, the property remains unchanged. + The property gets modified when the method sets the property to the next node and returns ; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/NamespaceIterator.xml b/xml/System.Xml.Xsl.Runtime/NamespaceIterator.xml index d67c3bbaa0d..0a690b9d4f2 100644 --- a/xml/System.Xml.Xsl.Runtime/NamespaceIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/NamespaceIterator.xml @@ -94,7 +94,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -130,7 +130,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the next namespace node exists, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/NodeKindContentIterator.xml b/xml/System.Xml.Xsl.Runtime/NodeKindContentIterator.xml index 682403754b7..7ad4b9b2d56 100644 --- a/xml/System.Xml.Xsl.Runtime/NodeKindContentIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/NodeKindContentIterator.xml @@ -97,7 +97,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -133,7 +133,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the next child content node with a matching node kind exists, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/NodeRangeIterator.xml b/xml/System.Xml.Xsl.Runtime/NodeRangeIterator.xml index 2799843f25e..f6ff00939a2 100644 --- a/xml/System.Xml.Xsl.Runtime/NodeRangeIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/NodeRangeIterator.xml @@ -111,7 +111,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -147,7 +147,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the next node exists, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/ParentIterator.xml b/xml/System.Xml.Xsl.Runtime/ParentIterator.xml index 51bf4d889ec..bd896d0f329 100644 --- a/xml/System.Xml.Xsl.Runtime/ParentIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/ParentIterator.xml @@ -30,7 +30,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -102,7 +102,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -138,7 +138,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the next matching parent node exists, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/PrecedingIterator.xml b/xml/System.Xml.Xsl.Runtime/PrecedingIterator.xml index feaf27d6aec..e24ed41c712 100644 --- a/xml/System.Xml.Xsl.Runtime/PrecedingIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/PrecedingIterator.xml @@ -30,7 +30,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -102,7 +102,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -138,7 +138,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the next preceding node exists, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/PrecedingSiblingDocOrderIterator.xml b/xml/System.Xml.Xsl.Runtime/PrecedingSiblingDocOrderIterator.xml index 1896f9202c8..6f2b813a638 100644 --- a/xml/System.Xml.Xsl.Runtime/PrecedingSiblingDocOrderIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/PrecedingSiblingDocOrderIterator.xml @@ -30,7 +30,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -102,7 +102,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -138,7 +138,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the next preceding node exists, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/PrecedingSiblingIterator.xml b/xml/System.Xml.Xsl.Runtime/PrecedingSiblingIterator.xml index 9877010f755..afe22f46bbb 100644 --- a/xml/System.Xml.Xsl.Runtime/PrecedingSiblingIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/PrecedingSiblingIterator.xml @@ -30,7 +30,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -102,7 +102,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -138,7 +138,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the next preceding node exists, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/UnionIterator.xml b/xml/System.Xml.Xsl.Runtime/UnionIterator.xml index 07814b916c1..e5eae5e5b76 100644 --- a/xml/System.Xml.Xsl.Runtime/UnionIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/UnionIterator.xml @@ -93,7 +93,7 @@ property gets modified when the method sets the property to the next node and returns ; otherwise, the property remains unchanged. + The property gets modified when the method sets the property to the next node and returns ; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/XPathFollowingIterator.xml b/xml/System.Xml.Xsl.Runtime/XPathFollowingIterator.xml index c158bb8365e..b295d8b4558 100644 --- a/xml/System.Xml.Xsl.Runtime/XPathFollowingIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/XPathFollowingIterator.xml @@ -104,7 +104,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -140,7 +140,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the iterator was set to the next following node, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/XPathFollowingMergeIterator.xml b/xml/System.Xml.Xsl.Runtime/XPathFollowingMergeIterator.xml index 8b0ccd7d3d8..ac19e49e205 100644 --- a/xml/System.Xml.Xsl.Runtime/XPathFollowingMergeIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/XPathFollowingMergeIterator.xml @@ -107,7 +107,7 @@ property changes when the method sets the property to the next node and returns ; otherwise, the property remains unchanged. + The property changes when the method sets the property to the next node and returns ; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/XPathPrecedingDocOrderIterator.xml b/xml/System.Xml.Xsl.Runtime/XPathPrecedingDocOrderIterator.xml index 9577e3b91e0..19c7004a807 100644 --- a/xml/System.Xml.Xsl.Runtime/XPathPrecedingDocOrderIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/XPathPrecedingDocOrderIterator.xml @@ -97,7 +97,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -133,7 +133,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the iterator was set to the next preceding node, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/XPathPrecedingIterator.xml b/xml/System.Xml.Xsl.Runtime/XPathPrecedingIterator.xml index 7e260e668b2..0c45277be81 100644 --- a/xml/System.Xml.Xsl.Runtime/XPathPrecedingIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/XPathPrecedingIterator.xml @@ -102,7 +102,7 @@ method has returned `true`. + The state of the navigator changes only if the method has returned `true`. ]]> @@ -138,7 +138,7 @@ method sets the property to the current result navigator; otherwise, the property remains unchanged. + If the iterator was set to the next preceding node, the method sets the property to the current result navigator; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/XPathPrecedingMergeIterator.xml b/xml/System.Xml.Xsl.Runtime/XPathPrecedingMergeIterator.xml index 14adaba1e0e..db65fbc021a 100644 --- a/xml/System.Xml.Xsl.Runtime/XPathPrecedingMergeIterator.xml +++ b/xml/System.Xml.Xsl.Runtime/XPathPrecedingMergeIterator.xml @@ -93,7 +93,7 @@ property changes when the method sets the property to the next node and returns ; otherwise, the property remains unchanged. + The property changes when the method sets the property to the next node and returns ; otherwise, the property remains unchanged. ]]> diff --git a/xml/System.Xml.Xsl.Runtime/XmlQueryRuntime.xml b/xml/System.Xml.Xsl.Runtime/XmlQueryRuntime.xml index 165ab70ed61..75a61871643 100644 --- a/xml/System.Xml.Xsl.Runtime/XmlQueryRuntime.xml +++ b/xml/System.Xml.Xsl.Runtime/XmlQueryRuntime.xml @@ -215,11 +215,11 @@ Returns an array containing the names of all the global variables and parameters used in this query. An array of values. - @@ -820,11 +820,11 @@ if the names are equal; otherwise, . - method calls the method to get the local name and the namespace URI based on the `indexLocalName` and `indexNamespaceUri`. - + method calls the method to get the local name and the namespace URI based on the `indexLocalName` and `indexNamespaceUri`. + ]]> diff --git a/xml/System.Xml.Xsl.Runtime/XsltLibrary.xml b/xml/System.Xml.Xsl.Runtime/XsltLibrary.xml index 91eedb0dda1..c822c994732 100644 --- a/xml/System.Xml.Xsl.Runtime/XsltLibrary.xml +++ b/xml/System.Xml.Xsl.Runtime/XsltLibrary.xml @@ -93,7 +93,7 @@ function returns `true` if and only if the `expanded name` is the name of an instruction. + The qualified name is expanded into an `expanded name` by using the namespace declarations in scope for the expression. The function returns `true` if and only if the `expanded name` is the name of an instruction. ]]> @@ -208,7 +208,7 @@ method formats `value` by using the `formatPicture` and decimal-format [expanded name](https://go.microsoft.com/fwlink/?LinkID=148269). The `errorMessageName` is used only for error reporting and must contain the qualified name of the decimal-format object. + The method formats `value` by using the `formatPicture` and decimal-format [expanded name](https://go.microsoft.com/fwlink/?LinkID=148269). The `errorMessageName` is used only for error reporting and must contain the qualified name of the decimal-format object. ]]> @@ -248,7 +248,7 @@ method formats the given value by using the given decimal formatter object, created by . + The method formats the given value by using the given decimal formatter object, created by . ]]> diff --git a/xml/System.Xml.Xsl/XslCompiledTransform.xml b/xml/System.Xml.Xsl/XslCompiledTransform.xml index 5547661ddb5..9117baefe70 100644 --- a/xml/System.Xml.Xsl/XslCompiledTransform.xml +++ b/xml/System.Xml.Xsl/XslCompiledTransform.xml @@ -191,7 +191,7 @@ The sample uses the following two input files: - The `enableDebug` parameter is set to `true`. -- The style sheet is passed to the method either as a URI, or an implementation of the class that implements the interface. The interface is implemented on all text-parsing objects. +- The style sheet is passed to the method either as a URI, or an implementation of the class that implements the interface. The interface is implemented on all text-parsing objects. In other words, if the style sheet is loaded using an object, such as an or , or an implementation that does not implement the interface, you cannot debug the style sheet. @@ -255,7 +255,7 @@ The sample uses the following two input files: method. Compiling style sheets with the `xsltc.exe` will meet the demands of most applications that leverage the use of compiled style sheets. The method should be used when building custom compilation tools. + The `xsltc.exe` tool is a wrapper around the method. Compiling style sheets with the `xsltc.exe` will meet the demands of most applications that leverage the use of compiled style sheets. The method should be used when building custom compilation tools. ]]> @@ -273,10 +273,10 @@ The sample uses the following two input files: class is better than the class, the method of the class might perform more slowly than the method of the class the first time it is called on a transformation. This is because the XSLT file must be compiled before it is loaded. For more information, see the following blog post: [XslCompiledTransform Slower than XslTransform?](https://go.microsoft.com/fwlink/?LinkId=130590) + Although the overall performance of the class is better than the class, the method of the class might perform more slowly than the method of the class the first time it is called on a transformation. This is because the XSLT file must be compiled before it is loaded. For more information, see the following blog post: [XslCompiledTransform Slower than XslTransform?](https://go.microsoft.com/fwlink/?LinkId=130590) > [!NOTE] -> There are differences between XSLT compiled in Debug mode and XSLT compiled in Release mode. In some situations, style sheets compiled in Debug mode will not throw errors during , but will later fail during . The same style sheet compiled in Release mode will fail during . An example of such behavior is when a variable that is not of a node-set type is assigned to an expression where a node-set is required. +> There are differences between XSLT compiled in Debug mode and XSLT compiled in Release mode. In some situations, style sheets compiled in Debug mode will not throw errors during , but will later fail during . The same style sheet compiled in Release mode will fail during . An example of such behavior is when a variable that is not of a node-set type is assigned to an expression where a node-set is required. ]]> @@ -333,13 +333,13 @@ The sample uses the following two input files: - An with no user credentials is used to resolve the style sheet URI, and process any `xsl:import` or `xsl:include` elements. -- An with default settings is used to load the style sheet. DTD processing is disabled on the . If you require DTD processing, create an with this feature enabled, and pass it to the method. +- An with default settings is used to load the style sheet. DTD processing is disabled on the . If you require DTD processing, create an with this feature enabled, and pass it to the method. - The `document()` function is disabled. - Embedded scripts are not supported. - You can use the overload to specify an with the necessary authentication credentials, or to specify different XSLT settings. + You can use the overload to specify an with the necessary authentication credentials, or to specify different XSLT settings. @@ -419,7 +419,7 @@ The sample uses the following two input files: method loads the compiled style sheet from the assembly. + The xsltc.exe tool is used to compile style sheets and generate assemblies from the style sheets. The method loads the compiled style sheet from the assembly. > [!NOTE] > You must also include the XSLT assembly as a reference in your application. @@ -492,7 +492,7 @@ xslt.Load(typeof(bookOrders)); ## Remarks The class supports the XSLT 1.0 syntax. The XSLT style sheet must use the `http://www.w3.org/1999/XSL/Transform` namespace. - The style sheet loads from the current node of the through all its children. This enables you to use a portion of a document as the style sheet. After the method completes, the is positioned on the next node after the end of the style sheet. If the end of the document is reached, the is positioned at the end of file (EOF). + The style sheet loads from the current node of the through all its children. This enables you to use a portion of a document as the style sheet. After the method completes, the is positioned on the next node after the end of the style sheet. If the end of the document is reached, the is positioned at the end of file (EOF). This method has the following behavior: @@ -502,7 +502,7 @@ xslt.Load(typeof(bookOrders)); - Embedded scripts are not supported. - You can use the overload to specify an with the necessary authentication credentials, or to specify different XSLT settings. + You can use the overload to specify an with the necessary authentication credentials, or to specify different XSLT settings. @@ -574,7 +574,7 @@ xslt.Load(typeof(bookOrders)); - Embedded scripts are not supported. - You can use the overload to specify an with the necessary authentication credentials, or to specify different XSLT settings. + You can use the overload to specify an with the necessary authentication credentials, or to specify different XSLT settings. @@ -659,7 +659,7 @@ xslt.Load(typeof(bookOrders)); ## Examples - The code example below uses the to load a compiled style sheet. The transformation reduces the value of the `Price` element by ten percent. + The code example below uses the to load a compiled style sheet. The transformation reduces the value of the `Price` element by ten percent. :::code language="csharp" source="~/snippets/csharp/System.Xml.Xsl/XslCompiledTransform/Load/XsltDynamicMethodLoad.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XsltDynamicMethodLoad/VB/XsltDynamicMethodLoad.vb" id="Snippet1"::: @@ -733,7 +733,7 @@ xslt.Load(typeof(bookOrders)); ## Remarks The class supports the XSLT 1.0 syntax. The XSLT style sheet must use the `http://www.w3.org/1999/XSL/Transform` namespace. - An with default settings is used to load the style sheet. DTD processing is disabled on the . If you require DTD processing, create an with this feature enabled, and pass it to the method. + An with default settings is used to load the style sheet. DTD processing is disabled on the . If you require DTD processing, create an with this feature enabled, and pass it to the method. @@ -819,7 +819,7 @@ xslt.Load(typeof(bookOrders)); ## Remarks The class supports the XSLT 1.0 syntax. The XSLT style sheet must use the `http://www.w3.org/1999/XSL/Transform` namespace. - The style sheet loads from the current node of the through all its children. This enables you to use a portion of a document as the style sheet. After the method completes, the is positioned on the next node after the end of the style sheet. If the end of the document is reached, the is positioned at the end of file (EOF). + The style sheet loads from the current node of the through all its children. This enables you to use a portion of a document as the style sheet. After the method completes, the is positioned on the next node after the end of the style sheet. If the end of the document is reached, the is positioned at the end of file (EOF). @@ -963,7 +963,7 @@ xslt.Load(typeof(bookOrders)); method. It contains information derived from the `xsl:output` element of a compiled style sheet. This object can be passed to the method to create the object to which you want to output. + This property is populated after a successful call to the method. It contains information derived from the `xsl:output` element of a compiled style sheet. This object can be passed to the method to create the object to which you want to output. @@ -1049,7 +1049,7 @@ xslt.Load(typeof(bookOrders)); ## Remarks > [!NOTE] -> There are differences between XSLT compiled in Debug mode and XSLT compiled in Release mode. In some situations, style sheets compiled in Debug mode will not throw errors during , but will later fail during . The same style sheet compiled in Release mode will fail during . An example of such behavior is when a variable that is not of a node-set type is assigned to an expression where a node-set is required. +> There are differences between XSLT compiled in Debug mode and XSLT compiled in Release mode. In some situations, style sheets compiled in Debug mode will not throw errors during , but will later fail during . The same style sheet compiled in Release mode will fail during . An example of such behavior is when a variable that is not of a node-set type is assigned to an expression where a node-set is required. ]]> @@ -1105,7 +1105,7 @@ xslt.Load(typeof(bookOrders)); ## Remarks This method uses a default with no user credentials to resolve the input and output documents. If any of these resources are located on a network resource that requires authentication, use the overload that takes an as one of its arguments and specify an with the necessary credentials. - An with default settings is used to load the input document. DTD processing is disabled on the . If you require DTD processing, create an with this feature enabled, and pass it to the method. + An with default settings is used to load the input document. DTD processing is disabled on the . If you require DTD processing, create an with this feature enabled, and pass it to the method. @@ -1193,9 +1193,9 @@ xslt.Load(typeof(bookOrders)); ## Remarks This method uses a default with no user credentials to resolve the input document and any instances of the XSLT `document()` function found in the style sheet. If any of these resources are located on a network resource that requires authentication, use the overload that takes an as one of its arguments and specify an with the necessary credentials. - An with default settings is used to load the input document. DTD processing is disabled on the . If you require DTD processing, create an with this feature enabled, and pass it to the method. + An with default settings is used to load the input document. DTD processing is disabled on the . If you require DTD processing, create an with this feature enabled, and pass it to the method. - This method does not support the `xsl:strip-space` element. If your compiled style sheet included the `xsl:strip-space` element, you must use the overload that takes an as the input argument. + This method does not support the `xsl:strip-space` element. If your compiled style sheet included the `xsl:strip-space` element, you must use the overload that takes an as the input argument. ## Examples The following example executes an XSLT transformation and outputs to an object. @@ -1336,7 +1336,7 @@ xslt.Load(typeof(bookOrders)); ## Remarks If the XSLT `document()` function is enabled, it is resolved using an with no user credentials. If the external resource is located on a network resource that requires authentication, use the overload that takes an as one of its arguments and specify an with the necessary credentials. - This method does not support the `xsl:strip-space` element. If your compiled style sheet included the `xsl:strip-space` element, you must use the overload that takes an as the input argument. + This method does not support the `xsl:strip-space` element. If your compiled style sheet included the `xsl:strip-space` element, you must use the overload that takes an as the input argument. The interface is implemented in the and classes. These classes represent an in-memory cache of XML data. @@ -1344,7 +1344,7 @@ xslt.Load(typeof(bookOrders)); - The class is a read-only data store based on the XPath data model. is the recommended class for XSLT processing. It provides faster performance when compared to the class. - Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an object containing just the node fragment, and pass that object to the method. For more information, see [How to: Transform a Node Fragment](/dotnet/standard/data/xml/how-to-transform-a-node-fragment). + Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an object containing just the node fragment, and pass that object to the method. For more information, see [How to: Transform a Node Fragment](/dotnet/standard/data/xml/how-to-transform-a-node-fragment). @@ -1420,7 +1420,7 @@ xslt.Load(typeof(bookOrders)); ## Remarks This method uses a default with no user credentials to resolve the input document and any instances of the XSLT `document()` function found in the style sheet. If any of these resources are located on a network resource that requires authentication, use the overload that takes an as one of its arguments and specify an with the necessary credentials. - An with default settings is used to load the input document. DTD processing is disabled on the . If you require DTD processing, create an with this feature enabled, and pass it to the method. + An with default settings is used to load the input document. DTD processing is disabled on the . If you require DTD processing, create an with this feature enabled, and pass it to the method. ]]> @@ -1497,7 +1497,7 @@ xslt.Load(typeof(bookOrders)); ## Remarks This method uses a default with no user credentials to resolve the input document and any instances of the XSLT `document()` function found in the style sheet. If any of these resources are located on a network resource that requires authentication, use the overload that takes an as one of its arguments and specify an with the necessary credentials. - An with default settings is used to load the input document. DTD processing is disabled on the . If you require DTD processing, create an with this feature enabled, and pass it to the method. + An with default settings is used to load the input document. DTD processing is disabled on the . If you require DTD processing, create an with this feature enabled, and pass it to the method. @@ -1584,7 +1584,7 @@ xslt.Load(typeof(bookOrders)); ## Remarks This method uses a default with no user credentials to resolve the input document and any instances of the XSLT `document()` function found in the style sheet. If any of these resources are located on a network resource that requires authentication, use the overload that takes an as one of its arguments and specify an with the necessary credentials. - An with default settings is used to load the input document. DTD processing is disabled on the . If you require DTD processing, create an with this feature enabled, and pass it to the method. + An with default settings is used to load the input document. DTD processing is disabled on the . If you require DTD processing, create an with this feature enabled, and pass it to the method. ## Examples The following example uses an object to create a parameter representing the current date and time. @@ -1877,7 +1877,7 @@ xslt.Load(typeof(bookOrders)); ## Remarks If the XSLT `document()` function is enabled, it is resolved using an with no user credentials. If the external resource is located on a network resource that requires authentication, use the overload that takes an as one of its arguments and specify an with the necessary credentials. - This method does not support the `xsl:strip-space` element. If your compiled style sheet included the `xsl:strip-space` element, you must use the overload that takes an as the input argument. + This method does not support the `xsl:strip-space` element. If your compiled style sheet included the `xsl:strip-space` element, you must use the overload that takes an as the input argument. The interface is implemented in the and classes. These classes represent an in-memory cache of XML data. @@ -1885,7 +1885,7 @@ xslt.Load(typeof(bookOrders)); - The class is a read-only data store based on the XPath data model. is the recommended class for XSLT processing. It provides faster performance when compared to the class. - Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an object containing just the node fragment, and pass that object to the method. For more information, see [How to: Transform a Node Fragment](/dotnet/standard/data/xml/how-to-transform-a-node-fragment). + Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an object containing just the node fragment, and pass that object to the method. For more information, see [How to: Transform a Node Fragment](/dotnet/standard/data/xml/how-to-transform-a-node-fragment). @@ -1961,7 +1961,7 @@ xslt.Load(typeof(bookOrders)); ## Remarks If the XSLT `document()` function is enabled, it is resolved using an with no user credentials. If the external resource is located on a network resource that requires authentication, use the overload that takes an as one of its arguments and specify an with the necessary credentials. - This method does not support the `xsl:strip-space` element. If your compiled style sheet included the `xsl:strip-space` element, you must use the overload that takes an as the input argument. + This method does not support the `xsl:strip-space` element. If your compiled style sheet included the `xsl:strip-space` element, you must use the overload that takes an as the input argument. The interface is implemented in the and classes. These classes represent an in-memory cache of XML data. @@ -1969,7 +1969,7 @@ xslt.Load(typeof(bookOrders)); - The class is a read-only data store based on the XPath data model. is the recommended class for XSLT processing. It provides faster performance when compared to the class. - Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an object containing just the node fragment, and pass that object to the method. For more information, see [How to: Transform a Node Fragment](/dotnet/standard/data/xml/how-to-transform-a-node-fragment). + Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an object containing just the node fragment, and pass that object to the method. For more information, see [How to: Transform a Node Fragment](/dotnet/standard/data/xml/how-to-transform-a-node-fragment). ]]> @@ -2039,7 +2039,7 @@ xslt.Load(typeof(bookOrders)); ## Remarks If the XSLT `document()` function is enabled, it is resolved using an with no user credentials. If the external resource is located on a network resource that requires authentication, use the overload that takes an as one of its arguments and specify an with the necessary credentials. - This method does not support the `xsl:strip-space` element. If your compiled style sheet included the `xsl:strip-space` element, you must use the overload that takes an as the input argument. + This method does not support the `xsl:strip-space` element. If your compiled style sheet included the `xsl:strip-space` element, you must use the overload that takes an as the input argument. The interface is implemented in the and classes. These classes represent an in-memory cache of XML data. @@ -2047,7 +2047,7 @@ xslt.Load(typeof(bookOrders)); - The class is a read-only data store based on the XPath data model. is the recommended class for XSLT processing. It provides faster performance when compared to the class. - Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an object containing just the node fragment, and pass that object to the method. For more information, see [How to: Transform a Node Fragment](/dotnet/standard/data/xml/how-to-transform-a-node-fragment). + Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an object containing just the node fragment, and pass that object to the method. For more information, see [How to: Transform a Node Fragment](/dotnet/standard/data/xml/how-to-transform-a-node-fragment). ]]> diff --git a/xml/System.Xml.Xsl/XslTransform.xml b/xml/System.Xml.Xsl/XslTransform.xml index c975c0acdb8..6a301d26ba3 100644 --- a/xml/System.Xml.Xsl/XslTransform.xml +++ b/xml/System.Xml.Xsl/XslTransform.xml @@ -71,19 +71,19 @@ 1. Create an object. -2. Use the method to load the style sheet for the transformation. This method has several overloads and can load a style sheet using an , , , or a URL with the location of the file. +2. Use the method to load the style sheet for the transformation. This method has several overloads and can load a style sheet using an , , , or a URL with the location of the file. -3. Use the method to transform the XML data. This method has several overloads and can handle different types of input and output. You can also specify an containing additional arguments to use as input during the transformation. +3. Use the method to transform the XML data. This method has several overloads and can handle different types of input and output. You can also specify an containing additional arguments to use as input during the transformation. **Security Considerations** When creating an application that uses the class, you should be aware of the following items and their implications: -- Extension objects are enabled by default. If an object containing extension objects is passed to the method, they are utilized. +- Extension objects are enabled by default. If an object containing extension objects is passed to the method, they are utilized. - XSLT style sheets can include references to other files and embedded script blocks. A malicious user can exploit this by supplying you with data or style sheets that when executed will cause your system to process until the computer runs low on resources. -- XSLT applications that run in a mixed trust environment can result in style sheet spoofing. For example, a malicious user can load an object with a harmful style sheet and hand it off to another user who subsequently calls the method and executes the transformation. +- XSLT applications that run in a mixed trust environment can result in style sheet spoofing. For example, a malicious user can load an object with a harmful style sheet and hand it off to another user who subsequently calls the method and executes the transformation. These security issues can be mitigated by not accepting objects, XSLT style sheets, or XML source data from untrusted sources. @@ -95,9 +95,9 @@ - If the style sheet was loaded from a Uniform Resource Identifier (URI), the URI is used to create the evidence. This evidence includes the URI along with its site and zone. -- If the style sheet was loaded using another source, you can provide evidence by passing a object to the method. Otherwise, the script assembly has full trust. +- If the style sheet was loaded using another source, you can provide evidence by passing a object to the method. Otherwise, the script assembly has full trust. - Semi-trusted callers: `UnmanagedCode` permission is required to compile the embedded script. `ControlEvidence` permission is required to provide to the method. A is thrown if the caller does not have the necessary permissions. See and for more information. + Semi-trusted callers: `UnmanagedCode` permission is required to compile the embedded script. `ControlEvidence` permission is required to provide to the method. A is thrown if the caller does not have the necessary permissions. See and for more information. The `msxsl:script` element has the following requirements: @@ -340,11 +340,11 @@ This method loads the XSLT style sheet, including any style sheets referenced in `xsl:include` and `xsl:import` elements. External resources are resolved using an with no user credentials. If the style sheet(s) are located on a network resource that requires authentication, use the overload that takes an as one of its arguments and specify an with the necessary credentials. - The style sheet loads from the current node of the through all its children. This enables you to use a portion of a document as the style sheet. After the method returns, the is positioned on the next node after the end of the style sheet. If the end of the document is reached, the is positioned at the end of file (EOF). + The style sheet loads from the current node of the through all its children. This enables you to use a portion of a document as the style sheet. After the method returns, the is positioned on the next node after the end of the style sheet. If the end of the document is reached, the is positioned at the end of file (EOF). If the style sheet contains entities, you should specify an that can resolve entities ( returns `true`). In this case, an can be used. - If the style sheet contains embedded scripting, the script is compiled to an assembly. The assembly has full trust. The recommended practice is to provide evidence using the method. + If the style sheet contains embedded scripting, the script is compiled to an assembly. The assembly has full trust. The recommended practice is to provide evidence using the method. > [!NOTE] > If the caller does not have `UnmanagedCode` permission, the embedded script is not compiled and a is thrown. See and for more information. @@ -415,7 +415,7 @@ This method loads the XSLT style sheet, including any style sheets referenced in `xsl:include` and `xsl:import` elements. External resources are resolved using an with no user credentials. If the style sheet(s) are located on a network resource that requires authentication, use the overload that takes an as one of its arguments and specify an with the necessary credentials. - If the style sheet contains embedded scripting, the script is compiled to an assembly. The assembly has full trust. The recommended practice is to provide evidence using the method. + If the style sheet contains embedded scripting, the script is compiled to an assembly. The assembly has full trust. The recommended practice is to provide evidence using the method. > [!NOTE] > If the caller does not have `UnmanagedCode` permission, the embedded script is not compiled and a is thrown. See and for more information. @@ -486,9 +486,9 @@ This method loads the XSLT style sheet, including any style sheets referenced in `xsl:include` and `xsl:import` elements. External resources are resolved using an with no user credentials. If the style sheet(s) are located on a network resource that requires authentication, use the overload that takes an as one of its arguments and specify an with the necessary credentials. - The style sheet is loaded from the current position of the . To use just a portion of the loaded document as the style sheet, navigate to the node corresponding to the beginning of the style sheet. After the method returns, the is positioned at the beginning of the style sheet (on the `xsl:style sheet` node). + The style sheet is loaded from the current position of the . To use just a portion of the loaded document as the style sheet, navigate to the node corresponding to the beginning of the style sheet. After the method returns, the is positioned at the beginning of the style sheet (on the `xsl:style sheet` node). - If the style sheet contains embedded scripting, the script is compiled to an assembly. The assembly has full trust. The recommended practice is to provide evidence using the method. + If the style sheet contains embedded scripting, the script is compiled to an assembly. The assembly has full trust. The recommended practice is to provide evidence using the method. > [!NOTE] > If the caller does not have `UnmanagedCode` permission, the embedded script is not compiled and a is thrown. See and for more information. @@ -659,11 +659,11 @@ This method loads the XSLT style sheet, including any style sheets referenced in `xsl:include` and `xsl:import` elements. The style sheet loads from the current node of the through all its children. This enables you to use a portion of a document as the style sheet. - After the method returns, the is positioned on the next node after the end of the style sheet. If the end of the document is reached, the is positioned at the end of file (EOF). + After the method returns, the is positioned on the next node after the end of the style sheet. If the end of the document is reached, the is positioned at the end of file (EOF). If the style sheet contains entities, you should specify an that can resolve entities ( returns `true`). In this case, an can be used. - If the style sheet contains embedded scripting, the script is compiled to an assembly. The assembly has full trust. The recommended practice is to provide evidence using the method. + If the style sheet contains embedded scripting, the script is compiled to an assembly. The assembly has full trust. The recommended practice is to provide evidence using the method. > [!NOTE] > If the caller does not have `UnmanagedCode` permission, the embedded script is not compiled and a is thrown. See and for more information. @@ -747,7 +747,7 @@ supports the XSLT 1.0 syntax. The XSLT style sheet must include the namespace declaration `xmlns:xsl= http://www.w3.org/1999/XSL/Transform`. - If the style sheet contains embedded scripting, the script is compiled to an assembly. The assembly has full trust. The recommended practice is to provide evidence using the method. + If the style sheet contains embedded scripting, the script is compiled to an assembly. The assembly has full trust. The recommended practice is to provide evidence using the method. > [!NOTE] > If the caller does not have `UnmanagedCode` permission, the embedded script is not compiled and a is thrown. See and for more information. @@ -831,9 +831,9 @@ supports the XSLT 1.0 syntax. The XSLT style sheet must include the namespace declaration `xmlns:xsl= http://www.w3.org/1999/XSL/Transform`. - The style sheet is loaded from the current position of the . To use a portion of the loaded document as the style sheet, navigate to the node corresponding to the beginning of the style sheet. After the method returns, the is positioned at the beginning of the style sheet (on the `xsl:style sheet` node). + The style sheet is loaded from the current position of the . To use a portion of the loaded document as the style sheet, navigate to the node corresponding to the beginning of the style sheet. After the method returns, the is positioned at the beginning of the style sheet (on the `xsl:style sheet` node). - If the style sheet contains embedded scripting, the script is compiled to an assembly. The assembly has full trust. The recommended practice is to provide evidence using the . + If the style sheet contains embedded scripting, the script is compiled to an assembly. The assembly has full trust. The recommended practice is to provide evidence using the . > [!NOTE] > If the caller does not have `UnmanagedCode` permission, the embedded script is not compiled and a is thrown. See and for more information. @@ -898,7 +898,7 @@ This method loads the XSLT style sheet, including any style sheets referenced in `xsl:include` and `xsl:import` elements. The style sheet loads from the current node of the through all its children. This enables you to use a portion of a document as the style sheet. - After the method returns, the is positioned on the next node after the end of the style sheet. If the end of the document is reached, the is positioned at the end of file (EOF). + After the method returns, the is positioned on the next node after the end of the style sheet. If the end of the document is reached, the is positioned at the end of file (EOF). If the style sheet contains entities, you should specify an that can resolve entities ( returns `true`). In this case, an can be used. @@ -1046,7 +1046,7 @@ supports the XSLT 1.0 syntax. The XSLT style sheet must include the namespace declaration `xmlns:xsl= http://www.w3.org/1999/XSL/Transform`. - The style sheet is loaded from the current position of the . To use a portion of the loaded document as the style sheet, navigate to the node corresponding to the beginning of the style sheet. After the method returns, the is positioned at the beginning of the style sheet (on the `xsl:style sheet` node). + The style sheet is loaded from the current position of the . To use a portion of the loaded document as the style sheet, navigate to the node corresponding to the beginning of the style sheet. After the method returns, the is positioned at the beginning of the style sheet (on the `xsl:style sheet` node). @@ -1154,7 +1154,7 @@ supports the XSLT 1.0 syntax. The XSLT style sheet must include the namespace declaration `xmlns:xsl= http://www.w3.org/1999/XSL/Transform`. > [!NOTE] -> This method is obsolete in version 1.1 of the .NET Framework. The setting of the property determines how the XSLT `document()` function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. +> This method is obsolete in version 1.1 of the .NET Framework. The setting of the property determines how the XSLT `document()` function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. ]]> @@ -1230,13 +1230,13 @@ supports the XSLT 1.0 syntax. The XSLT style sheet must include the namespace declaration `xmlns:xsl= http://www.w3.org/1999/XSL/Transform`. > [!NOTE] -> This method is now obsolete. The setting of the property determines how the XSLT `document()` function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. +> This method is now obsolete. The setting of the property determines how the XSLT `document()` function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. The `args` are matched with the `xsl:param` elements defined in the style sheet. The `xsl:output` element is not supported when outputting to an (the `xsl:output` element is ignored). See [Outputs from an XslTransform](/dotnet/standard/data/xml/outputs-from-an-xsltransform) for more information. This method enables you to do an asynchronous transformation of the source document. - Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an containing just the node fragment and pass that to the method. + Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an containing just the node fragment and pass that to the method. ]]> @@ -1311,14 +1311,14 @@ supports the XSLT 1.0 syntax. The XSLT style sheet must include the namespace declaration `xmlns:xsl= http://www.w3.org/1999/XSL/Transform`. - The `args` are matched with the `xsl:param` elements defined in the style sheet. The transformation selections apply to the document as a whole. In other words, if the current node is set on a node tree other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. After the transformation has been performed, the remains in its original state. This means that the node, which is current before the transformation process, remains the current node after the method has been called. + The `args` are matched with the `xsl:param` elements defined in the style sheet. The transformation selections apply to the document as a whole. In other words, if the current node is set on a node tree other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. After the transformation has been performed, the remains in its original state. This means that the node, which is current before the transformation process, remains the current node after the method has been called. Because provides read-only output, the `xsl:output` element is ignored. See [Outputs from an XslTransform](/dotnet/standard/data/xml/outputs-from-an-xsltransform) for more information. This method enables you to do an asynchronous transformation of the source document. > [!NOTE] -> This method is obsolete. The setting of the property determines how the XSLT document() function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. +> This method is obsolete. The setting of the property determines how the XSLT document() function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. ]]> @@ -1469,11 +1469,11 @@ supports the XSLT 1.0 syntax. The XSLT style sheet must include the namespace declaration `xmlns:xsl= http://www.w3.org/1999/XSL/Transform`. > [!NOTE] -> This method is now obsolete. The setting of the property determines how the XSLT `document()` function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. +> This method is now obsolete. The setting of the property determines how the XSLT `document()` function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. The `args` are matched with the `xsl:param` elements defined in the style sheet. - Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an containing just the node fragment and pass that to the method. + Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an containing just the node fragment and pass that to the method. ]]> @@ -1551,13 +1551,13 @@ supports the XSLT 1.0 syntax. The XSLT style sheet must include the namespace declaration `xmlns:xsl= http://www.w3.org/1999/XSL/Transform`. > [!NOTE] -> This method is now obsolete. The setting of the property determines how the XSLT `document()` function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. +> This method is now obsolete. The setting of the property determines how the XSLT `document()` function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. The `args` are matched with the `xsl:param` elements defined in the style sheet. The encoding attribute on an `xsl:output` element is not supported when outputting to a . See [Outputs from an XslTransform](/dotnet/standard/data/xml/outputs-from-an-xsltransform) for specifics on which `xsl:output` attributes are supported. - Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an containing just the node fragment, and pass that to the method. + Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an containing just the node fragment, and pass that to the method. ]]> @@ -1642,7 +1642,7 @@ This method enables you to do an asynchronous transformation of the source document. - Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an containing just the node fragment, and pass that to the method. + Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an containing just the node fragment, and pass that to the method. ]]> @@ -1720,11 +1720,11 @@ supports the XSLT 1.0 syntax. The XSLT style sheet must include the namespace declaration `xmlns:xsl= http://www.w3.org/1999/XSL/Transform`. > [!NOTE] -> This method is now obsolete. The setting of the property determines how the XSLT `document()` function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. +> This method is now obsolete. The setting of the property determines how the XSLT `document()` function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. The `args` are matched with the `xsl:param` elements defined in the style sheet. The `xsl:output` element is not supported when outputting to an (`xsl:output` is ignored). See [Outputs from an XslTransform](/dotnet/standard/data/xml/outputs-from-an-xsltransform) for more information. - Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an containing just the node fragment and pass that to the method. + Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an containing just the node fragment and pass that to the method. ]]> @@ -1801,12 +1801,12 @@ supports the XSLT 1.0 syntax. The XSLT style sheet must include the namespace declaration `xmlns:xsl= http://www.w3.org/1999/XSL/Transform`. - The `args` are matched with the `xsl:param` elements defined in the style sheet. The transformation selections apply to the document as a whole. In other words, if the current node is set on a node tree other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. After the transformation has been performed, the remains in its original state. This means that the node, which is current before the transformation process, remains the current node after the method has been called. + The `args` are matched with the `xsl:param` elements defined in the style sheet. The transformation selections apply to the document as a whole. In other words, if the current node is set on a node tree other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. After the transformation has been performed, the remains in its original state. This means that the node, which is current before the transformation process, remains the current node after the method has been called. See [Outputs from an XslTransform](/dotnet/standard/data/xml/outputs-from-an-xsltransform) for specifics on which `xsl:output` attributes are supported. > [!NOTE] -> This method is now obsolete. The setting of the property determines how the XSLT `document()` function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. +> This method is now obsolete. The setting of the property determines how the XSLT `document()` function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. ]]> @@ -1884,12 +1884,12 @@ supports the XSLT 1.0 syntax. The XSLT style sheet must include the namespace declaration `xmlns:xsl= http://www.w3.org/1999/XSL/Transform`. - The `args` are matched with the `xsl:param` elements defined in the style sheet. The transformation selections apply to the document as a whole. In other words, if the current node is set on a node tree other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. After the transformation is performed, the remains in its original state. This means that the node, which is current before the transformation process, remains the current node after the method has been called. + The `args` are matched with the `xsl:param` elements defined in the style sheet. The transformation selections apply to the document as a whole. In other words, if the current node is set on a node tree other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. After the transformation is performed, the remains in its original state. This means that the node, which is current before the transformation process, remains the current node after the method has been called. The encoding attribute on an `xsl:output` element is not supported when outputting to a . See [Outputs from an XslTransform](/dotnet/standard/data/xml/outputs-from-an-xsltransform) for specifics on which `xsl:output` attributes are supported. > [!NOTE] -> This method is now obsolete. The setting of the property determines how the XSLT `document()` function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. +> This method is now obsolete. The setting of the property determines how the XSLT `document()` function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. ]]> @@ -1971,7 +1971,7 @@ supports the XSLT 1.0 syntax. The XSLT style sheet must include the namespace declaration `xmlns:xsl= http://www.w3.org/1999/XSL/Transform`. - The `args` are matched with the `xsl:param` elements defined in the style sheet. The transformation selections apply to the document as a whole. In other words, if the current node is set on a node tree other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. After the transformation has been performed, the remains in its original state. This means that the node, which is current before the transformation process, remains the current node after the method has been called. + The `args` are matched with the `xsl:param` elements defined in the style sheet. The transformation selections apply to the document as a whole. In other words, if the current node is set on a node tree other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. After the transformation has been performed, the remains in its original state. This means that the node, which is current before the transformation process, remains the current node after the method has been called. Because provides read-only output, the `xsl:output` element is ignored. See [Outputs from an XslTransform](/dotnet/standard/data/xml/outputs-from-an-xsltransform) for more information. @@ -2053,12 +2053,12 @@ supports the XSLT 1.0 syntax. The XSLT style sheet must include the namespace declaration `xmlns:xsl= http://www.w3.org/1999/XSL/Transform`. - The `args` are matched with the `xsl:param` elements defined in the style sheet. The transformation selections apply to the document as a whole. In other words, if the current node is set on a node tree other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. After the transformation is performed, the remains in its original state. This means that the node, that is current before the transformation process, remains the current node after the method has been called. + The `args` are matched with the `xsl:param` elements defined in the style sheet. The transformation selections apply to the document as a whole. In other words, if the current node is set on a node tree other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. After the transformation is performed, the remains in its original state. This means that the node, that is current before the transformation process, remains the current node after the method has been called. The `xsl:output` element is not supported when outputting to an (`xsl:output` is ignored). See [Outputs from an XslTransform](/dotnet/standard/data/xml/outputs-from-an-xsltransform) for more information. > [!NOTE] -> This method is now obsolete. The setting of the property determines how the XSLT `document()` function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. +> This method is now obsolete. The setting of the property determines how the XSLT `document()` function is resolved. The recommended practice is to use the method that takes an object as one of its arguments. ]]> @@ -2143,7 +2143,7 @@ The `args` are matched with the `xsl:param` elements defined in the style sheet. - Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an containing just the node fragment and pass that to the method. + Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an containing just the node fragment and pass that to the method. ]]> @@ -2231,7 +2231,7 @@ The encoding attribute on an `xsl:output` element is not supported when outputting to a . See [Outputs from an XslTransform](/dotnet/standard/data/xml/outputs-from-an-xsltransform) for specifics on which `xsl:output` attributes are supported. - Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an containing just the node fragment and pass that to the method. + Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an containing just the node fragment and pass that to the method. ]]> @@ -2317,7 +2317,7 @@ The `args` are matched with the `xsl:param` elements defined in the style sheet. The `xsl:output` element is not supported when outputting to an (`xsl:output` is ignored). See [Outputs from an XslTransform](/dotnet/standard/data/xml/outputs-from-an-xsltransform) for more information. - Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an containing just the node fragment and pass that to the method. + Transformations apply to the document as a whole. In other words, if you pass in a node other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. To transform a node fragment, you must create an containing just the node fragment and pass that to the method. ]]> @@ -2401,7 +2401,7 @@ supports the XSLT 1.0 syntax. The XSLT style sheet must include the namespace declaration `xmlns:xsl= http://www.w3.org/1999/XSL/Transform`. - The `args` are matched with the `xsl:param` elements defined in the style sheet. The transformation selections apply to the document as a whole. In other words, if the current node is set on a node tree other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. After the transformation has been performed, the remains in its original state. This means that the node, which is current before the transformation process, remains the current node after the method has been called. + The `args` are matched with the `xsl:param` elements defined in the style sheet. The transformation selections apply to the document as a whole. In other words, if the current node is set on a node tree other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. After the transformation has been performed, the remains in its original state. This means that the node, which is current before the transformation process, remains the current node after the method has been called. See [Outputs from an XslTransform](/dotnet/standard/data/xml/outputs-from-an-xsltransform) for specifics on which `xsl:output` attributes are supported. @@ -2488,7 +2488,7 @@ supports the XSLT 1.0 syntax. The XSLT style sheet must include the namespace declaration `xmlns:xsl= http://www.w3.org/1999/XSL/Transform`. - The `args` are matched with the `xsl:param` elements defined in the style sheet. The transformation selections apply to the document as a whole. In other words, if the current node is set on a node tree other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. After the transformation is performed, the remains in its original state. This means that the node, which is current before the transformation process, remains the current node after the method has been called. + The `args` are matched with the `xsl:param` elements defined in the style sheet. The transformation selections apply to the document as a whole. In other words, if the current node is set on a node tree other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. After the transformation is performed, the remains in its original state. This means that the node, which is current before the transformation process, remains the current node after the method has been called. The encoding attribute on an `xsl:output` element is not supported when outputting to a . See [Outputs from an XslTransform](/dotnet/standard/data/xml/outputs-from-an-xsltransform) for specifics on which `xsl:output` attributes are supported. @@ -2575,7 +2575,7 @@ supports the XSLT 1.0 syntax. The XSLT style sheet must include the namespace declaration `xmlns:xsl= http://www.w3.org/1999/XSL/Transform`. - The `args` are matched with the `xsl:param` elements defined in the style sheet. The transformation selections apply to the document as a whole. In other words, if the current node is set on a node tree other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. After the transformation is performed, the remains in its original state. This means that the node, that is current before the transformation process, remains the current node after the method has been called. + The `args` are matched with the `xsl:param` elements defined in the style sheet. The transformation selections apply to the document as a whole. In other words, if the current node is set on a node tree other than the document root node, this does not prevent the transformation process from accessing all nodes in the loaded document. After the transformation is performed, the remains in its original state. This means that the node, that is current before the transformation process, remains the current node after the method has been called. The `xsl:output` element is not supported when outputting to an (`xsl:output` is ignored). See [Outputs from an XslTransform](/dotnet/standard/data/xml/outputs-from-an-xsltransform) for more information. @@ -2655,10 +2655,10 @@ `Semi-trusted code:` The property is set to `null`, which means the `document()` function is not resolved. Because full trust is required to specify an , this property also cannot be set. - This resolver is used when the XSLT `document()` function is invoked. It is not used to resolve `xsl:import` and `xsl:include` elements referenced in the style sheet. To specify an to use to resolve `xsl:import` and `xsl:include` elements referenced in the style sheet, use the overload, which takes an as one of its arguments. + This resolver is used when the XSLT `document()` function is invoked. It is not used to resolve `xsl:import` and `xsl:include` elements referenced in the style sheet. To specify an to use to resolve `xsl:import` and `xsl:include` elements referenced in the style sheet, use the overload, which takes an as one of its arguments. > [!NOTE] -> This property is obsolete in version 1.1 of the .NET Framework. Specifying an using the method is the recommended practice. In this case, the is not cached after the method completes. +> This property is obsolete in version 1.1 of the .NET Framework. Specifying an using the method is the recommended practice. In this case, the is not cached after the method completes. ]]> diff --git a/xml/System.Xml.Xsl/XsltArgumentList.xml b/xml/System.Xml.Xsl/XsltArgumentList.xml index e91f81086f5..0fd4020da46 100644 --- a/xml/System.Xml.Xsl/XsltArgumentList.xml +++ b/xml/System.Xml.Xsl/XsltArgumentList.xml @@ -59,7 +59,7 @@ method. It allows parameters and extension objects to be invoked from within the style sheet. + This class is used by the method. It allows parameters and extension objects to be invoked from within the style sheet. When the parameters and objects are added to the , they are associated with a namespace qualified name and a namespace URI, respectively. @@ -279,7 +279,7 @@ ## Examples - The following example uses the method to create a parameter representing the current date and time. + The following example uses the method to create a parameter representing the current date and time. :::code language="csharp" source="~/snippets/csharp/System.Xml.Xsl/XslCompiledTransform/Transform/addparam.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XsltArgumentList.AddParam/VB/addparam.vb" id="Snippet1"::: diff --git a/xml/System.Xml.Xsl/XsltSettings.xml b/xml/System.Xml.Xsl/XsltSettings.xml index cc6fd8a4d1b..79cbe18b2ed 100644 --- a/xml/System.Xml.Xsl/XsltSettings.xml +++ b/xml/System.Xml.Xsl/XsltSettings.xml @@ -54,7 +54,7 @@ class. These features are disabled by default. The class specifies which of these optional features to support. Features are enabled or disabled using the class properties. The object is then passed to the method. + Embedded script blocks and the XSLT `document()` function are optional features on the class. These features are disabled by default. The class specifies which of these optional features to support. Features are enabled or disabled using the class properties. The object is then passed to the method. > [!IMPORTANT] > XSLT style sheets can include references to other files and embedded script blocks. A malicious user can exploit this by supplying you with data or style sheets that when executed can cause your system to process until the computer runs low on resources. Do not enable scripting or the `document()` function unless the style sheet comes from a trusted source. If you cannot verify the source of the style sheet, or if the style sheet does not come from a trusted source, use the default XSLT settings. @@ -125,7 +125,7 @@ The new object does not support the XSLT `document()` function or embedded script blocks. > [!IMPORTANT] -> XSLT scripting should be enabled only if you require script support and you are working in a fully trusted environment. If you enable the `document()` function, you can restrict the resources that can be accessed by passing an object to the method. +> XSLT scripting should be enabled only if you require script support and you are working in a fully trusted environment. If you enable the `document()` function, you can restrict the resources that can be accessed by passing an object to the method. ]]> @@ -180,7 +180,7 @@ ## Remarks > [!IMPORTANT] -> XSLT scripting should be enabled only if you require script support and you are working in a fully trusted environment. If you enable the `document()` function, you can restrict the resources that can be accessed by passing an object to the method. +> XSLT scripting should be enabled only if you require script support and you are working in a fully trusted environment. If you enable the `document()` function, you can restrict the resources that can be accessed by passing an object to the method. @@ -302,7 +302,7 @@ ## Remarks > [!IMPORTANT] -> If you enable the `document()` function, you can restrict the resources that can be accessed by passing an object to the method. +> If you enable the `document()` function, you can restrict the resources that can be accessed by passing an object to the method. ]]> @@ -420,7 +420,7 @@ ## Remarks > [!IMPORTANT] -> XSLT scripting should be enabled only if you require script support and you are working in a fully trusted environment. If you enable the `document()` function, you can restrict the resources that can be accessed by passing an object to the method. +> XSLT scripting should be enabled only if you require script support and you are working in a fully trusted environment. If you enable the `document()` function, you can restrict the resources that can be accessed by passing an object to the method. diff --git a/xml/System.Xml/IHasXmlNode.xml b/xml/System.Xml/IHasXmlNode.xml index 806cd56fd08..bbee6a55313 100644 --- a/xml/System.Xml/IHasXmlNode.xml +++ b/xml/System.Xml/IHasXmlNode.xml @@ -47,13 +47,13 @@ from the current context or position. It is implemented by objects that operate over classes that have nodes. For example, if the `XPathNavigator` object is created by an , you can use the method to return the `XmlNode` representing the current position of the navigator. + The `IHasXmlNode` interface provides an interface that enables a class to return an from the current context or position. It is implemented by objects that operate over classes that have nodes. For example, if the `XPathNavigator` object is created by an , you can use the method to return the `XmlNode` representing the current position of the navigator. ## Examples The following example uses the `GetNode` method to retrieve and modify the selected node. - + :::code language="csharp" source="~/snippets/csharp/System.Xml/IHasXmlNode/Overview/hasxmlnode.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/IHasXmlNode.GetNode/VB/hasxmlnode.vb" id="Snippet1"::: diff --git a/xml/System.Xml/IStreamProvider.xml b/xml/System.Xml/IStreamProvider.xml index 22c59399e7d..322f23cc1aa 100644 --- a/xml/System.Xml/IStreamProvider.xml +++ b/xml/System.Xml/IStreamProvider.xml @@ -46,7 +46,7 @@ will use a sequence of calls similar to the following in its implementation: + When writing an outgoing message containing a streamed body to an XML writer, the will use a sequence of calls similar to the following in its implementation: - Write any necessary information preceding the stream (For example, the opening XML tag). @@ -56,7 +56,7 @@ This works well with encodings that are similar to the textual XML encoding. However, there are some encodings that do not place XML infoset information (For example, tags for starting and ending XML elements) together with the data contained within elements. For example, in the MTOM encoding, the message is split into multiple parts. One part contains the XML infoset, which may contain references to other parts for actual element contents. Since the XML infoset will normally be small compared to the streamed contents, it makes sense to buffer the infoset, write it out, and then write the contents in a streamed way. This means that by the time the closing element tag is written, we should not have written out the stream yet. - For this purpose, the interface is used. The interface has a method that returns the stream to be written. The correct way to write out a streamed message body in is as follows: + For this purpose, the interface is used. The interface has a method that returns the stream to be written. The correct way to write out a streamed message body in is as follows: - Write any necessary information preceding the stream (For example, the opening XML tag) diff --git a/xml/System.Xml/IXmlNamespaceResolver.xml b/xml/System.Xml/IXmlNamespaceResolver.xml index 6d2519138d2..2c19d350de7 100644 --- a/xml/System.Xml/IXmlNamespaceResolver.xml +++ b/xml/System.Xml/IXmlNamespaceResolver.xml @@ -100,7 +100,7 @@ ## Remarks The collection is keyed by prefix and can be used to enumerate the namespaces currently in scope. The collection is a disconnected copy of the current namespace list. - The following table lists the values and how it affects the whether or not the default and built-in namespaces are returned by the method. + The following table lists the values and how it affects the whether or not the default and built-in namespaces are returned by the method. |XmlNamespaceScope value|xmlns:xml|xmlns:xmlns|xmlns=""| |-----------------------------|---------------|-----------------|---------------| @@ -166,7 +166,7 @@ > [!NOTE] > Namespace URI-to-prefix mappings can change from node to node in an XML document. You cannot depend on the result of a lookup being consistent from one node to the next. - The following table describes how the default and built-in namespaces are handled by the method. + The following table describes how the default and built-in namespaces are handled by the method. |Prefix|Return Value| |------------|------------------| @@ -234,7 +234,7 @@ > [!NOTE] > Namespace URI to prefix mappings can change from node to node in an XML document. You cannot depend on the result of a lookup being consistent from one node to the next. - The following table describes how the default and built-in namespaces are handled by the method. + The following table describes how the default and built-in namespaces are handled by the method. |Namespace|Return value| |---------------|------------------| diff --git a/xml/System.Xml/NewLineHandling.xml b/xml/System.Xml/NewLineHandling.xml index 3946b0eba69..cee91a83083 100644 --- a/xml/System.Xml/NewLineHandling.xml +++ b/xml/System.Xml/NewLineHandling.xml @@ -51,7 +51,7 @@ method to specify whether the object will normalize line breaks in the output. + This enumeration is passed to the method to specify whether the object will normalize line breaks in the output. See the property to see a table detailing the behavior of each of the validation types. diff --git a/xml/System.Xml/UniqueId.xml b/xml/System.Xml/UniqueId.xml index 32d2c171f47..067f12832ed 100644 --- a/xml/System.Xml/UniqueId.xml +++ b/xml/System.Xml/UniqueId.xml @@ -671,7 +671,7 @@ if the two s are equal, or are both ; if they are not equal, or if only one of them is . - ]]> + ]]> @@ -724,7 +724,7 @@ if the overridden equality operator returns ; otherwise . - ]]> + ]]> diff --git a/xml/System.Xml/ValidationType.xml b/xml/System.Xml/ValidationType.xml index ddd1744f0c6..82a2e208bae 100644 --- a/xml/System.Xml/ValidationType.xml +++ b/xml/System.Xml/ValidationType.xml @@ -45,13 +45,13 @@ Specifies the type of validation to perform. - class can enforce validation using a schema or document type definition (DTD). The enumeration specifies the type of validation the created instance should perform. The instance can be either a validating object created by the method, or an object. - - The validation model has three characteristics, strict, informative, and status. Strict, does not allow the mixing of validation types, informative provides a warning if the schema or document type definition (DTD) cannot be found, and status provides warnings if validation cannot be performed for elements and attributes from schemas. - + class can enforce validation using a schema or document type definition (DTD). The enumeration specifies the type of validation the created instance should perform. The instance can be either a validating object created by the method, or an object. + + The validation model has three characteristics, strict, informative, and status. Strict, does not allow the mixing of validation types, informative provides a warning if the schema or document type definition (DTD) cannot be found, and status provides warnings if validation cannot be performed for elements and attributes from schemas. + ]]> @@ -105,9 +105,9 @@ 1 - Validates if DTD or schema information is found. + Validates if DTD or schema information is found. -Starting with .NET Framework 2.0, this field is obsolete. It applies only to the obsolete class. +Starting with .NET Framework 2.0, this field is obsolete. It applies only to the obsolete class. @@ -191,7 +191,7 @@ Starting with .NET Framework 2.0, this field is obsolete. It applies only to the 0 No validation is performed, and no validation errors are thrown. This setting creates an XML 1.0 compliant non-validating parser. - + Calls to report default attributes and resolve general entities. The DOCTYPE is not used for validation purposes. @@ -285,8 +285,8 @@ Calls to report default attr 3 Validate according to XML-Data Reduced (XDR) schemas, including inline XDR schemas. XDR schemas are recognized using the namespace prefix or the property. - -Starting with .NET Framework 2.0, this field is obsolete. It applies only to the obsolete class. + +Starting with .NET Framework 2.0, this field is obsolete. It applies only to the obsolete class. diff --git a/xml/System.Xml/XmlAttribute.xml b/xml/System.Xml/XmlAttribute.xml index 1c722c8b487..430fbeece73 100644 --- a/xml/System.Xml/XmlAttribute.xml +++ b/xml/System.Xml/XmlAttribute.xml @@ -72,7 +72,7 @@ ## Remarks Attributes can be associated with an element. Use the property to get the to which the attribute belongs. - The `XmlElement` class has several methods which allow you to access attribute nodes (, , , and so on). Additionally, you can call the property, which returns an enabling you to access attributes by name or index from the collection. + The `XmlElement` class has several methods which allow you to access attribute nodes (, , , and so on). Additionally, you can call the property, which returns an enabling you to access attributes by name or index from the collection. ]]> @@ -150,7 +150,7 @@ directly; instead, use methods such as . + Do not instantiate an directly; instead, use methods such as . ]]> @@ -210,12 +210,12 @@ ## Remarks If the `newChild` is already in the tree, it is first removed. - If the node being inserted was created from another document, you can use to import the node to the current document. The imported node can then be inserted into the current document. + If the node being inserted was created from another document, you can use to import the node to the current document. The imported node can then be inserted into the current document. ## Examples - For an example of the method, see the method. + For an example of the method, see the method. ]]> @@ -556,14 +556,14 @@ ## Remarks If `refChild` is `null`, insert `newChild` at the beginning of the list of child nodes. If `newChild` is an object, its child nodes are inserted, in the same order, after `refChild`. If the `newChild` is already in the tree, it is first removed. - If the node being inserted was created from another document, you can use to import the node to the current document. The imported node can then be inserted into the current document. + If the node being inserted was created from another document, you can use to import the node to the current document. The imported node can then be inserted into the current document. This method is a Microsoft extension to the Document Object Model (DOM). ## Examples - For an example of the method see the method. + For an example of the method see the method. ]]> @@ -640,12 +640,12 @@ ## Remarks If `refChild` is `null`, insert `newChild` at the end of the list of child nodes. If `newChild` is an object, its child nodes are inserted, in the same order, before `refChild`. If the `newChild` is already in the tree, it is first removed. - If the node being inserted was created from another document, you can use to import the node to the current document. The imported node can then be inserted into the current document. + If the node being inserted was created from another document, you can use to import the node to the current document. The imported node can then be inserted into the current document. ## Examples - For an example of the method, see the method. + For an example of the method, see the method. ]]> @@ -1199,14 +1199,14 @@ ## Remarks If the `newChild` is already in the tree, it is first removed. - If the node being inserted was created from another document, you can use to import the node to the current document. The imported node can then be inserted into the current document. + If the node being inserted was created from another document, you can use to import the node to the current document. The imported node can then be inserted into the current document. This method is a Microsoft extension to the Document Object Model (DOM). ## Examples - For an example of the method, see the method. + For an example of the method, see the method. ]]> @@ -1269,7 +1269,7 @@ method, see the method. + For an example of the method, see the method. ]]> @@ -1331,12 +1331,12 @@ ## Remarks If the `newChild` is already in the tree, it is first removed. - If the `newChild` was created from another document, you can use to import the node to the current document. + If the `newChild` was created from another document, you can use to import the node to the current document. ## Examples - For an example of the method, see the method. + For an example of the method, see the method. ]]> diff --git a/xml/System.Xml/XmlAttributeCollection.xml b/xml/System.Xml/XmlAttributeCollection.xml index 6fc24ef4d91..ad0b08c361e 100644 --- a/xml/System.Xml/XmlAttributeCollection.xml +++ b/xml/System.Xml/XmlAttributeCollection.xml @@ -466,7 +466,7 @@ . + This property is a Microsoft extension to the Document Object Model (DOM). It is equivalent to calling . @@ -544,7 +544,7 @@ . + This property is a Microsoft extension to the Document Object Model (DOM). It is equivalent to calling . @@ -629,7 +629,7 @@ . + This property is a Microsoft extension to the Document Object Model (DOM). It is equivalent to calling . ]]> diff --git a/xml/System.Xml/XmlCDataSection.xml b/xml/System.Xml/XmlCDataSection.xml index 13a45b22892..722a2763384 100644 --- a/xml/System.Xml/XmlCDataSection.xml +++ b/xml/System.Xml/XmlCDataSection.xml @@ -67,11 +67,11 @@ Represents a CDATA section. - @@ -193,13 +193,13 @@ Creates a duplicate of this node. The cloned node. - method in the `XmlNode` class. - - The cloned node has no parent ( returns `null`). - + method in the `XmlNode` class. + + The cloned node has no parent ( returns `null`). + ]]> @@ -499,13 +499,13 @@ The to which you want to save. Saves the children of the node to the specified . - @@ -558,11 +558,11 @@ The to which you want to save. Saves the node to the specified . - diff --git a/xml/System.Xml/XmlComment.xml b/xml/System.Xml/XmlComment.xml index a4cc225ddd4..84777bba073 100644 --- a/xml/System.Xml/XmlComment.xml +++ b/xml/System.Xml/XmlComment.xml @@ -132,11 +132,11 @@ The parent XML document. Initializes a new instance of the class. - directly; instead, use methods such as . - + directly; instead, use methods such as . + ]]> @@ -191,13 +191,13 @@ Creates a duplicate of this node. The cloned node. - method in the `XmlNode` class. - - The cloned node has no parent ( returns `null`). - + method in the `XmlNode` class. + + The cloned node has no parent ( returns `null`). + ]]> @@ -392,11 +392,11 @@ The to which you want to save. Saves all the children of the node to the specified . Because comment nodes do not have children, this method has no effect. - @@ -449,11 +449,11 @@ The to which you want to save. Saves the node to the specified . - diff --git a/xml/System.Xml/XmlConvert.xml b/xml/System.Xml/XmlConvert.xml index dd85eb9ea9c..399f7a15dd6 100644 --- a/xml/System.Xml/XmlConvert.xml +++ b/xml/System.Xml/XmlConvert.xml @@ -236,7 +236,7 @@ method except that it encodes the colon character, which guarantees that the name can be used as the local name part of a namespace qualified name. + This method is similar to the method except that it encodes the colon character, which guarantees that the name can be used as the local name part of a namespace qualified name. For example, if you passed this method the invalid name a:b, it returns a\_x003a\_b, which is a valid local name. @@ -319,7 +319,7 @@ The underscore character does not need to be escaped unless it is followed by a character sequence that together with the underscore can be misinterpreted as an escape sequence when decoding the name. For example, Order\_Details is not encoded, but Order\_x0020\_ is encoded as Order\_x005f\_x0020\_. No shortforms are allowed. For example, the forms \_x20\_ and \_\_ are not generated. - This method guarantees the name is valid according to the XML specification. It allows colons in any position, which means the name may still be invalid according to the [W3C Namespace Specification](https://www.w3.org/TR/REC-xml-names/). To guarantee it is a valid namespace qualified name use for the prefix and local name parts and join the result with a colon. + This method guarantees the name is valid according to the XML specification. It allows colons in any position, which means the name may still be invalid according to the [W3C Namespace Specification](https://www.w3.org/TR/REC-xml-names/). To guarantee it is a valid namespace qualified name use for the prefix and local name parts and join the result with a colon. @@ -926,7 +926,7 @@ [!NOTE] -> The method is obsolete in the 2.0 version of the .NET Framework and has been replaced by the method. +> The method is obsolete in the 2.0 version of the .NET Framework and has been replaced by the method. ]]> @@ -1188,7 +1188,7 @@ When more than seven digits are specified for fractional seconds, the value is rounded. For example, 00000004 becomes 0000000 and 00000005 becomes 0000001. ## Examples - The following example demonstrates how to read a string from an XML file and use the method to convert the string to a type. + The following example demonstrates how to read a string from an XML file and use the method to convert the string to a type. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlConvert/ToDateTimeOffset/XmlConvert_ToDateTimeOffset_ex1.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlConvert_ToDateTimeOffset_ex1/VB/XmlConvert_ToDateTimeOffset_ex1.vb" id="Snippet1"::: @@ -1280,7 +1280,7 @@ ## Examples - The following example demonstrates how to read a string from an XML file and use the method to convert the string to a type. The input string is validated against the specified format before being converted. + The following example demonstrates how to read a string from an XML file and use the method to convert the string to a type. The input string is validated against the specified format before being converted. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlConvert/ToDateTimeOffset/XmlConvert_ToDateTimeOffset_ex2.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlConvert_ToDateTimeOffset_ex2/VB/XmlConvert_ToDateTimeOffset_ex2.vb" id="Snippet1"::: @@ -1372,7 +1372,7 @@ ## Examples - The following example demonstrates how to read a string from an XML file and use the method to convert the string to a type. The input string must validate against one of the specified formats before being converted. + The following example demonstrates how to read a string from an XML file and use the method to convert the string to a type. The input string must validate against one of the specified formats before being converted. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlConvert/ToDateTimeOffset/XmlConvert_ToDateTimeOffset_ex3.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlConvert_ToDateTimeOffset_ex3/VB/XmlConvert_ToDateTimeOffset_ex3.vb" id="Snippet1"::: @@ -1505,7 +1505,7 @@ ## Examples - The following example uses `ToDouble` and to read strongly typed data. + The following example uses `ToDouble` and to read strongly typed data. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlConvert/ToDateTime/readdata.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlConvert.ToDouble/VB/readdata.vb" id="Snippet1"::: @@ -2086,8 +2086,8 @@ ## Remarks > [!NOTE] -> The method is obsolete in the 2.0 version of the .NET Framework and has been replaced with the method. -> The suggested mode is . If an exact match is expected, please use with the format string `yyyy-MM-ddTHH:mm:ss.fffffffzzzzzz`. +> The method is obsolete in the 2.0 version of the .NET Framework and has been replaced with the method. +> The suggested mode is . If an exact match is expected, please use with the format string `yyyy-MM-ddTHH:mm:ss.fffffffzzzzzz`. ]]> @@ -3618,7 +3618,7 @@ catch(Exception e) { ## Examples - The following example uses the method to detect the presence of an invalid character in a value assigned to the start element. + The following example uses the method to detect the presence of an invalid character in a value assigned to the start element. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlConvert/VerifyWhitespace/xmlconvertnewverify.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/xmlconvert.newverify/vb/xmlconvertnewverify.vb" id="Snippet5"::: @@ -3683,7 +3683,7 @@ catch(Exception e) { ## Examples - The following example uses the method used to detect an illegal character in the start element. + The following example uses the method used to detect an illegal character in the start element. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlConvert/VerifyWhitespace/xmlconvertnewverify.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/xmlconvert.newverify/vb/xmlconvertnewverify.vb" id="Snippet3"::: diff --git a/xml/System.Xml/XmlDataDocument.xml b/xml/System.Xml/XmlDataDocument.xml index 92a96b25258..f988accf8c3 100644 --- a/xml/System.Xml/XmlDataDocument.xml +++ b/xml/System.Xml/XmlDataDocument.xml @@ -60,9 +60,9 @@ `XmlDataDocument` has a close affiliation with the `DataSet` class, which provides a relational view of the loaded XML data. Any changes made to the `XmlDataDocument` are reflected in the `DataSet` and vice versa. - To load a `DataSet` with XML data, use to build a relational mapping. The XML data can then be loaded using or . + To load a `DataSet` with XML data, use to build a relational mapping. The XML data can then be loaded using or . - To load relational data, specify the `DataSet` containing the relational data as the parameter in the constructor. + To load relational data, specify the `DataSet` containing the relational data as the parameter in the constructor. ]]> @@ -222,7 +222,7 @@ If `deep` is set to `true`, the cloned `DataSet` is set with the schema and then populated with the data. - See in the `XmlNode` class to see a table describing how this method behaves with each of the different node types. + See in the `XmlNode` class to see a table describing how this method behaves with each of the different node types. ]]> @@ -383,12 +383,12 @@ method. + The `XPathNavigator` provides read-only, random access to data. Because it is optimized for XSLT transformations, it provides performance benefits when used as an input mechanism to the method. ## Examples - To see an XSLT transformation using `XmlDataDocument` and an `XPathNavigator`, see the method. + To see an XSLT transformation using `XmlDataDocument` and an `XPathNavigator`, see the method. ]]> @@ -579,7 +579,7 @@ ## Remarks > [!NOTE] -> It is recommended that you use the or method instead of the method. +> It is recommended that you use the or method instead of the method. ]]> @@ -640,7 +640,7 @@ ## Remarks > [!NOTE] -> In order to view the XML data relationally, you must first specify a schema to use for data mapping. This can be done either by calling the method or by creating the tables and columns within the `DataSet` manually. This step must be done before calling `Load`. +> In order to view the XML data relationally, you must first specify a schema to use for data mapping. This can be done either by calling the method or by creating the tables and columns within the `DataSet` manually. This step must be done before calling `Load`. `XmlDataDocument` does not support creating entity references. If the data includes entity references, the `Load` method resolves and expands any entity references. However, if you are using the `Load` overload that takes a as an argument, you must specify an `XmlReader` that can resolve entities. @@ -691,7 +691,7 @@ `XmlDataDocument` does not support creating entity references. If the data includes entity references, the `Load` method resolves and expands any entity references. > [!NOTE] -> In order to view the XML data relationally, you must first specify a schema to use for data mapping. This can be done either by calling the method or by creating the tables and columns within the `DataSet` manually. This step must be done before calling `Load`. +> In order to view the XML data relationally, you must first specify a schema to use for data mapping. This can be done either by calling the method or by creating the tables and columns within the `DataSet` manually. This step must be done before calling `Load`. ]]> @@ -740,7 +740,7 @@ `XmlDataDocument` does not support creating entity references. If the data includes entity references, the `Load` method resolves and expands any entity references. > [!NOTE] -> In order to view the XML data relationally, you must first specify a schema to use for data mapping. This can be done either by calling the method or by creating the tables and columns within the `DataSet` manually. This step must be done before calling `Load`. +> In order to view the XML data relationally, you must first specify a schema to use for data mapping. This can be done either by calling the method or by creating the tables and columns within the `DataSet` manually. This step must be done before calling `Load`. ]]> @@ -789,7 +789,7 @@ `XmlDataDocument` does not support creating entity references. If the data includes entity references, the `Load` method resolves and expands any entity references. > [!NOTE] -> In order to view the XML data relationally, you must first specify a schema to use for data mapping. This can be done either by calling the method or by creating the tables and columns within the `DataSet` manually. This step must be done before calling `Load`. +> In order to view the XML data relationally, you must first specify a schema to use for data mapping. This can be done either by calling the method or by creating the tables and columns within the `DataSet` manually. This step must be done before calling `Load`. ]]> @@ -856,7 +856,7 @@ instruction?> ``` - `Load` will succeed; however, you will have an incomplete DOM tree, because there is no root-level element. You have to add a root-level element before you save the document; otherwise, the method throws an exception. + `Load` will succeed; however, you will have an incomplete DOM tree, because there is no root-level element. You have to add a root-level element before you save the document; otherwise, the method throws an exception. If the reader is positioned on a leaf node that is invalid for the root level of a document (for example, a white space or attribute node), the reader continues to read until it is positioned on a node that can be used for the root. The document begins loading at this point. diff --git a/xml/System.Xml/XmlDateTimeSerializationMode.xml b/xml/System.Xml/XmlDateTimeSerializationMode.xml index 14d506d1792..e55d7e2fe1d 100644 --- a/xml/System.Xml/XmlDateTimeSerializationMode.xml +++ b/xml/System.Xml/XmlDateTimeSerializationMode.xml @@ -46,11 +46,11 @@ Specifies how to treat the time value when converting between string and . - and methods. - + and methods. + ]]> diff --git a/xml/System.Xml/XmlDeclaration.xml b/xml/System.Xml/XmlDeclaration.xml index d234f8027d6..f00ee3cb230 100644 --- a/xml/System.Xml/XmlDeclaration.xml +++ b/xml/System.Xml/XmlDeclaration.xml @@ -147,7 +147,7 @@ directly; instead, use methods such as . + Do not instantiate an directly; instead, use methods such as . ]]> @@ -206,7 +206,7 @@ . + `CloneNode` serves as a copy constructor for nodes. To see how this method behaves with other node types, see . The cloned node has no parent ( returns `null`). @@ -300,7 +300,7 @@ ## Examples The following example creates an `XmlDeclaration` node and adds it to an XML document. - + :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlDeclaration/Encoding/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/System.Xml/XmlDeclaration/Encoding/source.vb" id="Snippet1"::: diff --git a/xml/System.Xml/XmlDictionaryWriter.xml b/xml/System.Xml/XmlDictionaryWriter.xml index c37c0958cf9..da9a9d90bdb 100644 --- a/xml/System.Xml/XmlDictionaryWriter.xml +++ b/xml/System.Xml/XmlDictionaryWriter.xml @@ -3565,7 +3565,7 @@ An asynchronous method was calle ## Remarks The contents of the stream provided by the `IStreamProvider` are written as Base64 data, unless this method is overridden in a derived class. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ]]> @@ -3716,7 +3716,7 @@ An asynchronous method was calle , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . diff --git a/xml/System.Xml/XmlDocument.xml b/xml/System.Xml/XmlDocument.xml index dd26aac19ac..f633723c253 100644 --- a/xml/System.Xml/XmlDocument.xml +++ b/xml/System.Xml/XmlDocument.xml @@ -124,7 +124,7 @@ ## Examples -The following is an example of load-time validation. A document type definition (DTD) validating is passed to the method and a is provided to notify users of any validation errors. In this example a validation error is found, but the document is still loaded. Alternatively, you can define a validating to throw an exception and stop the load process when a validation error is found by not specifying the . For more information about validating XML data, see the Remarks section of the reference page. +The following is an example of load-time validation. A document type definition (DTD) validating is passed to the method and a is provided to notify users of any validation errors. In this example a validation error is found, but the document is still loaded. Alternatively, you can define a validating to throw an exception and stop the load process when a validation error is found by not specifying the . For more information about validating XML data, see the Remarks section of the reference page. [!code-csharp[XmlDocument.cctor#1](~/snippets/csharp/System.Xml/XmlDocument/.ctor/docload.cs#1)] [!code-vb[XmlDocument.cctor#1](~/snippets/visualbasic/VS_Snippets_Data/XmlDocument.cctor/VB/docload.vb#1)] @@ -289,7 +289,7 @@ The example uses the `bookDTD.xml` file as input. ## Remarks A networked XML document is comprised of chunks of data aggregated using various W3C standard inclusion mechanisms and therefore contains nodes that come from different places. The `BaseURI` tells you where these nodes came from. - For Document nodes, `BaseURI` returns the location of the XML document. For example, if the `XmlDocument` was loaded using the following call `doc.Load("http://server/mydata.xml")`, the `BaseURI` for the document node is `http://server/mydata.xml`. However, if the method is redirected by server to a different URI, `BaseURI` returns the original URI passed to the `Load` method. + For Document nodes, `BaseURI` returns the location of the XML document. For example, if the `XmlDocument` was loaded using the following call `doc.Load("http://server/mydata.xml")`, the `BaseURI` for the document node is `http://server/mydata.xml`. However, if the method is redirected by server to a different URI, `BaseURI` returns the original URI passed to the `Load` method. This property is a Microsoft extension to the Document Object Model (DOM). For additional information on `BaseURI` and how it behaves with other node types, see . @@ -352,7 +352,7 @@ The example uses the `bookDTD.xml` file as input. ## Remarks This method serves as a copy constructor for nodes. The cloned node has no parent ( returns `null`). - If `deep` is `true`, the cloned node includes all the child nodes, otherwise only the `XmlDocument` node is cloned. See the method to see how this method behaves on other node types. + If `deep` is `true`, the cloned node includes all the child nodes, otherwise only the `XmlDocument` node is cloned. See the method to see how this method behaves on other node types. ## Examples @@ -426,7 +426,7 @@ The following example shows the difference between a deep and shallow clone. using the method. + The `XmlAttribute` can be added to an using the method. ## Examples @@ -507,7 +507,7 @@ The following creates an attribute and adds it to an XML document. using the method. + The `XmlAttribute` can be added to an using the method. ]]> @@ -584,7 +584,7 @@ The following creates an attribute and adds it to an XML document. using the method. + The `XmlAttribute` can be added to an using the method. This method is a Microsoft extension to the Document Object Model (DOM). @@ -1306,7 +1306,7 @@ The following example adds a new element to the existing XML document. test"> ``` - If you call `CreateEntityReference("a")`, you get back a single node of type EntityReference with no children. If you append this node as a child of the following node, ``, then, at the time of calling , the parent of the newly created entity reference node is set and the children are expanded in this namespace context. The child element node `b` will have NamespaceURI equal to `urn:1`. The child nodes of the entity reference remain the same even if you move the entity reference to a place in the document that has a different default namespace context. This does not happen for existing entity reference nodes when you remove and insert them or for entity references that you clone with . It only happens for newly created entity references. + If you call `CreateEntityReference("a")`, you get back a single node of type EntityReference with no children. If you append this node as a child of the following node, ``, then, at the time of calling , the parent of the newly created entity reference node is set and the children are expanded in this namespace context. The child element node `b` will have NamespaceURI equal to `urn:1`. The child nodes of the entity reference remain the same even if you move the entity reference to a place in the document that has a different default namespace context. This does not happen for existing entity reference nodes when you remove and insert them or for entity references that you clone with . It only happens for newly created entity references. If the corresponding entity is not defined in the DocumentType when the entity reference node is added, because the entity reference is not defined, its only child node will be an empty text node. @@ -1396,7 +1396,7 @@ The following example creates two entity reference nodes and inserts them into a ## Examples - See for an example using this method. + See for an example using this method. ]]> @@ -1464,7 +1464,7 @@ The following example creates two entity reference nodes and inserts them into a ## Examples - See for an example using this method. + See for an example using this method. ]]> @@ -2342,7 +2342,7 @@ The following example displays the root element of the XML document. An `XmlDocument` can have one and only one child with equal to DocumentType. > [!NOTE] -> This property is read-only. To change the DocumentType node, delete the existing node, create a new one using the method, and add the new node to the document. +> This property is read-only. To change the DocumentType node, delete the existing node, create a new one using the method, and add the new node to the document. ## Examples @@ -2512,7 +2512,7 @@ The following example uses the `GetElementById` method. The nodes are placed in the order in which they would be encountered in the document. > [!NOTE] -> It is recommended that you use the or method instead of the method. +> It is recommended that you use the or method instead of the method. ## Examples @@ -2586,7 +2586,7 @@ The following example creates a `XmlDocument` object and uses the `GetElementsBy The nodes are placed in the order in which they would be encountered in the document tree. > [!NOTE] -> It is recommended that you use the or method instead of the method. +> It is recommended that you use the or method instead of the method. ]]> @@ -2648,7 +2648,7 @@ The following example creates a `XmlDocument` object and uses the `GetElementsBy ## Remarks `XmlDocument` objects created from the same `XmlImplementation` share the same . This allows users to compare attribute and element names as objects rather than strings. - Although the `XmlDocument` objects share the same implementation, to move nodes from one document to another you must use the method. + Although the `XmlDocument` objects share the same implementation, to move nodes from one document to another you must use the method. ## Examples @@ -3083,7 +3083,7 @@ The following example shows how to use the `IsReadOnly` property. > [!NOTE] > The `Load` method always preserves significant white space. The property determines whether or not insignificant white space, that is white space in element content, is preserved. The default is `false`; white space in element content is not preserved. - If you want validation to occur, you can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. + If you want validation to occur, you can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This method is a Microsoft extension to the Document Object Model (DOM). @@ -3152,7 +3152,7 @@ The following example shows how to use the `IsReadOnly` property. > [!NOTE] > The `Load` method always preserves significant white space. The property determines whether or not insignificant white space, that is white space in element content, is preserved. The default is `false`; white space in element content is not preserved. - If you want validation to occur, you can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. + If you want validation to occur, you can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This method is a Microsoft extension to the Document Object Model (DOM). @@ -3225,7 +3225,7 @@ The following example uses the class to load a str > [!NOTE] > The `Load` method always preserves significant white space. The property determines whether or not insignificant white space, that is white space in element content, is preserved. The default is `false`; white space in element content is not preserved. - If you want validation to occur, you can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. + If you want validation to occur, you can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This method is a Microsoft extension to the Document Object Model (DOM). @@ -3333,11 +3333,11 @@ The following example uses the class to load a str ``` - `Load` succeeds, but you have an incomplete DOM tree because there is no root level element. Before you save the document, you must add a root level element, otherwise will throw an exception. + `Load` succeeds, but you have an incomplete DOM tree because there is no root level element. Before you save the document, you must add a root level element, otherwise will throw an exception. If the reader is positioned on a leaf node that is invalid for the root level of a document, for example a white space or attribute node, the reader continues to read until it is positioned on a node that can be used for the root. The document begins loading at this point. - If you want validation to occur, you can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. + If you want validation to occur, you can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This method is a Microsoft extension to the Document Object Model (DOM). @@ -3420,7 +3420,7 @@ The example uses the file, `books.xml`, as input. ## Remarks By default the `LoadXml` method does not preserve white space or significant white space. - This method parses Document Type Definitions (DTDs), but does not do DTD or Schema validation. If you want validation to occur, you can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. + This method parses Document Type Definitions (DTDs), but does not do DTD or Schema validation. If you want validation to occur, you can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. If you want to load from a , , , or , use the Load method instead of this method. @@ -4166,9 +4166,9 @@ The following example loads XML into an `XmlDocument` object and saves it out to ## Remarks This property determines how white space is handled during the load and save process. - If `PreserveWhitespace` is `true` before or is called, white space nodes are preserved; otherwise, if this property is `false`, significant white space is preserved, white space is not. + If `PreserveWhitespace` is `true` before or is called, white space nodes are preserved; otherwise, if this property is `false`, significant white space is preserved, white space is not. - If `PreserveWhitespace` is `true` before is called, white space in the document is preserved in the output; otherwise, if this property is `false`, `XmlDocument` auto-indents the output. + If `PreserveWhitespace` is `true` before is called, white space in the document is preserved in the output; otherwise, if this property is `false`, `XmlDocument` auto-indents the output. This method is a Microsoft extension to the Document Object Model (DOM). @@ -4255,7 +4255,7 @@ while (reader.MoveToNextAttribute()) } ``` - `ReadNode` does consume the attribute value though, which means after calling `ReadNode` on an attribute, returns `false`. + `ReadNode` does consume the attribute value though, which means after calling `ReadNode` on an attribute, returns `false`. ## Examples @@ -4356,7 +4356,7 @@ doc.Save(Console.Out); This method is a Microsoft extension to the Document Object Model (DOM). - Note that only the method enforces a well-formed XML document. All other `Save` overloads only guarantee a well-formed fragment. + Note that only the method enforces a well-formed XML document. All other `Save` overloads only guarantee a well-formed fragment. ]]> @@ -4418,7 +4418,7 @@ doc.Save(Console.Out); This method is a Microsoft extension to the Document Object Model (DOM). - Note that only the method enforces a well-formed XML document. All other `Save` overloads only guarantee a well-formed fragment. + Note that only the method enforces a well-formed XML document. All other `Save` overloads only guarantee a well-formed fragment. ]]> @@ -4490,7 +4490,7 @@ doc.Save(Console.Out); This method is a Microsoft extension to the Document Object Model (DOM). - Note that only the method enforces a well-formed XML document. All other `Save` overloads only guarantee a well-formed fragment. + Note that only the method enforces a well-formed XML document. All other `Save` overloads only guarantee a well-formed fragment. ## Examples @@ -4578,7 +4578,7 @@ doc.Save(Console.Out); This method is a Microsoft extension to the Document Object Model (DOM). - Note that only the method enforces a well-formed XML document. All other `Save` overloads only guarantee a well-formed fragment. + Note that only the method enforces a well-formed XML document. All other `Save` overloads only guarantee a well-formed fragment. ## Examples @@ -4697,7 +4697,7 @@ The following example loads XML into an `XmlDocument` object and saves it out to object associated with an object are used for validation when the method of an is executed. + The schemas contained in an object associated with an object are used for validation when the method of an is executed. When an object is initialized with XML data from an object, the object is loaded from the property of the object. @@ -4771,9 +4771,9 @@ The following example loads XML into an `XmlDocument` object and saves it out to method validates the XML data in the against the schemas contained in the property. The method performs infoset augmentation. Specifically, after successful validation, schema defaults are applied, text values are converted to atomic values as necessary, and type information is associated with validated information items. The result is a previously un-typed XML sub-tree in the replaced with a typed sub-tree. + The method validates the XML data in the against the schemas contained in the property. The method performs infoset augmentation. Specifically, after successful validation, schema defaults are applied, text values are converted to atomic values as necessary, and type information is associated with validated information items. The result is a previously un-typed XML sub-tree in the replaced with a typed sub-tree. -Consider the following points when using the method: +Consider the following points when using the method: - Schema location hints like `xsi:schemaLocation` or `xsi:noNamespaceSchemaLocation` are ignored. - Inline schemas are ignored. @@ -4782,7 +4782,7 @@ Consider the following points when using the method. The example creates an that contains an associated XSD schema using the and objects. The example then uses the class to incorrectly modify the typed value of an element in the XML document generating a schema validation error. +The following example illustrates use of the method. The example creates an that contains an associated XSD schema using the and objects. The example then uses the class to incorrectly modify the typed value of an element in the XML document generating a schema validation error. [!code-csharp[XPathValidation#1](~/snippets/csharp/System.Xml/XmlDocument/Validate/XPathValidation.cs#1)] [!code-vb[XPathValidation#1](~/snippets/visualbasic/VS_Snippets_Data/XPathValidation/VB/XPathValidation.vb#1)] @@ -4856,9 +4856,9 @@ The example takes the `contosoBooks.xml` and `contosoBooks.xsd` files as input. method validates the XML data in the object against the schemas contained in the property. The method performs infoset augmentation. Specifically, after successful validation, schema defaults are applied, text values are converted to atomic values as necessary, and type information is associated with validated information items. The result is a previously un-typed XML sub-tree in the replaced with a typed sub-tree. + The method validates the XML data in the object against the schemas contained in the property. The method performs infoset augmentation. Specifically, after successful validation, schema defaults are applied, text values are converted to atomic values as necessary, and type information is associated with validated information items. The result is a previously un-typed XML sub-tree in the replaced with a typed sub-tree. - The following are important notes to consider when using the method. + The following are important notes to consider when using the method. - Schema location hints like `xsi:schemaLocation` or `xsi:noNamespaceSchemaLocation` are ignored. @@ -4871,7 +4871,7 @@ The example takes the `contosoBooks.xml` and `contosoBooks.xsd` files as input. ## Examples - For an example of the method, see the method. + For an example of the method, see the method. ]]> @@ -5078,7 +5078,7 @@ The following example displays the document. - If the document was loaded with a class that extends `XmlReader` and the `XmlReader` cannot resolve entities ( returns `false`), the `XmlResolver` on the `XmlDocument` is used to resolve any references in the DocumentType node and to expand any entity references. > [!NOTE] -> If the `XmlDocument` is loaded using an that had an `XmlResolver` set to it, the `XmlResolver` on the `XmlReader` is not cached by the `XmlDocument` after completes. +> If the `XmlDocument` is loaded using an that had an `XmlResolver` set to it, the `XmlResolver` on the `XmlReader` is not cached by the `XmlDocument` after completes. In version 1.1 of the.NET Framework, if this property is not set, the trust level of the application determines the default behavior. diff --git a/xml/System.Xml/XmlDocumentFragment.xml b/xml/System.Xml/XmlDocumentFragment.xml index 5b555dec128..793d9320927 100644 --- a/xml/System.Xml/XmlDocumentFragment.xml +++ b/xml/System.Xml/XmlDocumentFragment.xml @@ -119,7 +119,7 @@ directly; instead, use methods such as . + Do not instantiate an directly; instead, use methods such as . ]]> @@ -178,7 +178,7 @@ . + `CloneNode` serves as a copy constructor for nodes. To see how this method behaves with other node types, see . The cloned node has no parent ( returns `null`). @@ -186,7 +186,7 @@ ## Examples The following example shows the difference between a deep and shallow clone. - + :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlDocumentFragment/CloneNode/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/Classic WebData XmlDocumentFragment.CloneNode Example/VB/source.vb" id="Snippet1"::: diff --git a/xml/System.Xml/XmlDocumentType.xml b/xml/System.Xml/XmlDocumentType.xml index 19345e14efe..34ce0e028de 100644 --- a/xml/System.Xml/XmlDocumentType.xml +++ b/xml/System.Xml/XmlDocumentType.xml @@ -55,7 +55,7 @@ class can be used to return information about a document type declaration. Use the method to create an object. + The class can be used to return information about a document type declaration. Use the method to create an object. ]]> @@ -185,7 +185,7 @@ ## Remarks This method serves as a copy constructor for nodes. The cloned node has no parent ( returns `null`). - To see how this method behaves with other node types, see . + To see how this method behaves with other node types, see . ]]> @@ -240,7 +240,7 @@ ## Examples The following example displays information about the entities declared in the XML document. - + :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlDocumentType/Entities/entities.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlEntity/VB/entities.vb" id="Snippet1"::: diff --git a/xml/System.Xml/XmlElement.xml b/xml/System.Xml/XmlElement.xml index cd26076a691..d2c8ce11263 100644 --- a/xml/System.Xml/XmlElement.xml +++ b/xml/System.Xml/XmlElement.xml @@ -70,7 +70,7 @@ , , , , and so on). You can also use the property which returns an enabling you to access attributes by name or index from the collection. + Elements are one of the most common nodes in the W3C Document Object Model (DOM). Elements can have attributes associated with them. The `XmlElement` class has many methods for accessing attributes (, , , , and so on). You can also use the property which returns an enabling you to access attributes by name or index from the collection. ]]> @@ -151,7 +151,7 @@ directly; instead, use methods such as . + Do not instantiate an directly; instead, use methods such as . ]]> @@ -609,7 +609,7 @@ The nodes are placed in the order in which they would be encountered in a preorder traversal of the tree. > [!NOTE] -> It is recommended that you use the or method instead of the method. +> It is recommended that you use the or method instead of the method. @@ -684,7 +684,7 @@ The nodes are placed in the order in which they would be encountered in a preorder traversal of the `XmlElement` tree. > [!NOTE] -> It is recommended that you use the or method instead of the method. +> It is recommended that you use the or method instead of the method. ]]> @@ -2153,7 +2153,7 @@ This property is a Microsoft extension to the Document Object Model (DOM). node plus any and nodes, build the appropriate subtree and use to assign it as the value of an attribute. + If an attribute with the same name is already present in the element, its value is changed to that of `value`. `value` is a simple string. It is not parsed as it is being set. Any markup, such as syntax to be recognized as an entity reference, is treated as literal text and needs to be properly escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an node plus any and nodes, build the appropriate subtree and use to assign it as the value of an attribute. ]]> @@ -2356,7 +2356,7 @@ This property is a Microsoft extension to the Document Object Model (DOM). to assign a text value to the attribute or use (or a similar method) to add children to the attribute. + The `XmlAttribute` does not have any children. Use to assign a text value to the attribute or use (or a similar method) to add children to the attribute. diff --git a/xml/System.Xml/XmlEntityReference.xml b/xml/System.Xml/XmlEntityReference.xml index 28496b68b6a..d919791fbac 100644 --- a/xml/System.Xml/XmlEntityReference.xml +++ b/xml/System.Xml/XmlEntityReference.xml @@ -101,7 +101,7 @@ directly; instead, use methods such as . + Do not instantiate an directly; instead, use methods such as . ]]> diff --git a/xml/System.Xml/XmlImplementation.xml b/xml/System.Xml/XmlImplementation.xml index b3f0fcecb98..1410c7f120d 100644 --- a/xml/System.Xml/XmlImplementation.xml +++ b/xml/System.Xml/XmlImplementation.xml @@ -72,7 +72,7 @@ ## Remarks `XmlDocument` objects that are created from the same implementation share the same . This enables users to compare attribute and element names between the objects more efficiently. - Although the `XmlDocument` objects share the same implementation, to move nodes from one document to another, you must use the method. + Although the `XmlDocument` objects share the same implementation, to move nodes from one document to another, you must use the method. ]]> @@ -233,13 +233,13 @@ ## Remarks `XmlDocument` objects created from the same implementation share the same name table. This enables users to compare attribute and element names between the objects more efficiently. - Although the `XmlDocument` objects share the same implementation, to move nodes from one document to another, you must use the method. + Although the `XmlDocument` objects share the same implementation, to move nodes from one document to another, you must use the method. ## Examples The following example creates two `XmlDocument` objects from the same implementation. - + :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlImplementation/CreateDocument/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/Classic WebData XmlImplementation.CreateDocument Example/VB/source.vb" id="Snippet1"::: diff --git a/xml/System.Xml/XmlNamespaceManager.xml b/xml/System.Xml/XmlNamespaceManager.xml index 9545d1a4fac..5bc5dc0c998 100644 --- a/xml/System.Xml/XmlNamespaceManager.xml +++ b/xml/System.Xml/XmlNamespaceManager.xml @@ -78,25 +78,25 @@ |To|Use| |--------|---------| -|Add a namespace| method| -|Remove a namespace| method| +|Add a namespace| method| +|Remove a namespace| method| |Find the URI for the default namespace| property| -|Find the URI for a namespace prefix| method| -|Find the prefix for a namespace URI| method| -|Get a list of namespaces in the current node| method| -|Scope a namespace| and methods| -|Check whether a prefix is defined in the current scope| method| +|Find the URI for a namespace prefix| method| +|Find the prefix for a namespace URI| method| +|Get a list of namespaces in the current node| method| +|Scope a namespace| and methods| +|Check whether a prefix is defined in the current scope| method| |Get the name table used to look up prefixes and URIs| property| - To add namespaces to the namespace manager, you create a object and then use the method. Default prefix and namespace pairs are automatically added to the namespace manager on creation. + To add namespaces to the namespace manager, you create a object and then use the method. Default prefix and namespace pairs are automatically added to the namespace manager on creation. - When you create the namespace manager, you can specify a name table from the , , or class, and then use the method to add the namespaces. + When you create the namespace manager, you can specify a name table from the , , or class, and then use the method to add the namespaces. - You can supply the object as a parameter to the or method of the class to execute XPath query expressions that reference namespace-qualified element and attribute names. + You can supply the object as a parameter to the or method of the class to execute XPath query expressions that reference namespace-qualified element and attribute names. The namespace manager assumes that prefixes and namespaces have already been verified and conform to the [W3C Namespaces](https://www.w3.org/TR/REC-xml-names/) specification. The namespace manager does not perform any validation. - The namespace manager atomizes the strings when they are added by using the method and when a lookup is performed by using the or method. + The namespace manager atomizes the strings when they are added by using the method and when a lookup is performed by using the or method. The namespace manager implements enumeration support in addition to adding and retrieving namespaces. You can loop through the information saved in the namespace manager by using the `foreach` construct. For example, if you create a namespace manager with the name `nsmanager`, you can iterate through the table by using `foreach (String prefix in nsmanager)`. @@ -112,7 +112,7 @@ nsmgr.AddNamespace("xsd", "http://www.w3.org/2001/XMLSchema") nsmgr.AddNamespace("xsd", "http://www.w3.org/2001/XMLSchema"); ``` - You can then find the namespace by using the method: + You can then find the namespace by using the method: ```vb nsmgr.LookupNamespace("xsd") @@ -208,7 +208,7 @@ while (reader.Read()) For more information on atomized strings, see . > [!NOTE] -> If you specify an existing name table, any namespaces in the name table are not automatically added to . You must use and to add or remove namespaces. +> If you specify an existing name table, any namespaces in the name table are not automatically added to . You must use and to add or remove namespaces. @@ -501,7 +501,7 @@ Loop ## Remarks The dictionary consists of a collection of namespace names keyed by prefix. It can be used to enumerate the in-scope namespaces. The dictionary is a disconnected copy of the namespace list. It remains unchanged as the current in-scope namespace list changes. - The following table shows how values affect the namespaces returned by the method. + The following table shows how values affect the namespaces returned by the method. |XmlNamespaceScope value|xmlns:xml|xmlns:xmlns|xmlns=""| |-----------------------------|---------------|-----------------|---------------| @@ -721,7 +721,7 @@ Loop ## Examples - The following example shows how to use the method when writing an attribute. It uses the method to start the attribute, looks up the prefix for the `urn:samples` namespace URI, and then uses that prefix in the when writing the `ISBN` attribute: + The following example shows how to use the method when writing an attribute. It uses the method to start the attribute, looks up the prefix for the `urn:samples` namespace URI, and then uses that prefix in the when writing the `ISBN` attribute: ```vb Dim prefix As String = nsMgr.LookupPrefix("urn:samples") @@ -735,7 +735,7 @@ nsMgr.AddNamespace("bk","urn:samples");string prefix = writer nsMgr.LookupPrefix writer.WriteStartAttribute(prefix, "ISBN", "urn:samples"); ``` - The following example uses to find the prefix defined on an element. + The following example uses to find the prefix defined on an element. ```vb writer.WriteStartElement("root", "book") @@ -880,7 +880,7 @@ writer.WriteEndElement() (by calling ) since the last call to are removed. + When you call this method, all namespaces which were added to (by calling ) since the last call to are removed. @@ -943,7 +943,7 @@ writer.WriteEndElement() (by calling ), belong to the pushed namespace scope. + After a call to this method, all namespaces, which are added to (by calling ), belong to the pushed namespace scope. diff --git a/xml/System.Xml/XmlNode.xml b/xml/System.Xml/XmlNode.xml index a5af4de4776..6edc295654d 100644 --- a/xml/System.Xml/XmlNode.xml +++ b/xml/System.Xml/XmlNode.xml @@ -156,7 +156,7 @@ ## Remarks If the `newChild` is already in the tree, it is removed from its original position and added to its target position. For more information about inserting nodes, see [Inserting Nodes into an XML Document](/dotnet/standard/data/xml/inserting-nodes-into-an-xml-document). - If the node being inserted was created from another document, you can use to import the node to the current document. The imported node can then be inserted into the current document. + If the node being inserted was created from another document, you can use to import the node to the current document. The imported node can then be inserted into the current document. @@ -667,7 +667,7 @@ Where the DTD file contains the following: method. + The `XPathNavigator` provides read-only, random access to data. Because it is optimized for XSLT transformations, it provides performance benefits when used as an input mechanism to the method. This method is a Microsoft extension to the Document Object Model (DOM). @@ -1230,7 +1230,7 @@ d. ## Remarks If `refChild` is `null`, insert `newChild` at the beginning of the list of child nodes. All the contents of the `newChild` are inserted, in the same order, after `refChild`. If the `newChild` is already in the tree, it is removed from its original position and added to its target position. For more information about inserting nodes, see [Inserting Nodes into an XML Document](/dotnet/standard/data/xml/inserting-nodes-into-an-xml-document). - If the node being inserted was created from another document, you can use to import the node to the current document. The imported node can then be inserted into the current document. + If the node being inserted was created from another document, you can use to import the node to the current document. The imported node can then be inserted into the current document. This method is a Microsoft extension to the Document Object Model (DOM). @@ -1323,7 +1323,7 @@ d. ## Remarks If `refChild` is `null`, insert `newChild` at the end of the list of child nodes. All the contents of the `newChild` are inserted, in the same order, before `refChild`. If the `newChild` is already in the tree, it is removed from its original position and added to its target position. For more information about inserting nodes, see [Inserting Nodes into an XML Document](/dotnet/standard/data/xml/inserting-nodes-into-an-xml-document). - If the node being inserted was created from another document, you can use to import the node to the current document. The imported node can then be inserted into the current document. + If the node being inserted was created from another document, you can use to import the node to the current document. The imported node can then be inserted into the current document. @@ -2456,7 +2456,7 @@ d. ## Remarks If the `newChild` is already in the tree, it is removed from its original position and added to its target position. For more information about inserting nodes, see [Inserting Nodes into an XML Document](/dotnet/standard/data/xml/inserting-nodes-into-an-xml-document). - If the node being inserted was created from another document, you can use to import the node to the current document. The imported node can then be inserted into the current document. + If the node being inserted was created from another document, you can use to import the node to the current document. The imported node can then be inserted into the current document. This method is a Microsoft extension to the Document Object Model (DOM). @@ -2800,7 +2800,7 @@ d. ## Remarks If the `newChild` is already in the tree, it is first removed. - If the `newChild` was created from another document, you can use to import the node to the current document. The imported node can then be passed to the `ReplaceChild` method. + If the `newChild` was created from another document, you can use to import the node to the current document. The imported node can then be passed to the `ReplaceChild` method. diff --git a/xml/System.Xml/XmlNodeChangedEventArgs.xml b/xml/System.Xml/XmlNodeChangedEventArgs.xml index 65cdaf8cb05..6623b19fe0c 100644 --- a/xml/System.Xml/XmlNodeChangedEventArgs.xml +++ b/xml/System.Xml/XmlNodeChangedEventArgs.xml @@ -90,7 +90,7 @@ void NodeInsertedHandler(Object src, XmlNodeChangedEventArgs args) ``` > [!NOTE] -> If an operation is comprised of multiple actions, it results in multiple events. For example, an call may have to remove the node being appended from its previous parent. In this case you will see a `NodeRemoved` event followed by a `NodeInserted` event. +> If an operation is comprised of multiple actions, it results in multiple events. For example, an call may have to remove the node being appended from its previous parent. In this case you will see a `NodeRemoved` event followed by a `NodeInserted` event. ]]> diff --git a/xml/System.Xml/XmlNodeList.xml b/xml/System.Xml/XmlNodeList.xml index bc70ac4d778..25c0dc8a603 100644 --- a/xml/System.Xml/XmlNodeList.xml +++ b/xml/System.Xml/XmlNodeList.xml @@ -82,7 +82,7 @@ - - Returns an `XmlNodeList` containing all the children of the node. -- - Returns an `XmlNodeList` containing a collection of nodes matching the XPath query. +- - Returns an `XmlNodeList` containing a collection of nodes matching the XPath query. - `GetElementsByTagName` - Returns an `XmlNodeList` containing a list of all descendant elements that match the specified name. This method is available in both the and classes. @@ -189,8 +189,8 @@ object and uses the method and the resulting `XmlNodeList` to display all the book titles. - + The following example creates a object and uses the method and the resulting `XmlNodeList` to display all the book titles. + :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlElement/GetElementsByTagName/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/Classic WebData XmlElement.GetElementsByTagName Example/VB/source.vb" id="Snippet1"::: @@ -397,7 +397,7 @@ object and uses the method and the resulting `XmlNodeList` to display all the book titles. + The following example creates an object and uses the method and the resulting `XmlNodeList` to display all the book titles. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlElement/GetElementsByTagName/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/Classic WebData XmlElement.GetElementsByTagName Example/VB/source.vb" id="Snippet1"::: diff --git a/xml/System.Xml/XmlNodeReader.xml b/xml/System.Xml/XmlNodeReader.xml index 3141b79ca93..ab6851ac788 100644 --- a/xml/System.Xml/XmlNodeReader.xml +++ b/xml/System.Xml/XmlNodeReader.xml @@ -63,14 +63,14 @@ [!NOTE] -> Instead of using the , we recommend that you create instances by using the class and the method. This enables you to take advantage of conformance checking and compliance to the XML 1.0 recommendation. +> Instead of using the , we recommend that you create instances by using the class and the method. This enables you to take advantage of conformance checking and compliance to the XML 1.0 recommendation. The `XmlNodeReader` has the ability to read an XML DOM subtree. This class does not support document type definition (DTD) or schema validation. However, you can create an object that wraps around the object to validate the data stored in the object, as shown in Examples section. ]]> , which is then passed to the method. When the validating reader parses the file, it can validate any changes made to the XML file. +In the following example, an XML file is loaded into an XML document and modified. The XML document is passed to an , which is then passed to the method. When the validating reader parses the file, it can validate any changes made to the XML file. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlNodeReader/Overview/valid_dom.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlReader_Validate_DOM/VB/valid_dom.vb" id="Snippet1"::: @@ -133,9 +133,9 @@ Output: ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. - For more information and examples of the code used to create an `XmlNodeReader`, see and overloads of the method. + For more information and examples of the code used to create an `XmlNodeReader`, see and overloads of the method. ]]> @@ -186,7 +186,7 @@ Output: ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This property is relevant to `Element`, `DocumentType` and `XmlDeclaration` nodes only. (Other node types do not have attributes.) @@ -247,7 +247,7 @@ Output: ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. A networked XML document is comprised of chunks of data aggregated using various W3C standard inclusion mechanisms and therefore contains nodes that come from different places. DTD entities are an example of this, but this is not limited to DTDs. The base URI tells you where these nodes came from. If there is no base URI for the nodes being returned (for example, they were parsed from an in-memory string), String.Empty is returned. @@ -314,9 +314,9 @@ Output: ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. - The binary content read methods include the , , , and methods. + The binary content read methods include the , , , and methods. ]]> @@ -368,7 +368,7 @@ Output: ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. ]]> @@ -419,7 +419,7 @@ Output: ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This method also releases any resources held while reading. If `Close` has already been called, no action is performed. @@ -490,7 +490,7 @@ Output: ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. ]]> @@ -542,7 +542,7 @@ Output: ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. ]]> @@ -606,7 +606,7 @@ Output: ## Remarks -The recommended practice is to create instances using the class and the method. +The recommended practice is to create instances using the class and the method. This method does not move the reader. @@ -672,7 +672,7 @@ This method does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This method does not move the reader. @@ -749,7 +749,7 @@ This method does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. The following XML contains an attribute in a specific namespace: @@ -823,7 +823,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. @@ -883,7 +883,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. The following table lists node types that have a value to return. @@ -957,7 +957,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This property applies to attribute nodes only. If the reader is not positioned on an attribute node, this property returns `false`. @@ -1011,7 +1011,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This property enables you to determine the difference between the following: @@ -1066,7 +1066,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks -The recommended practice is to create instances using the class and the method. +The recommended practice is to create instances using the class and the method. This property does not move the reader. @@ -1144,7 +1144,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This property does not move the reader. @@ -1200,7 +1200,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. @@ -1270,7 +1270,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. In the following XML string, if the reader is positioned on the `href` attribute, the prefix `a` is resolved by calling `reader.LookupNamespace("a")`. The returned string is `urn:456`. @@ -1344,7 +1344,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. @@ -1409,7 +1409,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. After calling this method, the , , and properties reflect the properties of that attribute. @@ -1477,7 +1477,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. After calling this method, the , , and properties reflect the properties of that attribute. @@ -1532,7 +1532,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. Use this method to return to an element after navigating through its attributes. This method moves the reader to one of the following node types: `Element`, `DocumentType`, or `XmlDeclaration`. @@ -1595,7 +1595,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET FrameworkFor more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET FrameworkFor more information, see the Remarks section in the reference page. @@ -1656,9 +1656,9 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. - If the current node is not an attribute node, this method is equivalent to . If `MoveToNextAttribute` returns `true`, the reader moves to the next attribute; otherwise, the position of the reader does not change. + If the current node is not an attribute node, this method is equivalent to . If `MoveToNextAttribute` returns `true`, the reader moves to the next attribute; otherwise, the position of the reader does not change. @@ -1737,7 +1737,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. @@ -1800,7 +1800,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This property is relevant to `Element` and `Attribute` nodes only. @@ -1861,7 +1861,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. All node and attribute names returned from this class are atomized using the `NameTable`. When the same name is returned multiple times (for example, `Customer`), then the same `String` object is returned for that name. This makes it possible for you to write efficient code that does object comparisons on these strings instead of expensive string comparisons. @@ -1915,7 +1915,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. @@ -1978,7 +1978,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. @@ -2022,7 +2022,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. ]]> @@ -2081,7 +2081,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. When a reader is first created and initialized, there is no information available. You must call `Read` to read the first node. @@ -2152,9 +2152,9 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. - Use this method after calling to read through the text or entity reference nodes that make up the attribute value. The of the attribute value nodes is one plus the depth of the attribute node; it increments and decrements by one when you step into and out of general entity references. + Use this method after calling to read through the text or entity reference nodes that make up the attribute value. The of the attribute value nodes is one plus the depth of the attribute node; it increments and decrements by one when you step into and out of general entity references. @@ -2220,20 +2220,20 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This method streams the content, decodes the Base64 content, and returns the decoded binary bytes (for example, an inline Base64 encoded GIF image) into the buffer. This method can be called successively to read large streams of embedded text. For more information, see RFC 1521, "MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies". You can obtain RFCs from the [Request for Comments Web site](https://www.rfc-editor.org). > [!NOTE] -> You should not access any of the reader properties between calls to the method until the method returns the value 0. +> You should not access any of the reader properties between calls to the method until the method returns the value 0. This method has the following behavior: -- returns the value 0 when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node. +- returns the value 0 when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node. - If you ask for fewer, or the exact number, of bytes than are left in the stream the reader remains in its current position. -- is not supported on the following XML node types: Element, XmlDeclaration, None, Document, DocumentType, Notation, Entity, DocumentFragment. +- is not supported on the following XML node types: Element, XmlDeclaration, None, Document, DocumentType, Notation, Entity, DocumentFragment. ]]> @@ -2297,20 +2297,20 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This method streams the content, decodes the BinHex content, and returns the decoded binary bytes (for example, an inline BinHex encoded GIF image) into the buffer. This method can be called successively to read large streams of embedded text. > [!NOTE] -> You should not access any of the reader properties between calls to the method until the method returns the value 0. +> You should not access any of the reader properties between calls to the method until the method returns the value 0. This method has the following behavior: -- returns the value 0 when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node. +- returns the value 0 when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node. - If you ask for fewer, or the exact number, of bytes than are left in the stream the reader remains in its current position. -- is not supported on the following XML node types: Element, XmlDeclaration, None, Document, DocumentType, Notation, Entity, DocumentFragment. +- is not supported on the following XML node types: Element, XmlDeclaration, None, Document, DocumentType, Notation, Entity, DocumentFragment. ]]> @@ -2374,22 +2374,22 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This method reads the content, decodes it using Base64 encoding, and returns the decoded binary bytes (for example, an inline Base64 encoded GIF image) into the buffer. For more information, see RFC 1521, "MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies". You can obtain RFCs from the [Request for Comments Web site](https://www.rfc-editor.org). This method can only read simple-content elements. The element can contain text, white space, significant white space, CDATA sections, comments and processing instructions. It can also contain entity references, which are automatically expanded. The element cannot have child elements. - This method is very similar to the method except that it can only be called on element node types. + This method is very similar to the method except that it can only be called on element node types. - If the count value is higher than the number of bytes in the document, or if it is equal to the number of bytes in the document, the reads all the remaining bytes in the document and returns the number of bytes read. The next method call returns a zero and moves the reader to the node following the node. + If the count value is higher than the number of bytes in the document, or if it is equal to the number of bytes in the document, the reads all the remaining bytes in the document and returns the number of bytes read. The next method call returns a zero and moves the reader to the node following the node. - If you call before all of the element content is consumed, the reader may behave as if the first content was consumed and then the method was called. This means that the reader reads all the text until the end element is encountered. It then reads the end tag node, read the next node, and then position itself on the next subsequent node. + If you call before all of the element content is consumed, the reader may behave as if the first content was consumed and then the method was called. This means that the reader reads all the text until the end element is encountered. It then reads the end tag node, read the next node, and then position itself on the next subsequent node. ## Examples - See to see an example using this method. + See to see an example using this method. ]]> @@ -2454,22 +2454,22 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This method reads the element content, decodes it using BinHex encoding, and returns the decoded binary bytes (for example, an inline BinHex encoded GIF image) into the buffer. This method can only read simple-content elements. The element can contain text, white space, significant white space, CDATA sections, comments and processing instructions. It can also contain entity references, which are automatically expanded. The element cannot have child elements. - This method is very similar to the method except that it can only be called on element node types. + This method is very similar to the method except that it can only be called on element node types. If the count value is higher than the number of bytes in the document, or if it is equal to the number of bytes in the document, the reads all the remaining bytes in the document and returns the number of bytes read. The next method call returns a zero and moves the reader to the node following the node. - If you call before all of the element content is consumed, the reader may behave as if the first content was consumed and then the method was called. This means that the reader reads all the text until the end element is encountered. It then reads the end tag node, read the next node, and then position itself on the next subsequent node. + If you call before all of the element content is consumed, the reader may behave as if the first content was consumed and then the method was called. This means that the reader reads all the text until the end element is encountered. It then reads the end tag node, read the next node, and then position itself on the next subsequent node. ## Examples - See to see an example using this method. + See to see an example using this method. ]]> @@ -2533,7 +2533,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. ]]> @@ -2587,7 +2587,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. If positioned on an element, `ReadString` concatenates all text, significant white space, white space, and CData section node types together and returns the concatenated data as the element content. It stops when any markup is encountered. This could occur in a mixed content model, or when an element end tag is read. @@ -2650,12 +2650,12 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. - If the reader is positioned on an `EntityReference` node (`XmlNodeType.EntityReference`), if is called after calling this method, the entity replacement text is parsed. When the entity replacement text is finished, an `EndEntity` node is returned to close the entity reference scope. + If the reader is positioned on an `EntityReference` node (`XmlNodeType.EntityReference`), if is called after calling this method, the entity replacement text is parsed. When the entity replacement text is finished, an `EndEntity` node is returned to close the entity reference scope. > [!NOTE] -> After calling this method, if the entity is part of an attribute value, you must call to step into the entity. +> After calling this method, if the entity is part of an attribute value, you must call to step into the entity. @@ -2721,7 +2721,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. The interface represents the Post Schema Validation Infoset (PSVI) of the underlying XML node. The PSVI contents of this property are set after the node has been validated. @@ -2776,7 +2776,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. For example, suppose you have the following XML input: @@ -2791,7 +2791,7 @@ This property does not move the reader. If the reader is positioned on the "\" node or any of its attributes, calling `Skip` positions the reader to the "\" node. - If the reader is positioned on a leaf node already (such as element "x" or the text node "abc"), calling `Skip` is the same as calling . + If the reader is positioned on a leaf node already (such as element "x" or the text node "abc"), calling `Skip` is the same as calling . This method checks for well-formed XML. @@ -3047,7 +3047,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. @@ -3110,7 +3110,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This property represents the xml:lang scope within which the current node resides. For example, here is an XML fragment with `xml:lang` set to US English in the root element: @@ -3173,7 +3173,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. ]]> diff --git a/xml/System.Xml/XmlProcessingInstruction.xml b/xml/System.Xml/XmlProcessingInstruction.xml index c0c2c6350a3..15debba199d 100644 --- a/xml/System.Xml/XmlProcessingInstruction.xml +++ b/xml/System.Xml/XmlProcessingInstruction.xml @@ -137,7 +137,7 @@ directly; instead, use methods such as . + Do not instantiate an directly; instead, use methods such as . ]]> @@ -196,7 +196,7 @@ method in the `XmlNode` class. + `CloneNode` serves as a copy constructor for nodes. For processing instruction nodes, the cloned node always includes the target and data. To see how this method behaves with other node types, see the method in the `XmlNode` class. The cloned node has no parent ( returns `null`). diff --git a/xml/System.Xml/XmlQualifiedName.xml b/xml/System.Xml/XmlQualifiedName.xml index e15c7265318..89c89c70303 100644 --- a/xml/System.Xml/XmlQualifiedName.xml +++ b/xml/System.Xml/XmlQualifiedName.xml @@ -61,18 +61,18 @@ Represents an XML qualified name. - objects. This class assumes that prefixes are irrelevant. It is the responsibility of the user to ensure the local name does not contain a ":". - - - -## Examples - For an example using the class, see . - + objects. This class assumes that prefixes are irrelevant. It is the responsibility of the user to ensure the local name does not contain a ":". + + + +## Examples + For an example using the class, see . + ]]> @@ -128,11 +128,11 @@ Initializes a new instance of the class. - @@ -181,11 +181,11 @@ The local name to use as the name of the object. Initializes a new instance of the class with the specified name. - @@ -585,7 +585,7 @@ if the two objects have the same name and namespace values; otherwise, . - ]]> + ]]> @@ -640,7 +640,7 @@ if the name and namespace values for the two objects differ; otherwise, . - ]]> + ]]> diff --git a/xml/System.Xml/XmlReader.xml b/xml/System.Xml/XmlReader.xml index 09bf446131f..ca40adcfedb 100644 --- a/xml/System.Xml/XmlReader.xml +++ b/xml/System.Xml/XmlReader.xml @@ -296,7 +296,7 @@ The following example code shows how to use the asynchronous API to parse XML. , , , and methods. If this property returns `false` a is returned when any of the binary read methods is called. + The binary content read methods include the , , , and methods. If this property returns `false` a is returned when any of the binary read methods is called. All Microsoft .NET Framework implementations of the class return `true` for this property. @@ -351,9 +351,9 @@ The following example code shows how to use the asynchronous API to parse XML. objects that were created from the static method always return `true`. All other Microsoft .NET Framework implementations of the class, including the class, return `false`. + Text parsing objects that were created from the static method always return `true`. All other Microsoft .NET Framework implementations of the class, including the class, return `false`. - If this property returns `false` a is returned when the method is called. + If this property returns `false` a is returned when the method is called. ]]> @@ -407,7 +407,7 @@ The following example code shows how to use the asynchronous API to parse XML. that do not support DTD information. In this case, calling throws an exception. + This property always returns `false` for implementations of that do not support DTD information. In this case, calling throws an exception. ]]> @@ -461,7 +461,7 @@ The following example code shows how to use the asynchronous API to parse XML. has already been called, no action is performed. + This method also releases any resources held during reading. If has already been called, no action is performed. ]]> @@ -1036,7 +1036,7 @@ Note: In .NET for Win object. The underlying object can be another object created by the method, or an object created using one of the concrete implementations. + This method allows you add additional features to an underlying object. The underlying object can be another object created by the method, or an object created using one of the concrete implementations. A default with no credentials is used to access any external resources such as a schema. @@ -3322,7 +3322,7 @@ public class Sample ## Remarks If the current node is an attribute node, this method moves the reader back to the element that owns the attribute. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -3417,7 +3417,7 @@ public class Sample , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -3601,7 +3601,7 @@ An asynchronous method was called without . If `MoveToNextAttribute` returns `true`, the reader moves to the next attribute; otherwise, the position of the reader does not change. + If the current node is an element node, this method is equivalent to . If `MoveToNextAttribute` returns `true`, the reader moves to the next attribute; otherwise, the position of the reader does not change. @@ -4040,11 +4040,11 @@ An asynchronous method was called without is first created and initialized, there is no information available. You must call to read the first node. The method sets the state of the XML reader to initiate and moves through the XML file sequentially until it reaches the end of the file, at which point the method returns a value of `false`. + When an is first created and initialized, there is no information available. You must call to read the first node. The method sets the state of the XML reader to initiate and moves through the XML file sequentially until it reaches the end of the file, at which point the method returns a value of `false`. This method requires at least four bytes from the data stream in order to begin parsing. If fewer than four bytes are returned and there is no more data in the stream, the method returns `false`. If there is more data in the stream, the method will block parsing until receipt of the fourth byte. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -4114,7 +4114,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -4181,7 +4181,7 @@ An asynchronous method was called without to read through the text or entity reference nodes that make up the attribute value. The of the attribute value nodes is one plus the depth of the attribute node; it increments and decrements by one when you step into and out of general entity references. + Use this method after calling to read through the text or entity reference nodes that make up the attribute value. The of the attribute value nodes is one plus the depth of the attribute node; it increments and decrements by one when you step into and out of general entity references. ]]> @@ -4261,11 +4261,11 @@ An asynchronous method was called without 123 456 ``` - If the data is typed and a string array is supplied to the method call, then the integer values are converted from strings according to the list of valid CLR type mappings. + If the data is typed and a string array is supplied to the method call, then the integer values are converted from strings according to the list of valid CLR type mappings. - If the data is untyped and a string array is supplied to the method call, then the content is parsed into separate strings. An array containing two strings is returned with the values "123" and "456". The spaces are not preserved from the content. + If the data is untyped and a string array is supplied to the method call, then the content is parsed into separate strings. An array containing two strings is returned with the values "123" and "456". The spaces are not preserved from the content. - In general when reading untyped data the content is parsed according to the supplied type. For example, if an integer array is supplied to the method call then the string is parsed into an array of integers {123,456}. + In general when reading untyped data the content is parsed according to the supplied type. For example, if an integer array is supplied to the method call then the string is parsed into an array of integers {123,456}. In the following example the XML text is not separated by spaces @@ -4273,7 +4273,7 @@ An asynchronous method was called without 123456789 ``` - If the content is untyped and a string array is supplied to the method call then an array containing one concatenated string is returned with the value "123456789". + If the content is untyped and a string array is supplied to the method call then an array containing one concatenated string is returned with the value "123456789". The following table describes how this method treats each node type. @@ -4287,12 +4287,12 @@ An asynchronous method was called without For more information, see the Remarks section of the reference page and the [W3C XML Schema Part 2: Datatypes](https://go.microsoft.com/fwlink/?LinkId=4871) recommendation. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ## Examples - The following example uses the method to return the contents of the colors element into an array of string objects. + The following example uses the method to return the contents of the colors element into an array of string objects. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlReader/ReadContentAs/readContentAs.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlReader.ReadContentAs/VB/readContentAs.vb" id="Snippet2"::: @@ -4378,7 +4378,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -4449,17 +4449,17 @@ An asynchronous method was called without This method streams the content, decodes the `Base64` content, and returns the decoded binary bytes (for example, an inline `Base64` encoded GIF image) into the buffer. This method can be called successively to read large streams of embedded text. For more information, see RFC 1521, "MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies". You can obtain RFCs from the [Request for Comments web site](https://www.rfc-editor.org/). > [!NOTE] -> You should not access any of the reader properties between calls to the method until the method returns the value `0`. +> You should not access any of the reader properties between calls to the method until the method returns the value `0`. This method has the following behavior: -- returns the value `0` when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node. +- returns the value `0` when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node. - If you ask for fewer, or the exact number of, bytes than are left in the stream the reader remains in its current position. -- is not supported on the following XML node types: `Element`, `XmlDeclaration`, `None`, `Document`, `DocumentType`, `Notation`, `Entity`, `DocumentFragment`. +- is not supported on the following XML node types: `Element`, `XmlDeclaration`, `None`, `Document`, `DocumentType`, `Notation`, `Entity`, `DocumentFragment`. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ]]> @@ -4528,7 +4528,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -4599,17 +4599,17 @@ An asynchronous method was called without This method streams the content, decodes the `BinHex` content, and returns the decoded binary bytes (for example, an inline `BinHex` encoded GIF image) into the buffer. This method can be called successively to read large streams of embedded text. > [!NOTE] -> You should not access any of the reader properties between calls to the method until the method returns the value `0`. +> You should not access any of the reader properties between calls to the method until the method returns the value `0`. This method has the following behavior: -- returns the value `0` when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node. +- returns the value `0` when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node. - If you ask for fewer, or the exact number, of bytes than are left in the stream the reader remains in its current position. -- is not supported on the following XML node types: `Element`, `XmlDeclaration`, `None`, `Document`, `DocumentType`, `Notation, Entity`, `DocumentFragment`. +- is not supported on the following XML node types: `Element`, `XmlDeclaration`, `None`, `Document`, `DocumentType`, `Notation, Entity`, `DocumentFragment`. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ]]> @@ -4678,7 +4678,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -4758,7 +4758,7 @@ An asynchronous method was called without ## Examples - The following example uses the method to read the attribute as a `Boolean` value. + The following example uses the method to read the attribute as a `Boolean` value. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlReader/ReadContentAs/readContentAs.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlReader.ReadContentAs/VB/readContentAs.vb" id="Snippet1"::: @@ -4822,7 +4822,7 @@ An asynchronous method was called without If the content is typed `xsd:dateTime`, the reader returns an unboxed object. If the content is not typed `xsd:dateTime`, the reader attempts to convert it to a object according to the rules defined by the [W3C XML Schema Part 2: Datatypes](https://go.microsoft.com/fwlink/?LinkId=4871) recommendation. > [!NOTE] -> You cannot rely on the value when the content is typed as `xsd:gMonthDay`. always sets the value to 1904 in this case. +> You cannot rely on the value when the content is typed as `xsd:gMonthDay`. always sets the value to 1904 in this case. The following table describes how this method treats each node type. @@ -5284,7 +5284,7 @@ An asynchronous method was called without If the content is typed, the reader returns a boxed CLR of the most appropriate type, specified by the property. If the content is a list type, the reader returns an array of boxed objects of the appropriate type. > [!NOTE] -> If a validation error occurs while parsing the content and the reader is an object created by the method, the reader returns the content as a string. In other words when a validation error or warning occurs, the content is considered to be untyped. +> If a validation error occurs while parsing the content and the reader is an object created by the method, the reader returns the content as a string. In other words when a validation error or warning occurs, the content is considered to be untyped. If the content is not typed, the reader returns the content as a string. @@ -5300,7 +5300,7 @@ An asynchronous method was called without For more information, see the Remarks section of the reference page and the [W3C XML Schema Part 2: Datatypes](https://go.microsoft.com/fwlink/?LinkId=4871) recommendation. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ]]> @@ -5360,7 +5360,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -5437,7 +5437,7 @@ An asynchronous method was called without For more information, see the Remarks section of the reference page and the [W3C XML Schema Part 2: Datatypes](https://go.microsoft.com/fwlink/?LinkId=4871) recommendation. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ]]> @@ -5491,7 +5491,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -5576,12 +5576,12 @@ An asynchronous method was called without For more information, see the Remarks section of the reference page and the [W3C XML Schema Part 2: Datatypes](https://go.microsoft.com/fwlink/?LinkId=4871) recommendation. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ## Examples - The following example uses the method to read the content of the `date` node. + The following example uses the method to read the content of the `date` node. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlReader/Overview/readElementContentAs.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlReader.ReadElementContentAs/VB/readElementContentAs.vb" id="Snippet5"::: @@ -5740,7 +5740,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -5809,15 +5809,15 @@ An asynchronous method was called without ## Remarks This method reads the element content, decodes it using `Base64` encoding, and returns the decoded binary bytes (for example, an inline `Base64`-encoded GIF image) into the buffer. For more information, see RFC 1521, "MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies". You can obtain RFCs from the [Request for Comments web site](https://www.rfc-editor.org/). - can only read simple-content elements. The element can contain text, white space, significant white space, CDATA sections, comments and processing instructions. It can also contain entity references, which are automatically expanded. The element cannot have child elements. + can only read simple-content elements. The element can contain text, white space, significant white space, CDATA sections, comments and processing instructions. It can also contain entity references, which are automatically expanded. The element cannot have child elements. - This method is very similar to the method except that it can only be called on element node types. + This method is very similar to the method except that it can only be called on element node types. If the `count` value is higher than the number of bytes in the document, or if it is equal to the number of bytes in the document, the reads all the remaining bytes in the document and returns the number of bytes read. The next method call returns a zero and moves the reader to the node following the `EndElement`. - If you call before all of the element content is consumed, the reader may behave as if the first content was consumed and then the method was called. This means that the reader will read all the text until the end element is encountered. It will then read the end tag node, read the next node, and then position itself on the next subsequent node. + If you call before all of the element content is consumed, the reader may behave as if the first content was consumed and then the method was called. This means that the reader will read all the text until the end element is encountered. It will then read the end tag node, read the next node, and then position itself on the next subsequent node. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -5894,7 +5894,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -5966,13 +5966,13 @@ An asynchronous method was called without This method can only read simple-content elements. The element can contain text, white space, significant white space, CDATA sections, comments and processing instructions. It can also contain entity references, which are automatically expanded. The element cannot have child elements. - This method is very similar to the method except that it can only be called on element node types. + This method is very similar to the method except that it can only be called on element node types. If the `count` value is higher than the number of bytes in the document, or if it is equal to the number of bytes in the document, the reads all the remaining bytes in the document and returns the number of bytes read. The next method call returns a zero and moves the reader to the node following the `EndElement`. - If you call before all of the element content is consumed, the reader may behave as if the first content was consumed and then the method was called. This means that the reader will read all the text until the end element is encountered. It will then read the end tag node, read the next node, and then position itself on the next subsequent node. + If you call before all of the element content is consumed, the reader may behave as if the first content was consumed and then the method was called. This means that the reader will read all the text until the end element is encountered. It will then read the end tag node, read the next node, and then position itself on the next subsequent node. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -6049,7 +6049,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -6276,14 +6276,14 @@ An method was called before a previous asy If the content is typed `xsd:dateTime`, the reader returns an unboxed object. If the content is not typed `xsd:dateTime`, the reader attempts to convert it to a object according to the rules defined by the [W3C XML Schema Part 2: Datatypes](https://go.microsoft.com/fwlink/?LinkId=4871) recommendation. > [!NOTE] -> You cannot rely on the value when the content is typed as `xsd:gMonthDay`. always sets the value to 1904 in this case. +> You cannot rely on the value when the content is typed as `xsd:gMonthDay`. always sets the value to 1904 in this case. For more information, see the Remarks section of the reference page. ## Examples - The following example uses the method to read the content of the `date` element. + The following example uses the method to read the content of the `date` element. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlReader/Overview/readElementContentAs.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlReader.ReadElementContentAs/VB/readElementContentAs.vb" id="Snippet4"::: @@ -6360,7 +6360,7 @@ An method was called before a previous asy If the content is typed `xsd:dateTime`, the reader returns an unboxed object. If the content is not typed `xsd:dateTime`, the reader attempts to convert it to a object according to the rules defined by the [W3C XML Schema Part 2: Datatypes](https://go.microsoft.com/fwlink/?LinkId=4871) recommendation. > [!NOTE] -> You cannot rely on the value when the content is typed as `xsd:gMonthDay`. always sets the value to 1904 in this case. +> You cannot rely on the value when the content is typed as `xsd:gMonthDay`. always sets the value to 1904 in this case. For more information, see the Remarks section of the reference page. @@ -7071,7 +7071,7 @@ An method was called before a previous asy ## Examples - The following example uses the method to read the content of the `longValue` element. + The following example uses the method to read the content of the `longValue` element. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlReader/Overview/readElementContentAs.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlReader.ReadElementContentAs/VB/readElementContentAs.vb" id="Snippet3"::: @@ -7231,7 +7231,7 @@ An method was called before a previous asy For more information, see the Remarks section of the reference page and the [W3C XML Schema Part 2: Datatypes](https://go.microsoft.com/fwlink/?LinkId=4871) recommendation. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -7388,7 +7388,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -7466,7 +7466,7 @@ An asynchronous method was called without For more information, see the Remarks section of the reference page and the [W3C XML Schema Part 2: Datatypes](https://go.microsoft.com/fwlink/?LinkId=4871) recommendation. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -7629,7 +7629,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -7658,7 +7658,7 @@ An method was called before a previous asy method to read a text element. + We recommend that you use the method to read a text element. ]]> @@ -7838,7 +7838,7 @@ An method was called before a previous asy method to read a text element. + We recommend that you use the method to read a text element. ]]> @@ -7974,18 +7974,18 @@ An method was called before a previous asy |`Element`|On the `item1` start tag.|\text1\\text2\|text1|On the `item2` start tag.| |`Attribute`|On the `attr1` attribute node.|\text\|val1|Remains on the `attr1` attribute node.| - If the reader is positioned on a leaf node, calling `ReadInnerXml` is equivalent to calling . The method returns `String.Empty` (except for attribute nodes, in which case the value of the attribute is returned). + If the reader is positioned on a leaf node, calling `ReadInnerXml` is equivalent to calling . The method returns `String.Empty` (except for attribute nodes, in which case the value of the attribute is returned). This method checks for well-formed XML. If `ReadInnerXml` is called from an , this method also validates the content returned. As implemented in the , and `XmlValidatingReader` classes the `ReadOuterXml` method is namespace aware. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ## Examples - The following example compares the `ReadInnerXml` and methods. + The following example compares the `ReadInnerXml` and methods. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlReader/Overview/XmlReader_Basic.cs" id="Snippet12"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlReaderBasic/VB/xmlreader_basic.vb" id="Snippet12"::: @@ -8051,7 +8051,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -8113,7 +8113,7 @@ An asynchronous method was called without except it also returns the start and end tags. + This method is similar to except it also returns the start and end tags. This method handles element and attribute nodes in the following manner: @@ -8122,13 +8122,13 @@ An asynchronous method was called without |`Element`|On the `item1` start tag.|\text1\\text2\|\text1\|On the `item2` start tag.| |`Attribute`|On the `attr1` attribute node.|\text\|attr1="val1"|Remains on the `attr1` attribute node.| - If the reader is positioned on a leaf node, calling `ReadOuterXml` is equivalent to calling . The method returns `String.Empty` (except for attribute nodes, in which case the attribute markup is returned). + If the reader is positioned on a leaf node, calling `ReadOuterXml` is equivalent to calling . The method returns `String.Empty` (except for attribute nodes, in which case the attribute markup is returned). This method checks for well-formed XML. If `ReadOuterXml` is called from an , this method also validates the content returned As implemented in the , and `XmlValidatingReader` classes the `ReadOuterXml` method is namespace aware. Given the following XML text `hello`, if the reader were positioned on the `S:B` start tag, `ReadOuterXml` returns `hello`. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -8199,7 +8199,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -8269,7 +8269,7 @@ An asynchronous method was called without followed by to position you on the content of that element found in the input stream. + This method calls followed by to position you on the content of that element found in the input stream. ]]> @@ -8327,7 +8327,7 @@ An asynchronous method was called without followed by a call to . + A call to this method corresponds to a call to followed by a call to . @@ -8403,7 +8403,7 @@ An asynchronous method was called without followed by a call to . + A call to this method corresponds to a call to followed by a call to . ]]> @@ -8464,13 +8464,13 @@ An asynchronous method was called without ## Remarks The property has one of the following values: -- , when the method is called. +- , when the method is called. -- , when the method has been called, and additional methods may be called on the reader. +- , when the method has been called, and additional methods may be called on the reader. - , when the end of the XML document has been reached successfully. -- , when the method is called. +- , when the method is called. - , when an error is preventing the read operation from continuing. @@ -8529,7 +8529,7 @@ An asynchronous method was called without method to read the contents of an element or text node as a string. + We recommend that you use the method to read the contents of an element or text node as a string. ]]> @@ -8583,17 +8583,17 @@ An asynchronous method was called without can be called only on element nodes. When the entire sub-tree has been read, calls to the method returns `false`. When the new XML reader has been closed, the original reader is positioned on the `EndElement` node of the sub-tree. Thus, if you called the method on the start tag of the book element, after the sub-tree has been read and the new XML reader has been closed, the original XML reader is positioned on the end tag of the book element. + can be called only on element nodes. When the entire sub-tree has been read, calls to the method returns `false`. When the new XML reader has been closed, the original reader is positioned on the `EndElement` node of the sub-tree. Thus, if you called the method on the start tag of the book element, after the sub-tree has been read and the new XML reader has been closed, the original XML reader is positioned on the end tag of the book element. You should not perform any operations on the original reader until the new reader has been closed. This action is not supported and can result in unpredictable behavior. > [!NOTE] -> The method isn't intended for creating copies of the XML data that you can work with independently. It's designed to create a boundary around an XML element. This is useful if you want to pass data to another component for processing and you wish to limit how much of your data the component can access. When you pass an XML reader returned by the method to another application, the application can access only that XML element, not the entire XML document. +> The method isn't intended for creating copies of the XML data that you can work with independently. It's designed to create a boundary around an XML element. This is useful if you want to pass data to another component for processing and you wish to limit how much of your data the component can access. When you pass an XML reader returned by the method to another application, the application can access only that XML element, not the entire XML document. ## Examples - The following example shows how to use the method. + The following example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlReader/Overview/XmlReader_Basic.cs" id="Snippet13"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlReaderBasic/VB/xmlreader_basic.vb" id="Snippet13"::: @@ -8998,7 +8998,7 @@ reader.ReadToFollowing("item", "urn:1"); ## Remarks > [!NOTE] -> Do not call when the `XmlReader` is an initial state ( is ). You can call to advance the `XmlReader` and then call the method. +> Do not call when the `XmlReader` is an initial state ( is ). You can call to advance the `XmlReader` and then call the method. @@ -9068,7 +9068,7 @@ reader.ReadToFollowing("item", "urn:1"); ## Remarks > [!NOTE] -> Do not call when the `XmlReader` is an initial state ( is ). You can call to advance the `XmlReader` and then call the method. +> Do not call when the `XmlReader` is an initial state ( is ). You can call to advance the `XmlReader` and then call the method. ]]> @@ -9135,13 +9135,13 @@ reader.ReadToFollowing("item", "urn:1"); This method reads the specified number of characters (`count`) of the node value into a character buffer (`buffer`) at a specified offset (`index`) and returns the number of characters written to the buffer. It returns the `0` when it has reached the end of the value. It cannot be restarted to read through the value again. - In between calls to the properties do no change except for the property. When the property is accessed it may either return a partial value (with characters not yet returned by ) or a full value depending on the implementation. All the implementations in the namespace return a partial value for the property implementation. + In between calls to the properties do no change except for the property. When the property is accessed it may either return a partial value (with characters not yet returned by ) or a full value depending on the implementation. All the implementations in the namespace return a partial value for the property implementation. - Any Read method can be called in between calls to . If this occurs, the moves to the next in the stream and any characters not yet returned are skipped. + Any Read method can be called in between calls to . If this occurs, the moves to the next in the stream and any characters not yet returned are skipped. - There may be a case when returns less than the requested number of characters. For example, if you had a 200-character long value with a surrogate pair at positions 127 and 128 and you called with a 128-character buffer, the method call would return 127 characters instead of the requested 128. The surrogate pair would then be returned in the next call. In this case, did not return the requested 128 characters because doing so would have resulted in an incomplete surrogate pair at the end of the buffer. + There may be a case when returns less than the requested number of characters. For example, if you had a 200-character long value with a surrogate pair at positions 127 and 128 and you called with a 128-character buffer, the method call would return 127 characters instead of the requested 128. The surrogate pair would then be returned in the next call. In this case, did not return the requested 128 characters because doing so would have resulted in an incomplete surrogate pair at the end of the buffer. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ]]> @@ -9208,7 +9208,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -9268,10 +9268,10 @@ An asynchronous method was called without is called after calling this method, the entity replacement text is parsed. When the entity replacement text is finished, an `EndEntity` node is returned to close the entity reference scope. + If the reader is positioned on an `EntityReference` node (`XmlNodeType.EntityReference`), if is called after calling this method, the entity replacement text is parsed. When the entity replacement text is finished, an `EndEntity` node is returned to close the entity reference scope. > [!NOTE] -> After calling this method, if the entity is part of an attribute value, you must call to step into the entity. +> After calling this method, if the entity is part of an attribute value, you must call to step into the entity. ]]> @@ -9341,7 +9341,7 @@ An method was called before a previous asy The interface exposes a subset of the Post Schema Validation Infoset (PSVI) associated with an XML node. -If you have to get the post-schema-validation information set (PSVI) for an element, position the reader on the end tag of the element, rather than on the start tag. You get the PSVI through the `SchemaInfo` property of a reader. The validating reader that is created through with the property set to has complete PSVI for an element only when the reader is positioned on the end tag of an element. +If you have to get the post-schema-validation information set (PSVI) for an element, position the reader on the end tag of the element, rather than on the start tag. You get the PSVI through the `SchemaInfo` property of a reader. The validating reader that is created through with the property set to has complete PSVI for an element only when the reader is positioned on the end tag of an element. ]]> @@ -9459,7 +9459,7 @@ If you have to get the post-schema-validation information set (PSVI) for an elem ## Remarks In the following XML input if the reader is positioned on the `` node or any of its attributes, calling `Skip` positions the reader to the `` node. - If the reader is positioned on a leaf node already (such as the `` node or the text node `abc`), calling `Skip` is the same as calling . + If the reader is positioned on a leaf node already (such as the `` node or the text node `abc`), calling `Skip` is the same as calling . ```xml @@ -9479,15 +9479,15 @@ If you have to get the post-schema-validation information set (PSVI) for an elem |Type of XmlReader|Expands external entities| |-----------------------|-------------------------------| ||No.| -| instance created by the method that is reading text data.|No.| -| instance created by the method that is reading binary data.|Not applicable.| -|A schema validating instance created by the method.|Yes.| +| instance created by the method that is reading text data.|No.| +| instance created by the method that is reading binary data.|Not applicable.| +|A schema validating instance created by the method.|Yes.| ||Yes.| | instance returned by a object.|Not applicable.| ||No.| | instance wrapped around another instance.|Depends on the implementation of the underlying . (The `Skip` method on the underlying is called).| - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -9551,7 +9551,7 @@ If you have to get the post-schema-validation information set (PSVI) for an elem , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -9683,7 +9683,7 @@ This member may behave differently when it is used in a [Portable Class Library] method. + For the asynchronous version of this property, see the method. diff --git a/xml/System.Xml/XmlReaderSettings.xml b/xml/System.Xml/XmlReaderSettings.xml index 05ef79d8f8d..674a38acf49 100644 --- a/xml/System.Xml/XmlReaderSettings.xml +++ b/xml/System.Xml/XmlReaderSettings.xml @@ -242,7 +242,7 @@ The following example creates an that uses an instance if you want to use asynchronous methods on that instance. After the instance is created, the property is read-only. The default value of this property is `false`. - This flag is ignored by the overload. This means that if you create a new based on an existing , the async behavior depends on the input , and you cannot use the flag to change the async behavior. + This flag is ignored by the overload. This means that if you create a new based on an existing , the async behavior depends on the input , and you cannot use the flag to change the async behavior. ]]> @@ -423,7 +423,7 @@ If the is processing text data, it always checks tha is passed to the method. If a stream is created by the reader for its own processing, such as when the reader is created with a URI or when it opens an external document type definition, it is always closed when the reader is closed. + This setting is used when a stream or is passed to the method. If a stream is created by the reader for its own processing, such as when the reader is created with a URI or when it opens an external document type definition, it is always closed when the reader is closed. ]]> @@ -480,7 +480,7 @@ If the is processing text data, it always checks tha method meet the following compliance requirements by default: + XML readers that are created by the method meet the following compliance requirements by default: - New lines and attribute value are normalized according to the W3C [XML 1.0 Recommendation](https://www.w3.org/TR/2006/REC-xml-20060816/). @@ -500,7 +500,7 @@ If the is processing text data, it always checks tha |-------------|-----------------| ||Ensures that the XML data conforms to the rules for a well-formed XML 1.0 document. This level of checking ensures that any processor can consume the stream being read as an [well-formed XML 1.0 document](https://www.w3.org/TR/2006/REC-xml-20060816/#sec-well-formed).

The reader checks for the following:

- The top-level item must not have any nodes other than XML Declaration, document type definition (DTD), element, comment, white space, or processing instruction.
- The XML data must have exactly one top-level element node.| ||Ensures that the XML data conforms to the rules for a well-formed XML 1.0 document fragment.

This setting accepts XML data with multiple root elements, or text nodes at the top-level. This level of checking ensures that any processor can consume the stream being read as an [external parsed entity](https://www.w3.org/TR/2006/REC-xml-20060816/#wf-entities).| -||Specifies that the reader should determine the level of conformance checking based on the incoming data.

Document conformance checking is applied if the XML data contains DTD information.

Fragment conformance checking is applied if the XML data contains one of following:

- Text, CDATA, or entity reference node at the root level.
- More than one element at the root level.
- No element at the root level.

An is thrown if there is a conflict, such as when there is a text node and a DTD at the root level.

This setting can be used in wrapping scenarios when the method is used to add additional features to an existing . In this case, does not add any new conformance checking. Conformance checking is left to the that is being wrapped.| +||Specifies that the reader should determine the level of conformance checking based on the incoming data.

Document conformance checking is applied if the XML data contains DTD information.

Fragment conformance checking is applied if the XML data contains one of following:

- Text, CDATA, or entity reference node at the root level.
- More than one element at the root level.
- No element at the root level.

An is thrown if there is a conflict, such as when there is a text node and a DTD at the root level.

This setting can be used in wrapping scenarios when the method is used to add additional features to an existing . In this case, does not add any new conformance checking. Conformance checking is left to the that is being wrapped.| > [!NOTE] > The XML 1.0 recommendation requires document-level conformance when a DTD is present. Therefore, if the reader is configured to support , but the XML data contains a document type definition (DTD), an is thrown. @@ -1381,7 +1381,7 @@ There is an error in XML document (MaxCharactersInDocument, ). For more information about this API, see Supplemental API remarks for XmlReaderSettings.Schemas. object and the method to associate a schema with an XML document. The schema is added to the property of the object. The value of the property is an object. The schema is used to validate that the XML document conforms to the schema content model. Schema validation errors and warnings are handled by the defined in the object. +The example below uses the object and the method to associate a schema with an XML document. The schema is added to the property of the object. The value of the property is an object. The schema is used to validate that the XML document conforms to the schema content model. Schema validation errors and warnings are handled by the defined in the object. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlReaderSettings/Schemas/xmlschemasetexample.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlSchemaSetOverall Example/VB/xmlschemasetexample.vb" id="Snippet1"::: diff --git a/xml/System.Xml/XmlResolver.xml b/xml/System.Xml/XmlResolver.xml index f83846e932d..f2151852d5a 100644 --- a/xml/System.Xml/XmlResolver.xml +++ b/xml/System.Xml/XmlResolver.xml @@ -280,15 +280,15 @@ resolver.Credentials = myCache; ## Remarks This method is used when the caller wants to map a given URI into the object containing the actual resource that the URI represents. The type of object returned is negotiable; however, the implementation must always support . - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . > [!IMPORTANT] -> Your application can mitigate memory denial of service threats to the method by implementing an that limits the number of bytes read. This helps guard against situations where malicious code attempts to pass an infinite stream of bytes to the method. +> Your application can mitigate memory denial of service threats to the method by implementing an that limits the number of bytes read. This helps guard against situations where malicious code attempts to pass an infinite stream of bytes to the method. ## Examples - See for an example using this method. + See for an example using this method. ]]> @@ -364,7 +364,7 @@ resolver.Credentials = myCache; , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -435,7 +435,7 @@ resolver.Credentials = myCache; ## Examples - See for an example that uses this method. + See for an example that uses this method. ]]> diff --git a/xml/System.Xml/XmlSecureResolver.xml b/xml/System.Xml/XmlSecureResolver.xml index 5f6eed5edcd..b84e488b106 100644 --- a/xml/System.Xml/XmlSecureResolver.xml +++ b/xml/System.Xml/XmlSecureResolver.xml @@ -76,11 +76,11 @@ The three constructors provide three types of access restrictions: -- The constructor restricts access by using a URL. +- The constructor restricts access by using a URL. -- The constructor restricts access by using a permission set. +- The constructor restricts access by using a permission set. -- The constructor restricts access by using evidence. +- The constructor restricts access by using evidence. See the constructor reference topics for examples of these types of restrictions. @@ -250,12 +250,12 @@ See the constructor reference topics for examples of these types of restrictions ## Remarks > [!IMPORTANT] -> There are differences in the security infrastructure for code running on the .NET Framework common language runtime (CLR) and for code running on the CLR that is integrated within Microsoft SQL Server 2005. This can lead to cases where code developed for the .NET Framework CLR operates differently when used on the SQL Server integrated CLR. One of these differences affects the class when you have evidence that is based on a URL (that is, when you use the method or the constructor). The policy resolution mechanism of the SQL Server integrated CLR does not use the or information. Instead, it grants permissions based on the GUID that the server adds when assemblies are loaded. When you use the in the SQL Server integrated CLR, provide any required evidence directly by using a specified . +> There are differences in the security infrastructure for code running on the .NET Framework common language runtime (CLR) and for code running on the CLR that is integrated within Microsoft SQL Server 2005. This can lead to cases where code developed for the .NET Framework CLR operates differently when used on the SQL Server integrated CLR. One of these differences affects the class when you have evidence that is based on a URL (that is, when you use the method or the constructor). The policy resolution mechanism of the SQL Server integrated CLR does not use the or information. Instead, it grants permissions based on the GUID that the server adds when assemblies are loaded. When you use the in the SQL Server integrated CLR, provide any required evidence directly by using a specified . ## Examples - This example uses the constructor to create an object that is allowed to access your local intranet site only. + This example uses the constructor to create an object that is allowed to access your local intranet site only. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlSecureResolver/Overview/XmlSecureResolver_ex.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlSecureResolver_Samples/VB/XmlSecureResolver_ex.vb" id="Snippet3"::: @@ -300,7 +300,7 @@ See the constructor reference topics for examples of these types of restrictions ## Remarks > [!IMPORTANT] -> There are differences in the security infrastructure for code running on the .NET Framework common language runtime (CLR) and for code running on the CLR that is integrated within Microsoft SQL Server 2005. This can lead to cases where code developed for the .NET Framework CLR operates differently when used on the SQL Server integrated CLR. One of these differences affects the class when you have evidence that is based on a URL (that is, when you use the method or the constructor). The policy resolution mechanism of the SQL Server integrated CLR doesn't use the or information. Instead, it grants permissions based on the GUID that the server adds when assemblies are loaded. When you use the in the SQL Server integrated CLR, provide any required evidence directly by using a specified . +> There are differences in the security infrastructure for code running on the .NET Framework common language runtime (CLR) and for code running on the CLR that is integrated within Microsoft SQL Server 2005. This can lead to cases where code developed for the .NET Framework CLR operates differently when used on the SQL Server integrated CLR. One of these differences affects the class when you have evidence that is based on a URL (that is, when you use the method or the constructor). The policy resolution mechanism of the SQL Server integrated CLR doesn't use the or information. Instead, it grants permissions based on the GUID that the server adds when assemblies are loaded. When you use the in the SQL Server integrated CLR, provide any required evidence directly by using a specified . ]]> @@ -422,7 +422,7 @@ See the constructor reference topics for examples of these types of restrictions ## Remarks > [!IMPORTANT] -> Your application can mitigate memory denial of service threats to the method by implementing an that limits the number of bytes read. This helps guard against situations where malicious code attempts to pass an infinite stream of bytes to the method. +> Your application can mitigate memory denial of service threats to the method by implementing an that limits the number of bytes read. This helps guard against situations where malicious code attempts to pass an infinite stream of bytes to the method. ]]> diff --git a/xml/System.Xml/XmlSignificantWhitespace.xml b/xml/System.Xml/XmlSignificantWhitespace.xml index 2cb41f76ea2..b645d201d5a 100644 --- a/xml/System.Xml/XmlSignificantWhitespace.xml +++ b/xml/System.Xml/XmlSignificantWhitespace.xml @@ -194,7 +194,7 @@ . + `CloneNode` serves as a copy constructor for nodes. To see how this method behaves with other node types, see . The cloned node has no parent. returns `null`. diff --git a/xml/System.Xml/XmlText.xml b/xml/System.Xml/XmlText.xml index 0ebb3d4b380..a507798c2cc 100644 --- a/xml/System.Xml/XmlText.xml +++ b/xml/System.Xml/XmlText.xml @@ -132,11 +132,11 @@ The parent XML document. Initializes a new instance of the class. - directly; instead, use methods such as . - + directly; instead, use methods such as . + ]]> @@ -191,13 +191,13 @@ Creates a duplicate of this node. The cloned node. - method in the `XmlNode` class. - - The cloned node has no parent ( returns `null`). - + method in the `XmlNode` class. + + The cloned node has no parent ( returns `null`). + ]]> @@ -498,11 +498,11 @@ Splits the node into two nodes at the specified offset, keeping both in the tree as siblings. The new node. - @@ -609,11 +609,11 @@ The to which you want to save. Saves all the children of the node to the specified . nodes do not have children, so this method has no effect. - @@ -666,11 +666,11 @@ The to which you want to save. Saves the node to the specified . - diff --git a/xml/System.Xml/XmlTextReader.xml b/xml/System.Xml/XmlTextReader.xml index 4daca920b95..fbe9e5f1e5b 100644 --- a/xml/System.Xml/XmlTextReader.xml +++ b/xml/System.Xml/XmlTextReader.xml @@ -90,7 +90,7 @@ ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -180,7 +180,7 @@ ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. The decodes the stream using . @@ -236,7 +236,7 @@ ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. It is assumed that the `TextReader` is already set to the correct encoding. This is used by clients that have already read some things from the stream in a multi-part MIME scenario. @@ -305,12 +305,12 @@ ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. If the file is located on a resource that requires access credentials, use the property to specify the necessary credentials. > [!NOTE] -> In version 1.1 of the .NET Framework, partially trusted code cannot set the `XmlResolver` property. The workaround is to create an with the necessary credentials, pass the URI to the method, and then construct the `XmlTextReader` using the resulting object. The workaround is described in the following C# code. +> In version 1.1 of the .NET Framework, partially trusted code cannot set the `XmlResolver` property. The workaround is to create an with the necessary credentials, pass the URI to the method, and then construct the `XmlTextReader` using the resulting object. The workaround is described in the following C# code. ```csharp // Create a resolver with the necessary credentials. @@ -398,7 +398,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -452,7 +452,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. The decodes the stream using . @@ -511,7 +511,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. It is assumed that the `TextReader` is already set to the correct encoding. This is used by clients that have already read some things from the stream in a multi-part MIME scenario. @@ -575,7 +575,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -638,7 +638,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. It is assumed that the `TextReader` is already set to the correct encoding. This is used by clients that have already read some things from the stream in a multi-part MIME scenario. @@ -701,7 +701,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -777,7 +777,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This constructor parses the given string as a fragment of XML. If the XML fragment is an element or attribute, you can bypass the root level rules for well-formed XML documents. @@ -862,7 +862,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -926,7 +926,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. It is assumed that the `TextReader` is already set to the correct encoding. This is used by clients that have already read some things from the stream in a multi-part MIME scenario. @@ -1000,9 +1000,9 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. - This constructor parses the given string as a fragment of XML. If the XML fragment is an element or attribute, you can bypass the root level rules for well-formed XML documents. This constructor can handle strings returned from . + This constructor parses the given string as a fragment of XML. If the XML fragment is an element or attribute, you can bypass the root level rules for well-formed XML documents. This constructor can handle strings returned from . The following table lists valid values for `fragType` and how the reader parses each of the different node types. @@ -1075,7 +1075,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property is relevant to `Element`, `DocumentType` and `XmlDeclaration` nodes only. (Other node types do not have attributes.) @@ -1138,7 +1138,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. A networked XML document is comprised of chunks of data aggregated using various W3C standard inclusion mechanisms and therefore contains nodes that come from different places. DTD entities are an example of this, but this is not limited to DTDs. The base URI tells you where these nodes came from. If there is no base URI for the nodes being returned (for example, they were parsed from an in-memory string), `String.Empty` is returned. @@ -1204,9 +1204,9 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. - The binary content read methods include the , , , and methods. + The binary content read methods include the , , , and methods. ]]> @@ -1258,9 +1258,9 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. - The throws a if the method is called. + The throws a if the method is called. ]]> @@ -1312,7 +1312,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -1364,7 +1364,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This method also releases any resources held while reading. If this reader was constructed using a stream, this method also calls `Close` on the underlying stream. @@ -1420,7 +1420,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. @@ -1537,7 +1537,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of newer functionality. +> We recommend that you create instances by using the method to take advantage of newer functionality. Because uses the class, `XmlTextReader` also supports all encodings supported by that class. The exception to this is any encoding, such as UTF-7 or EBCDIC, that maps the ` [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. - This property can be changed on the fly and takes effect after the next call. + This property can be changed on the fly and takes effect after the next call. When `EntityHandling` is set to `ExpandCharEntities`, attribute values are only partially normalized. The reader normalizes each individual text node independently from the content of adjacent entity reference nodes. @@ -1667,7 +1667,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -1688,7 +1688,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -1743,7 +1743,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This method does not move the reader. @@ -1809,7 +1809,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This method does not move the reader. @@ -1891,7 +1891,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. The following XML contains an attribute in a specific namespace: @@ -1968,11 +1968,11 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. The dictionary consists of a collection of namespace names keyed by prefix. It can be used to enumerate the in-scope namespaces. The dictionary is a disconnected copy of the namespace list of the reader. It remains unchanged as the reader position, current in-scope namespace list, changes. - The following table describes how the enumeration value affects the whether or not the default and built-in namespaces are returned by . + The following table describes how the enumeration value affects the whether or not the default and built-in namespaces are returned by . |XmlNamespaceScope Value|xmlns:xml|xmlns:xmlns|xmlns=""| |-----------------------------|---------------|-----------------|---------------| @@ -2031,7 +2031,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. Because does a buffered `Read`, it must be able to return the remainder of the unused buffer so that no data is lost. This allows protocols (such as multi-part MIME) to package XML in the same stream as other things. @@ -2103,7 +2103,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -2156,7 +2156,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. The following table lists node types that have a value to return. @@ -2234,7 +2234,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property applies only to attribute nodes. @@ -2289,7 +2289,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property enables you to determine the difference between the following: @@ -2471,7 +2471,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property is most commonly used for error reporting, but can be called at any time. The starting value for this property is `1`. @@ -2537,7 +2537,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property is most commonly used for error reporting, but can be called at any time. The property's starting value is `1`. @@ -2613,7 +2613,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. @@ -2688,7 +2688,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. In the following XML, if the reader is positioned on the `href` attribute, the prefix `a` is resolved by calling `reader.LookupNamespace("a")`. The returned string is `urn:456`. @@ -2720,7 +2720,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -2774,7 +2774,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. @@ -2840,7 +2840,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. After calling `MoveToAttribute`, the , , and properties reflects the properties of that attribute. @@ -2909,7 +2909,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. After calling `MoveToAttribute`, the , , and properties reflects the properties of that attribute. @@ -2965,7 +2965,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. Use this method to return to an element after navigating through its attributes. This method moves the reader to one of the following node types: `Element`, `DocumentType`, or `XmlDeclaration`. @@ -3029,7 +3029,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. @@ -3095,9 +3095,9 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. - If the current node is an element node, this method is equivalent to . If `MoveToNextAttribute` returns `true`, the reader moves to the next attribute; otherwise, the position of the reader does not change. + If the current node is an element node, this method is equivalent to . If `MoveToNextAttribute` returns `true`, the reader moves to the next attribute; otherwise, the position of the reader does not change. @@ -3177,7 +3177,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. @@ -3242,7 +3242,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property determines whether the reader supports the W3C [Namespaces in XML](https://www.w3.org/TR/REC-xml-names) recommendation. @@ -3299,7 +3299,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property is relevant to `Element` and `Attribute` nodes only. @@ -3365,7 +3365,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. All node and attribute names returned from are atomized using the `NameTable`. When the same name is returned multiple times (for example, `Customer`), then the same `String` object is returned for that name. This makes it possible for you to write efficient code that does object comparisons on these strings instead of expensive string comparisons. @@ -3420,7 +3420,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property never returns the following `XmlNodeType` types: `Document`, `DocumentFragment`, `Entity`, `EndEntity`, or `Notation`. @@ -3487,7 +3487,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property can be changed at any time and takes effect on the next read operation. @@ -3571,7 +3571,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. @@ -3646,7 +3646,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. DTD processing is enabled by default for backwards compatibility. However, unless your application requires DTD processing, you should disable this setting. Disabling DTD processing can be useful in preventing certain denial of service attacks. If set to `true`, the reader throws an when any DTD content is encountered. @@ -3702,7 +3702,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property applies only to an attribute node. @@ -3758,7 +3758,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. When a reader is first created and initialized, there is no information available. You must call `Read` to read the first node. @@ -3834,7 +3834,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. Use this method after calling `MoveToAttribute` to read through the text or entity reference nodes that make up the attribute value. The of the attribute value nodes is one plus the depth of the attribute node; it increments and decrements by one when you step into and out of general entity references. @@ -3904,9 +3904,9 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. - Like , this method can be called successively to read large streams of embedded text. It decodes Base64 content and returns the decoded binary bytes (for example, an inline Base64 encoded GIF image) into the buffer. See RFC 1521. (You can obtain RFCs from the [Request for Comments Web site](https://www.rfc-editor.org).) + Like , this method can be called successively to read large streams of embedded text. It decodes Base64 content and returns the decoded binary bytes (for example, an inline Base64 encoded GIF image) into the buffer. See RFC 1521. (You can obtain RFCs from the [Request for Comments Web site](https://www.rfc-editor.org).) @@ -3983,9 +3983,9 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. - Like , this method can be called successively to read large streams of embedded text. It decodes `BinHex` content and returns the decoded binary bytes (for example, an inline `BinHex` encoded GIF image) into the buffer. + Like , this method can be called successively to read large streams of embedded text. It decodes `BinHex` content and returns the decoded binary bytes (for example, an inline `BinHex` encoded GIF image) into the buffer. @@ -4061,7 +4061,7 @@ abc ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This is the most efficient way to process very large streams of text embedded in an XML document. Rather than allocating large string objects, `ReadChars` returns text content a buffer at a time. This method is designed to work only on element nodes. Other node types cause `ReadChars` to return `0`. @@ -4185,20 +4185,20 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This method streams the content, decodes the `Base64` content, and returns the decoded binary bytes (for example, an inline `Base64`-encoded GIF image) into the buffer. This method can be called successively to read large streams of embedded text. For more information, see RFC 1521, "MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies". You can obtain RFCs from the [Request for Comments Web site](https://www.rfc-editor.org). > [!NOTE] -> You should not access any of the reader properties between calls to the method until the method returns the value 0. +> You should not access any of the reader properties between calls to the method until the method returns the value 0. This method has the following behavior: -- returns the value 0 when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node. +- returns the value 0 when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node. - If you ask for fewer, or the exact number, of bytes than are left in the stream the reader remains in its current position. -- is not supported on the following XML node types: `Element`, `XmlDeclaration`, `None`, `Document`, `DocumentType`, `Notation`, `Entity`, `DocumentFragment`. +- is not supported on the following XML node types: `Element`, `XmlDeclaration`, `None`, `Document`, `DocumentType`, `Notation`, `Entity`, `DocumentFragment`. ]]> @@ -4263,20 +4263,20 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This method streams the content, decodes the `BinHex` content, and returns the decoded binary bytes (for example, an inline `BinHex` encoded GIF image) into the buffer. This method can be called successively to read large streams of embedded text. > [!NOTE] -> You should not access any of the reader properties between calls to the method until the method returns the value 0. +> You should not access any of the reader properties between calls to the method until the method returns the value 0. This method has the following behavior: -- returns the value 0 when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node. +- returns the value 0 when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node. - If you ask for fewer, or the exact number, of bytes than are left in the stream the reader remains in its current position. -- is not supported on the following XML node types: `Element`, `XmlDeclaration`, `None`, `Document`, `DocumentType`, `Notation`, `Entity`, `DocumentFragment`. +- is not supported on the following XML node types: `Element`, `XmlDeclaration`, `None`, `Document`, `DocumentType`, `Notation`, `Entity`, `DocumentFragment`. ]]> @@ -4342,22 +4342,22 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This method reads the element content, decodes it using Base64 encoding, and returns the decoded binary bytes (for example, an inline Base64 encoded GIF image) into the buffer. For more information, see RFC 1521, "MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies". You can obtain RFCs from the [Request for Comments Web site](https://www.rfc-editor.org). This method can only read simple-content elements. The element can contain text, white space, significant white space, CDATA sections, comments and processing instructions. It can also contain entity references, which are automatically expanded. The element cannot have child elements. - This method is very similar to the method except that it can only be called on element node types. + This method is very similar to the method except that it can only be called on element node types. If the `count` value is higher than the number of bytes in the document, or if it is equal to the number of bytes in the document, the reads all the remaining bytes in the document and returns the number of bytes read. The next method call returns a zero and moves the reader to the node following the . - If you call before all of the element content is consumed, the reader may behave as if the first content was consumed and then the method was called. This means that the reader reads all the text until the end element is encountered. It then reads the end tag node, reads the next node, and then positions itself on the next subsequent node. + If you call before all of the element content is consumed, the reader may behave as if the first content was consumed and then the method was called. This means that the reader reads all the text until the end element is encountered. It then reads the end tag node, reads the next node, and then positions itself on the next subsequent node. ## Examples - See to see an example using this method. + See to see an example using this method. ]]> @@ -4423,22 +4423,22 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This method reads the element content, decodes it using `BinHex` encoding, and returns the decoded binary bytes (for example, an inline `BinHex` encoded GIF image) into the buffer. This method can only read simple-content elements. The element can contain text, white space, significant white space, CDATA sections, comments and processing instructions. It can also contain entity references, which are automatically expanded. The element cannot have child elements. - This method is very similar to the method except that it can only be called on element node types. + This method is very similar to the method except that it can only be called on element node types. If the `count` value is higher than the number of bytes in the document, or if it is equal to the number of bytes in the document, the reads all the remaining bytes in the document and returns the number of bytes read. The next method call returns a zero and moves the reader to the node following the . - If you call before all of the element content is consumed, the reader may behave as if the first content was consumed and then the method was called. This means that the reader reads all the text until the end element is encountered. It then reads the end tag node, reads the next node, and then positions itself on the next subsequent node. + If you call before all of the element content is consumed, the reader may behave as if the first content was consumed and then the method was called. This means that the reader reads all the text until the end element is encountered. It then reads the end tag node, reads the next node, and then positions itself on the next subsequent node. ## Examples - See to see an example using this method. + See to see an example using this method. ]]> @@ -4497,7 +4497,7 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -4550,7 +4550,7 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. If positioned on an element, `ReadString` concatenates all text, significant white space, white space, and `CData` section node types together and returns the concatenated data as the element content. It stops when any markup is encountered, including comments and processing instructions. This could occur in a mixed content model, or when an element end tag is read. @@ -4620,7 +4620,7 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This method enables you to parse multiple XML documents in a single stream. When you reach the end of an XML document, you can call `ResetState` to reset the state of the reader in preparation for the next XML document. @@ -4697,12 +4697,12 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. - If the reader is positioned on an `EntityReference` node (`XmlNodeType.EntityReference`), if is called after calling this method, the entity replacement text is parsed. When the entity replacement text is finished, an `EndEntity` node is returned to close the entity reference scope. + If the reader is positioned on an `EntityReference` node (`XmlNodeType.EntityReference`), if is called after calling this method, the entity replacement text is parsed. When the entity replacement text is finished, an `EndEntity` node is returned to close the entity reference scope. > [!NOTE] -> After calling this method, if the entity is part of an attribute value, you must call to step into the entity. +> After calling this method, if the entity is part of an attribute value, you must call to step into the entity. ]]> @@ -4738,7 +4738,7 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks -To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. +To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. ]]> @@ -4788,11 +4788,11 @@ To take advantage of newer features, the recommended practice is to create [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. In the following XML input if the reader is positioned on the `` node or any of its attributes, calling `Skip` positions the reader to the `` node. - If the reader is positioned on a leaf node already (such as the `` node or the text node `abc`), calling `Skip` is the same as calling . + If the reader is positioned on a leaf node already (such as the `` node or the text node `abc`), calling `Skip` is the same as calling . ```xml @@ -5079,7 +5079,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. @@ -5143,7 +5143,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property can be changed at any time and takes effect on the next read operation. @@ -5209,7 +5209,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property represents the `xml:lang` scope within which the current node resides. For example, here is an XML fragment with `xml:lang` set to US English in the root element: @@ -5288,7 +5288,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. The reader uses `XmlResolver` to resolve the location of the file loaded into the reader and also to resolve DTD references. For example, if your XML included the DOCTYPE declaration, `` the reader resolves this external file and ensures that the DTD is well-formed. The reader does not use the DTD for validation. @@ -5362,7 +5362,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks > [!NOTE] -> We recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. diff --git a/xml/System.Xml/XmlTextWriter.xml b/xml/System.Xml/XmlTextWriter.xml index 2a4ef49ffc3..62d51807426 100644 --- a/xml/System.Xml/XmlTextWriter.xml +++ b/xml/System.Xml/XmlTextWriter.xml @@ -75,7 +75,7 @@ We recommend that you use the class instea ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -126,7 +126,7 @@ We recommend that you use the class instea ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -187,7 +187,7 @@ We recommend that you use the class instea ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -251,7 +251,7 @@ We recommend that you use the class instea ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -315,7 +315,7 @@ We recommend that you use the class instea ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. If the writer was constructed using a `TextWriter` that is derived from the `StreamWriter` class, this property is equivalent to the property. If the writer was constructed using a , this property returns the `Stream` passed to the constructor. If the writer was constructed using a file name, this property returns the `Stream` representing the file. @@ -368,7 +368,7 @@ We recommend that you use the class instea ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. Any elements or attributes left open are automatically closed. @@ -431,9 +431,9 @@ We recommend that you use the class instea ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. - This is called instead of when you want to write more to the underlying stream without losing what is still in the buffer. + This is called instead of when you want to write more to the underlying stream without losing what is still in the buffer. @@ -498,7 +498,7 @@ We recommend that you use the class instea ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. If the `Indented` option is set, child elements are indented using the and properties. Only element content is indented. The following C# code writes out HTML elements including mixed content: @@ -590,7 +590,7 @@ XmlTextWriter w = new XmlTextWriter(Console.Out); ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. Indentation is performed on following node types: `DocumentType`, `Element`, `Comment`, `ProcessingInstruction`, and `CDATASection`. All other node types are not affected. The `XmlTextWriter` does not indent the internal DTD subset. However, you could do the following to apply formatting to the internal DTD subset. @@ -681,7 +681,7 @@ tw.WriteDocType(name, pubid, sysid, subset); The `XmlTextWriter` allows you to set this property to any character. To ensure valid XML, you must specify a valid white space character, 0x9, 0x10, 0x13, or 0x20. > [!NOTE] -> We recommend that you create instances by using the method and the class to take advantage of new functionality. +> We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -745,7 +745,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. @@ -815,7 +815,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This property determines whether the writer supports the W3C [Namespaces in XML](https://www.w3.org/TR/REC-xml-names) recommendation. @@ -875,7 +875,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -934,12 +934,12 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ## Examples - The following example encodes an input file using `WriteBase64` and generates a temporary XML file. The temporary XML file is decoded using the method and compared to the original file. + The following example encodes an input file using `WriteBase64` and generates a temporary XML file. The temporary XML file is decoded using the method and compared to the original file. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlTextWriter/WriteBase64/writebase64.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlWriter.WriteBase64/VB/writebase64.vb" id="Snippet1"::: @@ -1006,7 +1006,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -1067,7 +1067,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. If `text` is either `null` or `String.Empty`, this method writes an empty CDATA block, for example \. @@ -1133,7 +1133,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This method writes the Unicode character in hexadecimal character entity reference format. @@ -1203,7 +1203,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This method can be used to write large amounts of text one buffer at a time. @@ -1278,7 +1278,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. If `text` is either `null` or `String.Empty`, this method writes a `Comment` with no data content, for example \. @@ -1358,12 +1358,12 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This method does not check for invalid characters in `pubid`, `sysid` or `subset`. It also does not check that the internal subset is well-formed. > [!IMPORTANT] -> The does not validate any data that is passed to the method. You should not pass arbitrary data to this method. +> The does not validate any data that is passed to the method. You should not pass arbitrary data to this method. @@ -1429,11 +1429,11 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. If you call `WriteStartAttribute`, you can close the attribute with this method. - You can also close the attribute by calling `WriteStartAttribute` again, calling , or calling . + You can also close the attribute by calling `WriteStartAttribute` again, calling , or calling . @@ -1492,7 +1492,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. @@ -1558,7 +1558,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. If the element contains no content a short end tag "/>" is written; otherwise a full end tag is written. @@ -1622,7 +1622,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. @@ -1688,7 +1688,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This method always writes the full end tag. This is useful when dealing with elements that must include a full end tag. For example, browsers expect HTML script blocks to be closed with "\". @@ -1752,7 +1752,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. If is set to `true`, `WriteName` also checks that the name is also valid according to the W3C Namespaces in XML recommendation. @@ -1810,7 +1810,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -1876,7 +1876,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. If `text` is either `null` or `String.Empty`, this method writes a `ProcessingInstruction` with no data content, for example \. @@ -1955,7 +1955,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. For example, the following Microsoft Visual C# code: @@ -2017,7 +2017,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -2071,12 +2071,12 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This method does not escape special characters. > [!IMPORTANT] -> The does not validate any data that is passed to the method. You should not pass arbitrary data to this method. +> The does not validate any data that is passed to the method. You should not pass arbitrary data to this method. @@ -2142,12 +2142,12 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This method does not escape special characters. > [!IMPORTANT] -> The does not validate any data that is passed to the method. You should not pass arbitrary data to this method. +> The does not validate any data that is passed to the method. You should not pass arbitrary data to this method. ]]> @@ -2224,9 +2224,9 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. - This is a more advanced version of that allows you to write an attribute value using multiple write methods, such as . + This is a more advanced version of that allows you to write an attribute value using multiple write methods, such as . @@ -2257,7 +2257,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -2314,13 +2314,13 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. The encoding level of the document is determined by how the writer is implemented. For example, if an object is specified in the `XmlTextWriter` constructor, this determines the value of the encoding attribute. This method does not create a standalone attribute. When `WriteStartDocument` is called the writer validates that what you are writing is a well-formed XML document. For example, it checks that the XML declaration is the first node, that one and only one root-level element exists and so on. If this method is not called, the writer assumes an XML fragment is being written and applies no root level rules. - If `WriteStartDocument` has been called and then the method is used to create another XML declaration, an exception is thrown. + If `WriteStartDocument` has been called and then the method is used to create another XML declaration, an exception is thrown. @@ -2383,13 +2383,13 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. The encoding level of the document is determined by how the writer is implemented. For example, if an object is specified in the `XmlTextWriter` constructor, this determines the value of the encoding attribute. When `WriteStartDocument` is called the writer validates that what you are writing is a well-formed XML document. For example, it checks that the XML declaration is the first node, that one and only one root-level element exists and so on. If this method is not called, the writer assumes an XML fragment is being written and applies no root level rules. - If `WriteStartDocument` has been called and then the method is used to create another XML declaration, an exception is thrown. + If `WriteStartDocument` has been called and then the method is used to create another XML declaration, an exception is thrown. ]]> @@ -2456,9 +2456,9 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. - After calling this method you can either write attributes or create content using , , or for child elements. You can close the element with at which time an end tag is written out. + After calling this method you can either write attributes or create content using , , or for child elements. You can close the element with at which time an end tag is written out. @@ -2518,7 +2518,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -2573,7 +2573,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. `WriteString` does the following @@ -2648,7 +2648,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This method is only applicable on systems that use UTF-16 encoding. @@ -2712,7 +2712,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This method is used to manually format your document. Use the property to have the writer format the output automatically. @@ -2782,7 +2782,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This property allows one component to find out what state another component has left the writer in. For example, perhaps one component wants to tell another which language help text to generate. The language information is communicated by writing an `xml:lang` attribute. @@ -2853,7 +2853,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] ->We recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This property allows one component to find out in what state another component has left the writer. diff --git a/xml/System.Xml/XmlUrlResolver.xml b/xml/System.Xml/XmlUrlResolver.xml index 6000feaa85b..e18af9c209a 100644 --- a/xml/System.Xml/XmlUrlResolver.xml +++ b/xml/System.Xml/XmlUrlResolver.xml @@ -63,16 +63,16 @@ > objects can contain sensitive information such as user credentials. You should be careful when you cache objects and should not pass objects to an untrusted component. ## Resolving DTDs - If an XML reader () is reading an XML file that contains an external DTD, it calls the method to get a stream representation of the DTD. If the URI of the DTD is a relative URI, the XML reader calls the method and returns an absolute URI for the given `relativeUri` and `baseURi` parameters. If the doesn't know how to resolve the URI, it returns `null`. + If an XML reader () is reading an XML file that contains an external DTD, it calls the method to get a stream representation of the DTD. If the URI of the DTD is a relative URI, the XML reader calls the method and returns an absolute URI for the given `relativeUri` and `baseURi` parameters. If the doesn't know how to resolve the URI, it returns `null`. - The method uses the information in the property as appropriate to gain access to the resource. There is no `get` accessor to this property for security reasons. When overwriting , **GetEntity** is the method that utilizes the credential information in the **Credentials** property. + The method uses the information in the property as appropriate to gain access to the resource. There is no `get` accessor to this property for security reasons. When overwriting , **GetEntity** is the method that utilizes the credential information in the **Credentials** property. Resolving all other XML resources is very similar to resolving DTDs. negotiates the connection with the external resource and returns a representation of the content. The object that is making the call to interprets the stream. ## Extending the XmlUrlResolver class The default behavior of the class is to resolve an XML data resource from its source, not from cache. In some cases, resolving a data resource from cache can improve the performance of an application by saving a trip to the data resource's server. The performance gains here must be weighed against the need for up-to-date content. - The following example extends and builds a new class, `XmlCachingResolver`, to retrieve resources from the cache. This is done by overriding the property and the method. + The following example extends and builds a new class, `XmlCachingResolver`, to retrieve resources from the cache. This is done by overriding the property and the method. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlUrlResolver/Overview/XmlCachingResolver_ex.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlCachingResolver_ex/VB/XmlCachingResolver_ex.vb" id="Snippet1"::: @@ -336,15 +336,15 @@ resolver.Credentials = myCache; ## Remarks This method is used when the caller wants to map a given URI to an object that contains the resource that the URI represents. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . > [!IMPORTANT] -> Your application can mitigate memory denial of service threats to the method by implementing IStream to limit the number of bytes read. This helps guard against situations where malicious code attempts to pass an infinite stream of bytes to the method. +> Your application can mitigate memory denial of service threats to the method by implementing IStream to limit the number of bytes read. This helps guard against situations where malicious code attempts to pass an infinite stream of bytes to the method. ## Examples - The following example demonstrates the `GetEntity` and methods. + The following example demonstrates the `GetEntity` and methods. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlUrlResolver/GetEntity/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/Classic WebData XmlUrlResolver.ResolveUri Example/VB/source.vb" id="Snippet1"::: diff --git a/xml/System.Xml/XmlValidatingReader.xml b/xml/System.Xml/XmlValidatingReader.xml index dd7199817e6..d5bd2280840 100644 --- a/xml/System.Xml/XmlValidatingReader.xml +++ b/xml/System.Xml/XmlValidatingReader.xml @@ -86,7 +86,7 @@ throws an on XML parse errors. After an exception is thrown the state of the reader is not predictable. For example, the reported node type may be different than the actual node type of the current node. Use the property to check whether a reader is in error state. > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -151,7 +151,7 @@ ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. All nodes returned from the given `XmlReader` are also returned from this validating reader, so there is no information loss in the process. New nodes not returned from the underlying reader may be added by this reader (for example, default attributes and the children of an entity reference). Any properties set on the given `XmlTextReader` also apply to this validating reader. For example, if the supplied reader had WhitespaceHandling.None set, this validating reader also ignores white space. @@ -213,7 +213,7 @@ ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This constructor parses the given string as a fragment of XML. If the XML fragment is an element or attribute, you can bypass the root level rules for well-formed XML documents. @@ -303,9 +303,9 @@ ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. - This constructor parses the given string as a fragment of XML. If the XML fragment is an element or attribute, you can bypass the root level rules for well-formed XML documents. This constructor can handle strings returned from . + This constructor parses the given string as a fragment of XML. If the XML fragment is an element or attribute, you can bypass the root level rules for well-formed XML documents. This constructor can handle strings returned from . The following table lists valid values for `fragType` and how the reader parses each of the different node types. @@ -374,7 +374,7 @@ ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This property is relevant to `Element`, `DocumentType`, and `XmlDeclaration` nodes only. (Other node types do not have attributes.) @@ -429,7 +429,7 @@ ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. A networked XML document is comprised of chunks of data aggregated by using various World Wide Web Consortium (W3C) standard inclusion mechanisms and therefore contains nodes that come from different places. document type definition (DTD) entities are an example of this, but this is not limited to DTDs. The base URI tells you where these nodes came from. If there is no base URI for the nodes being returned (for example, they were parsed from an in-memory string), String.Empty is returned. @@ -483,9 +483,9 @@ ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. - The binary content read methods include the , , , and methods. + The binary content read methods include the , , , and methods. ]]> @@ -538,7 +538,7 @@ ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -590,7 +590,7 @@ ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This method also releases any resources held while reading. If this reader was constructed by using an , this method also calls `Close` on the underlying reader. If this reader was constructed by using a stream, this method also calls `Close` on the underlying stream. @@ -646,7 +646,7 @@ ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -706,7 +706,7 @@ ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. When any external reference is read (such as expanding an entity in a document type definition (DTD) file or reading a schema file) the encoding property is set to the encoding value of the external reference. If encoding is not specified in the external reference, and there is no byte-order mark, this defaults to UTF-8. @@ -762,9 +762,9 @@ ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. - This property can be changed and takes effect after the next call. + This property can be changed and takes effect after the next call. When `EntityHandling` is set to `ExpandCharEntities`, attribute values are only partially normalized. The reader normalizes each individual text node independently from the content of adjacent entity reference nodes. @@ -841,7 +841,7 @@ ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -908,7 +908,7 @@ This method does not move the reader. > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -972,7 +972,7 @@ ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This method does not move the reader. @@ -1042,7 +1042,7 @@ ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. The following XML contains an attribute in a specific namespace: @@ -1120,7 +1120,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -1173,7 +1173,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. The following table lists node types that have a value to return. @@ -1241,7 +1241,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); This property applies only to an attribute node. > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -1294,7 +1294,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This property enables you to determine the difference between the following: @@ -1463,7 +1463,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This property is most commonly used for error reporting, but can be called at any time. The starting value for this property is 1. Combined with , a value of 1,1 indicates the start of the document. @@ -1519,7 +1519,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This property is most commonly used for error reporting, but can be called at any time. The starting value for this property is `1`. @@ -1587,7 +1587,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -1650,7 +1650,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. In the following XML string, if the reader is positioned on the `href` attribute, the prefix `a` is resolved by calling `reader.LookupNamespace("a", true)`. The returned string is `urn:456`. @@ -1725,7 +1725,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -1783,7 +1783,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. After calling this method, the , , and properties reflect the properties of that attribute. @@ -1852,7 +1852,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. After calling this method, the , , and properties reflect the properties of that attribute. @@ -1908,7 +1908,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. Use this method to return to an element after navigating through its attributes. This method moves the reader to one of the following node types: `Element`, `DocumentType`, or `XmlDeclaration`. @@ -1964,7 +1964,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -2018,9 +2018,9 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. - If the current node is an element node, this method is equivalent to . If `MoveToNextAttribute` returns `true`, the reader moves to the next attribute; otherwise, the position of the reader does not change. + If the current node is an element node, this method is equivalent to . If `MoveToNextAttribute` returns `true`, the reader moves to the next attribute; otherwise, the position of the reader does not change. ]]> @@ -2092,7 +2092,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -2145,7 +2145,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -2198,7 +2198,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to This property is relevant to `Element` and `Attribute` nodes only. > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -2251,7 +2251,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. All node and attribute names returned from are atomized by using the `NameTable`. When the same name is returned multiple times (for example, `Customer`), the same `String` object will be returned for that name. This makes it possible for you to write efficient code that does object comparisons on these strings instead of expensive string comparisons. @@ -2306,7 +2306,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This property never returns the following `XmlNodeType` types: `Document`, `DocumentFragment`, `Entity`, or `Notation`. @@ -2360,7 +2360,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -2413,7 +2413,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to This property applies only to an attribute node. > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -2467,7 +2467,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. When a reader is first created and initialized, there is no information available. You must call `Read` to read the first node. @@ -2527,9 +2527,9 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. - Use this method after calling to read through the text or entity reference nodes that make up the attribute value. The of the attribute value nodes is one plus the depth of the attribute node. The `Depth` increments and decrements by one when you step into and out of general entity references. + Use this method after calling to read through the text or entity reference nodes that make up the attribute value. The of the attribute value nodes is one plus the depth of the attribute node. The `Depth` increments and decrements by one when you step into and out of general entity references. ]]> @@ -2588,20 +2588,20 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This method streams the content, decodes the Base64 content, and returns the decoded binary bytes (for example, an inline Base64 encoded GIF image) into the buffer. This method can be called successively to read large streams of embedded text. For more information, see RFC 1521, "MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies". You can obtain RFCs from the [Request for Comments Web site](https://www.rfc-editor.org). > [!NOTE] -> You should not access any of the reader properties between calls to the method until the method returns the value 0. +> You should not access any of the reader properties between calls to the method until the method returns the value 0. This method has the following behavior: -- returns the value 0 when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node. +- returns the value 0 when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node. - If you ask for fewer, or the exact number, of bytes than are left in the stream, the reader remains in its current position. -- is not supported on the following XML node types: Element, XmlDeclaration, None, Document, DocumentType, Notation, Entity, and DocumentFragment. +- is not supported on the following XML node types: Element, XmlDeclaration, None, Document, DocumentType, Notation, Entity, and DocumentFragment. ]]> @@ -2666,20 +2666,20 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This method streams the content, decodes the BinHex content, and returns the decoded binary bytes (for example, an inline BinHex encoded GIF image) into the buffer. This method can be called successively to read large streams of embedded text. > [!NOTE] -> You should not access any of the reader properties between calls to the method until the method returns the value 0. +> You should not access any of the reader properties between calls to the method until the method returns the value 0. This method has the following behavior: -- returns the value 0 when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node. +- returns the value 0 when it has reached the end of the byte stream it was operating on. The reader is positioned on the first non-content node. - If you ask for fewer, or the exact number, of bytes than are left in the stream, the reader remains in its current position. -- is not supported on the following XML node types: Element, XmlDeclaration, None, Document, DocumentType, Notation, Entity, and DocumentFragment. +- is not supported on the following XML node types: Element, XmlDeclaration, None, Document, DocumentType, Notation, Entity, and DocumentFragment. ]]> @@ -2745,17 +2745,17 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This method reads the element content, decodes it using Base64 encoding, and returns the decoded binary bytes (for example, an inline Base64 encoded GIF image) into the buffer. For more information, see RFC 1521, "MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies". You can obtain RFCs from the [Request for Comments Web site](https://www.rfc-editor.org). This method can read only simple-content elements. The element can contain text, white space, significant white space, CDATA sections, comments, and processing instructions. It can also contain entity references, which are automatically expanded. The element cannot have child elements. - This method is very similar to the method except that it can be called only on element node types. + This method is very similar to the method except that it can be called only on element node types. If the `count` value is higher than the number of bytes in the document, or if it is equal to the number of bytes in the document, the reads all the remaining bytes in the document and returns the number of bytes read. The next method call returns a zero and moves the reader to the node following the . - If you call before all of the element content is consumed, the reader may behave as if the first content was consumed and then the method was called. This means that the reader will read all the text until the end element is encountered. It will then read the end tag node, read the next node, and then position itself on the next subsequent node. + If you call before all of the element content is consumed, the reader may behave as if the first content was consumed and then the method was called. This means that the reader will read all the text until the end element is encountered. It will then read the end tag node, read the next node, and then position itself on the next subsequent node. ]]> @@ -2821,17 +2821,17 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This method reads the element content, decodes it using BinHex encoding, and returns the decoded binary bytes (for example, an inline BinHex encoded GIF image) into the buffer. This method can read only simple-content elements. The element can contain text, white space, significant white space, CDATA sections, comments, and processing instructions. It can also contain entity references, which are automatically expanded. The element cannot have child elements. - This method is very similar to the method except that it can be called only on element node types. + This method is very similar to the method except that it can be called only on element node types. If the `count` value is higher than the number of bytes in the document, or if it is equal to the number of bytes in the document, the reads all the remaining bytes in the document and returns the number of bytes read. The next method call returns a zero and moves the reader to the node following the . - If you call before all of the element content is consumed, the reader may behave as if the first content was consumed and then the method was called. This means that the reader will read all the text until the end element is encountered. It will then read the end tag node, read the next node, and then position itself on the next subsequent node. + If you call before all of the element content is consumed, the reader may behave as if the first content was consumed and then the method was called. This means that the reader will read all the text until the end element is encountered. It will then read the end tag node, read the next node, and then position itself on the next subsequent node. ]]> @@ -2890,7 +2890,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This property allows the user to access properties specific to the supplied reader. It returns a typed `XmlReader`. The user should query for the type before casting. @@ -2946,7 +2946,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -3001,7 +3001,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to The text node can be either an element or an attribute text node. > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. If positioned on an element, `ReadString` concatenates all text, significant white space, white space, and CDATA section node types together and returns the concatenated data as the element content. The reader stops when any markup is encountered, including comments and processing instructions. This could occur in a mixed content model, or when an element end tag is read. @@ -3066,9 +3066,9 @@ The text node can be either an element or an attribute text node. ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. - For example, if the schema type is defined as `xsd:int`, the runtime type `int32` is returned for the object. This can be tested using the method and cast accordingly. The method always returns a type that is derived from the class. It never returns the type. + For example, if the schema type is defined as `xsd:int`, the runtime type `int32` is returned for the object. This can be tested using the method and cast accordingly. The method always returns a type that is derived from the class. It never returns the type. If the reader is positioned on an attribute, this method returns the runtime typed object, but does not change the position of the reader. If the reader is positioned on an element, `ReadTypedValue` reads any CDATA, text, white space, significant white space, and comment nodes, returns the runtime typed object and positions the reader on the end tag. Any types that do not have a direct mapping, for example `NMTOKENS`, are returned as strings. @@ -3076,7 +3076,7 @@ The text node can be either an element or an attribute text node. > If has been set to ValidationType.None, data type information is not provided from either schemas or document type definitions (DTDs). > [!CAUTION] -> After calling , `ReadTypedValue` will return `null`. +> After calling , `ReadTypedValue` will return `null`. ]]> @@ -3128,12 +3128,12 @@ The text node can be either an element or an attribute text node. ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. - If the reader is positioned on an `EntityReference` node (`XmlNodeType.EntityReference`), if is called after calling this method, the entity replacement text is parsed. After the entity replacement text is finished, an `EndEntity` node is returned to close the entity reference scope. + If the reader is positioned on an `EntityReference` node (`XmlNodeType.EntityReference`), if is called after calling this method, the entity replacement text is parsed. After the entity replacement text is finished, an `EndEntity` node is returned to close the entity reference scope. > [!NOTE] -> After calling this method, if the entity is part of an attribute value, you must call to step into the entity. +> After calling this method, if the entity is part of an attribute value, you must call to step into the entity. ]]> @@ -3187,13 +3187,13 @@ The text node can be either an element or an attribute text node. ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. The `XmlSchemaCollection` holds pre-loaded XML-Data Reduced (XDR) and XML Schema definition language (XSD) schemas. This property gives the reader access to the cache of schemas and allows it to validate without having to re-load schemas every time. The reader does not add anything to the `XmlSchemaCollection`. If the `XmlSchemaCollection` includes an XML schema (XSD) that contains `include` or `import` elements that reference other namespaces, the schemas for these other namespaces are loaded for validation purposes only. Unless these schemas were explicitly added to the schema collection, they will not be accessible using any of the collection methods or properties. For example, if the collection contains the schema file `a.xsd`, which contains a reference to the schema file `b.xsd`, you must add `b.xsd` to the schema collection before you can access it using any of the collection methods or properties. - When the `XmlSchemaCollection` is accessed using the `Schemas` property, the method uses the specified by the property. + When the `XmlSchemaCollection` is accessed using the `Schemas` property, the method uses the specified by the property. > [!NOTE] > The schemas must be added to the `XmlSchemaCollection` before the first `Read` call. @@ -3256,7 +3256,7 @@ The text node can be either an element or an attribute text node. ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. The user needs to test for the returned type. @@ -3272,7 +3272,7 @@ The text node can be either an element or an attribute text node. > If has been set to ValidationType.None, no data type information is provided from either schemas or DTDs. > [!CAUTION] -> After calling , SchemaType will return Null. +> After calling , SchemaType will return Null. ]]> @@ -3311,7 +3311,7 @@ The text node can be either an element or an attribute text node. > [!NOTE] > The class is obsolete in .NET Framework version 2.0. -> You can create a validating instance by using the class and the method. +> You can create a validating instance by using the class and the method. > For more information, see [Validating XML Data with XmlReader](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/hdf992b8(v=vs.100)). ]]> @@ -3559,9 +3559,9 @@ The text node can be either an element or an attribute text node. ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. - These events occur during and only if a of DTD, XDR, Schema, or Auto is specified. + These events occur during and only if a of DTD, XDR, Schema, or Auto is specified. If no event handler is provided, an is thrown on the first validation error (Severity is equal to XmlSeverityType.Error). @@ -3621,9 +3621,9 @@ The text node can be either an element or an attribute text node. ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. - This property must be set before the first call to . Setting this property to ValidationType.None creates a non-validating reader. + This property must be set before the first call to . Setting this property to ValidationType.None creates a non-validating reader. If external document type definitions (DTDs) or schemas are needed for validation, the is used. @@ -3702,7 +3702,7 @@ The text node can be either an element or an attribute text node. ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> @@ -3754,7 +3754,7 @@ The text node can be either an element or an attribute text node. ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. This property represents the xml:lang scope within which the current node resides. For example, here is an XML fragment with `xml:lang` set to U.S. English in the root element: @@ -3818,11 +3818,11 @@ The text node can be either an element or an attribute text node. ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. The `XmlResolver` is used to load any DTDs, entities, or schemas needed to complete the validation process. - This property can be set at any time and takes affect after the next call. If this property is set to `null`, the reader assumes the user is not interested in resolving external references. In this case, the reader only validates against internal resources, if the resource is present. + This property can be set at any time and takes affect after the next call. If this property is set to `null`, the reader assumes the user is not interested in resolving external references. In this case, the reader only validates against internal resources, if the resource is present. In version 1.1 of .NET Framework , if this property is not set, the trust level of the application determines the default behavior. @@ -3886,7 +3886,7 @@ The text node can be either an element or an attribute text node. ## Remarks > [!NOTE] -> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. +> The class is obsolete in .NET Framework 2.0. You can create a validating instance by using the class and the method. For more information, see the Remarks section of the reference page. ]]> diff --git a/xml/System.Xml/XmlWhitespace.xml b/xml/System.Xml/XmlWhitespace.xml index c5f7da4c2e0..3cef9c1710f 100644 --- a/xml/System.Xml/XmlWhitespace.xml +++ b/xml/System.Xml/XmlWhitespace.xml @@ -194,7 +194,7 @@ serves as a copy constructor for nodes. To see how this method behaves with other node types, see . + serves as a copy constructor for nodes. To see how this method behaves with other node types, see . The cloned node has no parent. returns `null`. @@ -345,7 +345,7 @@ ## Examples The following example adds a white space node to the document. - + :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlWhitespace/NodeType/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/Classic WebData XmlWhitespace.NodeType Example/VB/source.vb" id="Snippet1"::: diff --git a/xml/System.Xml/XmlWriter.xml b/xml/System.Xml/XmlWriter.xml index 18011935cf1..f4ff9d20106 100644 --- a/xml/System.Xml/XmlWriter.xml +++ b/xml/System.Xml/XmlWriter.xml @@ -196,7 +196,7 @@ Any elements or attributes left open are automatically closed. > [!NOTE] -> When you use the methods to output XML, the elements and attributes will not be written until you call the method. For example, if you are using the XmlWriter to populate an , until you close the , you will not be able to observe the written elements and attributes in the target document. +> When you use the methods to output XML, the elements and attributes will not be written until you call the method. For example, if you are using the XmlWriter to populate an , until you close the , you will not be able to observe the written elements and attributes in the target document. @@ -228,17 +228,17 @@ An method was called before a previous asy overloads include a `settings` parameter that accepts an object. You can use this object to: + Some of the overloads include a `settings` parameter that accepts an object. You can use this object to: - Specify which features you want supported on the created object. - Reuse the object to create multiple writer objects. The object is copied and marked read-only for each created writer. Changes to the settings on an instance do not affect existing writers with the same settings. Thus, you can use the same settings to create multiple writers with the same functionality. Or, you can modify the settings on an instance and create a new writer with a different set of features. -- Add features to an existing XML writer. The method can accept another object. The underlying object does not have to be an XML writer created by the static method. For example, you can specify a user-defined XML writer to add additional features to. +- Add features to an existing XML writer. The method can accept another object. The underlying object does not have to be an XML writer created by the static method. For example, you can specify a user-defined XML writer to add additional features to. -- Take full advantage of features such as better conformance checking and compliance to the [XML 1.0 recommendation](https://www.w3.org/TR/2006/REC-xml-20060816/) that are available only on objects created by the static method. +- Take full advantage of features such as better conformance checking and compliance to the [XML 1.0 recommendation](https://www.w3.org/TR/2006/REC-xml-20060816/) that are available only on objects created by the static method. - If you use a overload that doesn't accept an object, the following default writer settings are used: + If you use a overload that doesn't accept an object, the following default writer settings are used: |Setting|Default| |-------------|-------------| @@ -257,7 +257,7 @@ An method was called before a previous asy ||`true`| > [!NOTE] -> Although the .NET Framework includes the class, which is a concrete implementation of the class, we recommend that you create instances by using the method. +> Although the .NET Framework includes the class, which is a concrete implementation of the class, we recommend that you create instances by using the method. ]]> @@ -341,7 +341,7 @@ An method was called before a previous asy Also, XmlWriter always writes a Byte Order Mark (BOM) to the underlying data stream; however, some streams must not have a BOM. To omit the BOM, create a new object and set the Encoding property to be a new object with the Boolean value in the constructor set to false. ## Examples - The following example writes an XML fragment to a memory stream. (It uses the overload, which also configures the settings on the new XML writer instance.) + The following example writes an XML fragment to a memory stream. (It uses the overload, which also configures the settings on the new XML writer instance.) :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlWriter/Create/writestream2.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlWriterSettings.CloseOutput/VB/writestream2.vb" id="Snippet1"::: @@ -659,7 +659,7 @@ An method was called before a previous asy object. The underlying object can be an object created by the method, or an object created using the implementation. + This method allows you add features to an underlying object. The underlying object can be an object created by the method, or an object created using the implementation. When you use this overload, an object with default settings is used to create the XML writer. @@ -1026,7 +1026,7 @@ An method was called before a previous asy object. The underlying object can be an object created by the method, or an object created using the implementation. + This method allows you add additional features to an underlying object. The underlying object can be an object created by the method, or an object created using the implementation. ]]> @@ -1260,9 +1260,9 @@ An method was called before a previous asy when you want to write more to the underlying stream without losing what is still in the buffer. + This is called instead of when you want to write more to the underlying stream without losing what is still in the buffer. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -1322,7 +1322,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -1562,7 +1562,7 @@ This member may behave differently when it is used in a Portable Class Library p If this method is called using , to ensure well-formed XML any content (which has been expanded from the entities) that could result in an invalid document is replaced when written. For example, if an attribute includes an `>` entity that has been expanded, to ensure a well-formed document the expanded > is replaced when written out with `>`. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -1641,7 +1641,7 @@ This member may behave differently when it is used in a Portable Class Library p , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -1670,7 +1670,7 @@ An asynchronous method was called without . + For the asynchronous version of this method, see . ]]> @@ -1743,7 +1743,7 @@ An asynchronous method was called without - If writing an `xml:lang` attribute, the writer does not verify that the attribute value is valid according to the W3C XML 1.0 recommendation. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -1840,12 +1840,12 @@ An method was called before a previous asy - If writing an `xml:lang` attribute, the writer does not verify that the attribute value is valid according to the W3C XML 1.0 recommendation. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ## Examples - The following example uses the method to write a namespace declaration. + The following example uses the method to write a namespace declaration. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlWriter/WriteAttributeString/writeattrstring.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlWriter.WriteAttributeString/VB/writeattrstring.vb" id="Snippet1"::: @@ -1933,12 +1933,12 @@ An method was called before a previous asy - If writing an `xml:lang` attribute, the writer does not verify that the attribute value is valid according to the W3C XML 1.0 recommendation. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ## Examples - The following example uses the method to write a namespace declaration. + The following example uses the method to write a namespace declaration. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlWriter/WriteAttributeString/writeattrstring.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlWriter.WriteAttributeString/VB/writeattrstring.vb" id="Snippet1"::: @@ -2022,7 +2022,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -2092,12 +2092,12 @@ An asynchronous method was called without ## Remarks For example, the byte buffer may contain the binary contents of a GIF image. This clearly would not be valid XML. The `Base64` encoding is designed to represent arbitrary byte sequences in a text form comprised of the 65 US-ASCII characters ([A-Za-z0-9+/=]) where each character encodes 6 bits of the binary data. For more information, see Requests for Comments (RFC) 1521 located on the [Request for Comments Web site](https://www.rfc-editor.org). - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ## Examples - The following example uses the method to write `Base64` data. The `Base64` data is embedded within an `` element. + The following example uses the method to write `Base64` data. The `Base64` data is embedded within an `` element. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlReader/ReadElementContentAsBase64/readBinary.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlReader_Read_Write_Binary/VB/readBinary.vb" id="Snippet3"::: @@ -2167,7 +2167,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -2239,12 +2239,12 @@ An asynchronous method was called without . + For the asynchronous version of this method, see . ## Examples - The following example uses the method to write `BinHex` data. The `BinHex` data is embedded within an `` element. + The following example uses the method to write `BinHex` data. The `BinHex` data is embedded within an `` element. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlReader/ReadElementContentAsBase64/readBinary.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlReader_Read_Write_Binary/VB/readBinary.vb" id="Snippet1"::: @@ -2317,7 +2317,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -2384,7 +2384,7 @@ An asynchronous method was called without ## Remarks If `text` is either `null` or `String.Empty`, this method writes an empty CDATA block, for example \. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -2456,7 +2456,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -2522,12 +2522,12 @@ An asynchronous method was called without ## Remarks This method writes the Unicode character in hexadecimal character entity reference format. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ## Examples - See for an example using this method. + See for an example using this method. ]]> @@ -2583,7 +2583,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -2655,7 +2655,7 @@ An asynchronous method was called without Special handling must be done to ensure the `WriteChars` method does not split surrogate pair characters across multiple buffer writes. The XML specification defines the valid ranges for surrogate pairs. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -2728,7 +2728,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -2795,9 +2795,9 @@ An asynchronous method was called without ## Remarks If `text` is either `null` or `String.Empty`, this method writes a comment with no data content, for example \. - If `text` contains an invalid sequence of two dashes "--" the can either throw an ( objects) or insert a space between the dashes "- -" so that the text is a valid XML comment ( objects created by the method). + If `text` contains an invalid sequence of two dashes "--" the can either throw an ( objects) or insert a space between the dashes "- -" so that the text is a valid XML comment ( objects created by the method). - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -2869,7 +2869,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -2950,9 +2950,9 @@ An asynchronous method was called without This method does not check for invalid characters in `pubid`, `sysid` or `subset`. It also does not check that the internal subset is well-formed. > [!IMPORTANT] -> The does not validate the data that is passed to the method. You should not pass arbitrary data to this method. +> The does not validate the data that is passed to the method. You should not pass arbitrary data to this method. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -3034,7 +3034,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -3063,7 +3063,7 @@ An asynchronous method was called without . + For the asynchronous version of this method, see . ]]> @@ -3134,7 +3134,7 @@ An asynchronous method was called without . + For the asynchronous version of this method, see . @@ -3216,7 +3216,7 @@ An asynchronous method was called without . + For the asynchronous version of this method, see . @@ -3299,7 +3299,7 @@ An asynchronous method was called without . + For the asynchronous version of this method, see . ]]> @@ -3387,7 +3387,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -3450,12 +3450,12 @@ An asynchronous method was called without ## Remarks If you call `WriteStartAttribute`, you can close the attribute with this method. - You can also close the attribute by calling `WriteStartAttribute` again, calling , or calling . + You can also close the attribute by calling `WriteStartAttribute` again, calling , or calling . > [!NOTE] -> When you use the methods to output XML, the elements and attributes will not be written until you call the method. For example, if you are using the XmlWriter to populate an , until you close the , you will not be able to observe the written elements and attributes in the target document. +> When you use the methods to output XML, the elements and attributes will not be written until you call the method. For example, if you are using the XmlWriter to populate an , until you close the , you will not be able to observe the written elements and attributes in the target document. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ]]> @@ -3507,7 +3507,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -3570,9 +3570,9 @@ An asynchronous method was called without ## Remarks > [!NOTE] -> When you use the methods to output XML, the elements and attributes will not be written until you call the method. For example, if you are using the XmlWriter to populate an , until you close the , you will not be able to observe the written elements and attributes in the target document. +> When you use the methods to output XML, the elements and attributes will not be written until you call the method. For example, if you are using the XmlWriter to populate an , until you close the , you will not be able to observe the written elements and attributes in the target document. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -3633,7 +3633,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -3697,14 +3697,14 @@ An asynchronous method was called without If the element contains no content, a short end tag "/>" is written; otherwise, a full end tag is written. > [!NOTE] -> When you use the methods to output XML, the elements and attributes will not be written until you call the method. For example, if you are using the XmlWriter to populate an , until you close the , you will not be able to observe the written elements and attributes in the target document. +> When you use the methods to output XML, the elements and attributes will not be written until you call the method. For example, if you are using the XmlWriter to populate an , until you close the , you will not be able to observe the written elements and attributes in the target document. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ## Examples - The following example uses the and the methods. + The following example uses the and the methods. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlWriter/WriteEndElement/writerfullend_v2.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlWriter.WriteFullEndElement/VB/writerfullend_v2.vb" id="Snippet1"::: @@ -3763,7 +3763,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -3827,7 +3827,7 @@ An asynchronous method was called without . + For the asynchronous version of this method, see . @@ -3892,7 +3892,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -3955,12 +3955,12 @@ An asynchronous method was called without ## Remarks This method always writes the full end tag. This is useful when dealing with elements that must include a full end tag. For example, browsers expect HTML script blocks to be closed with "\". - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ## Examples - The following example uses the and the methods. + The following example uses the and the methods. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlWriter/WriteEndElement/writerfullend_v2.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlWriter.WriteFullEndElement/VB/writerfullend_v2.vb" id="Snippet1"::: @@ -4015,7 +4015,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -4085,7 +4085,7 @@ An asynchronous method was called without ## Remarks If is set to `true`, `WriteName` also checks that the name is also valid according to the W3C Namespaces in XML recommendation. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ]]> @@ -4142,7 +4142,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -4210,7 +4210,7 @@ An asynchronous method was called without . + For the asynchronous version of this method, see . ]]> @@ -4267,7 +4267,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -4296,7 +4296,7 @@ An asynchronous method was called without . + For the asynchronous version of this method, see . ]]> @@ -4360,7 +4360,7 @@ An asynchronous method was called without |--------------|------------------------| |`None`|Writes out all the nodes irrespective of type. That is, the writer consumes the and writes out all the nodes read including attributes, processing instructions, comments, and so on.

This situation occurs when the is in an initial state. (The property returns `ReaderState.Initial`).| |`Element`|Writes out the element node and any attribute nodes.| -|`Attribute`|No operation. Use or instead.| +|`Attribute`|No operation. Use or instead.| |`Text`|Writes out the text node.| |`CDATA`|Writes out the CDATA section node.| |`EntityReference`|Writes out the entity reference node.| @@ -4398,7 +4398,7 @@ while (!reader.EOF){ If the reader is configured to return white space and the writer has is configured to indent output, `WriteNode` may produce strange output. You will essentially be getting double formatting. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -4475,20 +4475,20 @@ while (!reader.EOF){ |-------------------|------------------------| |`Root`|Writes out all the nodes irrespective of type. That is, the writer consumes the and writes out all the nodes from the root node (including attributes, processing instructions, comments and so on.)| |`Element`|Writes out the element node and any attribute nodes.| -|`Attribute`|No operation. Use or instead.| +|`Attribute`|No operation. Use or instead.| |`Text`|Writes out the text node.| -|`Namespace`|No operation. Use the or method to write the namespace declaration.| +|`Namespace`|No operation. Use the or method to write the namespace declaration.| |`ProcessingInstruction`|Writes out the processing instruction node.| |`Comment`|Writes out the comment node.| |`SignificantWhitespace`|Writes out the significant white space node.| |`Whitespace`|Writes out the white space node.| - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ## Examples - The following example uses the method to copy the first book node from a document and write it to the console. + The following example uses the method to copy the first book node from a document and write it to the console. :::code language="csharp" source="~/snippets/csharp/System.Xml/XmlWriter/WriteNode/XmlWriteNode_nav.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/XmlWriteNode_nav/VB/XmlWriteNode_nav.vb" id="Snippet1"::: @@ -4518,7 +4518,7 @@ while (!reader.EOF){ , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. ]]> @@ -4577,7 +4577,7 @@ while (!reader.EOF){ , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -4646,7 +4646,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -4720,7 +4720,7 @@ An asynchronous method was called without ). This could result in the encoding attribute being incorrectly written. For example, the following C# code would result in an invalid XML document because the default encoding is UTF-8. + This method can be used to write the XML declaration (rather than ). This could result in the encoding attribute being incorrectly written. For example, the following C# code would result in an invalid XML document because the default encoding is UTF-8. ```csharp XmlWriter writer = XmlWriter.Create("output.xml"); @@ -4731,9 +4731,9 @@ writer.Close(); If `text` is either `null` or `String.Empty`, this method writes a `ProcessingInstruction` with no data content, for example \. - If text contains an invalid sequence of "?>", the can either throw an ( objects) or insert a space "? >" to avoid writing invalid XML ( objects created by the method). + If text contains an invalid sequence of "?>", the can either throw an ( objects) or insert a space "? >" to avoid writing invalid XML ( objects created by the method). - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -4811,7 +4811,7 @@ writer.Close(); , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -4894,9 +4894,9 @@ An asynchronous method was called without When writing attribute values, this method generates a prefix if `ns` is not found. When writing element content, it throws an exception if `ns` is not found. > [!NOTE] -> If a class derived from the does not override this method `localName` is not checked to be a valid W3C XML name. In such case, before calling this method, the validity of the string can be checked by method. +> If a class derived from the does not override this method `localName` is not checked to be a valid W3C XML name. In such case, before calling this method, the validity of the string can be checked by method. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -4985,7 +4985,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -5014,7 +5014,7 @@ An asynchronous method was called without . + For the asynchronous version of this method, see . ]]> @@ -5072,14 +5072,14 @@ An asynchronous method was called without This method does not escape special characters. > [!IMPORTANT] -> The does not validate the data that is passed to the method. You should not pass arbitrary data to this method. +> The does not validate the data that is passed to the method. You should not pass arbitrary data to this method. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ## Examples - See for an example using this method. + See for an example using this method. ]]> @@ -5144,9 +5144,9 @@ An asynchronous method was called without This method does not escape special characters. > [!IMPORTANT] -> The does not validate the data that is passed to the method. You should not pass arbitrary data to this method. +> The does not validate the data that is passed to the method. You should not pass arbitrary data to this method. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ]]> @@ -5175,7 +5175,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. ]]> @@ -5231,7 +5231,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -5298,7 +5298,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -5327,7 +5327,7 @@ An asynchronous method was called without . + For the asynchronous version of this method, see . ]]> @@ -5389,7 +5389,7 @@ An asynchronous method was called without ## Remarks This method enables you to write a value using multiple Write methods. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ]]> @@ -5466,14 +5466,14 @@ An method was called before a previous asy that allows you to write an attribute value using multiple write methods, such as , , and so on. + This is a more advanced version of that allows you to write an attribute value using multiple write methods, such as , , and so on. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ## Examples - See for an example using this method. + See for an example using this method. ]]> @@ -5545,7 +5545,7 @@ An method was called before a previous asy ## Remarks This method enables you to write a value using multiple Write methods. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ]]> @@ -5620,7 +5620,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -5649,7 +5649,7 @@ An asynchronous method was called without . + For the asynchronous version of this method, see . ]]> @@ -5705,9 +5705,9 @@ An asynchronous method was called without When `WriteStartDocument` is called the writer validates that what you are writing is a well-formed XML document. For example, it checks that the XML declaration is the first node, that one and only one root-level element exists, and so on. If this method is not called, the writer assumes an XML fragment is being written and applies no root level rules. - If `WriteStartDocument` has been called and then the method is used to create another XML declaration, an exception will be thrown. + If `WriteStartDocument` has been called and then the method is used to create another XML declaration, an exception will be thrown. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ]]> @@ -5771,9 +5771,9 @@ An method was called before a previous asy When `WriteStartDocument` is called, the writer validates that what you are writing is a well-formed XML document. For example, it checks that the XML declaration is the first node, that one and only one root-level element exists, and so on. If this method is not called, the writer assumes an XML fragment is being written and applies no root level rules. - If `WriteStartDocument` has been called and then the method is used to create another XML declaration, an exception will be thrown. + If `WriteStartDocument` has been called and then the method is used to create another XML declaration, an exception will be thrown. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ]]> @@ -5798,7 +5798,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. ]]> @@ -5851,7 +5851,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -5914,7 +5914,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -5943,7 +5943,7 @@ An asynchronous method was called without . + For the asynchronous version of this method, see . ]]> @@ -6004,7 +6004,7 @@ An asynchronous method was called without . + For the asynchronous version of this method, see . @@ -6089,7 +6089,7 @@ An method was called before a previous asy , , or `WriteStartElement` for child elements. You can close the element with either or . For example, the following C# code: + After calling this method you can either write attributes, or create content using , , or `WriteStartElement` for child elements. You can close the element with either or . For example, the following C# code: ```csharp writer.WriteStartElement("item",null); @@ -6103,7 +6103,7 @@ writer.WriteEndElement(); some text ``` - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ]]> @@ -6176,7 +6176,7 @@ An method was called before a previous asy . + For the asynchronous version of this method, see . @@ -6263,7 +6263,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -6378,7 +6378,7 @@ An asynchronous method was called without - The characters `&`, `<`, and `>` are replaced with `&`, `<`, and `>`, respectively. -- The default behavior of an created using is to throw an when attempting to write character values in the range 0x-0x1F (excluding white space characters 0x9, 0xA, and 0xD). These invalid XML characters can be written by creating the with the property set to `false`. Doing so will result in the characters being replaced with numeric character entities (&\#0; through �x1F). Additionally, an created with the `new` operator will replace the invalid characters with numeric character entities by default. +- The default behavior of an created using is to throw an when attempting to write character values in the range 0x-0x1F (excluding white space characters 0x9, 0xA, and 0xD). These invalid XML characters can be written by creating the with the property set to `false`. Doing so will result in the characters being replaced with numeric character entities (&\#0; through �x1F). Additionally, an created with the `new` operator will replace the invalid characters with numeric character entities by default. **Note** Microsoft does not encourage the practice of writing invalid XML characters, since many applications that consume XML are not designed to handle invalid characters. @@ -6392,7 +6392,7 @@ test<item>test If `text` is either `null` or `String.Empty`, this method writes a text node with no data content. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . @@ -6464,7 +6464,7 @@ test<item>test , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -6538,7 +6538,7 @@ An asynchronous method was called without For more information regarding surrogates or characters, refer to section 3.7 of the Unicode 3.0/Unicode 2.0 standard located at , or [section 2.2 of the W3C XML 1.0 Recommendation](https://www.w3.org/TR/REC-xml#charsets). - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ]]> @@ -6596,7 +6596,7 @@ An asynchronous method was called without , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . @@ -6625,9 +6625,9 @@ An asynchronous method was called without method accepts common language runtime (CLR) simple-typed values, converts them to their string representations according to the XML schema definition language (XSD) data type conversion rules, and writes them out by using the method. This enables you to pipeline simple-type values with minimal reparsing overhead when passing data between , , and objects. This ability is also useful when dealing with CLR simple-types and an instance. You can call the method to write the typed value instead of using the methods in the class to convert the typed data to a string value before writing it out. + The method accepts common language runtime (CLR) simple-typed values, converts them to their string representations according to the XML schema definition language (XSD) data type conversion rules, and writes them out by using the method. This enables you to pipeline simple-type values with minimal reparsing overhead when passing data between , , and objects. This ability is also useful when dealing with CLR simple-types and an instance. You can call the method to write the typed value instead of using the methods in the class to convert the typed data to a string value before writing it out. - For asynchronous operations, convert the return value of to a string and use the method. + For asynchronous operations, convert the return value of to a string and use the method. The following table shows the default XSD data types that correspond to CLR types. @@ -6650,9 +6650,9 @@ An asynchronous method was called without ||xsd:string| ||xsd:base64Binary| - **These types are not CLS-compliant. They do not have corresponding methods. + **These types are not CLS-compliant. They do not have corresponding methods. - If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. + If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. ]]> @@ -6708,13 +6708,13 @@ An asynchronous method was called without ## Remarks This method takes the common language runtime object and converts the input value to the desired output type using the XML Schema definition language (XSD) data type conversion rules. - When the method is called, the converts the value to its string representations according to the XML Schema (XSD) data type rules and writes it out using the method. + When the method is called, the converts the value to its string representations according to the XML Schema (XSD) data type rules and writes it out using the method. - If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. Pass an array type to the overload to write out an array of distinct values. + If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. Pass an array type to the overload to write out an array of distinct values. If this method is called on an instance that outputs text-only, the typed value is serialized to text. - For asynchronous operations, convert the return value of this method to a string and use the method. + For asynchronous operations, convert the return value of this method to a string and use the method. ]]> @@ -6770,13 +6770,13 @@ An asynchronous method was called without ## Remarks This method takes the common language runtime object and converts the input value to the desired output type using the XML Schema definition language (XSD) data type conversion rules. - When the method is called, the converts the value to its string representations according to the XML Schema (XSD) data type rules and writes it out using the method. + When the method is called, the converts the value to its string representations according to the XML Schema (XSD) data type rules and writes it out using the method. - If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. Pass an array type to the overload to write out an array of distinct values. + If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. Pass an array type to the overload to write out an array of distinct values. If this method is called on an instance that outputs text-only, the typed value is serialized to text. - For asynchronous operations, convert the return value of this method to a string and use the method. + For asynchronous operations, convert the return value of this method to a string and use the method. @@ -6839,7 +6839,7 @@ An asynchronous method was called without method. + For asynchronous operations, convert the return value of this method to a string and use the method. ]]> @@ -6896,13 +6896,13 @@ An asynchronous method was called without ## Remarks This method takes the common language runtime object and converts the input value to the desired output type using the XML Schema definition language (XSD) data type conversion rules. - When the method is called, the converts the value to its string representations according to the XML Schema (XSD) data type rules and writes it out using the method. + When the method is called, the converts the value to its string representations according to the XML Schema (XSD) data type rules and writes it out using the method. - If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. Pass an array type to the overload to write out an array of distinct values. + If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. Pass an array type to the overload to write out an array of distinct values. If this method is called on an instance that outputs text-only, the typed value is serialized to text. - For asynchronous operations, convert the return value of this method to a string and use the method. + For asynchronous operations, convert the return value of this method to a string and use the method. ]]> @@ -6960,13 +6960,13 @@ An asynchronous method was called without ## Remarks This method takes the common language runtime object and converts the input value to the desired output type using the XML Schema definition language (XSD) data type conversion rules. - When the method is called, the converts the value to its string representations according to the XML Schema (XSD) data type rules and writes it out using the method. + When the method is called, the converts the value to its string representations according to the XML Schema (XSD) data type rules and writes it out using the method. - If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. Pass an array type to the overload to write out an array of distinct values. + If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. Pass an array type to the overload to write out an array of distinct values. If this method is called on an instance that outputs text-only, the typed value is serialized to text. - For asynchronous operations, convert the return value of this method to a string and use the method. + For asynchronous operations, convert the return value of this method to a string and use the method. @@ -7032,13 +7032,13 @@ An asynchronous method was called without ## Remarks This method takes the common language runtime object and converts the input value to the desired output type using the XML Schema definition language (XSD) data type conversion rules. - When the method is called, the converts the value to its string representations according to the XML Schema (XSD) data type rules and writes it out using the method. + When the method is called, the converts the value to its string representations according to the XML Schema (XSD) data type rules and writes it out using the method. - If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. Pass an array type to the overload to write out an array of distinct values. + If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. Pass an array type to the overload to write out an array of distinct values. If this method is called on an instance that outputs text-only, the typed value is serialized to text. - For asynchronous operations, convert the return value of this method to a string and use the method. + For asynchronous operations, convert the return value of this method to a string and use the method. ]]> @@ -7096,13 +7096,13 @@ An asynchronous method was called without ## Remarks This method takes the common language runtime object and converts the input value to the desired output type using the XML Schema definition language (XSD) data type conversion rules. - When the method is called, the converts the value to its string representations according to the XML Schema (XSD) data type rules and writes it out using the method. + When the method is called, the converts the value to its string representations according to the XML Schema (XSD) data type rules and writes it out using the method. - If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. Pass an array type to the overload to write out an array of distinct values. + If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. Pass an array type to the overload to write out an array of distinct values. If this method is called on an instance that outputs text-only, the typed value is serialized to text. - For asynchronous operations, convert the return value of this method to a string and use the method. + For asynchronous operations, convert the return value of this method to a string and use the method. ]]> @@ -7162,11 +7162,11 @@ An asynchronous method was called without ## Remarks This method takes the common language runtime (CLR) object and converts the input value to the desired output type using the XML Schema definition language (XSD) data type conversion rules. - If the CLR object is a list type such as , , or , it is treated as an array of the value type. The converts the value to its string representations according to the XML Schema (XSD) data type rules and writes it out using the method. + If the CLR object is a list type such as , , or , it is treated as an array of the value type. The converts the value to its string representations according to the XML Schema (XSD) data type rules and writes it out using the method. If this method is called on an instance that outputs text-only, the typed value is serialized to text. - For asynchronous operations, convert the return value of this method to a string and use the method. + For asynchronous operations, convert the return value of this method to a string and use the method. ]]> @@ -7229,13 +7229,13 @@ An method was called before a previous asy ## Remarks This method takes the common language runtime object and converts the input value to the desired output type using the XML Schema definition language (XSD) data type conversion rules. - When the method is called, the converts the value to its string representations according to the XML Schema (XSD) data type rules and writes it out using the method. + When the method is called, the converts the value to its string representations according to the XML Schema (XSD) data type rules and writes it out using the method. - If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. Pass an array type to the overload to write out an array of distinct values. + If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. Pass an array type to the overload to write out an array of distinct values. If this method is called on an instance that outputs text-only, the typed value is serialized to text. - For asynchronous operations, convert the return value of this method to a string and use the method. + For asynchronous operations, convert the return value of this method to a string and use the method. ]]> @@ -7294,11 +7294,11 @@ An method was called before a previous asy ## Remarks This method takes the common language runtime object and converts the input value to the desired output type using the XML Schema definition language (XSD) data type conversion rules. - If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. Pass an array type to the overload to write out an array of distinct values. + If is called multiple times in succession, the values are not delimited by a space. You must call between calls to to insert white space. Pass an array type to the overload to write out an array of distinct values. If this method is called on an instance that outputs text-only, the typed value is serialized to text. - For asynchronous operations, use the method. + For asynchronous operations, use the method. ]]> @@ -7358,7 +7358,7 @@ An method was called before a previous asy ## Remarks This method is used to manually format your document. - For the asynchronous version of this method, see . + For the asynchronous version of this method, see . ]]> @@ -7422,7 +7422,7 @@ An method was called before a previous asy , with the same functionality. To use this method, you must set the flag to `true`. + This is the asynchronous version of , with the same functionality. To use this method, you must set the flag to `true`. This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as , are still thrown synchronously. For the stored exceptions, see the exceptions thrown by . diff --git a/xml/System.Xml/XmlWriterSettings.xml b/xml/System.Xml/XmlWriterSettings.xml index 3c314d647f7..4d8bb0a9d6d 100644 --- a/xml/System.Xml/XmlWriterSettings.xml +++ b/xml/System.Xml/XmlWriterSettings.xml @@ -58,10 +58,10 @@ method is the preferred mechanism for obtaining instances. The method uses the class to specify which features to implement in the object that is created. + The method is the preferred mechanism for obtaining instances. The method uses the class to specify which features to implement in the object that is created. > [!NOTE] -> If you're using the object with the method, you should use the property to obtain an object with the correct settings. This ensures that the created object has the correct output settings. +> If you're using the object with the method, you should use the property to obtain an object with the correct settings. This ensures that the created object has the correct output settings. The class provides properties that control data conformance and output format. @@ -71,7 +71,7 @@ |--------------|---------------|-----------|-------------| ||Whether to check that characters are in the legal XML character set, as defined by W3C.|`true` or `false`|`true`| ||Whether to check that output is a well-formed XML 1.0 document or fragment.| (document-level), (fragment-level), or (auto-detection)| (document-level conformance)| -||Whether to add closing tags to all unclosed elements when the method is called.|`true` or `false`|`true`| +||Whether to add closing tags to all unclosed elements when the method is called.|`true` or `false`|`true`| To specify output format, use these properties: @@ -224,7 +224,7 @@ ## Remarks You must set this value to `true` when you create a new instance if you want to use asynchronous methods on that instance. After the instance is created, the property is read-only. The default value of this property is `false`. - This flag is ignored by the overload. This means that if you create a new based on an existing , the async behavior depends on the input , and you cannot use the flag to change the async behavior. + This flag is ignored by the overload. This means that if you create a new based on an existing , the async behavior depends on the input , and you cannot use the flag to change the async behavior. ]]> @@ -469,28 +469,28 @@ |-------------|-----------------| ||Ensures that the XML output conforms to the [rules for a well-formed XML 1.0 document](https://www.w3.org/TR/REC-xml/#sec-well-formed) and can be processed by any conforming processor.

The document conformance checks include most of the fragment-level checks and also ensure the following:

- The top-level item doesn't have any nodes other than XML Declaration, DTD, element, comment, white space, or processing instruction.
- The XML data has one and only one top-level element node.

The XML writer doesn't parse DTD information that is written. The user is responsible for ensuring that the DTD is well-formed.| ||Ensures that the XML output conforms to the [rules for a well-formed XML 1.0 document fragment](https://www.w3.org/TR/REC-xml/#wf-entities).

This setting accepts XML data that has multiple root elements or text nodes at the top level. This level of checking ensures that any processor can consume the stream being read as an XML 1.0 external parsed entity.

DTD information isn't allowed in document fragments.| -||Specifies that the XML writer should determine the level of conformance checking based on the incoming data. This setting can be useful when you don't know whether the generated XML will be a well-formed XML document or a fragment.

Document conformance checking is applied in the following cases:

- If the method is called.
- If DTD information is written.

Fragment conformance checking is applied if the XML data contains one of these:

- Text, CDATA, or EntityReference node at the root level.
- More than one element at the root level.
- No element at the root level.

An is thrown if there is a conflict, such as when you try to write a text node and a DTD at the root level.

If you are wrapping another object, the outer object doesn't do any additional conformance checking; this is left to the underlying object.| +||Specifies that the XML writer should determine the level of conformance checking based on the incoming data. This setting can be useful when you don't know whether the generated XML will be a well-formed XML document or a fragment.

Document conformance checking is applied in the following cases:

- If the method is called.
- If DTD information is written.

Fragment conformance checking is applied if the XML data contains one of these:

- Text, CDATA, or EntityReference node at the root level.
- More than one element at the root level.
- No element at the root level.

An is thrown if there is a conflict, such as when you try to write a text node and a DTD at the root level.

If you are wrapping another object, the outer object doesn't do any additional conformance checking; this is left to the underlying object.| If the XML writer detects any information that would violate the specified level of conformance, it throws an exception. In some cases, the XML writer automatically corrects the conformance error. For example, the writer closes an unclosed attribute without throwing an exception. The following table shows how various conformance violations are handled in each setting. |Condition|||| |---------------|---------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| |DTD information is found.|Not a violation for this setting. However, the XML writer doesn't check the DTD; the user must ensure that the DTD is well-formed.| is thrown.|Document conformance checking is applied.| -| is called.|Not considered a violation for this setting.| is thrown.|Document conformance checking is applied.| -| is called multiple times.| is thrown.| is thrown.| is thrown.| +| is called.|Not considered a violation for this setting.| is thrown.|Document conformance checking is applied.| +| is called multiple times.| is thrown.| is thrown.| is thrown.| |A text value appears at the top level (not below an element or attribute node).| is thrown.|Not considered a violation.|Fragment conformance checking is applied.| |Multiple elements or no elements appear at the top level.| is thrown.|Not considered a violation.|Fragment conformance checking is applied.| |Top-level item is white space.|Not considered a violation.|Not considered a violation.|Not considered a violation.| -| isn't called to end an attribute node.|Fixed by XML writer.|Fixed by XML writer.|Fixed by XML writer.| -|The XML writer is in an improperly nested state (for example, a call is followed by a ).| is thrown.| is thrown.| is thrown.| +| isn't called to end an attribute node.|Fixed by XML writer.|Fixed by XML writer.|Fixed by XML writer.| +|The XML writer is in an improperly nested state (for example, a call is followed by a ).| is thrown.| is thrown.| is thrown.| |Top-level item is an attribute.| is thrown.| is thrown.| is thrown.| |Multiple, contiguous text nodes are found.|Not considered a violation, but it's the responsibility of the user to concatenate the text nodes.|Not considered a violation, but it's the responsibility of the user to concatenate the text nodes.|Not considered a violation, but it's the responsibility of the user to concatenate the text nodes.| |The same namespace prefix is declared twice in an element.|The XML writer generates a new prefix for the second namespace.|The XML writer generates a new prefix for the second namespace.|The XML writer generates a new prefix for the second namespace.| -| specifies a prefix and a namespace that isn't declared within that scope, or the prefix is associated with a different namespace.|The XML writer writes the necessary namespace node.|The XML writer writes the necessary namespace node.|The XML writer writes the necessary namespace node.| -| specifies a prefix and a namespace that isn't declared within that scope.|The XML writer writes the necessary namespace node.|The XML writer writes the necessary namespace node.|The XML writer writes the necessary namespace node.| -| specifies a prefix and a namespace, but the prefix is associated with a different in-scope namespace.|The XML writer ignores the specified prefix and either looks up the correct prefix or generates a new prefix.|The XML writer ignores the specified prefix and either looks up the correct prefix or generates a new prefix.|The XML writer ignores the specified prefix and either looks up the correct prefix or generates a new prefix.| -| is used to write element content by using a namespace that doesn't exist within the scope.| is thrown.| is thrown.| is thrown.| -| is used to write attribute content by using a namespace that doesn't exist within the scope.|The XML writer writes the necessary namespace declaration.|The XML writer writes the necessary namespace declaration.|The XML writer writes the necessary namespace declaration.| +| specifies a prefix and a namespace that isn't declared within that scope, or the prefix is associated with a different namespace.|The XML writer writes the necessary namespace node.|The XML writer writes the necessary namespace node.|The XML writer writes the necessary namespace node.| +| specifies a prefix and a namespace that isn't declared within that scope.|The XML writer writes the necessary namespace node.|The XML writer writes the necessary namespace node.|The XML writer writes the necessary namespace node.| +| specifies a prefix and a namespace, but the prefix is associated with a different in-scope namespace.|The XML writer ignores the specified prefix and either looks up the correct prefix or generates a new prefix.|The XML writer ignores the specified prefix and either looks up the correct prefix or generates a new prefix.|The XML writer ignores the specified prefix and either looks up the correct prefix or generates a new prefix.| +| is used to write element content by using a namespace that doesn't exist within the scope.| is thrown.| is thrown.| is thrown.| +| is used to write attribute content by using a namespace that doesn't exist within the scope.|The XML writer writes the necessary namespace declaration.|The XML writer writes the necessary namespace declaration.|The XML writer writes the necessary namespace declaration.| |The `xml:space` attribute doesn't contain a valid value.| is thrown.| is thrown.| is thrown.| |An invalid name is encountered.| is thrown.| is thrown.| is thrown.| |The `xml` prefix isn't matched to a URI.|The XML writer doesn't check for this type of violation.|The XML writer doesn't check for this type of violation.|The XML writer doesn't check for this type of violation.| @@ -603,7 +603,7 @@ encodes a buffer of characters all at once, rather than character by character. An exception is thrown when the method is called if any encoding errors are encountered. + The encodes a buffer of characters all at once, rather than character by character. An exception is thrown when the method is called if any encoding errors are encountered. The property only applies to the instances that are created either with the specified or with the specified file name. If the instance is created with the specified , the property is overridden by the encoding of the underlying . For example, if this property is set to Unicode (UTF-16) for a particular , but the underlying writer is a (which derives from ) with its encoding set to UTF8, the output will be UTF-8 encoded. @@ -695,7 +695,7 @@ using (StreamWriter output = ## Remarks This property only applies to instances that output text content; otherwise, this setting is ignored. - The elements are indented as long as the element does not contain mixed content. Once the or method is called to write out a mixed element content, the stops indenting. The indenting resumes once the mixed content element is closed. + The elements are indented as long as the element does not contain mixed content. Once the or method is called to write out a mixed element content, the stops indenting. The indenting resumes once the mixed content element is closed. @@ -941,7 +941,7 @@ using (StreamWriter output = - The setting tells the to leave the input unchanged. This setting is used when you do not want any new-line processing. This is useful when the output is read by an that does not do any normalization (for example, an with default settings.) - The following tables show the output of the method when supplied with the input value depending on the property setting. The tables show the output when writing text content and also when writing an attribute value. + The following tables show the output of the method when supplied with the input value depending on the property setting. The tables show the output when writing text content and also when writing an attribute value. Text Node Value: @@ -970,7 +970,7 @@ Attribute Value: | Attribute | single space | single space | single space | single space | > [!NOTE] -> A normalizing reader is any object created by the method. These objects always perform line break normalization and full normalization of attributes. The object can also be a normalizing reader if its property is set to `true`. +> A normalizing reader is any object created by the method. These objects always perform line break normalization and full normalization of attributes. The object can also be a normalizing reader if its property is set to `true`. ]]> @@ -1113,7 +1113,7 @@ This setting has no effect when the p The XML declaration is always written if is set to , even if is set to `true`. - The XML declaration is never written if is set to . You can call to explicitly write out an XML declaration. + The XML declaration is never written if is set to . You can call to explicitly write out an XML declaration. From f410b7c2d3b8472351c15cbd050604e7697e2045 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Mon, 30 Mar 2026 15:58:33 -0700 Subject: [PATCH 2/6] System.Workflow --- ...ctiveDirectoryRoleFactoryConfiguration.xml | 66 ++-- xml/System.Workflow.Activities.Rules/Rule.xml | 80 ++--- .../RuleAction.xml | 4 +- .../RuleAnalysis.xml | 20 +- .../RuleCondition.xml | 2 +- .../RuleEvaluationException.xml | 12 +- ...leEvaluationIncompatibleTypesException.xml | 26 +- .../RuleException.xml | 12 +- .../RuleExpressionCondition.xml | 34 +- .../RuleLiteralResult.xml | 10 +- .../RulePathQualifier.xml | 38 +-- .../RuleSet.xml | 2 +- .../RuleStatementAction.xml | 10 +- .../RuleUpdateAction.xml | 6 +- .../ActiveDirectoryRole.xml | 140 ++++----- .../CallExternalMethodActivity.xml | 2 +- .../CorrelationAliasAttribute.xml | 4 +- .../DelayActivity.xml | 8 +- .../EventQueueName.xml | 64 ++-- .../ExternalDataEventArgs.xml | 2 +- .../HandleExternalEventActivity.xml | 6 +- .../InvokeWebServiceActivity.xml | 2 +- .../OperationInfo.xml | 6 +- .../ReceiveActivity.xml | 20 +- .../ReplicatorActivity.xml | 4 +- .../SendActivity.xml | 6 +- .../SequenceActivity.xml | 2 +- .../SetStateEventArgs.xml | 4 +- .../StateMachineWorkflowActivity.xml | 8 +- .../WebServiceInputActivity.xml | 6 +- .../WebWorkflowRole.xml | 46 +-- .../ActivityValidator.xml | 4 +- .../ActivityValidatorAttribute.xml | 54 ++-- .../CompositeActivityValidator.xml | 36 +-- .../TypeProvider.xml | 4 +- .../ValidationManager.xml | 70 ++--- .../Validator.xml | 66 ++-- .../WorkflowCompilationContext.xml | 4 +- .../WorkflowCompiler.xml | 2 +- .../WorkflowValidationFailedException.xml | 26 +- .../ActivityBindTypeConverter.xml | 8 +- .../ActivityDesigner.xml | 290 +++++++++--------- .../ActivityDesignerAccessibleObject.xml | 8 +- .../ActivityDesignerPaint.xml | 6 +- .../ActivityDesignerTheme.xml | 26 +- .../ActivityPreviewDesigner.xml | 42 +-- .../ActivityPreviewDesignerTheme.xml | 40 +-- .../ActivityToolboxItem.xml | 6 +- .../AmbientTheme.xml | 10 +- .../CommentGlyph.xml | 2 +- .../CompositeActivityDesigner.xml | 82 ++--- .../CompositeDesignerAccessibleObject.xml | 26 +- .../CompositeDesignerTheme.xml | 6 +- .../ConfigErrorGlyph.xml | 26 +- .../ConnectionPoint.xml | 34 +- .../Connector.xml | 96 +++--- .../ConnectorHitTestInfo.xml | 2 +- .../DesignerAction.xml | 4 +- .../DesignerEdges.xml | 20 +- .../DesignerGlyph.xml | 6 +- .../DesignerTheme.xml | 8 +- .../DesignerView.xml | 8 +- .../FreeformActivityDesigner.xml | 66 ++-- .../HitTestInfo.xml | 10 +- .../HitTestLocations.xml | 2 +- .../IDesignerGlyphProviderService.xml | 2 +- .../IDesignerVerbProviderService.xml | 26 +- .../IIdentifierCreationService.xml | 4 +- .../ParallelActivityDesigner.xml | 4 +- .../ReadOnlyActivityGlyph.xml | 22 +- .../SelectionGlyph.xml | 60 ++-- .../SequentialActivityDesigner.xml | 10 +- .../SequentialWorkflowRootDesigner.xml | 30 +- .../StructuredCompositeActivityDesigner.xml | 10 +- .../TypeBrowserDialog.xml | 74 ++--- .../WorkflowDesignerLoader.xml | 4 +- .../WorkflowDesignerMessageFilter.xml | 50 +-- .../WorkflowMenuCommands.xml | 2 +- .../WorkflowOutline.xml | 4 +- .../WorkflowOutlineNode.xml | 36 +-- .../WorkflowTheme.xml | 20 +- .../WorkflowView.xml | 154 +++++----- .../ActivityCodeDomSerializationManager.xml | 24 +- .../ActivityMarkupSerializer.xml | 80 ++--- .../ActivityTypeCodeDomSerializer.xml | 26 +- .../ContentPropertyAttribute.xml | 6 +- .../WorkflowMarkupSerializationException.xml | 26 +- .../WorkflowMarkupSerializationManager.xml | 104 +++---- .../WorkflowMarkupSerializer.xml | 34 +- .../Activity.xml | 8 +- .../ActivityBind.xml | 4 +- .../ActivityChangeAction.xml | 36 +-- .../ActivityCollection.xml | 22 +- .../ActivityCondition.xml | 24 +- .../ActivityExecutionContextManager.xml | 50 +-- ...ctivityExecutionStatusChangedEventArgs.xml | 2 +- .../CompositeActivity.xml | 4 +- .../DependencyObject.xml | 18 +- .../DependencyProperty.xml | 4 +- .../GetValueOverride.xml | 2 +- .../PropertyMetadata.xml | 8 +- .../SetValueOverride.xml | 2 +- .../SuspendActivity.xml | 2 +- .../TerminateActivity.xml | 2 +- .../WorkflowChanges.xml | 2 +- .../WorkflowRuntimeSection.xml | 78 ++--- .../WorkflowRuntimeServiceElement.xml | 52 ++-- ...orkflowRuntimeServiceElementCollection.xml | 36 +-- .../ChannelManagerService.xml | 4 +- .../DefaultWorkflowSchedulerService.xml | 96 +++--- .../ManualWorkflowSchedulerService.xml | 26 +- ...nnectionWorkflowCommitWorkBatchService.xml | 2 +- .../SqlWorkflowPersistenceService.xml | 18 +- .../WorkflowPersistenceService.xml | 26 +- .../WorkflowRuntimeService.xml | 44 +-- .../WorkflowSchedulerService.xml | 2 +- .../ActivityDataTrackingExtract.xml | 64 ++-- .../ActivityTrackPoint.xml | 24 +- .../ActivityTrackingCondition.xml | 16 +- .../ActivityTrackingLocation.xml | 100 +++--- .../ActivityTrackingLocationCollection.xml | 36 +-- .../ActivityTrackingRecord.xml | 132 ++++---- .../IProfileNotification.xml | 36 +-- .../ProfileRemovedEventArgs.xml | 46 +-- .../ProfileUpdatedEventArgs.xml | 56 ++-- .../SqlTrackingQuery.xml | 4 +- .../SqlTrackingQueryOptions.xml | 50 +-- .../SqlTrackingService.xml | 32 +- .../SqlTrackingWorkflowInstance.xml | 24 +- .../TrackingAnnotationCollection.xml | 36 +-- .../TrackingChannel.xml | 8 +- .../TrackingCondition.xml | 50 +-- .../TrackingDataItem.xml | 6 +- .../TrackingDataItemValue.xml | 12 +- .../TrackingExtract.xml | 36 +-- .../TrackingParameters.xml | 36 +-- .../TrackingProfile.xml | 8 +- .../TrackingProfileCache.xml | 30 +- ...rackingProfileDeserializationException.xml | 22 +- .../TrackingProfileSerializer.xml | 6 +- .../TrackingRecord.xml | 6 +- .../TrackingService.xml | 12 +- .../TrackingWorkflowChangedEventArgs.xml | 20 +- .../TrackingWorkflowExceptionEventArgs.xml | 6 +- .../TrackingWorkflowSuspendedEventArgs.xml | 2 +- .../TrackingWorkflowTerminatedEventArgs.xml | 8 +- .../UserTrackPoint.xml | 102 +++--- .../UserTrackingLocation.xml | 40 +-- .../UserTrackingLocationCollection.xml | 36 +-- .../UserTrackingRecord.xml | 164 +++++----- .../WorkflowDataTrackingExtract.xml | 64 ++-- .../WorkflowTrackPoint.xml | 58 ++-- .../WorkflowTrackingLocation.xml | 36 +-- .../WorkflowTrackingRecord.xml | 128 ++++---- .../CorrelationToken.xml | 2 +- xml/System.Workflow.Runtime/IPendingWork.xml | 54 ++-- xml/System.Workflow.Runtime/IWorkBatch.xml | 26 +- .../ServicesExceptionNotHandledEventArgs.xml | 4 +- .../TimerEventSubscription.xml | 72 ++--- .../TimerEventSubscriptionCollection.xml | 100 +++--- .../WorkflowCompletedEventArgs.xml | 2 +- .../WorkflowEnvironment.xml | 4 +- .../WorkflowInstance.xml | 42 +-- .../WorkflowOwnershipException.xml | 42 +-- xml/System.Workflow.Runtime/WorkflowQueue.xml | 12 +- .../WorkflowQueueInfo.xml | 16 +- .../WorkflowRuntime.xml | 78 ++--- .../WorkflowRuntimeEventArgs.xml | 22 +- .../WorkflowSuspendedEventArgs.xml | 26 +- .../WorkflowTerminatedEventArgs.xml | 6 +- 170 files changed, 2599 insertions(+), 2599 deletions(-) diff --git a/xml/System.Workflow.Activities.Configuration/ActiveDirectoryRoleFactoryConfiguration.xml b/xml/System.Workflow.Activities.Configuration/ActiveDirectoryRoleFactoryConfiguration.xml index 6813905a9f2..96bdad17fb5 100644 --- a/xml/System.Workflow.Activities.Configuration/ActiveDirectoryRoleFactoryConfiguration.xml +++ b/xml/System.Workflow.Activities.Configuration/ActiveDirectoryRoleFactoryConfiguration.xml @@ -23,15 +23,15 @@ Represents the section in the configuration file that addresses the role class. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - This class derives from which represents a section in a configuration file when implemented in a derived class. More information may be obtained by reference to this class. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + This class derives from which represents a section in a configuration file when implemented in a derived class. More information may be obtained by reference to this class. + ]]> @@ -80,11 +80,11 @@ Gets or sets the names of the direct reports. The names of the direct reports. - is a defined for this type with default value "`DirectReports`". This type represents a configuration property, attribute, or child element that is contained in an element of a configuration file. - + is a defined for this type with default value "`DirectReports`". This type represents a configuration property, attribute, or child element that is contained in an element of a configuration file. + ]]> @@ -115,11 +115,11 @@ Gets or sets the distinguished name for this instance. The distinguished name for this instance. - is a defined for this type with default value "`distinguishedName`". This type represents a configuration property, attribute, or child element that is contained in an element of a configuration file. - + is a defined for this type with default value "`distinguishedName`". This type represents a configuration property, attribute, or child element that is contained in an element of a configuration file. + ]]> @@ -178,11 +178,11 @@ Gets or sets the name of the manager associated with this instance. The name of the manager associated with this instance. - is a defined for this type with default value "`Manager`". This type represents a configuration property, attribute, or child element that is contained in an element of a configuration file. - + is a defined for this type with default value "`Manager`". This type represents a configuration property, attribute, or child element that is contained in an element of a configuration file. + ]]> @@ -213,11 +213,11 @@ Gets or sets the member for this instance. The member for this instance. - is a defined for this type with default value "`Member`". This type represents a configuration property, attribute, or child element that is contained in an element of a configuration file. - + is a defined for this type with default value "`Member`". This type represents a configuration property, attribute, or child element that is contained in an element of a configuration file. + ]]> @@ -248,11 +248,11 @@ Gets or sets the root path for this instance. The root path for this instance. - is a defined for this type with default value "`RootPath` ". This type represents a configuration property, attribute, or child element that is contained in an element of a configuration file. - + is a defined for this type with default value "`RootPath` ". This type represents a configuration property, attribute, or child element that is contained in an element of a configuration file. + ]]> diff --git a/xml/System.Workflow.Activities.Rules/Rule.xml b/xml/System.Workflow.Activities.Rules/Rule.xml index 0eab1160193..5fe329e6288 100644 --- a/xml/System.Workflow.Activities.Rules/Rule.xml +++ b/xml/System.Workflow.Activities.Rules/Rule.xml @@ -23,20 +23,20 @@ Defines a condition with an associated set of actions to perform. - consists of a and one or both or collections. - - - -## Examples - The following example shows how to create a named . - -```csharp -private Rule firstRule = new Rule("firstRule"); -``` - + consists of a and one or both or collections. + + + +## Examples + The following example shows how to create a named . + +```csharp +private Rule firstRule = new Rule("firstRule"); +``` + ]]> @@ -165,11 +165,11 @@ private Rule firstRule = new Rule("firstRule"); if the Rule should be evaluated; otherwise, . - @@ -267,13 +267,13 @@ private Rule firstRule = new Rule("firstRule"); Gets a collection of classes to perform in the ELSE case. A collection of to perform in the ELSE case. - typically set a variable value on one of the properties of the activity, calls a method of the activity, or calls static methods on types in referenced assemblies. - - The causes the to stop executing and returns control to the calling method. A modifies a property or calls a method. A explicitly indicates that a rule is updating a variable. This causes the re-evaluation of any affected rules. - + typically set a variable value on one of the properties of the activity, calls a method of the activity, or calls static methods on types in referenced assemblies. + + The causes the to stop executing and returns control to the calling method. A modifies a property or calls a method. A explicitly indicates that a rule is updating a variable. This causes the re-evaluation of any affected rules. + ]]> @@ -370,13 +370,13 @@ private Rule firstRule = new Rule("firstRule"); Gets or sets a value that indicates the order in which a should be run. A value that indicates the order in which a should be run. - classes that have a higher priority value are run before lower priority classes. Rules that have the same priority are run in the alphabetic order of their name properties. - - The value can be positive or negative. The default value for any is 0. - + classes that have a higher priority value are run before lower priority classes. Rules that have the same priority are run in the alphabetic order of their name properties. + + The value can be positive or negative. The default value for any is 0. + ]]> @@ -429,13 +429,13 @@ private Rule firstRule = new Rule("firstRule"); Gets a collection of classes to perform in the THEN case. A collection of classes to perform in the THEN case. - typically set a variable value on one of the properties of the activity, call a method of the activity, or call static methods on types in referenced assemblies. - - The causes the to stop executing and returns control to the calling method. A explicitly indicates that a rule is updating a variable. This causes the re-evaluation of any affected rules. - + typically set a variable value on one of the properties of the activity, call a method of the activity, or call static methods on types in referenced assemblies. + + The causes the to stop executing and returns control to the calling method. A explicitly indicates that a rule is updating a variable. This causes the re-evaluation of any affected rules. + ]]> diff --git a/xml/System.Workflow.Activities.Rules/RuleAction.xml b/xml/System.Workflow.Activities.Rules/RuleAction.xml index 48bf18a4cf0..a74f51a4aa3 100644 --- a/xml/System.Workflow.Activities.Rules/RuleAction.xml +++ b/xml/System.Workflow.Activities.Rules/RuleAction.xml @@ -26,7 +26,7 @@ objects (which can be used as both and ) typically set a variable value on one of the properties of the activity, call a method of the activity, or call static methods on types in referenced assemblies. + objects (which can be used as both and ) typically set a variable value on one of the properties of the activity, call a method of the activity, or call static methods on types in referenced assemblies. is the base type that , , and classes derive from. The uses of these classes is as follows: @@ -254,7 +254,7 @@ namespace LogRuleAction contains errors (the `Validate` method returns `false`), then will contain the list of errors encountered. + If the contains errors (the `Validate` method returns `false`), then will contain the list of errors encountered. ]]> diff --git a/xml/System.Workflow.Activities.Rules/RuleAnalysis.xml b/xml/System.Workflow.Activities.Rules/RuleAnalysis.xml index 035cc4b8101..f6d3f8cc9a9 100644 --- a/xml/System.Workflow.Activities.Rules/RuleAnalysis.xml +++ b/xml/System.Workflow.Activities.Rules/RuleAnalysis.xml @@ -17,11 +17,11 @@ Stores the fields and properties read by a condition or written to by an action. - is important because it identifies dependencies and side effects of rules in the rule set. These dependencies and side effects drive the chaining behavior. - + is important because it identifies dependencies and side effects of rules in the rule set. These dependencies and side effects drive the chaining behavior. + ]]> @@ -73,11 +73,11 @@ A string that represents the path to a field or property. Adds the fields and properties used by an expression as symbols to the instance. - method to add fields and properties used by an expression to the list of symbols for the instance. - + method to add fields and properties used by an expression to the list of symbols for the instance. + ]]> diff --git a/xml/System.Workflow.Activities.Rules/RuleCondition.xml b/xml/System.Workflow.Activities.Rules/RuleCondition.xml index 5d17387734b..7d02ab42e82 100644 --- a/xml/System.Workflow.Activities.Rules/RuleCondition.xml +++ b/xml/System.Workflow.Activities.Rules/RuleCondition.xml @@ -197,7 +197,7 @@ contains errors (the `Validate` method returns `false`), then will contain the list of errors encountered. + If the contains errors (the `Validate` method returns `false`), then will contain the list of errors encountered. ]]> diff --git a/xml/System.Workflow.Activities.Rules/RuleEvaluationException.xml b/xml/System.Workflow.Activities.Rules/RuleEvaluationException.xml index 6fedfbfd682..813a9af3499 100644 --- a/xml/System.Workflow.Activities.Rules/RuleEvaluationException.xml +++ b/xml/System.Workflow.Activities.Rules/RuleEvaluationException.xml @@ -63,8 +63,8 @@ |Property|Value| |--------------|-----------| -||A null reference (`Nothing` in Visual Basic).| -||A system-supplied localized description.| +||A null reference (`Nothing` in Visual Basic).| +||A system-supplied localized description.| ]]> @@ -99,8 +99,8 @@ |Property|Value| |--------------|-----------| -||A null reference (`Nothing` in Visual Basic).| -||The error message string.| +||A null reference (`Nothing` in Visual Basic).| +||The error message string.| ]]> @@ -168,8 +168,8 @@ |Property|Value| |--------------|-----------| -||The inner reference.| -||The error message string.| +||The inner reference.| +||The error message string.| ]]> diff --git a/xml/System.Workflow.Activities.Rules/RuleEvaluationIncompatibleTypesException.xml b/xml/System.Workflow.Activities.Rules/RuleEvaluationIncompatibleTypesException.xml index cbe37f439cb..dd8b3e62884 100644 --- a/xml/System.Workflow.Activities.Rules/RuleEvaluationIncompatibleTypesException.xml +++ b/xml/System.Workflow.Activities.Rules/RuleEvaluationIncompatibleTypesException.xml @@ -85,8 +85,8 @@ |Property|Value| |--------------|-----------| -||A null reference (`Nothing` in Visual Basic).| -||The error message string.| +||A null reference (`Nothing` in Visual Basic).| +||The error message string.| ]]> @@ -190,11 +190,11 @@ |Property|Value| |--------------|-----------| -||A null reference (`Nothing` in Visual Basic).| -||The value of the argument `message`| -||The value of the argument `left`.| -||The value of the argument `op`.| -||The value of the argument `right`.| +||A null reference (`Nothing` in Visual Basic).| +||The value of the argument `message`| +||The value of the argument `left`.| +||The value of the argument `op`.| +||The value of the argument `right`.| ]]> @@ -235,11 +235,11 @@ |Property|Value| |--------------|-----------| -||The value of the argument `ex`.| -||The value of the argument `message`| -||The value of the argument `left`.| -||The value of the argument `op`.| -||The value of the argument `right`.| +||The value of the argument `ex`.| +||The value of the argument `message`| +||The value of the argument `left`.| +||The value of the argument `op`.| +||The value of the argument `right`.| ]]> @@ -276,7 +276,7 @@ sets a with all the object data targeted for serialization. During de-serialization, this exception is reconstituted from the transmitted over the stream. + sets a with all the object data targeted for serialization. During de-serialization, this exception is reconstituted from the transmitted over the stream. ]]> diff --git a/xml/System.Workflow.Activities.Rules/RuleException.xml b/xml/System.Workflow.Activities.Rules/RuleException.xml index 2444b1ba3ae..139f313e106 100644 --- a/xml/System.Workflow.Activities.Rules/RuleException.xml +++ b/xml/System.Workflow.Activities.Rules/RuleException.xml @@ -63,8 +63,8 @@ |Property|Value| |--------------|-----------| -||A null reference (`Nothing` in Visual Basic).| -||A system-supplied localized description.| +||A null reference (`Nothing` in Visual Basic).| +||A system-supplied localized description.| ]]> @@ -99,8 +99,8 @@ |Property|Value| |--------------|-----------| -||A null reference (`Nothing` in Visual Basic).| -||The error message string.| +||A null reference (`Nothing` in Visual Basic).| +||The error message string.| ]]> @@ -168,8 +168,8 @@ |Property|Value| |--------------|-----------| -||The inner reference.| -||The error message string.| +||The inner reference.| +||The error message string.| ]]> diff --git a/xml/System.Workflow.Activities.Rules/RuleExpressionCondition.xml b/xml/System.Workflow.Activities.Rules/RuleExpressionCondition.xml index 9d42a93584d..1aae7f15569 100644 --- a/xml/System.Workflow.Activities.Rules/RuleExpressionCondition.xml +++ b/xml/System.Workflow.Activities.Rules/RuleExpressionCondition.xml @@ -23,13 +23,13 @@ Defines the condition definition behind a . This class cannot be inherited. - class defines the base conditions evaluated when a is executed. - - This condition type is modeled with CodeDom types. For more information about CodeDom types, see [CodeDOM Types Supported by Windows Workflow Foundation](https://msdn.microsoft.com/library/0381740f-0a29-43ae-96e2-17e14e832083). - + class defines the base conditions evaluated when a is executed. + + This condition type is modeled with CodeDom types. For more information about CodeDom types, see [CodeDOM Types Supported by Windows Workflow Foundation](https://msdn.microsoft.com/library/0381740f-0a29-43ae-96e2-17e14e832083). + ]]> @@ -329,11 +329,11 @@ Called when all properties have been given values. - @@ -386,11 +386,11 @@ if the expression has no errors; otherwise, . - contains errors (the `Validate` method returns `false`), then will contain the list of errors encountered. - + contains errors (the `Validate` method returns `false`), then will contain the list of errors encountered. + ]]> diff --git a/xml/System.Workflow.Activities.Rules/RuleLiteralResult.xml b/xml/System.Workflow.Activities.Rules/RuleLiteralResult.xml index 9f79a0bf3f2..ce3653b7bc4 100644 --- a/xml/System.Workflow.Activities.Rules/RuleLiteralResult.xml +++ b/xml/System.Workflow.Activities.Rules/RuleLiteralResult.xml @@ -61,11 +61,11 @@ Gets the result of the expression. The result of the expression. - is thrown every time an attempt to set occurs. - + is thrown every time an attempt to set occurs. + ]]> diff --git a/xml/System.Workflow.Activities.Rules/RulePathQualifier.xml b/xml/System.Workflow.Activities.Rules/RulePathQualifier.xml index 3237df52aab..014adffb11b 100644 --- a/xml/System.Workflow.Activities.Rules/RulePathQualifier.xml +++ b/xml/System.Workflow.Activities.Rules/RulePathQualifier.xml @@ -17,13 +17,13 @@ Builds the path of a field or property. - @@ -50,13 +50,13 @@ The next entity, or the field or property, for the path. Null if is the name of the property or field at the root of the path. Initializes a new instance of the class. - @@ -103,11 +103,11 @@ Gets the next field or property for the path. The next entity, or the field or property, for the path. - is null if is the name of the property or field at the root of the path. - + is null if is the name of the property or field at the root of the path. + ]]> diff --git a/xml/System.Workflow.Activities.Rules/RuleSet.xml b/xml/System.Workflow.Activities.Rules/RuleSet.xml index 6abd19f07c8..c48010791d1 100644 --- a/xml/System.Workflow.Activities.Rules/RuleSet.xml +++ b/xml/System.Workflow.Activities.Rules/RuleSet.xml @@ -321,7 +321,7 @@ contains errors (the `Validate` method returns `false`), then contains the list of errors encountered. + If the contains errors (the `Validate` method returns `false`), then contains the list of errors encountered. ]]> diff --git a/xml/System.Workflow.Activities.Rules/RuleStatementAction.xml b/xml/System.Workflow.Activities.Rules/RuleStatementAction.xml index 2fcfc0ef72f..0f1a57af635 100644 --- a/xml/System.Workflow.Activities.Rules/RuleStatementAction.xml +++ b/xml/System.Workflow.Activities.Rules/RuleStatementAction.xml @@ -290,11 +290,11 @@ if the had no errors; otherwise, . - contains errors (the Validate method returns false), then will contain the list of errors encountered. - + contains errors (the Validate method returns false), then will contain the list of errors encountered. + ]]> diff --git a/xml/System.Workflow.Activities.Rules/RuleUpdateAction.xml b/xml/System.Workflow.Activities.Rules/RuleUpdateAction.xml index a1ae8a1bedb..2d9020326d1 100644 --- a/xml/System.Workflow.Activities.Rules/RuleUpdateAction.xml +++ b/xml/System.Workflow.Activities.Rules/RuleUpdateAction.xml @@ -89,7 +89,7 @@ To specify that all fields and properties are modified, append "\*" to the end of the path. For example, `this/SomeProperty/*` indicates that all fields and properties on `this.SomeProperty` were modified. Therefore, all rules that use any field or property on `this.SomeProperty` would be reevaluated. > [!NOTE] -> If the rule set is run with set to , this action is ignored. +> If the rule set is run with set to , this action is ignored. ]]> @@ -242,12 +242,12 @@ is a string that represents the name of the field or property that is changed. "/" is used as a separator. To indicate that the property `this.SomeProperty` has been modified, the property would be "`this/SomeProperty`". You can specify the changed value as specifically as you prefer (for example, if you only modified `this.SomeProperty/SomeOtherProperty`, you can specify "`this/SomeProperty/SomeOtherProperty`"). In the latter case, other rules that used `this.SomeProperty/AnyOtherProperty` would not be reevaluated. + is a string that represents the name of the field or property that is changed. "/" is used as a separator. To indicate that the property `this.SomeProperty` has been modified, the property would be "`this/SomeProperty`". You can specify the changed value as specifically as you prefer (for example, if you only modified `this.SomeProperty/SomeOtherProperty`, you can specify "`this/SomeProperty/SomeOtherProperty`"). In the latter case, other rules that used `this.SomeProperty/AnyOtherProperty` would not be reevaluated. To specify that all fields and properties are modified, append "\*" to the end of the path. For example, "`this/SomeProperty/*`" indicates that all fields and properties on `this.SomeProperty` have been modified. Therefore, all rules that use any field or property on `this.SomeProperty` would be reevaluated. > [!NOTE] -> If the rule set is run with set to , this action is ignored. +> If the rule set is run with set to , this action is ignored. ]]> diff --git a/xml/System.Workflow.Activities/ActiveDirectoryRole.xml b/xml/System.Workflow.Activities/ActiveDirectoryRole.xml index 27c8968c2d7..b9bad30d312 100644 --- a/xml/System.Workflow.Activities/ActiveDirectoryRole.xml +++ b/xml/System.Workflow.Activities/ActiveDirectoryRole.xml @@ -34,17 +34,17 @@ Represents an Active Directory role in a Windows Workflow Foundation hosting environment. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Typically, the Active Directory store is used for storing organizational information for personnel. The main purpose for the is for making queries against such organizational information for business reasons. - - Active Directory roles typically correspond to a job function, title, or job skill within the context of the organization. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Typically, the Active Directory store is used for storing organizational information for personnel. The main purpose for the is for making queries against such organizational information for business reasons. + + Active Directory roles typically correspond to a job function, title, or job skill within the context of the organization. + ]]> @@ -71,11 +71,11 @@ Returns an that contains all the roles that report to the current role either directly or indirectly. A that contains all the roles that either directly or indirectly report to the current role. - returns all nodes below the current node. Use to return only the nodes that are directly below the current node. - + returns all nodes below the current node. Use to return only the nodes that are directly below the current node. + ]]> @@ -101,11 +101,11 @@ Returns an that contains all the roles that report directly to the current role. An that contains all the roles that directly report to the current role. - returns only the nodes that are directly below the current node. To return all nodes below the current node use . - + returns only the nodes that are directly below the current node. To return all nodes below the current node use . + ]]> @@ -131,11 +131,11 @@ Returns the generic collection that contains all objects associated with the current . The generic collection that is associated with the current . - to return all directory objects associated with the role. - + to return all directory objects associated with the role. + ]]> @@ -161,11 +161,11 @@ Gets a generic list of the Windows NT accounts associated with the . A generic list of values that represent the Windows NT accounts associated with the . - obtains all objects associated with the and converts each of them into a string value. - + obtains all objects associated with the and converts each of them into a string value. + ]]> @@ -191,11 +191,11 @@ Returns an Active Directory role that contains information about the manager of the current . The that contains information about the manager of the current role. - returns the direct manager for the current role. To return all roles above the current node, use . - + returns the direct manager for the current role. To return all roles above the current node, use . + ]]> @@ -221,11 +221,11 @@ Returns the Active Directory role that contains information about the managerial chain associated with the current . The that contains information about the managerial chain associated with the current role. - returns all nodes above the current role. To return just the direct manager of the current role, use . - + returns all nodes above the current role. To return just the direct manager of the current role, use . + ]]> @@ -251,11 +251,11 @@ Returns an Active Directory role that contains information about all the directory operations that are supervised by the manager of the current . A that contains information about all directory operations that are supervised by the manager of the current . - returned contains information from all objects managed by the manager of this role but does not contain this information from the current role. - + returned contains information from all objects managed by the manager of this role but does not contain this information from the current role. + ]]> @@ -281,11 +281,11 @@ Returns a generic list of objects associated with the current . A generic list of objects associated with the current . - checks each returned by the method to see if the entry has a security identifier in its collection. If the has such a property, adds a to the list it returns. - + checks each returned by the method to see if the entry has a security identifier in its collection. If the has such a property, adds a to the list it returns. + ]]> @@ -315,11 +315,11 @@ to indicate that is included in the ; otherwise, . - to test that a specified identity is included within this role. - + to test that a specified identity is included within this role. + ]]> @@ -344,11 +344,11 @@ Gets or sets the Active Directory role name. The Active Directory role name. - @@ -373,11 +373,11 @@ Gets the root Active Directory node associated with the . A that represents the root Active Directory node associated with the . - @@ -443,11 +443,11 @@ This member is an explicit interface member implementation. It can be used only The destination for this serialization. Populates a with the data required to serialize the target object. - allows this object to be serialized. - + allows this object to be serialized. + ]]> diff --git a/xml/System.Workflow.Activities/CallExternalMethodActivity.xml b/xml/System.Workflow.Activities/CallExternalMethodActivity.xml index 90dc7881f59..d8c01c8f9c6 100644 --- a/xml/System.Workflow.Activities/CallExternalMethodActivity.xml +++ b/xml/System.Workflow.Activities/CallExternalMethodActivity.xml @@ -237,7 +237,7 @@ property, verifies the and properties are set and verifies that the event referenced in the property can be found in the interface referenced in the property. + This method initializes the property, verifies the and properties are set and verifies that the event referenced in the property can be found in the interface referenced in the property. ]]> diff --git a/xml/System.Workflow.Activities/CorrelationAliasAttribute.xml b/xml/System.Workflow.Activities/CorrelationAliasAttribute.xml index 210ebe24c90..c0b8523e642 100644 --- a/xml/System.Workflow.Activities/CorrelationAliasAttribute.xml +++ b/xml/System.Workflow.Activities/CorrelationAliasAttribute.xml @@ -71,8 +71,8 @@ |Property|Value| |--------------|-----------| -||The value of `name`.| -||The value of `path`.| +||The value of `name`.| +||The value of `path`.| ]]> diff --git a/xml/System.Workflow.Activities/DelayActivity.xml b/xml/System.Workflow.Activities/DelayActivity.xml index 1a82a7d24ac..c7b23b6dc8e 100644 --- a/xml/System.Workflow.Activities/DelayActivity.xml +++ b/xml/System.Workflow.Activities/DelayActivity.xml @@ -59,11 +59,11 @@ When notified that its timer has expired, a completes its execution. - You can set a time out on the so that your workflow pauses before resuming execution. You specify the using . This causes your workflow to pause until the specified has elapsed. + You can set a time out on the so that your workflow pauses before resuming execution. You specify the using . This causes your workflow to pause until the specified has elapsed. The class runs the code method associated with the event before the activity starts and the code-beside method can be used to initialize the property. - The is guaranteed to complete no sooner than the indicated . The delay can take longer because the timer notification might occur some time after the is reached. One reason for a longer delay is if the workflow is running under high system stress in a server environment. + The is guaranteed to complete no sooner than the indicated . The delay can take longer because the timer notification might occur some time after the is reached. One reason for a longer delay is if the workflow is running under high system stress in a server environment. ]]> @@ -253,7 +253,7 @@ for a . The time-out duration should be set in the workflow's `InitializeComponent` method instead. + This event should not be used to set the for a . The time-out duration should be set in the workflow's `InitializeComponent` method instead. ]]> @@ -340,7 +340,7 @@ method. + The name of the workflow queue is set by the method. ]]> diff --git a/xml/System.Workflow.Activities/EventQueueName.xml b/xml/System.Workflow.Activities/EventQueueName.xml index 16fdc5cf67e..8de42eab899 100644 --- a/xml/System.Workflow.Activities/EventQueueName.xml +++ b/xml/System.Workflow.Activities/EventQueueName.xml @@ -31,15 +31,15 @@ Represents the name of a queue associated with an event on a . This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - This class can be associated with a or any other queues used by the Workflow Foundation (WF). - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + This class can be associated with a or any other queues used by the Workflow Foundation (WF). + ]]> @@ -139,11 +139,11 @@ Compares the current to the specified . A 32-bit signed integer that indicates the whether the comparands match. -1 indicates that the current and the specified object do not match; 0 indicates that the and the specified object match. - , returns -1. - + , returns -1. + ]]> @@ -245,11 +245,11 @@ Returns a hash code for the current . An integer that represents the hash code generated for the current . - returns a hash value based on the interface type and operation used to create the current . - + returns a hash value based on the interface type and operation used to create the current . + ]]> @@ -325,12 +325,12 @@ if and are equal; otherwise, . - returns `true`. - - The equivalent method for this operator is ]]> + returns `true`. + + The equivalent method for this operator is ]]> @@ -361,7 +361,7 @@ if is greater than ; otherwise, . - ]]> + ]]> or contains a null reference ( in Visual Basic). @@ -394,7 +394,7 @@ if and are not equal; otherwise, . - ]]> + ]]> @@ -425,7 +425,7 @@ if is greater than ; otherwise, . - ]]> + ]]> or contains a null reference ( in Visual Basic). @@ -452,11 +452,11 @@ Returns a representation of the current . A representation of the current . - returns includes the interface type, operation and any correlation values that are associated with the . - + returns includes the interface type, operation and any correlation values that are associated with the . + ]]> diff --git a/xml/System.Workflow.Activities/ExternalDataEventArgs.xml b/xml/System.Workflow.Activities/ExternalDataEventArgs.xml index bb04e073ae0..1d6b79be8a4 100644 --- a/xml/System.Workflow.Activities/ExternalDataEventArgs.xml +++ b/xml/System.Workflow.Activities/ExternalDataEventArgs.xml @@ -231,7 +231,7 @@ ## Remarks The default value is `false`. - A value of `true` indicates that data was submitted to the workflow using . A value of `false` indicates that data was submitted to the workflow using . + A value of `true` indicates that data was submitted to the workflow using . A value of `false` indicates that data was submitted to the workflow using . ]]> diff --git a/xml/System.Workflow.Activities/HandleExternalEventActivity.xml b/xml/System.Workflow.Activities/HandleExternalEventActivity.xml index a1231dc547f..c04cbfa9d7c 100644 --- a/xml/System.Workflow.Activities/HandleExternalEventActivity.xml +++ b/xml/System.Workflow.Activities/HandleExternalEventActivity.xml @@ -58,7 +58,7 @@ The is a blocking activity. - Classes that derive from should not implement the interface because the derived class does not execute correctly. + Classes that derive from should not implement the interface because the derived class does not execute correctly. ]]> @@ -401,7 +401,7 @@ property, verifies the and properties are set and verifies that the event referenced in the property can be found in the interface referenced in the property. + This method initializes the property, verifies the and properties are set and verifies that the event referenced in the property can be found in the interface referenced in the property. ]]> @@ -590,7 +590,7 @@ method in derived classes is to extract members from the received to set the values of the derived-classed activity's public properties. + The most common use of the method in derived classes is to extract members from the received to set the values of the derived-classed activity's public properties. ]]> diff --git a/xml/System.Workflow.Activities/InvokeWebServiceActivity.xml b/xml/System.Workflow.Activities/InvokeWebServiceActivity.xml index 2a36df06eae..fceb6a2824a 100644 --- a/xml/System.Workflow.Activities/InvokeWebServiceActivity.xml +++ b/xml/System.Workflow.Activities/InvokeWebServiceActivity.xml @@ -488,7 +488,7 @@ is used, the session is shared. + If a previous is used, the session is shared. ]]> diff --git a/xml/System.Workflow.Activities/OperationInfo.xml b/xml/System.Workflow.Activities/OperationInfo.xml index 45b88e5a516..691fa08df4e 100644 --- a/xml/System.Workflow.Activities/OperationInfo.xml +++ b/xml/System.Workflow.Activities/OperationInfo.xml @@ -88,7 +88,7 @@ object, with the same , , , and values. + This method creates a deep copy of the object, with the same , , , and values. ]]> @@ -144,7 +144,7 @@ , , , and values. + This operation compares the values of the , , , and values. ]]> @@ -454,7 +454,7 @@ value if extant; otherwise, it returns the value. + This method returns the value if extant; otherwise, it returns the value. ]]> diff --git a/xml/System.Workflow.Activities/ReceiveActivity.xml b/xml/System.Workflow.Activities/ReceiveActivity.xml index 8422a07fb1b..26d800c6958 100644 --- a/xml/System.Workflow.Activities/ReceiveActivity.xml +++ b/xml/System.Workflow.Activities/ReceiveActivity.xml @@ -215,9 +215,9 @@ activity that has set to `true` represents a service operation that, when invoked by a service client without being part of a conversation, causes a new instance of the service workflow to be created. + A activity that has set to `true` represents a service operation that, when invoked by a service client without being part of a conversation, causes a new instance of the service workflow to be created. - Service workflows that do not have a activity with set to `true` cannot be instantiated by a client using a service operation invocation. Such workflows can be created using the method of the associated object. + Service workflows that do not have a activity with set to `true` cannot be instantiated by a client using a service operation invocation. Such workflows can be created using the method of the associated object. The default value for this property is `false`. @@ -305,9 +305,9 @@ is defined within the scope of an owner activity. Users can model two distinct context tokens with the same name but different owner scopes. The value of the contexts associated with these context tokens are different at runtime. + Each is defined within the scope of an owner activity. Users can model two distinct context tokens with the same name but different owner scopes. The value of the contexts associated with these context tokens are different at runtime. - By default, each workflow has an implicit root context token, scoped at the root activity level. The name of the root context token is '(RootContext)' and the is `null`. If a activity does not have a associated with it, the root context token is used. + By default, each workflow has an implicit root context token, scoped at the root activity level. The name of the root context token is '(RootContext)' and the is `null`. If a activity does not have a associated with it, the root context token is used. ]]> @@ -590,7 +590,7 @@ property is an attached dependency property defined by the activity. This dependency property is attached to the root workflow that contains the activity using the method call at design time. + The property is an attached dependency property defined by the activity. This dependency property is attached to the root workflow that contains the activity using the method call at design time. The property is used for defining service-level behavior attributes that are applied to the workflow service when it starts. These cannot be modified at runtime. @@ -734,7 +734,7 @@ ## Remarks This is an optional event handler that is fired when the activity is about to receive a message. The associated handler can be used to perform ClaimSet-based security checks to authorize client invocation of the service operation implemented by the activity. - Setting to `false` in the event handler rejects the service operation invocation and the client receives a . If is set to `true`, then the service operation invocation succeeds and the activity receives and processes the message. + Setting to `false` in the event handler rejects the service operation invocation and the client receives a . If is set to `true`, then the service operation invocation succeeds and the activity receives and processes the message. ]]> @@ -801,9 +801,9 @@ can be used to specify a binding between the service operation parameters and public field/properties of the workflow that contain the activity. When a client invokes the operation, the corresponding parameter values are written to bound workflow properties during the receive activity's execution. + can be used to specify a binding between the service operation parameters and public field/properties of the workflow that contain the activity. When a client invokes the operation, the corresponding parameter values are written to bound workflow properties during the receive activity's execution. - can also be used by the receive activity's child activities to read the parameter values passed in by client invocation. Child activities can use the collection to set the return value of the parent activity. + can also be used by the receive activity's child activities to read the parameter values passed in by client invocation. Child activities can use the collection to set the return value of the parent activity. All parameters of the service contract should be included in the `ParameterBindings` property. Unbound parameters cause compiler warnings upon compilation and an exception can occur when the returns this message back to the client. @@ -880,7 +880,7 @@ property is an attached dependency property defined by the activity. This dependency property is attached to the root workflow that contains the activity using the method call at design time. + The property is an attached dependency property defined by the activity. This dependency property is attached to the root workflow that contains the activity using the method call at design time. The property is used for defining service-level behavior attributes that are applied to the workflow service when it starts. These cannot be modified at runtime. @@ -1031,7 +1031,7 @@ property is an attached dependency property defined by the activity. This dependency property is attached to the root workflow that contains the activity using the method call at design time. + The property is an attached dependency property defined by the activity. This dependency property is attached to the root workflow that contains the activity using the method call at design time. The property is used for defining service-level behavior attributes that are applied to the workflow service when it starts. These cannot be modified at runtime. diff --git a/xml/System.Workflow.Activities/ReplicatorActivity.xml b/xml/System.Workflow.Activities/ReplicatorActivity.xml index e7905183dbd..0f60411985a 100644 --- a/xml/System.Workflow.Activities/ReplicatorActivity.xml +++ b/xml/System.Workflow.Activities/ReplicatorActivity.xml @@ -147,7 +147,7 @@ writer an easy way to get this information without having to maintain their own collection or evaluate over a dynamic activity set. + This property allows the writer an easy way to get this information without having to maintain their own collection or evaluate over a dynamic activity set. ]]> @@ -268,7 +268,7 @@ of the event handler. The child instance is passed in the call so that the can set values on the child. The relevant object from the `Children` collection is also passed. + If subscribed to, this event is raised every time that an instance of the child activity is created for an item in the `Children` collection. The `Children` collection is set through the of the event handler. The child instance is passed in the call so that the can set values on the child. The relevant object from the `Children` collection is also passed. ]]> diff --git a/xml/System.Workflow.Activities/SendActivity.xml b/xml/System.Workflow.Activities/SendActivity.xml index f18bd1e5687..c0ea2504521 100644 --- a/xml/System.Workflow.Activities/SendActivity.xml +++ b/xml/System.Workflow.Activities/SendActivity.xml @@ -597,9 +597,9 @@ can be used to specify bindings between the service operation parameters and public field and properties of the workflow that contains the activity. When the activity executes, the corresponding parameter values are read from the workflow properties they are bound to and are sent to the service as service operation parameters. + can be used to specify bindings between the service operation parameters and public field and properties of the workflow that contains the activity. When the activity executes, the corresponding parameter values are read from the workflow properties they are bound to and are sent to the service as service operation parameters. - can also be used to retrieve the return values from a service operation. + can also be used to retrieve the return values from a service operation. All parameters of the service operation should be bound. Unbound service operation parameters produce compiler warnings and the default values of the parameter are sent when the is invoked. @@ -629,7 +629,7 @@ associated with the activity in the event handler. + This string can be used to retrieve the return value from the associated with the activity in the event handler. ]]> diff --git a/xml/System.Workflow.Activities/SequenceActivity.xml b/xml/System.Workflow.Activities/SequenceActivity.xml index 4f0e8b39231..f3ed2767554 100644 --- a/xml/System.Workflow.Activities/SequenceActivity.xml +++ b/xml/System.Workflow.Activities/SequenceActivity.xml @@ -50,7 +50,7 @@ The class coordinates the running of a set of child activities in an ordered manner, one at a time. The is completed when the final child activity is finished. - Classes that derive from should not implement the interface, or the derived class will not execute correctly. + Classes that derive from should not implement the interface, or the derived class will not execute correctly. ]]> diff --git a/xml/System.Workflow.Activities/SetStateEventArgs.xml b/xml/System.Workflow.Activities/SetStateEventArgs.xml index f103b8786b1..b5a08f6cd18 100644 --- a/xml/System.Workflow.Activities/SetStateEventArgs.xml +++ b/xml/System.Workflow.Activities/SetStateEventArgs.xml @@ -40,9 +40,9 @@ The allows for setting the state from the host application. This enables the host application to override the current state of a state machine. This can be accomplished by enqueuing an instance of the class to the WorkflowQueue named by the constant . - A simpler way to accomplish this is to use the method in the class. + A simpler way to accomplish this is to use the method in the class. - You can use the method to perform a SetState operation from the host, or you can do it yourself by enqueuing an event to the state machine workflow. + You can use the method to perform a SetState operation from the host, or you can do it yourself by enqueuing an event to the state machine workflow. The state machine workflow uses a special queue called `SetStateQueue` to listen to these special events. diff --git a/xml/System.Workflow.Activities/StateMachineWorkflowActivity.xml b/xml/System.Workflow.Activities/StateMachineWorkflowActivity.xml index bdac013f65d..d46f76f8c75 100644 --- a/xml/System.Workflow.Activities/StateMachineWorkflowActivity.xml +++ b/xml/System.Workflow.Activities/StateMachineWorkflowActivity.xml @@ -152,9 +152,9 @@ , the workflow execution is completed. The is not mandatory. This means that you can have a that is not completed. This does not mean that the state machine workflow is always active in memory. The might be unloaded as it waits for an event. + When a transition is made to the , the workflow execution is completed. The is not mandatory. This means that you can have a that is not completed. This does not mean that the state machine workflow is always active in memory. The might be unloaded as it waits for an event. - For more information about and , see . + For more information about and , see . ]]> @@ -288,9 +288,9 @@ property is mandatory and must be provided when a is created. The of the state machine is like any other state activity that is contained within the state machine. The state activity can be a direct child of the root activity and a can have only one . + The property is mandatory and must be provided when a is created. The of the state machine is like any other state activity that is contained within the state machine. The state activity can be a direct child of the root activity and a can have only one . - For more information about and , see . + For more information about and , see . ]]> diff --git a/xml/System.Workflow.Activities/WebServiceInputActivity.xml b/xml/System.Workflow.Activities/WebServiceInputActivity.xml index 101be1e3ed9..fea70187c07 100644 --- a/xml/System.Workflow.Activities/WebServiceInputActivity.xml +++ b/xml/System.Workflow.Activities/WebServiceInputActivity.xml @@ -414,7 +414,7 @@ property set to `true`. If more than one is set to `true`, the session is locked on the first request. This lasts as long as the other receive blocks the workflow; the session is deadlocked. + Only the first receive in a workflow can have the property set to `true`. If more than one is set to `true`, the session is locked on the first request. This lasts as long as the other receive blocks the workflow; the session is deadlocked. ]]> @@ -557,7 +557,7 @@ on a are used to bind the inbound parameters to locations in the workflow. When the executes, the bound locations are set to the values of the corresponding inbound parameters. + on a are used to bind the inbound parameters to locations in the workflow. When the executes, the bound locations are set to the values of the corresponding inbound parameters. ]]> @@ -626,7 +626,7 @@ collection. + Security access exceptions are thrown if the Web service receives a request from a non-member of the collection. The default value is an empty collection, which gives open access to the Web service. diff --git a/xml/System.Workflow.Activities/WebWorkflowRole.xml b/xml/System.Workflow.Activities/WebWorkflowRole.xml index 3cc69d6c0fa..cdbed2c8b30 100644 --- a/xml/System.Workflow.Activities/WebWorkflowRole.xml +++ b/xml/System.Workflow.Activities/WebWorkflowRole.xml @@ -27,13 +27,13 @@ Represents a Workflow role that is backed by a . - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + ]]> @@ -93,11 +93,11 @@ A string that defines the role provider. Initializes a new instance of the class by using the specified role name and role provider. - are classes that inherit from . These classes include , and . - + are classes that inherit from . These classes include , and . + ]]> @@ -125,13 +125,13 @@ Returns a generic list of ASP.NET accounts associated with the . A generic list of string values that represent the ASP.NET accounts associated with the . - supports only and . Furthermore, it supports these methods only for the user account that is currently the WindowsPrincipal associated with the request context, so you cannot call for any user account in the domain. When using the method with the , the following provider exception is thrown: - - The configured Role Provider (WindowsTokenRoleProvider) relies upon Windows authentication to determine the groups that the user is allowed to be a member of. ASP.NET Role Manager cannot be used to manage Windows users and groups. Use the SQLRoleProvider if you want to support custom user/role assignment. - + supports only and . Furthermore, it supports these methods only for the user account that is currently the WindowsPrincipal associated with the request context, so you cannot call for any user account in the domain. When using the method with the , the following provider exception is thrown: + + The configured Role Provider (WindowsTokenRoleProvider) relies upon Windows authentication to determine the groups that the user is allowed to be a member of. ASP.NET Role Manager cannot be used to manage Windows users and groups. Use the SQLRoleProvider if you want to support custom user/role assignment. + ]]> @@ -207,11 +207,11 @@ Gets or sets the role provider for the . A string that contains the role provider for the . - are classes that inherit from . These classes include , and . - + are classes that inherit from . These classes include , and . + ]]> diff --git a/xml/System.Workflow.ComponentModel.Compiler/ActivityValidator.xml b/xml/System.Workflow.ComponentModel.Compiler/ActivityValidator.xml index 41b7de894fd..9e2b0f3355e 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/ActivityValidator.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/ActivityValidator.xml @@ -81,9 +81,9 @@ to validate the properties of the . + This method calls to validate the properties of the . - This method only validates the uniqueness of the for the if the is not a root . + This method only validates the uniqueness of the for the if the is not a root . ]]> diff --git a/xml/System.Workflow.ComponentModel.Compiler/ActivityValidatorAttribute.xml b/xml/System.Workflow.ComponentModel.Compiler/ActivityValidatorAttribute.xml index 3f4c20175c7..9492efb1b03 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/ActivityValidatorAttribute.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/ActivityValidatorAttribute.xml @@ -27,15 +27,15 @@ Identifies the class that performs validation on an that is subject to validation. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - For a list of initial property values for an instance of the class, see the constructor. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + For a list of initial property values for an instance of the class, see the constructor. + ]]> @@ -48,15 +48,15 @@ Initializes a new instance of the class. - class. - -|Property|Value| -|--------------|-----------| -||`null` reference (`Nothing` in Visual Basic).| - + class. + +|Property|Value| +|--------------|-----------| +||`null` reference (`Nothing` in Visual Basic).| + ]]> @@ -81,11 +81,11 @@ Type of the . Initializes an instance of the class by using the type of the validator. - class, see the constructor. - + class, see the constructor. + ]]> @@ -110,11 +110,11 @@ The name of the type. Initializes a new instance of the class by using the specified validator type name. - class, see the constructor. - + class, see the constructor. + ]]> diff --git a/xml/System.Workflow.ComponentModel.Compiler/CompositeActivityValidator.xml b/xml/System.Workflow.ComponentModel.Compiler/CompositeActivityValidator.xml index 83ac2d43592..6bc700a1519 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/CompositeActivityValidator.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/CompositeActivityValidator.xml @@ -23,15 +23,15 @@ Derivative of that is the base class for all composite activity validator components. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - The class provides validation logic for a . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + The class provides validation logic for a . + ]]> @@ -80,11 +80,11 @@ Validates the configuration. A of errors found during validation. - on every child in the collection. It also checks that no more than one , , or is attached to the . - + on every child in the collection. It also checks that no more than one , , or is attached to the . + ]]> @@ -117,11 +117,11 @@ Validates the change based on the affected and provides the error. The by the validation. - diff --git a/xml/System.Workflow.ComponentModel.Compiler/TypeProvider.xml b/xml/System.Workflow.ComponentModel.Compiler/TypeProvider.xml index feb5e941c82..3f47086a472 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/TypeProvider.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/TypeProvider.xml @@ -40,7 +40,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - This implementation, in addition to handling compiled assemblies ( and methods), can handle types that have not been compiled yet (). The limited implementation of is returned for types referenced using . + This implementation, in addition to handling compiled assemblies ( and methods), can handle types that have not been compiled yet (). The limited implementation of is returned for types referenced using . > [!NOTE] > only returns public types from referenced assemblies, and both public and non-public types from local assemblies. @@ -786,7 +786,7 @@ is raised when this method is invoked. Call before you call otherwise it has no affect on the . + The is raised when this method is invoked. Call before you call otherwise it has no affect on the . ]]> diff --git a/xml/System.Workflow.ComponentModel.Compiler/ValidationManager.xml b/xml/System.Workflow.ComponentModel.Compiler/ValidationManager.xml index ba78a0785ec..30e3e9581d1 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/ValidationManager.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/ValidationManager.xml @@ -27,15 +27,15 @@ Enables the sharing of contextual information, such as property validation, parent activity, and so on, across validators during the compilation process. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - For a list of initial property values regarding an instance of the class, see the constructor. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + For a list of initial property values regarding an instance of the class, see the constructor. + ]]> @@ -48,16 +48,16 @@ Initializes a new instance of the class. - |A null reference (`Nothing` in Visual Basic).| -||`true`| - + |A null reference (`Nothing` in Visual Basic).| +||`true`| + ]]> @@ -82,11 +82,11 @@ An that locates a GUID identified service. Initializes a new instance of the class using the identified service provider. - class, see the constructor. - + class, see the constructor. + ]]> @@ -114,11 +114,11 @@ to validate the child classes of the current ; otherwise, . Initializes a new instance of the class using the identified service provider and indicates whether child classes should be validated. - class, see the constructor. - + class, see the constructor. + ]]> @@ -198,13 +198,13 @@ Returns an array of validators that are associated with a type by looking up the validator attribute applied on the type. An array of classes. - classes contains the indicated by `type`, an array of classes is returned. - - If the hash table does not contain the indicated by `type`, a new hash table of classes is created and then an array of the classes is returned. - + classes contains the indicated by `type`, an array of classes is returned. + + If the hash table does not contain the indicated by `type`, a new hash table of classes is created and then an array of the classes is returned. + ]]> diff --git a/xml/System.Workflow.ComponentModel.Compiler/Validator.xml b/xml/System.Workflow.ComponentModel.Compiler/Validator.xml index 41c41e14b95..090ba7cdc82 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/Validator.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/Validator.xml @@ -23,21 +23,21 @@ Base class for all validator components. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - The Validator class is used to ensure that activities are configured properly at design time. Validators are instantiated during design time when the designer validates the properties assigned to activities; if an activity's parameters are not configured properly, the designer will show smart tag errors for the incorrect values. Validators also run during compile time, and will return validation errors if constraints such as object parent or child type, minimum number of children, etc. are not correct. Validators will also run at runtime when a markup-based workflow is instantiated using the method. - - The main purpose of a Validator is to ensure that errors are known during design time, and are not exposed as exceptions during runtime. - - Validators are associated with the activities that they validate using the attribute; all activity validators must inherit from the class. - - By default, validators will validate meta properties; they do not validate instance properties which are settable at runtime. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + The Validator class is used to ensure that activities are configured properly at design time. Validators are instantiated during design time when the designer validates the properties assigned to activities; if an activity's parameters are not configured properly, the designer will show smart tag errors for the incorrect values. Validators also run during compile time, and will return validation errors if constraints such as object parent or child type, minimum number of children, etc. are not correct. Validators will also run at runtime when a markup-based workflow is instantiated using the method. + + The main purpose of a Validator is to ensure that errors are known during design time, and are not exposed as exceptions during runtime. + + Validators are associated with the activities that they validate using the attribute; all activity validators must inherit from the class. + + By default, validators will validate meta properties; they do not validate instance properties which are settable at runtime. + ]]> @@ -84,15 +84,15 @@ Helper method to extract the full property name. The full property name. - in the stack to build the full name of the property. - - For example: the name My.Actor.Bas is built using three items. - - If the validated property belongs to an object that is an item in a collection, the method will produce the name of the collection. - + in the stack to build the full name of the property. + + For example: the name My.Actor.Bas is built using three items. + + If the validated property belongs to an object that is an item in a collection, the method will produce the name of the collection. + ]]> @@ -159,11 +159,11 @@ When overridden in a derived class, validates a change based on a specified being added or removed. This function is called during the application of changes that are made to the workflow during dynamic updates. The generated by the operation. - @@ -238,11 +238,11 @@ Performs validation on a property and returns a that contains the results of that validation. A that contains the results of that validation. - is returned. - + is returned. + ]]> diff --git a/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompilationContext.xml b/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompilationContext.xml index b422aabf05a..eedd6e4ee0d 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompilationContext.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompilationContext.xml @@ -29,7 +29,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - This class can only be created on a scope basis, using the method. + This class can only be created on a scope basis, using the method. ]]> @@ -58,7 +58,7 @@ indicates whether the types in the workflow being compiled are checked against a list that allows or excludes types based on the value of the property. + indicates whether the types in the workflow being compiled are checked against a list that allows or excludes types based on the value of the property. ]]> diff --git a/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompiler.xml b/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompiler.xml index 6ac5a0f7686..3b971905bb9 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompiler.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/WorkflowCompiler.xml @@ -88,7 +88,7 @@ method. The code also creates new instances of the and classes and sets some values. This code assumes that `results` is of type . This code example is part of the Outlook Workflow Wizard SDK sample from the WizardForm.cs file. For more information, see [Outlook Workflow Wizard](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). + The following code example demonstrates how to use the method. The code also creates new instances of the and classes and sets some values. This code assumes that `results` is of type . This code example is part of the Outlook Workflow Wizard SDK sample from the WizardForm.cs file. For more information, see [Outlook Workflow Wizard](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms741721(v=vs.90)). diff --git a/xml/System.Workflow.ComponentModel.Compiler/WorkflowValidationFailedException.xml b/xml/System.Workflow.ComponentModel.Compiler/WorkflowValidationFailedException.xml index e8119ae8792..0b6f5d9c3d8 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/WorkflowValidationFailedException.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/WorkflowValidationFailedException.xml @@ -27,15 +27,15 @@ Represents an that occurs when a workflow does not pass validation. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - represents an exception that occurs while validating the workflow when run using . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + represents an exception that occurs while validating the workflow when run using . + ]]> @@ -184,11 +184,11 @@ Provides the means to serialize the exception data. Sets the specified with information about the . - diff --git a/xml/System.Workflow.ComponentModel.Design/ActivityBindTypeConverter.xml b/xml/System.Workflow.ComponentModel.Design/ActivityBindTypeConverter.xml index b158ae8b038..54abde07ae0 100644 --- a/xml/System.Workflow.ComponentModel.Design/ActivityBindTypeConverter.xml +++ b/xml/System.Workflow.ComponentModel.Design/ActivityBindTypeConverter.xml @@ -35,7 +35,7 @@ For more information about type converters, see the TypeConverter base class and [How to: Implement a Type Converter](https://learn.microsoft.com/previous-versions/visualstudio/visual-studio-2013/ayybcxe5(v=vs.120)). > [!NOTE] -> You should never create an instance of . Instead, call the method of the class. For more information, see the examples in the class. +> You should never create an instance of . Instead, call the method of the class. For more information, see the examples in the class. ]]> @@ -89,7 +89,7 @@ returns `true` if `sourceType` is a string. + returns `true` if `sourceType` is a string. ]]> @@ -207,7 +207,7 @@ converts an to a string. + converts an to a string. `context` can be used to extract additional information about the environment this converter is being invoked from. This can be a null reference (`Nothing` in Visual Basic), so always check. Also, properties on the `context` object can return a null reference (`Nothing`). @@ -333,7 +333,7 @@ method provides. If the values are exclusive, the list returned by should not allow these values to be edited. + If the list is exclusive, such as in an enumeration data type, then no other values are valid. If the list is not exclusive, then other valid values might exist in addition to the list of standard values that the method provides. If the values are exclusive, the list returned by should not allow these values to be edited. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/ActivityDesigner.xml b/xml/System.Workflow.ComponentModel.Design/ActivityDesigner.xml index 3639af848de..6cf872a2d6d 100644 --- a/xml/System.Workflow.ComponentModel.Design/ActivityDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/ActivityDesigner.xml @@ -258,7 +258,7 @@ always returns `true`. + Unless overridden in a derived class, always returns `true`. ]]> @@ -291,7 +291,7 @@ displays the default design-time layout for the activity. + Unless overridden in a derived class, displays the default design-time layout for the activity. ]]> @@ -461,7 +461,7 @@ always returns `false`. + Unless overridden in a derived class, always returns `false`. ]]> @@ -519,7 +519,7 @@ (`false`). Override to customize the cleanup. + This method cleans up resources by calling (`false`). Override to customize the cleanup. ]]> @@ -685,7 +685,7 @@ to access a read-only list of designer glyphs. These glyphs can be used to graphically represent components of the in a graphical environment. + Use to access a read-only list of designer glyphs. These glyphs can be used to graphically represent components of the in a graphical environment. ]]> @@ -718,9 +718,9 @@ , together with the method of the control is used to determine which part of an control the user has clicked. The contains logical coordinates of the point on the where the mouse was clicked. + The , together with the method of the control is used to determine which part of an control the user has clicked. The contains logical coordinates of the point on the where the mouse was clicked. - The method receives a that contains an x and y coordinate. + The method receives a that contains an x and y coordinate. ]]> @@ -778,7 +778,7 @@ to retrieve the coordinates for the rectangle that encloses the image associated with the designer. You can use these coordinates for drawing connectors or overlaying graphics. + Use the to retrieve the coordinates for the rectangle that encloses the image associated with the designer. You can use these coordinates for drawing connectors or overlaying graphics. ]]> @@ -917,7 +917,7 @@ get operation returns a null reference (`Nothing` in Visual Basic) and the set operation throws a . + Unless overridden in a derived class, the get operation returns a null reference (`Nothing` in Visual Basic) and the set operation throws a . ]]> @@ -975,7 +975,7 @@ determines whether an activity can be modified. This affects drag operations, changes to properties, and changes to the position of the activity in the designer window. + determines whether an activity can be modified. This affects drag operations, changes to properties, and changes to the position of the activity in the designer window. ]]> @@ -1005,7 +1005,7 @@ to affect highlighting or update property sheets in your graphical representation of the workflow. IsPrimarySelection is useful when multiple activities are selected as IsPrimarySelection will indicate the starting point of a multiple selection. + You can use to affect highlighting or update property sheets in your graphical representation of the workflow. IsPrimarySelection is useful when multiple activities are selected as IsPrimarySelection will indicate the starting point of a multiple selection. ]]> @@ -1099,7 +1099,7 @@ is called only if the activity designer is a root designer. + is called only if the activity designer is a root designer. ]]> @@ -1129,7 +1129,7 @@ to determine whether an activity is visible on the designer. For large workflows you could provide a search mechanism and locate, select, and move into the viewable area an activity currently not visible found by the user. + Use to determine whether an activity is visible on the designer. For large workflows you could provide a search mechanism and locate, select, and move into the viewable area an activity currently not visible found by the user. ]]> @@ -1234,7 +1234,7 @@ is determined by the size settings accessible through the property. + is determined by the size settings accessible through the property. ]]> @@ -1298,7 +1298,7 @@ to perform any design-time processing of the when a user starts resizing the activity designer. + You can use to perform any design-time processing of the when a user starts resizing the activity designer. ]]> @@ -1332,7 +1332,7 @@ has no default behavior. You must override this method in a class that derives from to provide processing when a connection is made between two designers. + has no default behavior. You must override this method in a class that derives from to provide processing when a connection is made between two designers. ]]> @@ -1396,30 +1396,30 @@ event is raised when the mouse is dragged into the designer. + The event is raised when the mouse is dragged into the designer. The following describes how and when events related to drag-and-drop operations are raised. - If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. Changes in the pointer position, keyboard state, and mouse comment state are tracked. -- If the user moves out of the designer bounds, the event is raised. +- If the user moves out of the designer bounds, the event is raised. -- If the mouse enters another designer, the for that designer is raised. +- If the mouse enters another designer, the for that designer is raised. -- If the mouse moves but stays within the same designer, the event is raised. +- If the mouse moves but stays within the same designer, the event is raised. -- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . +- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . - If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. > [!NOTE] -> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. +> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. If the value is `DragAction.Drop`, the drop effect value is returned to the source, so that the source application can perform the appropriate operation on the source data; for example, see comment the data if the operation was a move. - If the value is `DragAction.Cancel`, the event is raised. + If the value is `DragAction.Cancel`, the event is raised. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1450,30 +1450,30 @@ event is raised when the user drags the pointer out of the designer or the user cancels the current drag-and-drop operation. + The event is raised when the user drags the pointer out of the designer or the user cancels the current drag-and-drop operation. The following describes how and when events related to drag-and-drop operations are raised. - If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. Changes in the pointer position, keyboard state, and mouse button state are tracked. -- If the user moves out of the designer bounds, the event is raised. +- If the user moves out of the designer bounds, the event is raised. -- If the mouse enters another designer, the for that designer is raised. +- If the mouse enters another designer, the for that designer is raised. -- If the mouse moves but stays within the same designer, the event is raised. +- If the mouse moves but stays within the same designer, the event is raised. -- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . +- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . - If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. > [!NOTE] -> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. +> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. If the value is `DragAction.Drop`, the drop effect value is returned to the source, so that the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - If the value is `DragAction.Cancel`, the event is raised. + If the value is `DragAction.Cancel`, the event is raised. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1507,30 +1507,30 @@ event is raised when the user drags the pointer over of the designer. + The event is raised when the user drags the pointer over of the designer. The following describes how and when events related to drag-and-drop operations are raised. - If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - Changes in the pointer position, keyboard state, and mouse button state are tracked. -- If the user moves out of the designer bounds, the event is raised. +- If the user moves out of the designer bounds, the event is raised. -- If the mouse enters another designer, the for that designer is raised. +- If the mouse enters another designer, the for that designer is raised. -- If the mouse moves but stays within the same designer, the event is raised. +- If the mouse moves but stays within the same designer, the event is raised. -- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . +- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . - If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. > [!NOTE] -> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. +> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. If the value is `DragAction.Drop`, the drop effect value is returned to the source, so that the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - If the value is `DragAction.Cancel`, the event is raised. + If the value is `DragAction.Cancel`, the event is raised. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1615,26 +1615,26 @@ ## Remarks The following describes how and when events related to drag-and-drop operations are raised. - If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - Changes in the pointer position, keyboard state, and mouse button state are tracked. -- If the user moves out of the designer bounds, the event is raised. +- If the user moves out of the designer bounds, the event is raised. -- If the mouse enters another designer, the for that designer is raised. +- If the mouse enters another designer, the for that designer is raised. -- If the mouse moves but stays within the same designer, the event is raised. +- If the mouse moves but stays within the same designer, the event is raised. -- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . +- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . - If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. > [!NOTE] -> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. +> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. If the value is `DragAction.Drop`, the drop effect value is returned to the source, so that the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - If the value is `DragAction.Cancel`, the event is raised. + If the value is `DragAction.Cancel`, the event is raised. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1843,26 +1843,26 @@ ## Remarks The following describes how and when events related to drag-and-drop operations are raised. - If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - Changes in the pointer position, keyboard state, and mouse button state are tracked. -- If the user moves out of the designer bounds, the event is raised. +- If the user moves out of the designer bounds, the event is raised. -- If the mouse enters another designer, the for that designer is raised. +- If the mouse enters another designer, the for that designer is raised. -- If the mouse moves but stays within the same designer, the event is raised. +- If the mouse moves but stays within the same designer, the event is raised. -- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . +- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . - If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. > [!NOTE] -> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. +> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. If the value is `DragAction.Drop`, the drop effect value is returned to the source, so that the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - If the value is `DragAction.Cancel`, the event is raised. + If the value is `DragAction.Cancel`, the event is raised. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1900,26 +1900,26 @@ ## Remarks The following describes how and when events related to drag-and-drop operations are raised. - If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - Changes in the pointer position, keyboard state, and mouse button state are tracked. -- If the user moves out of the designer bounds, the event is raised. +- If the user moves out of the designer bounds, the event is raised. -- If the mouse enters another designer, the for that designer is raised. +- If the mouse enters another designer, the for that designer is raised. -- If the mouse moves but stays within the same designer, the event is raised. +- If the mouse moves but stays within the same designer, the event is raised. -- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . +- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . - If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. > [!NOTE] -> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. +> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. If the value is `DragAction.Drop`, the drop effect value is returned to the source, so that the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - If the value is `DragAction.Cancel`, the event is raised. + If the value is `DragAction.Cancel`, the event is raised. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1952,26 +1952,26 @@ ## Remarks The following describes how and when events related to drag-and-drop operations are raised. - If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - Changes in the pointer position, keyboard state, and mouse button state are tracked. -- If the user moves out of the designer bounds, the event is raised. +- If the user moves out of the designer bounds, the event is raised. -- If the mouse enters another designer, the for that designer is raised. +- If the mouse enters another designer, the for that designer is raised. -- If the mouse moves but stays within the same designer, the event is raised. +- If the mouse moves but stays within the same designer, the event is raised. -- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . +- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . - If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. > [!NOTE] -> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. +> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. If the value is `DragAction.Drop`, the drop effect value is returned to the source, so that the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - If the value is `DragAction.Cancel`, the event is raised. + If the value is `DragAction.Cancel`, the event is raised. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -2007,26 +2007,26 @@ ## Remarks The following describes how and when events related to drag-and-drop operations are raised. - If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - Changes in the pointer position, keyboard state, and mouse button state are tracked. -- If the user moves out of the designer bounds, the event is raised. +- If the user moves out of the designer bounds, the event is raised. -- If the mouse enters another designer, the for that designer is raised. +- If the mouse enters another designer, the for that designer is raised. -- If the mouse moves but stays within the same designer, the event is raised. +- If the mouse moves but stays within the same designer, the event is raised. -- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . +- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . - If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. > [!NOTE] -> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. +> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. If the value is `DragAction.Drop`, the drop effect value is returned to the source, so that the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - If the value is `DragAction.Cancel`, the event is raised. + If the value is `DragAction.Cancel`, the event is raised. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -2062,26 +2062,26 @@ ## Remarks The following describes how and when events related to drag-and-drop operations are raised. - If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - Changes in the pointer position, keyboard state, and mouse button state are tracked. -- If the user moves out of the designer bounds, the event is raised. +- If the user moves out of the designer bounds, the event is raised. -- If the mouse enters another designer, the for that designer is raised. +- If the mouse enters another designer, the for that designer is raised. -- If the mouse moves but stays within the same designer, the event is raised. +- If the mouse moves but stays within the same designer, the event is raised. -- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . +- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . - If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. > [!NOTE] -> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. +> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. If the value is `DragAction.Drop`, the drop effect value is returned to the source, so that the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - If the value is `DragAction.Cancel`, the event is raised. + If the value is `DragAction.Cancel`, the event is raised. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -2117,26 +2117,26 @@ ## Remarks The following describes how and when events related to drag-and-drop operations are raised. - If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - Changes in the pointer position, keyboard state, and mouse button state are tracked. -- If the user moves out of the designer bounds, the event is raised. +- If the user moves out of the designer bounds, the event is raised. -- If the mouse enters another designer, the for that designer is raised. +- If the mouse enters another designer, the for that designer is raised. -- If the mouse moves but stays within the same designer, the event is raised. +- If the mouse moves but stays within the same designer, the event is raised. -- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . +- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . - If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. > [!NOTE] -> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. +> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. If the value is `DragAction.Drop`, the drop effect value is returned to the source, so that the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - If the value is `DragAction.Cancel`, the event is raised. + If the value is `DragAction.Cancel`, the event is raised. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -2169,26 +2169,26 @@ ## Remarks The following describes how and when events related to drag-and-drop operations are raised. - If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - Changes in the pointer position, keyboard state, and mouse button state are tracked. -- If the user moves out of the designer bounds, the event is raised. +- If the user moves out of the designer bounds, the event is raised. -- If the mouse enters another designer, the for that designer is raised. +- If the mouse enters another designer, the for that designer is raised. -- If the mouse moves but stays within the same designer, the event is raised. +- If the mouse moves but stays within the same designer, the event is raised. -- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . +- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . - If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. > [!NOTE] -> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. +> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. If the value is `DragAction.Drop`, the drop effect value is returned to the source, so that the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - If the value is `DragAction.Cancel`, the event is raised. + If the value is `DragAction.Cancel`, the event is raised. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -2224,26 +2224,26 @@ ## Remarks The following describes how and when events related to drag-and-drop operations are raised. - If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - Changes in the pointer position, keyboard state, and mouse button state are tracked. -- If the user moves out of the designer bounds, the event is raised. +- If the user moves out of the designer bounds, the event is raised. -- If the mouse enters another designer, the for that designer is raised. +- If the mouse enters another designer, the for that designer is raised. -- If the mouse moves but stays within the same designer, the event is raised. +- If the mouse moves but stays within the same designer, the event is raised. -- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . +- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . - If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. > [!NOTE] -> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. +> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. If the value is `DragAction.Drop`, the drop effect value is returned to the source, so that the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - If the value is `DragAction.Cancel`, the event is raised. + If the value is `DragAction.Cancel`, the event is raised. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -2279,26 +2279,26 @@ ## Remarks The following describes how and when events related to drag-and-drop operations are raised. - If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - Changes in the pointer position, keyboard state, and mouse button state are tracked. -- If the user moves out of the designer bounds, the event is raised. +- If the user moves out of the designer bounds, the event is raised. -- If the mouse enters another designer, the for that designer is raised. +- If the mouse enters another designer, the for that designer is raised. -- If the mouse moves but stays within the same designer, the event is raised. +- If the mouse moves but stays within the same designer, the event is raised. -- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . +- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . - If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. > [!NOTE] -> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. +> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. If the value is `DragAction.Drop`, the drop effect value is returned to the source, so that the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - If the value is `DragAction.Cancel`, the event is raised. + If the value is `DragAction.Cancel`, the event is raised. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -2386,26 +2386,26 @@ ## Remarks The following describes how and when events related to drag-and-drop operations are raised. - If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - Changes in the pointer position, keyboard state, and mouse button state are tracked. -- If the user moves out of the designer bounds, the event is raised. +- If the user moves out of the designer bounds, the event is raised. -- If the mouse enters another designer, the for that designer is raised. +- If the mouse enters another designer, the for that designer is raised. -- If the mouse moves but stays within the same designer, the event is raised. +- If the mouse moves but stays within the same designer, the event is raised. -- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . +- If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the Action property of the event . - If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. > [!NOTE] -> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. +> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up to date feedback on the mouse position. If the value is `DragAction.Drop`, the drop effect value is returned to the source, so that the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - If the value is `DragAction.Cancel`, the event is raised. + If the value is `DragAction.Cancel`, the event is raised. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -2473,7 +2473,7 @@ provide no default behavior. You must override it in a class that derives from to provide processing logic when a scroll position changes. + provide no default behavior. You must override it in a class that derives from to provide processing logic when a scroll position changes. ]]> @@ -2578,7 +2578,7 @@ to move up the tree of nested objects or to find the root designer. + You can use the to move up the tree of nested objects or to find the root designer. ]]> @@ -2905,7 +2905,7 @@ updates these errors with any recent changes. + Designer actions represent the possible configuration errors associated with a designer. Calling updates these errors with any recent changes. ]]> @@ -2934,7 +2934,7 @@ will refresh the menus to show any recent changes. + Designer verbs are shown in context menus and menu bars. Calling will refresh the menus to show any recent changes. ]]> @@ -2966,7 +2966,7 @@ . + The view state is the accumulation of the values of designer properties. When the view state is saved to a stream, the designer values and settings can be restored using . ]]> @@ -2983,7 +2983,7 @@ uses the logic to display info tips. + Unless overridden in a derived class, uses the logic to display info tips. ]]> @@ -3015,7 +3015,7 @@ to show a rectangle of text that can be used to display extended information about the designer. + Use to show a rectangle of text that can be used to display extended information about the designer. ]]> @@ -3099,7 +3099,7 @@ to determine whether to show a smart tag when an activity has focus in the designer. + Use to determine whether to show a smart tag when an activity has focus in the designer. ]]> @@ -3157,7 +3157,7 @@ and to display a smart tag of available designer actions at the location specified by . + Use together with and to display a smart tag of available designer actions at the location specified by . ]]> @@ -3243,7 +3243,7 @@ causes the default action associated with the designer to be executed. + causes the default action associated with the designer to be executed. ]]> @@ -3510,7 +3510,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks This member is an explicit interface member implementation. It can be used only when the is cast to an interface. - For more information, see . + For more information, see . ]]> @@ -3579,7 +3579,7 @@ This member is an explicit interface member implementation. It can be used only . + For more information, see . ]]> @@ -3614,7 +3614,7 @@ This member is an explicit interface member implementation. It can be used only . + For more information, see . ]]> @@ -3849,7 +3849,7 @@ This member is an explicit interface member implementation. It can be used only will be displayed. + Use to determine the location on the designer where will be displayed. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/ActivityDesignerAccessibleObject.xml b/xml/System.Workflow.ComponentModel.Design/ActivityDesignerAccessibleObject.xml index 8695ec9d5b7..2aec49a5338 100644 --- a/xml/System.Workflow.ComponentModel.Design/ActivityDesignerAccessibleObject.xml +++ b/xml/System.Workflow.ComponentModel.Design/ActivityDesignerAccessibleObject.xml @@ -181,7 +181,7 @@ . + Clients can retrieve the designer's default action by using . ]]> @@ -258,9 +258,9 @@ property is a string used by clients to identify, find, or announce an activity for the user. To access the name of a child activity, you must first call with the index of the name of the child activity you are retrieving. + The property is a string used by clients to identify, find, or announce an activity for the user. To access the name of a child activity, you must first call with the index of the name of the child activity you are retrieving. - You cannot perform a set operation on . + You cannot perform a set operation on . ]]> @@ -391,7 +391,7 @@ has the following possible values: + has the following possible values: , , , , , , , and . diff --git a/xml/System.Workflow.ComponentModel.Design/ActivityDesignerPaint.xml b/xml/System.Workflow.ComponentModel.Design/ActivityDesignerPaint.xml index b958c310c09..3570342761c 100644 --- a/xml/System.Workflow.ComponentModel.Design/ActivityDesignerPaint.xml +++ b/xml/System.Workflow.ComponentModel.Design/ActivityDesignerPaint.xml @@ -144,7 +144,7 @@ , the source rectangle is set to the size, in pixels, of the image, the transparency setting is set to 1.0f, and drawing grayscales is not allowed. + When you use this version of , the source rectangle is set to the size, in pixels, of the image, the transparency setting is set to 1.0f, and drawing grayscales is not allowed. ]]> @@ -228,7 +228,7 @@ uses the method to obtain the path to draw. + uses the method to obtain the path to draw. ]]> @@ -304,7 +304,7 @@ method uses to obtain the path to draw. + The method uses to obtain the path to draw. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/ActivityDesignerTheme.xml b/xml/System.Workflow.ComponentModel.Design/ActivityDesignerTheme.xml index 89740140306..54bf2fc7393 100644 --- a/xml/System.Workflow.ComponentModel.Design/ActivityDesignerTheme.xml +++ b/xml/System.Workflow.ComponentModel.Design/ActivityDesignerTheme.xml @@ -97,7 +97,7 @@ indicates the ending color of a background gradient. To use background gradient color, set the and properties. The background will gradually change color from the starting color to the ending color. + indicates the ending color of a background gradient. To use background gradient color, set the and properties. The background will gradually change color from the starting color to the ending color. ]]> @@ -140,7 +140,7 @@ indicates the background color, or the beginning color of a background gradient. To use background gradient color, set the and properties. The background will gradually change color from the start color to the end color. + indicates the background color, or the beginning color of a background gradient. To use background gradient color, set the and properties. The background will gradually change color from the start color to the end color. ]]> @@ -175,7 +175,7 @@ to get or set how the background displays color. The can be set to one of four modes: + Use to get or set how the background displays color. The can be set to one of four modes: `BackwardDiagonal`\ Specifies a gradient from upper right to lower left. @@ -226,7 +226,7 @@ represents the font to use for highlighted text for the theme. + represents the font to use for highlighted text for the theme. ]]> @@ -269,7 +269,7 @@ is the color used to draw borders for shapes. + The is the color used to draw borders for shapes. ]]> @@ -308,7 +308,7 @@ is the pen used to draw borders for shapes. + The is the pen used to draw borders for shapes. ]]> @@ -347,7 +347,7 @@ is the style of line to draw for borders of shapes. + The is the style of line to draw for borders of shapes. ]]> @@ -386,7 +386,7 @@ is the width in pixels for borders of shapes. + The is the width in pixels for borders of shapes. ]]> @@ -425,7 +425,7 @@ represents the default geometry of shapes for the theme. + represents the default geometry of shapes for the theme. `Rectangle` Draws shapes with squared corners. @@ -470,7 +470,7 @@ is the default image to display for the designer. + The is the default image to display for the designer. ]]> @@ -509,7 +509,7 @@ is the path to the image file to use as the default image to display for the designer. + The is the path to the image file to use as the default image to display for the designer. ]]> @@ -784,7 +784,7 @@ is the of the default image used by the theme for the designer. + The is the of the default image used by the theme for the designer. ]]> @@ -845,7 +845,7 @@ is used to notify the theme to apply changes to ambient properties. + is used to notify the theme to apply changes to ambient properties. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/ActivityPreviewDesigner.xml b/xml/System.Workflow.ComponentModel.Design/ActivityPreviewDesigner.xml index 2515e0d40fd..1452222852c 100644 --- a/xml/System.Workflow.ComponentModel.Design/ActivityPreviewDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/ActivityPreviewDesigner.xml @@ -132,7 +132,7 @@ set operation sets the target in the preview strip that appears at the top of the . + The set operation sets the target in the preview strip that appears at the top of the . ]]> @@ -190,7 +190,7 @@ verifies that all activity designers in the , and their children, are displayed in the preview strip at the top of the designer. + verifies that all activity designers in the , and their children, are displayed in the preview strip at the top of the designer. ]]> @@ -221,7 +221,7 @@ and do not contain null references (`Nothing` in Visual Basic), will return the value of the property of the . If the property contains a null reference (`Nothing`), will return the associated with the first designer in the collection. + If and do not contain null references (`Nothing` in Visual Basic), will return the value of the property of the . If the property contains a null reference (`Nothing`), will return the associated with the first designer in the collection. ]]> @@ -251,7 +251,7 @@ returns an empty array if one or more of the following conditions occur: + returns an empty array if one or more of the following conditions occur: - The is not the active designer on the workflow design surface. @@ -259,7 +259,7 @@ - The is not expanded on the workflow design surface. -- is set to `true`. +- is set to `true`. ]]> @@ -292,7 +292,7 @@ preview strip, returns the possible drop targets in the strip. + If `dropPoint` is in the preview strip, returns the possible drop targets in the strip. ]]> @@ -327,7 +327,7 @@ , only recognizes and . + Since users can only navigate horizontally in the preview pane of the , only recognizes and . ]]> @@ -356,7 +356,7 @@ contains the collection of glyphs to display in the preview strip at the top of the . + contains the collection of glyphs to display in the preview strip at the top of the . ]]> @@ -385,7 +385,7 @@ set operation adds text to the preview strip at the top of the . + The set operation adds text to the preview strip at the top of the . ]]> @@ -477,7 +477,7 @@ is `true` and the preview window is set to preview mode, returns `false`. + If is `true` and the preview window is set to preview mode, returns `false`. ]]> @@ -508,7 +508,7 @@ and do not contain null references (`Nothing` in Visual Basic), returns the value of the property of the . If the contains a null reference (`Nothing` in Visual Basic), returns the associated with the last designer in the collection. + If and do not contain null references (`Nothing` in Visual Basic), returns the value of the property of the . If the contains a null reference (`Nothing` in Visual Basic), returns the associated with the last designer in the collection. ]]> @@ -565,7 +565,7 @@ set operation updates the location of the and all child designers it contains. + The set operation updates the location of the and all child designers it contains. ]]> @@ -597,7 +597,7 @@ . updates the designer verbs associated with the and modifies the designer layout on the workflow design surface. + `listChangeArgs` contains the activity designers that have been added and removed from the . updates the designer verbs associated with the and modifies the designer layout on the workflow design surface. ]]> @@ -713,9 +713,9 @@ determines the size of the preview strip that displays the collection of child activity designers and the preview window that displays the selected activity designer. also determines the size of the preview window depending on whether the designer is in edit or preview mode. + determines the size of the preview strip that displays the collection of child activity designers and the preview window that displays the selected activity designer. also determines the size of the preview window depending on whether the designer is in edit or preview mode. - If returns `false`, returns the base implementation inherited from . + If returns `false`, returns the base implementation inherited from . ]]> @@ -747,7 +747,7 @@ enables edit mode on the . + When the user double-clicks in the preview window enables edit mode on the . ]]> @@ -890,7 +890,7 @@ not only updates the theme property settings for , it also renders the new settings to the preview window. + not only updates the theme property settings for , it also renders the new settings to the preview window. ]]> @@ -919,7 +919,7 @@ , returns a null reference (`Nothing` in Visual Basic). + If no designer is selected in the preview strip section of the , returns a null reference (`Nothing` in Visual Basic). ]]> @@ -948,7 +948,7 @@ not only updates the actions associated with , it also renders the new views to the preview window. + not only updates the actions associated with , it also renders the new views to the preview window. ]]> @@ -977,7 +977,7 @@ must be set to `true` for to perform view updates. + must be set to `true` for to perform view updates. ]]> @@ -1009,7 +1009,7 @@ saves the currently selected activity designer in the preview strip and, if returns `true`, the contents of the preview window. + saves the currently selected activity designer in the preview strip and, if returns `true`, the contents of the preview window. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/ActivityPreviewDesignerTheme.xml b/xml/System.Workflow.ComponentModel.Design/ActivityPreviewDesignerTheme.xml index d0e99801b9d..9f0c8910860 100644 --- a/xml/System.Workflow.ComponentModel.Design/ActivityPreviewDesignerTheme.xml +++ b/xml/System.Workflow.ComponentModel.Design/ActivityPreviewDesignerTheme.xml @@ -23,17 +23,17 @@ Provides theme settings for activity designers that use a preview mode on the workflow design surface. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Activity designers that use preview mode on the workflow design surface can have theme settings specific to the preview display area. contains the properties that provide these preview-area specific settings. - - Activities that provide a preview mode when they are added to the workflow design surface include and . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Activity designers that use preview mode on the workflow design surface can have theme settings specific to the preview display area. contains the properties that provide these preview-area specific settings. + + Activities that provide a preview mode when they are added to the workflow design surface include and . + ]]> @@ -106,11 +106,11 @@ Performs any additional initialization tasks for that is not performed by . - is set to `true`, sets all properties to reflect the style settings of the operating system on which Windows Workflow Foundation is installed. - + is set to `true`, sets all properties to reflect the style settings of the operating system on which Windows Workflow Foundation is installed. + ]]> @@ -138,11 +138,11 @@ The enumeration value that the activity preview designer theme should now use. Notifies the that the ambient property settings for the designer have changed. - checks the value passed to `ambientProperty` and applies the appropriate ambient theme settings based on that value. If the value is , it applies the ambient styles provided by the designer. If the value is , it applies the ambient styles provided by the operating system. - + checks the value passed to `ambientProperty` and applies the appropriate ambient theme settings based on that value. If the value is , it applies the ambient styles provided by the designer. If the value is , it applies the ambient styles provided by the operating system. + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/ActivityToolboxItem.xml b/xml/System.Workflow.ComponentModel.Design/ActivityToolboxItem.xml index d3a6ca57a62..f5203ea3e9e 100644 --- a/xml/System.Workflow.ComponentModel.Design/ActivityToolboxItem.xml +++ b/xml/System.Workflow.ComponentModel.Design/ActivityToolboxItem.xml @@ -123,7 +123,7 @@ is called, it deserializes the toolbox item. + When is called, it deserializes the toolbox item. ]]> @@ -156,7 +156,7 @@ method returns the component or components that the creates. + The method returns the component or components that the creates. ]]> @@ -189,7 +189,7 @@ . + Activity designer developers can override this method to display a dialog box when the toolbox item is dragged onto the design surface. Unless overridden, this method has the same behavior as . ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/AmbientTheme.xml b/xml/System.Workflow.ComponentModel.Design/AmbientTheme.xml index a76f772f0d9..d9768d946b4 100644 --- a/xml/System.Workflow.ComponentModel.Design/AmbientTheme.xml +++ b/xml/System.Workflow.ComponentModel.Design/AmbientTheme.xml @@ -930,7 +930,7 @@ returns `true`, sets all properties to the values defined by the operating system. + If returns `true`, sets all properties to the values defined by the operating system. ]]> @@ -1343,7 +1343,7 @@ is not null reference (`Nothing` in Visual Basic) when you set , will dispose of any resources used by and set it to `null` (`Nothing`). + If is not null reference (`Nothing` in Visual Basic) when you set , will dispose of any resources used by and set it to `null` (`Nothing`). ]]> @@ -1552,7 +1552,7 @@ allows you to determine whether the text displayed on a workflow design surface, and all its child designers, is anti-aliased or aliased. Anti-aliased text provides higher quality text display, while aliased text requires fewer resources to maintain. + allows you to determine whether the text displayed on a workflow design surface, and all its child designers, is anti-aliased or aliased. Anti-aliased text provides higher quality text display, while aliased text requires fewer resources to maintain. ]]> @@ -1656,7 +1656,7 @@ to associate an image as a watermark image for a workflow design surface. If is not `null` (`Nothing` in Visual Basic) when you set , disposes of any resources used by and sets its value to `null` (`Nothing`). + Use to associate an image as a watermark image for a workflow design surface. If is not `null` (`Nothing` in Visual Basic) when you set , disposes of any resources used by and sets its value to `null` (`Nothing`). ]]> @@ -1695,7 +1695,7 @@ to associate an image as a watermark image for a workflow design surface. If is not `null` (`Nothing` in Visual Basic) when you set , disposes of any resources used by and sets its value to `null` (`Nothing`). + Use to associate an image as a watermark image for a workflow design surface. If is not `null` (`Nothing` in Visual Basic) when you set , disposes of any resources used by and sets its value to `null` (`Nothing`). ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/CommentGlyph.xml b/xml/System.Workflow.ComponentModel.Design/CommentGlyph.xml index b3ad3151a3d..5e1bede9395 100644 --- a/xml/System.Workflow.ComponentModel.Design/CommentGlyph.xml +++ b/xml/System.Workflow.ComponentModel.Design/CommentGlyph.xml @@ -84,7 +84,7 @@ inflates the bounds of `designer` by the value held in and returns the resultant rectangle. + inflates the bounds of `designer` by the value held in and returns the resultant rectangle. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/CompositeActivityDesigner.xml b/xml/System.Workflow.ComponentModel.Design/CompositeActivityDesigner.xml index 599ee805ae2..9d03f347fc8 100644 --- a/xml/System.Workflow.ComponentModel.Design/CompositeActivityDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/CompositeActivityDesigner.xml @@ -158,7 +158,7 @@ to determine if a list of activities can be inserted into a composite activity. + Use to determine if a list of activities can be inserted into a composite activity. ]]> @@ -194,7 +194,7 @@ to determine if a list of activities can be moved from within a composite activity. + Use to determine if a list of activities can be moved from within a composite activity. ]]> @@ -228,7 +228,7 @@ to determine if a list of contained activities can be removed from the composite activity. + Use to determine if a list of contained activities can be removed from the composite activity. ]]> @@ -257,7 +257,7 @@ accessor to retrieve a read-only collection of the designers contained within the . + Use the accessor to retrieve a read-only collection of the designers contained within the . ]]> @@ -351,7 +351,7 @@ to make sure the contained designer is visible. In a custom designer you can use to make visible a designer located within a collapsed composite designer. + Use to make sure the contained designer is visible. In a custom designer you can use to make visible a designer located within a collapsed composite designer. ]]> @@ -380,7 +380,7 @@ to return a that describes the area of the screen that encloses the expand button on a . This is useful for detecting mouse events to react to your requests to expand or collapse a . + Use to return a that describes the area of the screen that encloses the expand button on a . This is useful for detecting mouse events to react to your requests to expand or collapse a . ]]> @@ -416,7 +416,7 @@ and , use to determine the proper action when a user clicks the expand or collapse button on the . + In combination with and , use to determine the proper action when a user clicks the expand or collapse button on the . ]]> @@ -445,7 +445,7 @@ to return the first selectable object contained within the . + When overridden in a derived class, use to return the first selectable object contained within the . ]]> @@ -508,7 +508,7 @@ causes the selection to move from the current selection to the next selectable object in the direction specified. + causes the selection to move from the current selection to the next selectable object in the direction specified. ]]> @@ -563,9 +563,9 @@ , together with the method of the control is used to determine which part of a controls you have clicked. The contains logical coordinates of the point on the where the mouse was clicked. + The , together with the method of the control is used to determine which part of a controls you have clicked. The contains logical coordinates of the point on the where the mouse was clicked. - The method receives a that contains an x and y coordinate. + The method receives a that contains an x and y coordinate. ]]> @@ -594,7 +594,7 @@ to retrieve the coordinates for the rectangle that encloses the image associated with the designer. You can use these coordinates for drawing connectors or overlaying graphics. + Use the to retrieve the coordinates for the rectangle that encloses the image associated with the designer. You can use these coordinates for drawing connectors or overlaying graphics. ]]> @@ -626,7 +626,7 @@ loads the designer with the specified . The designer loads the activity service, updates the verbs associated with the activity, and assigns the default text and image to the designer. + loads the designer with the specified . The designer loads the activity service, updates the verbs associated with the activity, and assigns the default text and image to the designer. ]]> @@ -669,9 +669,9 @@ to insert a list of activities into the location specified. + Use to insert a list of activities into the location specified. - Prior to calling , use to make sure that the specified activities can be inserted. + Prior to calling , use to make sure that the specified activities can be inserted. ]]> @@ -709,9 +709,9 @@ to insert a list of activities into the composite activity. + Use to insert a list of activities into the composite activity. - Prior to calling , use to make sure the specified list of activities can be inserted. + Prior to calling , use to make sure the specified list of activities can be inserted. ]]> @@ -745,7 +745,7 @@ to determine if the specified designer is visible. + Use to determine if the specified designer is visible. ]]> @@ -804,7 +804,7 @@ to return the last selectable object contained within the designer. + When overridden in a derived class, use to return the last selectable object contained within the designer. ]]> @@ -836,7 +836,7 @@ to restore the designer to a state previously saved using . + Use to restore the designer to a state previously saved using . ]]> @@ -865,7 +865,7 @@ to position the designer at design or run time. + Use to position the designer at design or run time. ]]> @@ -899,7 +899,7 @@ to move a list of activities from one composite activity to another. + Use to move a list of activities from one composite activity to another. ]]> @@ -934,7 +934,7 @@ to move an activity contained within the composite activity forward or backwards in the index of contained activities. + Use to move an activity contained within the composite activity forward or backwards in the index of contained activities. ]]> @@ -966,7 +966,7 @@ to respond to changes to activities inside the composite activity. + Use to respond to changes to activities inside the composite activity. ]]> @@ -1000,7 +1000,7 @@ to respond to changes that are occurring to the activities contained within the composite activity. + Use to respond to changes that are occurring to the activities contained within the composite activity. ]]> @@ -1034,7 +1034,7 @@ to respond to changes in the activities contained within the composite activity. + Use to respond to changes in the activities contained within the composite activity. ]]> @@ -1093,7 +1093,7 @@ performs layout tasks for all of the child activity designers that the contains. + performs layout tasks for all of the child activity designers that the contains. ]]> @@ -1128,7 +1128,7 @@ performs resizing tasks for each activity designer that the composite activity designer contains. + performs resizing tasks for each activity designer that the composite activity designer contains. ]]> @@ -1162,26 +1162,26 @@ ## Remarks The following describes how and when events related to drag-and-drop operations are raised. - If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. + If the designer is a valid drop target, the event is raised with the drag-and-drop effect specified. For a list of drag-and-drop effects, see the enumeration. - Changes in the pointer position, keyboard state, and mouse button state are tracked. -- If the user moves out of the designer bounds, the event is raised. +- If the user moves out of the designer bounds, the event is raised. -- If the mouse enters another designer, the for that designer is raised. +- If the mouse enters another designer, the for that designer is raised. -- If the mouse moves but stays within the same designer, the event is raised. +- If the mouse moves but stays within the same designer, the event is raised. -- If there is a change in the keyboard or mouse state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the `Action` property of the event . +- If there is a change in the keyboard or mouse state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the `Action` property of the event . - If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. > [!NOTE] -> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up-to-date feedback about the mouse position. +> The and events are paired so that as the mouse moves across the drop target, the user is supplied with the most up-to-date feedback about the mouse position. If the value is `DragAction.Drop`, the drop effect value is returned to the source, so that the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - If the value is `DragAction.Cancel`, the event is raised. + If the value is `DragAction.Cancel`, the event is raised. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1240,7 +1240,7 @@ occurs any time the theme associated with the designer changes. When the theme changes it is likely that the designer look and feel needs to change. + occurs any time the theme associated with the designer changes. When the theme changes it is likely that the designer look and feel needs to change. ]]> @@ -1283,7 +1283,7 @@ to remove activities from the composite activity. + Use to remove activities from the composite activity. ]]> @@ -1351,7 +1351,7 @@ to remove the specified list of activities from the composite activity within the specified transaction. + Use to remove the specified list of activities from the composite activity within the specified transaction. ]]> @@ -1383,7 +1383,7 @@ to save the state of a composite activity to a stream. To restore the view state use . + Use to save the state of a composite activity to a stream. To restore the view state use . ]]> @@ -1470,7 +1470,7 @@ describes the height of the title area of the designer. Typically this can contain the heading, icon, and expand or collapse button. + The describes the height of the title area of the designer. Typically this can contain the heading, icon, and expand or collapse button. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/CompositeDesignerAccessibleObject.xml b/xml/System.Workflow.ComponentModel.Design/CompositeDesignerAccessibleObject.xml index d8dcc75bc01..4ae27b3ab2d 100644 --- a/xml/System.Workflow.ComponentModel.Design/CompositeDesignerAccessibleObject.xml +++ b/xml/System.Workflow.ComponentModel.Design/CompositeDesignerAccessibleObject.xml @@ -23,13 +23,13 @@ Implements an accessible object that classes use to adjust the designer user interface for users who have impairments. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + ]]> @@ -125,13 +125,13 @@ Gets the accessible state of the current . A combination of values. - has the following possible values: - - , , , , , , , , , and . - + has the following possible values: + + , , , , , , , , , and . + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/CompositeDesignerTheme.xml b/xml/System.Workflow.ComponentModel.Design/CompositeDesignerTheme.xml index e1aac70ddb4..6aac2ae3a70 100644 --- a/xml/System.Workflow.ComponentModel.Design/CompositeDesignerTheme.xml +++ b/xml/System.Workflow.ComponentModel.Design/CompositeDesignerTheme.xml @@ -239,7 +239,7 @@ is called, the method disposes of the previous brush and creates a new one. + If the background brush for the expand button is not set to `null` (`Nothing` in Visual Basic) before is called, the method disposes of the previous brush and creates a new one. ]]> @@ -268,7 +268,7 @@ property is set to `true`, the method obtains settings for the object from the operating system. + If the property is set to `true`, the method obtains settings for the object from the operating system. ]]> @@ -300,7 +300,7 @@ and properties to . + When this method is called it sets the and properties to . The enumeration determines where a designer theme obtains its ambient property settings. If the value is set, the designer theme class obtains its ambient settings from the property. If the value is set, the designer theme class obtains its ambient settings from the operating system on which the designer is installed. diff --git a/xml/System.Workflow.ComponentModel.Design/ConfigErrorGlyph.xml b/xml/System.Workflow.ComponentModel.Design/ConfigErrorGlyph.xml index 0fce6de20aa..1052a8af697 100644 --- a/xml/System.Workflow.ComponentModel.Design/ConfigErrorGlyph.xml +++ b/xml/System.Workflow.ComponentModel.Design/ConfigErrorGlyph.xml @@ -23,15 +23,15 @@ Provides a glyph for an to display when a user has not performed required designer actions at design time. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Activity designers use to display actions associated with smart tags on the designer surface. For example, if an activity requires users to set a property, the activity designer displays to help notify them that they are required to set the property. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Activity designers use to display actions associated with smart tags on the designer surface. For example, if an activity requires users to set a property, the activity designer displays to help notify them that they are required to set the property. + ]]> @@ -131,11 +131,11 @@ The on which the glyph is drawn. Notifies the glyph that an action has been performed which has activated the glyph. - is called, the designer verbs associated with the glyph are displayed on the activity designer surface. - + is called, the designer verbs associated with the glyph are displayed on the activity designer surface. + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/ConnectionPoint.xml b/xml/System.Workflow.ComponentModel.Design/ConnectionPoint.xml index f795ec48356..4e786219250 100644 --- a/xml/System.Workflow.ComponentModel.Design/ConnectionPoint.xml +++ b/xml/System.Workflow.ComponentModel.Design/ConnectionPoint.xml @@ -23,15 +23,15 @@ Represents a connection point that is displayed on the outer edges of an activity designer on a workflow design surface. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - A connection point appears as a small square on the edge of an activity designer surface. It is used as a point where a Connector can originate on the activity designer to connect it with another activity designer. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + A connection point appears as a small square on the edge of an activity designer surface. It is used as a point where a Connector can originate on the activity designer to connect it with another activity designer. + ]]> @@ -61,10 +61,10 @@ Initializes a new instance of the class by using the specified , enumeration value, and an integer. To be added. - is less than zero. - - -- or -- - + is less than zero. + + -- or -- + is greater than or equal to the number of connection points on . contains a null reference ( in Visual Basic). @@ -156,11 +156,11 @@ Gets the connection index for the current . An integer that represents the connection index for the current . - to identify a in the read-only collection returned by . - + to identify a in the read-only collection returned by . + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/Connector.xml b/xml/System.Workflow.ComponentModel.Design/Connector.xml index 5a199abe34f..a26b284869c 100644 --- a/xml/System.Workflow.ComponentModel.Design/Connector.xml +++ b/xml/System.Workflow.ComponentModel.Design/Connector.xml @@ -31,15 +31,15 @@ Represents a connector between two activity designers on a workflow design surface. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - A connector is the line that appears on a workflow design surface that connects one activity designer to another. provides methods and properties that allow you to customize how to draw a set of connectors when an activity designer is rendered at design time. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + A connector is the line that appears on a workflow design surface that connects one activity designer to another. provides methods and properties that allow you to customize how to draw a set of connectors when an activity designer is rendered at design time. + ]]> @@ -184,11 +184,11 @@ if the specified connector is equal to the current ; otherwise, . - and properties of the two connectors hold references to the same objects. - + and properties of the two connectors hold references to the same objects. + ]]> @@ -262,11 +262,11 @@ Returns a service object of the specified type if it is available. A service object of type or a null reference ( in Visual Basic) if there is no service object of type . - returns the service object available through . - + returns the service object available through . + ]]> @@ -296,11 +296,11 @@ if resides on the current ; otherwise, . - indicates whether a user has clicked a point on a connector displayed on a workflow design surface. - + indicates whether a user has clicked a point on a connector displayed on a workflow design surface. + ]]> @@ -325,11 +325,11 @@ Invalidates the current and causes it to be redrawn. - causes all contents found in to be included in the update region for the . - + causes all contents found in to be included in the update region for the . + ]]> @@ -382,11 +382,11 @@ The that contains the event data. Notifies the that layout operations are occurring. - clears and repopulates it with a new range of points. - + clears and repopulates it with a new range of points. + ]]> @@ -443,11 +443,11 @@ Coordinated for the edit points on the . Used for drawing the Connector when it is dragged from one state to another. - @@ -523,11 +523,11 @@ Gets the workflow view associated with the connector. The that is associated with the connector. - provides access to the workflow design surface on which the connector appears. - + provides access to the workflow design surface on which the connector appears. + ]]> @@ -552,11 +552,11 @@ Performs layout tasks for the . - calls the method and specifies that the layout update does not need to occur immediately. - + calls the method and specifies that the layout update does not need to occur immediately. + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/ConnectorHitTestInfo.xml b/xml/System.Workflow.ComponentModel.Design/ConnectorHitTestInfo.xml index 297fc81c06a..42b3809b06e 100644 --- a/xml/System.Workflow.ComponentModel.Design/ConnectorHitTestInfo.xml +++ b/xml/System.Workflow.ComponentModel.Design/ConnectorHitTestInfo.xml @@ -179,7 +179,7 @@ always returns the current . + always returns the current . ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/DesignerAction.xml b/xml/System.Workflow.ComponentModel.Design/DesignerAction.xml index bbf60bfb617..7651d69ad4d 100644 --- a/xml/System.Workflow.ComponentModel.Design/DesignerAction.xml +++ b/xml/System.Workflow.ComponentModel.Design/DesignerAction.xml @@ -177,7 +177,7 @@ method is called when you click a validation error displayed by the activity designer on the workflow design surface. + The method is called when you click a validation error displayed by the activity designer on the workflow design surface. ]]> @@ -206,7 +206,7 @@ of the provides a visual cue that signals the presence of an associated . + In the property editor, the property that corresponds to the of the provides a visual cue that signals the presence of an associated . ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/DesignerEdges.xml b/xml/System.Workflow.ComponentModel.Design/DesignerEdges.xml index 0512dffcb27..8dce9f6dc7b 100644 --- a/xml/System.Workflow.ComponentModel.Design/DesignerEdges.xml +++ b/xml/System.Workflow.ComponentModel.Design/DesignerEdges.xml @@ -26,17 +26,17 @@ Specifies the edge or edges of an activity designer on a workflow design surface where design-time processing is performed, such as a location on the activity designer. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - The enumeration value returned from that specifies where on the activity designer a or a collection of objects reside. The method can be used to retrieve this collection. - - You can also use it to determine which edge or edges of an activity designer a user is resizing by observing the enumeration value returned from . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + The enumeration value returned from that specifies where on the activity designer a or a collection of objects reside. The method can be used to retrieve this collection. + + You can also use it to determine which edge or edges of an activity designer a user is resizing by observing the enumeration value returned from . + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/DesignerGlyph.xml b/xml/System.Workflow.ComponentModel.Design/DesignerGlyph.xml index 7dfb723db2f..442ea9e2e98 100644 --- a/xml/System.Workflow.ComponentModel.Design/DesignerGlyph.xml +++ b/xml/System.Workflow.ComponentModel.Design/DesignerGlyph.xml @@ -32,7 +32,7 @@ The class is the base class for all designer glyphs used on a workflow design surface. - Activity designer developers can use classes that inherit from to draw custom glyphs onto the surface of an . classes draw such glyphs at the top-level Z order, which places the custom glyph visually on top of all other glyphs on the designer based on the value of the custom glyph. A lower value for the property indicates a higher priority and therefore draws the glyph at the top-most Z order position on an activity designer. + Activity designer developers can use classes that inherit from to draw custom glyphs onto the surface of an . classes draw such glyphs at the top-level Z order, which places the custom glyph visually on top of all other glyphs on the designer based on the value of the custom glyph. A lower value for the property indicates a higher priority and therefore draws the glyph at the top-most Z order position on an activity designer. ]]> @@ -112,7 +112,7 @@ returns the bounds of the activity designer with which the glyph is associated. + Unless overridden in a derived class, returns the bounds of the activity designer with which the glyph is associated. ]]> @@ -274,7 +274,7 @@ uses to draw the bounds of the comment glyph and to fill it. + uses to draw the bounds of the comment glyph and to fill it. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/DesignerTheme.xml b/xml/System.Workflow.ComponentModel.Design/DesignerTheme.xml index 6c9eaefa087..a292712f14e 100644 --- a/xml/System.Workflow.ComponentModel.Design/DesignerTheme.xml +++ b/xml/System.Workflow.ComponentModel.Design/DesignerTheme.xml @@ -141,7 +141,7 @@ property returns the object that the used during initialization. + The property returns the object that the used during initialization. ]]> @@ -238,7 +238,7 @@ releases only unmanaged resources prior to garbage collection. + releases only unmanaged resources prior to garbage collection. ]]> @@ -341,9 +341,9 @@ that the is initialized with is not a null reference (`Nothing` in Visual Basic), obtains its value from the property. If the is a null reference (`Nothing`), is `false`. + If the that the is initialized with is not a null reference (`Nothing` in Visual Basic), obtains its value from the property. If the is a null reference (`Nothing`), is `false`. - If the is assigned to the , the property is set to `true`, and properties on all designer themes associated with this theme cannot be changed. If required, properties can be set after loading the theme but before assigning it to the . + If the is assigned to the , the property is set to `true`, and properties on all designer themes associated with this theme cannot be changed. If required, properties can be set after loading the theme but before assigning it to the . ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/DesignerView.xml b/xml/System.Workflow.ComponentModel.Design/DesignerView.xml index f4b7e2be9a7..6cf83c39f8f 100644 --- a/xml/System.Workflow.ComponentModel.Design/DesignerView.xml +++ b/xml/System.Workflow.ComponentModel.Design/DesignerView.xml @@ -151,7 +151,7 @@ uses the property to determine whether the compared designer views are equal. + uses the property to determine whether the compared designer views are equal. ]]> @@ -225,7 +225,7 @@ has no default behavior; classes that inherit from must implement their own logic. + has no default behavior; classes that inherit from must implement their own logic. ]]> @@ -254,7 +254,7 @@ has no default behavior; classes that inherit from must implement their own logic. + has no default behavior; classes that inherit from must implement their own logic. ]]> @@ -305,7 +305,7 @@ is `null`, a is created to hold the user data. + If is `null`, a is created to hold the user data. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/FreeformActivityDesigner.xml b/xml/System.Workflow.ComponentModel.Design/FreeformActivityDesigner.xml index f05f89102ea..8c397677ed7 100644 --- a/xml/System.Workflow.ComponentModel.Design/FreeformActivityDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/FreeformActivityDesigner.xml @@ -124,7 +124,7 @@ is called when a user adds a to the . + is called when a user adds a to the . ]]> @@ -164,7 +164,7 @@ , the layout of the is updated. + When you set , the layout of the is updated. ]]> @@ -193,11 +193,11 @@ is a object with dimensions of 40 pixels by 40 pixels. + The default size of is a object with dimensions of 40 pixels by 40 pixels. - If the property associated with the current workflow theme is set to `true`, settings are half the height and half the width of the grid size. + If the property associated with the current workflow theme is set to `true`, settings are half the height and half the width of the grid size. - When you set , the layout of the is updated. + When you set , the layout of the is updated. ]]> @@ -232,9 +232,9 @@ allows the to grow as necessary to fit its contents but does not shrink smaller than the value of the property. + The default behavior of allows the to grow as necessary to fit its contents but does not shrink smaller than the value of the property. - When you set , the layout of the is updated. + When you set , the layout of the is updated. ]]> @@ -266,9 +266,9 @@ modifies the z-order for the to display the specified as its top visible child designer. You can use this method to display a designer at the top of the z-order when a user selects it. + modifies the z-order for the to display the specified as its top visible child designer. You can use this method to display a designer at the top of the z-order when a user selects it. - `containedDesigner` must be in a child of the before you call . If it is not, throws an . + `containedDesigner` must be in a child of the before you call . If it is not, throws an . ]]> @@ -331,7 +331,7 @@ always returns `false`. + always returns `false`. ]]> @@ -365,7 +365,7 @@ returns `true` if `containedDesigner` is a . Other types of designers cannot be resized. + Unless overridden in a derived class, returns `true` if `containedDesigner` is a . Other types of designers cannot be resized. ]]> @@ -394,7 +394,7 @@ is the registered delegate event handler for the event. + is the registered delegate event handler for the event. ]]> @@ -425,7 +425,7 @@ ## Remarks A connector is changed when a user changes the locations at either end of a object. - is the registered delegate event handler for the event. + is the registered delegate event handler for the event. ]]> @@ -454,7 +454,7 @@ is the registered delegate event handler for the event. + is the registered delegate event handler for the event. ]]> @@ -596,7 +596,7 @@ is set to `true` and is set to , returns `false`. In all other conditions returns `true`. + If is set to `true` and is set to , returns `false`. In all other conditions returns `true`. ]]> @@ -625,7 +625,7 @@ returns the first child designer in the collection, or a `null` reference (`Nothing` in Visual Basic) if the collection count is zero. + returns the first child designer in the collection, or a `null` reference (`Nothing` in Visual Basic) if the collection count is zero. ]]> @@ -682,7 +682,7 @@ returns a glyph for each connectable child designer found on the . + returns a glyph for each connectable child designer found on the . ]]> @@ -715,7 +715,7 @@ checks whether the location has occurred on a connector or one of the child activity designers. If the occurs on a child activity that is being dragged to another location, returns information about the , not the designer being moved. + checks whether the location has occurred on a connector or one of the child activity designers. If the occurs on a child activity that is being dragged to another location, returns information about the , not the designer being moved. ]]> @@ -803,7 +803,7 @@ returns the last child designer in the property or a `null` reference (`Nothing` in Visual Basic) if the does not contain any child designers. + returns the last child designer in the property or a `null` reference (`Nothing` in Visual Basic) if the does not contain any child designers. ]]> @@ -832,7 +832,7 @@ is set due to a user resizing the , the designer maintains the relative positions of its child designers. + When is set due to a user resizing the , the designer maintains the relative positions of its child designers. ]]> @@ -915,9 +915,9 @@ sets new bounds for the moved designer and performs all required layout operations for the on the workflow design surface. + sets new bounds for the moved designer and performs all required layout operations for the on the workflow design surface. - `containedDesigner` must be in a child of the before you call . If it is not, throws an . + `containedDesigner` must be in a child of the before you call . If it is not, throws an . ]]> @@ -1062,7 +1062,7 @@ is called when a is drawn between the source on one of the object's contained activity designers to target on a second contained activity designer. + is called when a is drawn between the source on one of the object's contained activity designers to target on a second contained activity designer. ]]> @@ -1195,7 +1195,7 @@ returns the size of the current bounding rectangle for the when is set to `false`. If is set to `true` and is set to , calculates and returns new size settings for the bounding rectangle. If is set to true and is not set to , returns . + returns the size of the current bounding rectangle for the when is set to `false`. If is set to `true` and is set to , calculates and returns new size settings for the bounding rectangle. If is set to true and is not set to , returns . ]]> @@ -1227,7 +1227,7 @@ is set to `true` and is set to , performs all resizing tasks on the workflow design surface. If is set to `true` and is set to , performs layout tasks, but no resizing tasks. If is set to `false`, all contained designers retain their previous locations on the . + If is set to `true` and is set to , performs all resizing tasks on the workflow design surface. If is set to `true` and is set to , performs layout tasks, but no resizing tasks. If is set to `false`, all contained designers retain their previous locations on the . ]]> @@ -1259,9 +1259,9 @@ always sets the property to an empty string and the property to `null` (`Nothing` in Visual Basic). + Unless overridden in a derived class, always sets the property to an empty string and the property to `null` (`Nothing` in Visual Basic). - If is set to `true`, the locations of each child designer in the is snapped to the nearest grid line. + If is set to `true`, the locations of each child designer in the is snapped to the nearest grid line. ]]> @@ -1293,7 +1293,7 @@ deletes the specified connector from the collection and calls the method. + deletes the specified connector from the collection and calls the method. ]]> @@ -1329,9 +1329,9 @@ sets new bounds for the resized designer and performs all required layout operations for the on the workflow design surface. + sets new bounds for the resized designer and performs all required layout operations for the on the workflow design surface. - `containedDesigner` must be in a child of the before you call . If it is not, throws an . + `containedDesigner` must be in a child of the before you call . If it is not, throws an . ]]> @@ -1367,9 +1367,9 @@ modifies the z-order for the to display the specified as the bottom visible designer on the design surface. You can use this method to display a designer at the bottom of the z-order when a user deselects it. + modifies the z-order for the to display the specified as the bottom visible designer on the design surface. You can use this method to display a designer at the bottom of the z-order when a user deselects it. - `containedDesigner` must be in a child of the before you call . If it is not, throws an . + `containedDesigner` must be in a child of the before you call . If it is not, throws an . ]]> @@ -1403,7 +1403,7 @@ , always returns `false`. + Unless overridden in a class that derives from , always returns `false`. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/HitTestInfo.xml b/xml/System.Workflow.ComponentModel.Design/HitTestInfo.xml index dff61fef5ca..fb45d16e118 100644 --- a/xml/System.Workflow.ComponentModel.Design/HitTestInfo.xml +++ b/xml/System.Workflow.ComponentModel.Design/HitTestInfo.xml @@ -30,7 +30,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - The class, in conjunction with the method of the is used to determine which part of an the user has clicked. The class contains the location and associated designer that was clicked. + The class, in conjunction with the method of the is used to determine which part of an the user has clicked. The class contains the location and associated designer that was clicked. ]]> @@ -159,7 +159,7 @@ to determine on what area of the designer the hit occurred. + Use the to determine on what area of the designer the hit occurred. ]]> @@ -189,7 +189,7 @@ to determine which designer was hit. This is useful for insertion or deletion operations. + Use the value returned by to determine which designer was hit. This is useful for insertion or deletion operations. ]]> @@ -253,7 +253,7 @@ , will return the activity associated with the designer, or null reference (`Nothing`) if no designer is associated with the . + Use `SelectableObject` to get the selectable object associated with the hit area. If a designer is associated with the , will return the activity associated with the designer, or null reference (`Nothing`) if no designer is associated with the . ]]> @@ -288,7 +288,7 @@ to store user information about the . If no user data has been stored, calling creates a new, empty dictionary for use. + Use to store user information about the . If no user data has been stored, calling creates a new, empty dictionary for use. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/HitTestLocations.xml b/xml/System.Workflow.ComponentModel.Design/HitTestLocations.xml index 8c077f7d2fd..83c89ccc802 100644 --- a/xml/System.Workflow.ComponentModel.Design/HitTestLocations.xml +++ b/xml/System.Workflow.ComponentModel.Design/HitTestLocations.xml @@ -33,7 +33,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - is used by methods to describe the area of the designer hit by mouse clicks and drag and drop operations. Use the to decide what kind of action to take in response to a successful hit test. + is used by methods to describe the area of the designer hit by mouse clicks and drag and drop operations. Use the to decide what kind of action to take in response to a successful hit test. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/IDesignerGlyphProviderService.xml b/xml/System.Workflow.ComponentModel.Design/IDesignerGlyphProviderService.xml index f4ed77d1f66..dff6d149fea 100644 --- a/xml/System.Workflow.ComponentModel.Design/IDesignerGlyphProviderService.xml +++ b/xml/System.Workflow.ComponentModel.Design/IDesignerGlyphProviderService.xml @@ -81,7 +81,7 @@ returns an collection that is associated with a specific . + returns an collection that is associated with a specific . ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/IDesignerVerbProviderService.xml b/xml/System.Workflow.ComponentModel.Design/IDesignerVerbProviderService.xml index a1d82ffed12..396be70f0f8 100644 --- a/xml/System.Workflow.ComponentModel.Design/IDesignerVerbProviderService.xml +++ b/xml/System.Workflow.ComponentModel.Design/IDesignerVerbProviderService.xml @@ -20,15 +20,15 @@ Allows activity designer developers to add custom designer verb providers to an activity designer. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Classes that implement this interface can add and remove custom verb providers--any classes that implement the interface -- to and from classes. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Classes that implement this interface can add and remove custom verb providers--any classes that implement the interface -- to and from classes. + ]]> @@ -103,11 +103,11 @@ Gets an read-only collection. An read-only collection. - returns an collection that contains all verb providers associated with a specific . - + returns an collection that contains all verb providers associated with a specific . + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/IIdentifierCreationService.xml b/xml/System.Workflow.ComponentModel.Design/IIdentifierCreationService.xml index 7ee7546be16..30fac8436fd 100644 --- a/xml/System.Workflow.ComponentModel.Design/IIdentifierCreationService.xml +++ b/xml/System.Workflow.ComponentModel.Design/IIdentifierCreationService.xml @@ -61,7 +61,7 @@ to ensure activities inserted into a have unique identifiers. + Use to ensure activities inserted into a have unique identifiers. ]]> @@ -95,7 +95,7 @@ to make sure an identifier is unique and properly formatted for use within a specified . + Use to make sure an identifier is unique and properly formatted for use within a specified . ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/ParallelActivityDesigner.xml b/xml/System.Workflow.ComponentModel.Design/ParallelActivityDesigner.xml index f97fc7c95c3..ca91acf806e 100644 --- a/xml/System.Workflow.ComponentModel.Design/ParallelActivityDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/ParallelActivityDesigner.xml @@ -133,7 +133,7 @@ property or the property is set to `false`, returns a null reference (`Nothing` in Visual Basic). If the property count is greater than 0, returns the associated with the first activity designer in the collection. + If the designer's property or the property is set to `false`, returns a null reference (`Nothing` in Visual Basic). If the property count is greater than 0, returns the associated with the first activity designer in the collection. ]]> @@ -216,7 +216,7 @@ or property is set to `false`, returns a null reference (`Nothing` in Visual Basic). If contains child activity designers, returns the last selectable object associated with the first child activity designer. If the child activity designer is collapsed, returns the associated with the first activity designer in the collection. + If the designer's or property is set to `false`, returns a null reference (`Nothing` in Visual Basic). If contains child activity designers, returns the last selectable object associated with the first child activity designer. If the child activity designer is collapsed, returns the associated with the first activity designer in the collection. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/ReadOnlyActivityGlyph.xml b/xml/System.Workflow.ComponentModel.Design/ReadOnlyActivityGlyph.xml index 658d19d5d75..6ac9791a474 100644 --- a/xml/System.Workflow.ComponentModel.Design/ReadOnlyActivityGlyph.xml +++ b/xml/System.Workflow.ComponentModel.Design/ReadOnlyActivityGlyph.xml @@ -23,13 +23,13 @@ Provides a glyph for an to display when the activity it is associated with is set to read only at design time. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + ]]> @@ -135,11 +135,11 @@ Gets the priority setting for the glyph on the activity designer surface. An integer value that represents the priority setting for the on the activity designer surface. - always returns the integer value associated with . - + always returns the integer value associated with . + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/SelectionGlyph.xml b/xml/System.Workflow.ComponentModel.Design/SelectionGlyph.xml index 31e1975a09f..81778b68f6c 100644 --- a/xml/System.Workflow.ComponentModel.Design/SelectionGlyph.xml +++ b/xml/System.Workflow.ComponentModel.Design/SelectionGlyph.xml @@ -23,15 +23,15 @@ Provides methods and properties for all glyph classes that an displays when it is selected on the workflow design surface. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Some glyphs that are displayed on an activity designer can be selected by the user while others cannot. When a user selects a glyph that can be selected, the glyph changes appearance on the activity design surface. The class is the base class for all glyph classes that change appearance when a user selects it on the activity design surface. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Some glyphs that are displayed on an activity designer can be selected by the user while others cannot. When a user selects a glyph that can be selected, the glyph changes appearance on the activity design surface. The class is the base class for all glyph classes that change appearance when a user selects it on the activity design surface. + ]]> @@ -84,11 +84,11 @@ Returns the bounds for the selection glyph on the specified . A that represents the bounds for the glyph. - returns a rectangle one-and-one-half times the size of the of `designer`. - + returns a rectangle one-and-one-half times the size of the of `designer`. + ]]> @@ -117,11 +117,11 @@ Returns an array of rectangles that represents the selected glyph's grab handles. A array of the grab handles to display on the selected glyph. - @@ -179,11 +179,11 @@ The from which to obtain information about user actions. Performs any tasks required to render the glyph on the activity designer surface. - draws all elements of the glyph that the user selects, including the glyphs grab handles. - + draws all elements of the glyph that the user selects, including the glyphs grab handles. + ]]> @@ -208,13 +208,13 @@ Gets the view priority of the glyph on the activity designer. An integer that represents the view priority of the glyph on the activity designer. - fields: - - , , and . - + fields: + + , , and . + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/SequentialActivityDesigner.xml b/xml/System.Workflow.ComponentModel.Design/SequentialActivityDesigner.xml index 154de0f8257..37885d15fbe 100644 --- a/xml/System.Workflow.ComponentModel.Design/SequentialActivityDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/SequentialActivityDesigner.xml @@ -107,9 +107,9 @@ returns `true`, the designer renders an expand-collapse button on the workflow design surface. + If returns `true`, the designer renders an expand-collapse button on the workflow design surface. - If the parent designer of the is , returns `false`. Additionally, if the is the root designer, returns `false`. + If the parent designer of the is , returns `false`. Additionally, if the is the root designer, returns `false`. ]]> @@ -184,7 +184,7 @@ returns an empty array. If there are no activity designers in the parent designer, returns an array of one rectangle. + If the current designer is not the active designer or if the designer is not expanded, returns an empty array. If there are no activity designers in the parent designer, returns an array of one rectangle. ]]> @@ -366,7 +366,7 @@ is based on the point on the workflow design surface that was passed to it. It includes the activity designer associated with the point, the bounds of that activity designer, the exact hit location of the point, any selectable objects associated with the point, and any user data associated with the point. + The information returned by is based on the point on the workflow design surface that was passed to it. It includes the activity designer associated with the point, the bounds of that activity designer, the exact hit location of the point, any selectable objects associated with the point, and any user data associated with the point. ]]> @@ -398,7 +398,7 @@ assigns a value for the property that is displayed on the if it does not contain any child designers. + assigns a value for the property that is displayed on the if it does not contain any child designers. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/SequentialWorkflowRootDesigner.xml b/xml/System.Workflow.ComponentModel.Design/SequentialWorkflowRootDesigner.xml index f65ad0f143e..dc1bb45b414 100644 --- a/xml/System.Workflow.ComponentModel.Design/SequentialWorkflowRootDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/SequentialWorkflowRootDesigner.xml @@ -82,7 +82,7 @@ returns `false`. + Root designers cannot have a parent activity designer on a workflow design surface. Unless overridden in an inheriting class, returns `false`. ]]> @@ -112,7 +112,7 @@ is always set to `false`. + Unless overridden in a deriving class, is always set to `false`. ]]> @@ -141,7 +141,7 @@ appear at the bottom of the root designer on the workflow design surface. Icons and text can be displayed in the footer, including button icons that change the designer view when a user selects one of them. + The contents of appear at the bottom of the root designer on the workflow design surface. Icons and text can be displayed in the footer, including button icons that change the designer view when a user selects one of them. ]]> @@ -225,7 +225,7 @@ appear at the top of the root designer on the workflow design surface. Icons and text can be displayed in the header, including text that indicates the designer view that is currently displayed on the design surface. + The contents of appear at the top of the root designer on the workflow design surface. Icons and text can be displayed in the header, including text that indicates the designer view that is currently displayed on the design surface. ]]> @@ -256,7 +256,7 @@ ## Remarks property is set to the to display. You can do this at design time or at run time. - Unless overridden in a derived class, returns a null reference (`Nothing` in Visual Basic). + Unless overridden in a derived class, returns a null reference (`Nothing` in Visual Basic). ]]> @@ -285,7 +285,7 @@ to retrieve the coordinates for the rectangle that encloses the image associated with the designer. You can use these coordinates for drawing connectors or overlaying graphics. + Use the to retrieve the coordinates for the rectangle that encloses the image associated with the designer. You can use these coordinates for drawing connectors or overlaying graphics. ]]> @@ -336,7 +336,7 @@ represents the smallest size to which a user can resize the . + represents the smallest size to which a user can resize the . ]]> @@ -394,9 +394,9 @@ draws any text to include in the headers and footers with the appropriate theme settings. It also draws any images to include in the headers and footers. + draws any text to include in the headers and footers with the appropriate theme settings. It also draws any images to include in the headers and footers. - **Note** When you override in a derived class, be sure to call the method of the base class so that registered delegates receive the event. + **Note** When you override in a derived class, be sure to call the method of the base class so that registered delegates receive the event. ]]> @@ -431,9 +431,9 @@ invalidates the text rectangle associated with the . + When called, invalidates the text rectangle associated with the . - **Note** When you override in a derived class, be sure to call the base class's method so that registered delegates receive the event. + **Note** When you override in a derived class, be sure to call the base class's method so that registered delegates receive the event. ]]> @@ -463,7 +463,7 @@ property is not set to a null reference (`Nothing` in Visual Basic) and the corresponding property is not an empty string or set to a null reference (`Nothing`), returns `true`. + If the property is not set to a null reference (`Nothing` in Visual Basic) and the corresponding property is not an empty string or set to a null reference (`Nothing`), returns `true`. ]]> @@ -492,7 +492,7 @@ and to display a smart tag of available at the location specified by . + You can use and to display a smart tag of available at the location specified by . ]]> @@ -521,7 +521,7 @@ returns . + Unless overridden in an inheriting class, returns . ]]> @@ -552,7 +552,7 @@ ## Remarks A root designer title area typically contains the header and any icon associated with the designer. - calculates the integer it returns by getting the value of its base implementation and adding the height integer defined for the . + calculates the integer it returns by getting the value of its base implementation and adding the height integer defined for the . ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/StructuredCompositeActivityDesigner.xml b/xml/System.Workflow.ComponentModel.Design/StructuredCompositeActivityDesigner.xml index 4274c701231..c7901e053f8 100644 --- a/xml/System.Workflow.ComponentModel.Design/StructuredCompositeActivityDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/StructuredCompositeActivityDesigner.xml @@ -83,7 +83,7 @@ contains the view ID and any text, images, activity designers, and user data associated with the view. + contains the view ID and any text, images, activity designers, and user data associated with the view. ]]> @@ -277,7 +277,7 @@ returns the associated with the property that is exposed through . + returns the associated with the property that is exposed through . ]]> @@ -336,7 +336,7 @@ class can contain other designers, and returns a read-only collection of all the connection points for the designers associated with `edges` that are contained by the . + Connectors are links between separate designers on a workflow design surface. These links appear as lines on the design surface and each line end connects to a visible point on each designer it connects. These points are called connection points. Designer classes that inherit from the class can contain other designers, and returns a read-only collection of all the connection points for the designers associated with `edges` that are contained by the . ]]> @@ -396,7 +396,7 @@ ensures that the active view loaded into the workflow design surface is a valid view. + ensures that the active view loaded into the workflow design surface is a valid view. ]]> @@ -452,7 +452,7 @@ is the active activity designer, returns `null` (`Nothing` in Visual Basic). If a child activity designer is the active designer, it returns the last selectable object associated with the active child designer. + If the is the active activity designer, returns `null` (`Nothing` in Visual Basic). If a child activity designer is the active designer, it returns the last selectable object associated with the active child designer. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/TypeBrowserDialog.xml b/xml/System.Workflow.ComponentModel.Design/TypeBrowserDialog.xml index 485a9a6b2bf..555700605d1 100644 --- a/xml/System.Workflow.ComponentModel.Design/TypeBrowserDialog.xml +++ b/xml/System.Workflow.ComponentModel.Design/TypeBrowserDialog.xml @@ -30,15 +30,15 @@ Represents a dialog box that allows the user to choose a type. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - This class prompts the user to browse a list of Windows Workflow Foundation and .NET Framework namespaces and their contained types and select a single type. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + This class prompts the user to browse a list of Windows Workflow Foundation and .NET Framework namespaces and their contained types and select a single type. + ]]> @@ -304,13 +304,13 @@ Gets the component to associate with the type browser dialog box. The to bind to the . - . - - This property is required because implements . For , always returns a null reference (`Nothing` in Visual Basic). - + . + + This property is required because implements . For , always returns a null reference (`Nothing` in Visual Basic). + ]]> @@ -338,13 +338,13 @@ Gets the container to associate with the type browser dialog. The to associate with the . - returns a null reference (`Nothing` in Visual Basic), has not bound an to the . - - This method is required because implements . For , always returns a null reference (`Nothing` in Visual Basic). - + returns a null reference (`Nothing` in Visual Basic), has not bound an to the . + + This method is required because implements . For , always returns a null reference (`Nothing` in Visual Basic). + ]]> @@ -373,11 +373,11 @@ if is in design mode; otherwise, . The default is . - implements . For , always returns `true`. - + implements . For , always returns `true`. + ]]> @@ -405,11 +405,11 @@ Gets or sets name of the component associated with the type browser dialog. The name of the component associated with the type browser dialog. - implements . - + implements . + ]]> @@ -441,11 +441,11 @@ Retrieves the service object for the specified type. A service object of type , or a null reference ( in Visual Basic) if there is no service object of type . - , returns a service object. Otherwise, it returns a null reference (`Nothing` in Visual Basic). - + , returns a service object. Otherwise, it returns a null reference (`Nothing` in Visual Basic). + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/WorkflowDesignerLoader.xml b/xml/System.Workflow.ComponentModel.Design/WorkflowDesignerLoader.xml index 3217077775a..02904fd36f2 100644 --- a/xml/System.Workflow.ComponentModel.Design/WorkflowDesignerLoader.xml +++ b/xml/System.Workflow.ComponentModel.Design/WorkflowDesignerLoader.xml @@ -30,7 +30,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - Designer loader classes are used to load the designer and save any changes to the state of the designer when the user so instructs. The class can be implemented to support custom loading of a workflow designer and workflow designer components. A workflow designer loader is also responsible for writing changes to an open document back to the storage the loader used when loading the document after the method is called. + Designer loader classes are used to load the designer and save any changes to the state of the designer when the user so instructs. The class can be implemented to support custom loading of a workflow designer and workflow designer components. A workflow designer loader is also responsible for writing changes to an open document back to the storage the loader used when loading the document after the method is called. ]]> @@ -106,7 +106,7 @@ releases all services used by the designer host, but it does not write pending changes to the designer loader. If you want to save any pending changes prior to releasing all resources, call before you call . + releases all services used by the designer host, but it does not write pending changes to the designer loader. If you want to save any pending changes prior to releasing all resources, call before you call . ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/WorkflowDesignerMessageFilter.xml b/xml/System.Workflow.ComponentModel.Design/WorkflowDesignerMessageFilter.xml index 3acfab47595..fc9a227579c 100644 --- a/xml/System.Workflow.ComponentModel.Design/WorkflowDesignerMessageFilter.xml +++ b/xml/System.Workflow.ComponentModel.Design/WorkflowDesignerMessageFilter.xml @@ -36,7 +36,7 @@ The workflow designer provides a `Strategy` design pattern to create replaceable message filter objects to handle events. - Derive from the class to create message filters that can respond to workflow designer events, such as drag operations, layout and paint operations, and other designer events. To add a custom message filter to the message filters chain, call the on the or override the virtual property on the custom root activity and add the custom message filter to the collection returned from the base class. + Derive from the class to create message filters that can respond to workflow designer events, such as drag operations, layout and paint operations, and other designer events. To add a custom message filter to the message filters chain, call the on the or override the virtual property on the custom root activity and add the custom message filter to the collection returned from the base class. ]]> @@ -121,7 +121,7 @@ method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the `disposing` parameter set to `true`. invokes `Dispose` with disposing set to `false`. + This method is called by the public `Dispose()` method and the method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the `disposing` parameter set to `true`. invokes `Dispose` with disposing set to `false`. When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this references. This method invokes the `Dispose()` method of each referenced object. @@ -252,7 +252,7 @@ occurs when the mouse button is released above an object during a drag operation. + occurs when the mouse button is released above an object during a drag operation. ]]> @@ -286,7 +286,7 @@ occurs when the mouse pointer enters the bounds of an object during a drag operation. + occurs when the mouse pointer enters the bounds of an object during a drag operation. ]]> @@ -317,7 +317,7 @@ occurs when the mouse pointer leaves the bounds of an object during a drag operation. + occurs when the mouse pointer leaves the bounds of an object during a drag operation. ]]> @@ -351,7 +351,7 @@ occurs when the mouse pointer moves within the bounds of an object during a drag operation. + occurs when the mouse pointer moves within the bounds of an object during a drag operation. ]]> @@ -385,7 +385,7 @@ occurs when a drag operation is started. allows the source of a drag operation to modify the appearance of the mouse pointer to give you visual feedback during a drag operation. + occurs when a drag operation is started. allows the source of a drag operation to modify the appearance of the mouse pointer to give you visual feedback during a drag operation. ]]> @@ -419,7 +419,7 @@ occurs when a key is pressed when a specific object has focus. + occurs when a key is pressed when a specific object has focus. ]]> @@ -453,7 +453,7 @@ occurs when a key is released when a specific object has focus. + occurs when a key is released when a specific object has focus. ]]> @@ -485,7 +485,7 @@ occurs when child objects should be repositioned within the parent container. + occurs when child objects should be repositioned within the parent container. ]]> @@ -516,7 +516,7 @@ occurs when the items selected by dragging the mouse changes. + occurs when the items selected by dragging the mouse changes. ]]> @@ -550,7 +550,7 @@ occurs when you double-click the mouse. The double-click is determined by the mouse settings of the operating system. You can set the time between clicks of a mouse button that is considered a double-click rather than two clicks. + occurs when you double-click the mouse. The double-click is determined by the mouse settings of the operating system. You can set the time between clicks of a mouse button that is considered a double-click rather than two clicks. ]]> @@ -584,7 +584,7 @@ occurs when a mouse button is clicked. + occurs when a mouse button is clicked. ]]> @@ -618,7 +618,7 @@ occurs when the mouse pointer enters the bounds of an object. + occurs when the mouse pointer enters the bounds of an object. ]]> @@ -652,7 +652,7 @@ occurs when the mouse pointer hovers above an object. + occurs when the mouse pointer hovers above an object. ]]> @@ -683,7 +683,7 @@ occurs when the mouse pointer leaves the bounds of an object. + occurs when the mouse pointer leaves the bounds of an object. ]]> @@ -717,7 +717,7 @@ occurs when the mouse pointer moves while within the bounds of an object. + occurs when the mouse pointer moves while within the bounds of an object. ]]> @@ -751,7 +751,7 @@ occurs when you release a mouse button. + occurs when you release a mouse button. ]]> @@ -785,7 +785,7 @@ occurs when the mouse wheel moves. + occurs when the mouse wheel moves. ]]> @@ -823,7 +823,7 @@ occurs when a paint message is received. Use the parameters passed to to determine the area to be painted, the theme used, and additional information about the event passed in the `PaintEventArgs`. + occurs when a paint message is received. Use the parameters passed to to determine the area to be painted, the theme used, and additional information about the event passed in the `PaintEventArgs`. ]]> @@ -931,9 +931,9 @@ occurs when you use a scroll bar on a designer to scroll up, down, left, or right. + occurs when you use a scroll bar on a designer to scroll up, down, left, or right. - Unless overridden in a derived class, always returns `false`. + Unless overridden in a derived class, always returns `false`. ]]> @@ -967,7 +967,7 @@ occurs when the workflow should show a context menu. + occurs when the workflow should show a context menu. ]]> @@ -996,7 +996,7 @@ occurs when you make changes to the workflow theme. + occurs when you make changes to the workflow theme. ]]> @@ -1025,7 +1025,7 @@ . The message filter is associated with a using . When an event occurs in the it passes the message on to the to be handled. + A message filter responds to events in a . The message filter is associated with a using . When an event occurs in the it passes the message on to the to be handled. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/WorkflowMenuCommands.xml b/xml/System.Workflow.ComponentModel.Design/WorkflowMenuCommands.xml index 22d55d840ae..a25c132499b 100644 --- a/xml/System.Workflow.ComponentModel.Design/WorkflowMenuCommands.xml +++ b/xml/System.Workflow.ComponentModel.Design/WorkflowMenuCommands.xml @@ -30,7 +30,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - contains a set of fields that can be used to specify a command to link when adding a command using the method of the . + contains a set of fields that can be used to specify a command to link when adding a command using the method of the . ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/WorkflowOutline.xml b/xml/System.Workflow.ComponentModel.Design/WorkflowOutline.xml index 0ef818c1013..ffc70a6fcf5 100644 --- a/xml/System.Workflow.ComponentModel.Design/WorkflowOutline.xml +++ b/xml/System.Workflow.ComponentModel.Design/WorkflowOutline.xml @@ -297,10 +297,10 @@ method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. > [!NOTE] -> When overriding in a derived class, be sure to call the base class's `OnLoad` method so that registered delegates receive the event. +> When overriding in a derived class, be sure to call the base class's `OnLoad` method so that registered delegates receive the event. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/WorkflowOutlineNode.xml b/xml/System.Workflow.ComponentModel.Design/WorkflowOutlineNode.xml index bf0d63056fb..841a9b24fd9 100644 --- a/xml/System.Workflow.ComponentModel.Design/WorkflowOutlineNode.xml +++ b/xml/System.Workflow.ComponentModel.Design/WorkflowOutlineNode.xml @@ -23,15 +23,15 @@ Represents a node in a workflow outline document displayed in the workflow designer. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - A contains one for each activity a user adds to a workflow design surface. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + A contains one for each activity a user adds to a workflow design surface. + ]]> @@ -80,11 +80,11 @@ Gets the activity associated with the node. The associated with the . - document by a . - + document by a . + ]]> @@ -134,11 +134,11 @@ Updates property settings on the . - updates the foreground color and text of the to the settings associated with the activity the node represents on the workflow design surface. - + updates the foreground color and text of the to the settings associated with the activity the node represents on the workflow design surface. + ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/WorkflowTheme.xml b/xml/System.Workflow.ComponentModel.Design/WorkflowTheme.xml index bebf52780ff..48adce3e69b 100644 --- a/xml/System.Workflow.ComponentModel.Design/WorkflowTheme.xml +++ b/xml/System.Workflow.ComponentModel.Design/WorkflowTheme.xml @@ -154,7 +154,7 @@ to get the directory part of the . + Use to get the directory part of the . ]]> @@ -187,7 +187,7 @@ to create a new theme available anyone who uses the workflow designer. + Use to create a new theme available anyone who uses the workflow designer. ]]> @@ -216,7 +216,7 @@ to make changes to the theme used to display the workflow. + Use to make changes to the theme used to display the workflow. ]]> @@ -274,7 +274,7 @@ to retrieve a list of designer themes that are associated with the workflow. + Use to retrieve a list of designer themes that are associated with the workflow. ]]> @@ -343,7 +343,7 @@ represents the path to the file that stores the theme settings. + The represents the path to the file that stores the theme settings. ]]> @@ -373,7 +373,7 @@ (`false`). Override to customize the cleanup. + This method cleans up resources by calling (`false`). Override to customize the cleanup. ]]> @@ -403,7 +403,7 @@ to create a unique file path for the theme. + Use to create a unique file path for the theme. ]]> @@ -442,7 +442,7 @@ to retrieve the theme associated with a specified activity designer. + Use to retrieve the theme associated with a specified activity designer. ]]> @@ -691,7 +691,7 @@ to persist a theme to a file. + Use to persist a theme to a file. ]]> @@ -720,7 +720,7 @@ to save the theme to the registry using the key specified by . + Use to save the theme to the registry using the key specified by . ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/WorkflowView.xml b/xml/System.Workflow.ComponentModel.Design/WorkflowView.xml index b5d6b223efa..c1846dc0942 100644 --- a/xml/System.Workflow.ComponentModel.Design/WorkflowView.xml +++ b/xml/System.Workflow.ComponentModel.Design/WorkflowView.xml @@ -271,7 +271,7 @@ method, it will be called when the property is referenced. + If you do not explicitly call the method, it will be called when the property is referenced. > [!NOTE] > To create a , you must add a reference to the `Accessibility` assembly installed with the .NET Framework. @@ -371,7 +371,7 @@ when you are working with an object in the workflow that requires user interface cues. will expand parent objects and scroll the as necessary to make the object visible on the designer. + Use when you are working with an object in the workflow that requires user interface cues. will expand parent objects and scroll the as necessary to make the object visible on the designer. ]]> @@ -539,7 +539,7 @@ to cause a , in client coordinates, to be added to the update region. + Use to cause a , in client coordinates, to be added to the update region. ]]> @@ -571,7 +571,7 @@ to cause a , in logical coordinates, to be added to the update region. + Use to cause a , in logical coordinates, to be added to the update region. ]]> @@ -603,7 +603,7 @@ restores view-state information previously saved by calling the method. + restores view-state information previously saved by calling the method. Override this method when you need to customize how a custom designer restores its view-state. @@ -785,7 +785,7 @@ is called when a child control is added to the . The only child controls allowed are and controls. + is called when a child control is added to the . The only child controls allowed are and controls. ]]> @@ -818,7 +818,7 @@ occurs when the user releases the mouse button over the during a drag operation. + occurs when the user releases the mouse button over the during a drag operation. ]]> @@ -850,7 +850,7 @@ occurs when the user first drags the mouse cursor over the during a drag operation. + occurs when the user first drags the mouse cursor over the during a drag operation. ]]> @@ -882,7 +882,7 @@ occurs when the user drags the mouse cursor out of the during a drag operation. + occurs when the user drags the mouse cursor out of the during a drag operation. ]]> @@ -914,7 +914,7 @@ occurs when the mouse cursor moves within bounds of the . + occurs when the mouse cursor moves within bounds of the . ]]> @@ -946,7 +946,7 @@ occurs when a drag operation is started. allows the source of a drag operation to modify the appearance of the mouse pointer in order to give the user visual feedback during a drag operation. + occurs when a drag operation is started. allows the source of a drag operation to modify the appearance of the mouse pointer in order to give the user visual feedback during a drag operation. ]]> @@ -978,7 +978,7 @@ occurs when a key is pressed while the has focus. + occurs when a key is pressed while the has focus. ]]> @@ -1010,7 +1010,7 @@ occurs when a key is released while the has focus. + occurs when a key is released while the has focus. ]]> @@ -1042,7 +1042,7 @@ occurs when child controls are added or removed, when the bounds of the changes, and when other changes occur that can affect the layout of the . + occurs when child controls are added or removed, when the bounds of the changes, and when other changes occur that can affect the layout of the . ]]> @@ -1074,7 +1074,7 @@ occurs when the user makes a selection with the mouse that differs from any existing selection. + occurs when the user makes a selection with the mouse that differs from any existing selection. ]]> @@ -1140,15 +1140,15 @@ ## Remarks Mouse events occur in the following order: - 1. + 1. - 2. + 2. - 3./ or + 3./ or - 4. + 4. - 5. + 5. `OnMouseEnter` occurs when the mouse pointer enters the . @@ -1186,17 +1186,17 @@ ## Remarks Mouse events occur in the following order: - 1. + 1. - 2. + 2. - 3. or or + 3. or or - 4. + 4. - 5. + 5. - occurs when the mouse pointer enters the . + occurs when the mouse pointer enters the . ]]> @@ -1230,17 +1230,17 @@ ## Remarks Mouse events occur in the following order: - 1. + 1. - 2. + 2. - 3. or or + 3. or or - 4. + 4. - 5. + 5. - occurs when the mouse pointer hovers over the . + occurs when the mouse pointer hovers over the . ]]> @@ -1274,17 +1274,17 @@ ## Remarks Mouse events occur in the following order: - 1. + 1. - 2. + 2. - 3. or or + 3. or or - 4. + 4. - 5. + 5. - occurs when the mouse pointer leaves the . + occurs when the mouse pointer leaves the . ]]> @@ -1318,17 +1318,17 @@ ## Remarks Mouse events occur in the following order: - 1. + 1. - 2. + 2. - 3. or or + 3. or or - 4. + 4. - 5. + 5. - occurs when the mouse pointer moves over the . + occurs when the mouse pointer moves over the . ]]> @@ -1362,17 +1362,17 @@ ## Remarks Mouse events occur in the following order: - 1. + 1. - 2. + 2. - 3. or or + 3. or or - 4. + 4. - 5. + 5. - occurs when the mouse pointer is over the and a button is released. + occurs when the mouse pointer is over the and a button is released. ]]> @@ -1406,17 +1406,17 @@ ## Remarks Mouse events occur in the following order: - 1. + 1. - 2. + 2. - 3. or or + 3. or or - 4. + 4. - 5. + 5. - occurs when the mouse wheel is moved over the . + occurs when the mouse wheel is moved over the . ]]> @@ -1448,7 +1448,7 @@ occurs when the is redrawn. + occurs when the is redrawn. ]]> @@ -1480,30 +1480,30 @@ event is raised when there is a change in the keyboard or mouse button state during a drag operation. The event allows the drag source to determine whether the drag operation should be canceled. + The event is raised when there is a change in the keyboard or mouse button state during a drag operation. The event allows the drag source to determine whether the drag operation should be canceled. - Events related to drag operations are raised when the control is a valid drop target. The event is raised with the drag effect specified. For a list of drag effects, see the enumeration. + Events related to drag operations are raised when the control is a valid drop target. The event is raised with the drag effect specified. For a list of drag effects, see the enumeration. Changes in the mouse cursor position, keyboard state, and mouse button state are tracked. -- If the user moves out of a window, the event is raised. +- If the user moves out of a window, the event is raised. -- If the mouse enters another control, the for that control is raised. +- If the mouse enters another control, the for that control is raised. -- If the mouse moves but stays within the same control, the event is raised. +- If the mouse moves but stays within the same control, the event is raised. - If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the `Action` property of the event . + If there is a change in the keyboard or mouse button state, the event is raised and determines whether to continue the drag, to drop the data, or to cancel the operation based on the value of the `Action` property of the event . - If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. + If the value is `DragAction.Continue`, the event is raised to continue the operation and the event is raised with the new effect so appropriate visual feedback can be set. For a list of valid drop effects, see the enumeration. > [!NOTE] -> The and events are paired so that as the mouse moves across the drop target, the user is given the most up-to-date feedback on the mouse position. +> The and events are paired so that as the mouse moves across the drop target, the user is given the most up-to-date feedback on the mouse position. If the value is `DragAction.Drop`, the drop effect value is returned to the source, so the source application can perform the appropriate operation on the source data; for example, cut the data if the operation was a move. - If the value is `DragAction.Cancel`, the event is raised. + If the value is `DragAction.Cancel`, the event is raised. - By default, the event sets `Action` to `DragAction.Cancel` if the ESC key was pressed and sets `Action` to `DragAction.Drop` if the left, middle, or right mouse button is pressed. + By default, the event sets `Action` to `DragAction.Cancel` if the ESC key was pressed and sets `Action` to `DragAction.Drop` if the left, middle, or right mouse button is pressed. ]]> @@ -1580,7 +1580,7 @@ updates all child controls in the , resizing and moving them as necessary. + updates all child controls in the , resizing and moving them as necessary. ]]> @@ -1609,7 +1609,7 @@ object to set the properties that describe how to print, and call the `Print` method to start the printing process. + Use the object to set the properties that describe how to print, and call the `Print` method to start the printing process. ]]> @@ -1747,7 +1747,7 @@ method. + View state is the accumulation of the values of the properties and child controls of a view. Property values are persisted to the stream after saving and can be restored using the method. ]]> @@ -1915,7 +1915,7 @@ to get or adjust the location of the scrollbar in the design surface. + Use the to get or adjust the location of the scrollbar in the design surface. ]]> @@ -1944,7 +1944,7 @@ to get or adjust the shadow depth of text shown on the workflow design surface. + Use the to get or adjust the shadow depth of text shown on the workflow design surface. ]]> @@ -2071,7 +2071,7 @@ ## Remarks `ToolTips` are helpful notes to the user that display useful information about an object underneath the pointer. - Use to display a `ToolTip` with the specified text and a desired location. + Use to display a `ToolTip` with the specified text and a desired location. ]]> @@ -2166,7 +2166,7 @@ contains the visible area of the workflow. + The contains the visible area of the workflow. ]]> @@ -2224,7 +2224,7 @@ to get the vertical scrollbar on the , which you can use to make user interface adjustments. + Use to get the vertical scrollbar on the , which you can use to make user interface adjustments. ]]> @@ -2256,9 +2256,9 @@ method. + All messages are sent to the method. - The method corresponds exactly to the Windows `WindowProc` function. For more information about processing Windows messages, see [WindowProc function](/previous-versions/windows/desktop/legacy/ms633573(v=vs.85)). + The method corresponds exactly to the Windows `WindowProc` function. For more information about processing Windows messages, see [WindowProc function](/previous-versions/windows/desktop/legacy/ms633573(v=vs.85)). ]]> diff --git a/xml/System.Workflow.ComponentModel.Serialization/ActivityCodeDomSerializationManager.xml b/xml/System.Workflow.ComponentModel.Serialization/ActivityCodeDomSerializationManager.xml index 3897951e0b1..b534446f802 100644 --- a/xml/System.Workflow.ComponentModel.Serialization/ActivityCodeDomSerializationManager.xml +++ b/xml/System.Workflow.ComponentModel.Serialization/ActivityCodeDomSerializationManager.xml @@ -117,7 +117,7 @@ to provide information to a nested . + Use to provide information to a nested . ]]> @@ -164,7 +164,7 @@ method of the same name. + This provides an indirect reference to the method of the same name. ]]> @@ -200,7 +200,7 @@ method of the same name. + This provides an indirect reference to the method of the same name. ]]> @@ -276,7 +276,7 @@ is invoked. + If the object type is a string, a default serializer is returned. Otherwise the corresponding method of the is invoked. ]]> @@ -341,7 +341,7 @@ provides an indirect reference to the property of the same name. + This version of provides an indirect reference to the property of the same name. ]]> @@ -373,9 +373,9 @@ class, you can query about its contents. Use the property to determine the number of elements in the collection. Use the property to obtain a specific property by index number or by name. + Using the properties available in the class, you can query about its contents. Use the property to determine the number of elements in the collection. Use the property to obtain a specific property by index number or by name. - In addition to properties, you can use the method to obtain a description of the property that uses the specified name from the collection. + In addition to properties, you can use the method to obtain a description of the property that uses the specified name from the collection. ]]> @@ -410,9 +410,9 @@ . + `provider` must have been added using . - provides an indirect reference to the property of the same name. + provides an indirect reference to the property of the same name. ]]> @@ -447,11 +447,11 @@ + `errorInformation` can be of any object type. If the object is an exception, the message of the exception is extracted and reported to the user. If the object is any other type, is called to display the information to the user. - provides an indirect reference to the method of the same name. + provides an indirect reference to the method of the same name. ]]> @@ -579,7 +579,7 @@ provides an indirect reference to the method of the same name. + provides an indirect reference to the method of the same name. An exception is thrown if you try to rename an existing object or if you try to give a new object a name that is already taken. In addition, an exception is thrown if you do not pass in an existing object to the method. diff --git a/xml/System.Workflow.ComponentModel.Serialization/ActivityMarkupSerializer.xml b/xml/System.Workflow.ComponentModel.Serialization/ActivityMarkupSerializer.xml index 912f9ce8dea..8bd73c86c84 100644 --- a/xml/System.Workflow.ComponentModel.Serialization/ActivityMarkupSerializer.xml +++ b/xml/System.Workflow.ComponentModel.Serialization/ActivityMarkupSerializer.xml @@ -27,17 +27,17 @@ Provides extensible Application Markup Language (XAML) serialization services for an at design time. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - provides methods that serialize activity class objects into XAML format and deserialize XAML content into activity class objects. These services are primarily used by activity designers to persist the classes on the workflow design surface. - - For more information about serialization, see [Serialization](/dotnet/standard/serialization/). - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + provides methods that serialize activity class objects into XAML format and deserialize XAML content into activity class objects. These services are primarily used by activity designers to persist the classes on the workflow design surface. + + For more information about serialization, see [Serialization](/dotnet/standard/serialization/). + ]]> @@ -107,11 +107,11 @@ The index of the last character in the activity definition. - @@ -135,11 +135,11 @@ The index of the last line in the activity definition. - @@ -169,11 +169,11 @@ The that was serialized. Notifies the that an object has just been serialized. - is called immediately after the method runs and performs post-serialization processing on `obj`, primarily formatting and indenting code and extensible Application Markup Language (XAML) in the .xoml file. - + is called immediately after the method runs and performs post-serialization processing on `obj`, primarily formatting and indenting code and extensible Application Markup Language (XAML) in the .xoml file. + ]]> @@ -203,11 +203,11 @@ The to be serialized. Notifies the that an object is about to be serialized. - is called immediately before the method runs on the activity specified by `obj`. writes the opening extensible Application Markup Language (XAML) tag for the activity, including any required attributes. - + is called immediately before the method runs on the activity specified by `obj`. writes the opening extensible Application Markup Language (XAML) tag for the activity, including any required attributes. + ]]> @@ -235,11 +235,11 @@ The index of the first character in the activity definition. - @@ -263,11 +263,11 @@ The index of the first line in the activity definition. - diff --git a/xml/System.Workflow.ComponentModel.Serialization/ActivityTypeCodeDomSerializer.xml b/xml/System.Workflow.ComponentModel.Serialization/ActivityTypeCodeDomSerializer.xml index 0de7abdba1b..e40336eed96 100644 --- a/xml/System.Workflow.ComponentModel.Serialization/ActivityTypeCodeDomSerializer.xml +++ b/xml/System.Workflow.ComponentModel.Serialization/ActivityTypeCodeDomSerializer.xml @@ -23,15 +23,15 @@ Serializes an to a new type. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - performs the same tasks as , but if you use this class to serialize an it defines a new type. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + performs the same tasks as , but if you use this class to serialize an it defines a new type. + ]]> @@ -110,11 +110,11 @@ Returns the method where the statements used to serialize a member are stored. The used to emit all of the initialization code for the given member. - creates a new . - + creates a new . + ]]> diff --git a/xml/System.Workflow.ComponentModel.Serialization/ContentPropertyAttribute.xml b/xml/System.Workflow.ComponentModel.Serialization/ContentPropertyAttribute.xml index de31e0a2893..1df5d515c84 100644 --- a/xml/System.Workflow.ComponentModel.Serialization/ContentPropertyAttribute.xml +++ b/xml/System.Workflow.ComponentModel.Serialization/ContentPropertyAttribute.xml @@ -32,7 +32,7 @@ For Windows Workflow Foundation, the following restrictions pertain to : -- , , and are not supported `ContentProperty` types. +- , , and are not supported `ContentProperty` types. - An empty string is deserialized as a null value. @@ -96,7 +96,7 @@ ## Remarks For Windows Workflow Foundation, the following restrictions pertain to `ContentPropertyAttribute`: -- , , and are not supported `ContentProperty` types. +- , , and are not supported `ContentProperty` types. - An empty string will be deserialized as a null value. @@ -133,7 +133,7 @@ ## Remarks The following restrictions pertain to `ContentPropertyAttribute`: -- , , and are not supported `ContentProperty` types. +- , , and are not supported `ContentProperty` types. - An empty string will be deserialized as a null value. diff --git a/xml/System.Workflow.ComponentModel.Serialization/WorkflowMarkupSerializationException.xml b/xml/System.Workflow.ComponentModel.Serialization/WorkflowMarkupSerializationException.xml index e79c6bc6903..3a016937ea5 100644 --- a/xml/System.Workflow.ComponentModel.Serialization/WorkflowMarkupSerializationException.xml +++ b/xml/System.Workflow.ComponentModel.Serialization/WorkflowMarkupSerializationException.xml @@ -23,15 +23,15 @@ The exception that is thrown by methods that perform serialization and deserialization. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - includes information about the line and column locations that caused the exception to be thrown. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + includes information about the line and column locations that caused the exception to be thrown. + ]]> @@ -212,11 +212,11 @@ A that contains the context information about the source or destination of the bits the serializer was using. Sets the specified with information about the . - sets a with all the exception object data targeted for serialization. During de-serialization, the exception is reconstituted from the transmitted over the stream. - + sets a with all the exception object data targeted for serialization. During de-serialization, the exception is reconstituted from the transmitted over the stream. + ]]> diff --git a/xml/System.Workflow.ComponentModel.Serialization/WorkflowMarkupSerializationManager.xml b/xml/System.Workflow.ComponentModel.Serialization/WorkflowMarkupSerializationManager.xml index cec84cd4075..762e7c30a23 100644 --- a/xml/System.Workflow.ComponentModel.Serialization/WorkflowMarkupSerializationManager.xml +++ b/xml/System.Workflow.ComponentModel.Serialization/WorkflowMarkupSerializationManager.xml @@ -24,15 +24,15 @@ Manages design-time serialization to and from extensible Application Markup Language (XAML) for workflows. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - A workflow or activity designer can use to access services useful to managing design-time serialization processes. For example, can be used to create objects, look up types, identify objects, and customize the serialization of particular types. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + A workflow or activity designer can use to access services useful to managing design-time serialization processes. For example, can be used to create objects, look up types, identify objects, and customize the serialization of particular types. + ]]> @@ -85,11 +85,11 @@ The to add. Adds the specified serialization provider to the serialization manager. - adds a custom serialization provider to the serialization manager. Serialization providers can provide custom serializers for a particular type of object or set of types of objects. During serialization, each custom serialization provider is queried to return a serializer for a specific data type, if it can provide one. The serialization manager uses the custom serializer provided by this method before using the default serializer for a particular type. - + adds a custom serialization provider to the serialization manager. Serialization providers can provide custom serializers for a particular type of object or set of types of objects. During serialization, each custom serialization provider is queried to return a serializer for a specific data type, if it can provide one. The serialization manager uses the custom serializer provided by this method before using the default serializer for a particular type. + ]]> @@ -117,11 +117,11 @@ Gets a stack-based, user-defined storage area that is useful for communication between serializers. A that contains information about the current object being serialized. - enables a serializer to set data about the context of an object that it is serializing to a where another serializer can access it. - + enables a serializer to set data about the context of an object that it is serializing to a where another serializer can access it. + ]]> @@ -248,13 +248,13 @@ Returns that type associated with the specified XML qualified name. The associated with . - objects. It is the responsibility of the user to ensure the local name does not contain a ":" - + objects. It is the responsibility of the user to ensure the local name does not contain a ":" + ]]> @@ -367,11 +367,11 @@ The error to report. Reports an error in serialization. - is called to display the information to the user. - + is called to display the information to the user. + ]]> @@ -432,11 +432,11 @@ Creates an instance of the specified type and adds it to a collection of named instances. The newly created object. - for this to have any effect. - + for this to have any effect. + ]]> @@ -468,11 +468,11 @@ Returns an instance of a created object of the specified name. An instance of the object with the given name, or a null reference ( in Visual Basic) if no object by that name can be found. - . - + . + ]]> @@ -529,11 +529,11 @@ Gets a collection of properties that can be serialized with available serializers. A that contains the properties to serialize. - @@ -561,7 +561,7 @@ @@ -591,7 +591,7 @@ This event provides a way for a serializer to create an object on demand, so tha event, and clear the data after serialization. Restoring the proper state after serialization is important because serializers can be reused during serialization, and leftover state data or open streams might not be correct. @@ -628,11 +628,11 @@ Generally, serialization code is written to emit serialization data and does not The name to assign to the object. Sets the name of the specified existing object. - is useful when you need to create and then name an instance of an object without using . - + is useful when you need to create and then name an instance of an object without using . + ]]> diff --git a/xml/System.Workflow.ComponentModel.Serialization/WorkflowMarkupSerializer.xml b/xml/System.Workflow.ComponentModel.Serialization/WorkflowMarkupSerializer.xml index 4dfb0291e5b..bd3e498cde2 100644 --- a/xml/System.Workflow.ComponentModel.Serialization/WorkflowMarkupSerializer.xml +++ b/xml/System.Workflow.ComponentModel.Serialization/WorkflowMarkupSerializer.xml @@ -131,7 +131,7 @@ provides no default behavior. You must override to provide logic for this method in an inheriting serializer. + Other than exception behavior, provides no default behavior. You must override to provide logic for this method in an inheriting serializer. ]]> @@ -202,7 +202,7 @@ provides no default behavior. You must override to provide logic for this method in an inheriting serializer. + Other than exception behavior, provides no default behavior. You must override to provide logic for this method in an inheriting serializer. ]]> @@ -273,7 +273,7 @@ uses the type constructor that best matches the specified parameter. + uses the type constructor that best matches the specified parameter. ]]> @@ -482,7 +482,7 @@ code1.SetValue(WorkflowMarkupSerializer.EventsProperty, eventsHashtable); always returns `null` (`Nothing`). + Unless overridden in a class that inherits from always returns `null` (`Nothing`). ]]> @@ -578,9 +578,9 @@ code1.SetValue(WorkflowMarkupSerializer.EventsProperty, eventsHashtable); is called immediately after the method runs. You can override in a class that inherits to perform any required processing on `obj` after it has been serialized to extensible Application Markup Language (XAML). + is called immediately after the method runs. You can override in a class that inherits to perform any required processing on `obj` after it has been serialized to extensible Application Markup Language (XAML). - provides no default behavior. You must override it in a derived class to add any processing logic. + provides no default behavior. You must override it in a derived class to add any processing logic. ]]> @@ -614,9 +614,9 @@ code1.SetValue(WorkflowMarkupSerializer.EventsProperty, eventsHashtable); is called immediately after the method runs. You can override in a class that inherits to perform any required processing on `obj` after it has been serialized to extensible Application Markup Language (XAML). + is called immediately after the method runs. You can override in a class that inherits to perform any required processing on `obj` after it has been serialized to extensible Application Markup Language (XAML). - provides no default behavior. You must override it in a derived class to add any processing logic. + provides no default behavior. You must override it in a derived class to add any processing logic. ]]> @@ -650,9 +650,9 @@ code1.SetValue(WorkflowMarkupSerializer.EventsProperty, eventsHashtable); is called immediately before the method runs. You can override in a class that inherits to perform required processing on `obj` before it is serialized to extensible Application Markup Language (XAML). + is called immediately before the method runs. You can override in a class that inherits to perform required processing on `obj` before it is serialized to extensible Application Markup Language (XAML). - provides no default behavior. You must override it in a derived class to add any processing logic. + provides no default behavior. You must override it in a derived class to add any processing logic. ]]> @@ -686,9 +686,9 @@ code1.SetValue(WorkflowMarkupSerializer.EventsProperty, eventsHashtable); is called immediately before the method runs. You can override in a class that inherits to perform required processing on `obj` before it the step in the serialization process has begun. + is called immediately before the method runs. You can override in a class that inherits to perform required processing on `obj` before it the step in the serialization process has begun. - provides no default behavior. You must override it in a derived class to add any processing logic. + provides no default behavior. You must override it in a derived class to add any processing logic. ]]> @@ -766,7 +766,7 @@ code1.SetValue(WorkflowMarkupSerializer.EventsProperty, eventsHashtable); to create a . + You must serialize either a new instance of a workflow type or the root activity in a programmatically-created workflow to create workflow markup that can be used in to create a . For more information about workflow markup, see [Using Workflow Markup](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms735921(v=vs.90)). @@ -810,7 +810,7 @@ code1.SetValue(WorkflowMarkupSerializer.EventsProperty, eventsHashtable); to create a . + You must serialize either a new instance of a workflow type or the root activity in a programmatically-created workflow to create workflow markup that can be used in to create a . For more information on workflow markup, see [Using Workflow Markup](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms735921(v=vs.90)). @@ -856,7 +856,7 @@ code1.SetValue(WorkflowMarkupSerializer.EventsProperty, eventsHashtable); instance is assignable from `value`, writes the method name associated with `value` to a string. If a instance is assignable from `value`, writes the fully-qualified name of the type associated with `value` to a string. If neither of these conditions exist, converts `value` to a string and writes the result. + If a instance is assignable from `value`, writes the method name associated with `value` to a string. If a instance is assignable from `value`, writes the fully-qualified name of the type associated with `value` to a string. If neither of these conditions exist, converts `value` to a string and writes the result. ]]> @@ -894,9 +894,9 @@ code1.SetValue(WorkflowMarkupSerializer.EventsProperty, eventsHashtable); is called by before it serializes the specified object. The method returns `false` if `value` contains a null reference (`Nothing`) or if `value` and the of the current serialization context are equal. + is called by before it serializes the specified object. The method returns `false` if `value` contains a null reference (`Nothing`) or if `value` and the of the current serialization context are equal. - You can override in a class that inherits from to customize how to determine whether the specified object should be serialized. + You can override in a class that inherits from to customize how to determine whether the specified object should be serialized. ]]> diff --git a/xml/System.Workflow.ComponentModel/Activity.xml b/xml/System.Workflow.ComponentModel/Activity.xml index 672d19a7778..7109c044448 100644 --- a/xml/System.Workflow.ComponentModel/Activity.xml +++ b/xml/System.Workflow.ComponentModel/Activity.xml @@ -231,7 +231,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. For more information about handling events, see [Handling and raising events](/dotnet/standard/events/). @@ -913,7 +913,7 @@ For more information about handling events, see [Handling and Raising Events](/d method and returns the result of this attempt. + The default method tries to call the method and returns the result of this attempt. ]]> @@ -1659,7 +1659,7 @@ For more information about handling events, see [Handling and Raising Events](/d and the of the type of this instance. + The string returned is a combination of the and the of the type of this instance. ]]> @@ -1760,7 +1760,7 @@ For more information about handling events, see [Handling and Raising Events](/d ## Remarks This method provides the activity with an opportunity to clean up resources allocated during initialization. - is called when an activity instance is guaranteed not to perform any more execution. For activities that do not implement , this occurs immediately after the activity closes, or, if the activity never executed, at workflow completion. For activities, this occurs either after compensation or at workflow completion. + is called when an activity instance is guaranteed not to perform any more execution. For activities that do not implement , this occurs immediately after the activity closes, or, if the activity never executed, at workflow completion. For activities, this occurs either after compensation or at workflow completion. ]]> diff --git a/xml/System.Workflow.ComponentModel/ActivityBind.xml b/xml/System.Workflow.ComponentModel/ActivityBind.xml index c60148cba59..b2e8f814334 100644 --- a/xml/System.Workflow.ComponentModel/ActivityBind.xml +++ b/xml/System.Workflow.ComponentModel/ActivityBind.xml @@ -240,7 +240,7 @@ Returns the run-time value. and also of setting the . + This example illustrates creating and using an and also of setting the . This code example is part of the Throw Activity SDK sample and is from the ThrowActivity.cs file. For more information, see [Using the ThrowActivity Activity](https://msdn.microsoft.com/library/82bc0fef-d78a-4750-82b4-e4cb397a10f1). @@ -289,7 +289,7 @@ Returns the run-time value. ## Examples - This example illustrates creating and using an , and also setting the and . + This example illustrates creating and using an , and also setting the and . This code example is part of the Throw Activity SDK sample and is from the ThrowActivity.cs file. For more information, see [Using the ThrowActivity Activity](https://msdn.microsoft.com/library/82bc0fef-d78a-4750-82b4-e4cb397a10f1). diff --git a/xml/System.Workflow.ComponentModel/ActivityChangeAction.xml b/xml/System.Workflow.ComponentModel/ActivityChangeAction.xml index 19a72389d9a..cff58032fb9 100644 --- a/xml/System.Workflow.ComponentModel/ActivityChangeAction.xml +++ b/xml/System.Workflow.ComponentModel/ActivityChangeAction.xml @@ -27,15 +27,15 @@ Represents a proposed change to a within a running workflow instance. This class must be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - This class is the base class for the canonical change actions which are added and removed and may be performed on a collection. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + This class is the base class for the canonical change actions which are added and removed and may be performed on a collection. + ]]> @@ -117,11 +117,11 @@ Gets or sets the of the associated with this instance. The of the associated with this instance. - member of the associated . Therefore, trying to set this without first initializing the associated will cause an exception to be thrown. - + member of the associated . Therefore, trying to set this without first initializing the associated will cause an exception to be thrown. + ]]> @@ -150,11 +150,11 @@ Validates the changes pending on the target activity. A that contains any resulting from running each defined for the target activity. - a null reference is returned. - + a null reference is returned. + ]]> diff --git a/xml/System.Workflow.ComponentModel/ActivityCollection.xml b/xml/System.Workflow.ComponentModel/ActivityCollection.xml index 0a45c5e8522..87946e1c4c1 100644 --- a/xml/System.Workflow.ComponentModel/ActivityCollection.xml +++ b/xml/System.Workflow.ComponentModel/ActivityCollection.xml @@ -66,7 +66,7 @@ This class is used to represent the list of child activities for a . > [!NOTE] -> Only call methods derived from and not , such as using to add activities instead of . Calling methods derived from will have unexpected consequences. +> Only call methods derived from and not , such as using to add activities instead of . Calling methods derived from will have unexpected consequences. ]]> @@ -249,15 +249,15 @@ ## Remarks Enumerators only enable reading the data in the collection. You cannot use enumerators to modify the underlying collection. - To begin, the enumerator is positioned before the first element in the collection. also brings the enumerator back to this position. At this position, calling raises an exception. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . + To begin, the enumerator is positioned before the first element in the collection. also brings the enumerator back to this position. At this position, calling raises an exception. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . - returns the same object until either or is called. sets to the next element. + returns the same object until either or is called. sets to the next element. - After the end of the collection is passed, the enumerator is positioned after the last element in the collection, and calling returns `false`. If the last call to returned `false`, calling raises an exception. + After the end of the collection is passed, the enumerator is positioned after the last element in the collection, and calling returns `false`. If the last call to returned `false`, calling raises an exception. - To set `Current` to the first element of the collection again, you can call `Reset` followed by . + To set `Current` to the first element of the collection again, you can call `Reset` followed by . - An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting elements, the enumerator is irreversibly invalidated and the next call to or `Reset` raises an . If the collection is modified between and , will return the element that it is set to, even if the enumerator is already invalidated. + An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying or deleting elements, the enumerator is irreversibly invalidated and the next call to or `Reset` raises an . If the collection is modified between and , will return the element that it is set to, even if the enumerator is already invalidated. The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection. This causes the enumerator to raise an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. @@ -751,7 +751,7 @@ uses , whereas, allows the user to specify the implementation to use for comparing keys. + Implementations can vary in how they determine equality of objects; for example, uses , whereas, allows the user to specify the implementation to use for comparing keys. In collections of contiguous elements, such as lists, the elements that follow the removed element move up to occupy the vacated spot. If the collection is indexed, the indexes of the elements that are moved are also updated. This behavior does not apply to collections where elements are conceptually grouped into buckets, such as a hash table. @@ -791,11 +791,11 @@ Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection. - Initially, the enumerator is positioned before the first element in the collection. At this position, is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . + Initially, the enumerator is positioned before the first element in the collection. At this position, is undefined. Therefore, you must call to advance the enumerator to the first element of the collection before reading the value of . - returns the same object until is called. sets to the next element. + returns the same object until is called. sets to the next element. - If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns false. When the enumerator is at this position, subsequent calls to also return false. If the last call to returned false, is undefined. You cannot set to the first element of the collection again; you must create a new enumerator instance instead. + If passes the end of the collection, the enumerator is positioned after the last element in the collection and returns false. When the enumerator is at this position, subsequent calls to also return false. If the last call to returned false, is undefined. You cannot set to the first element of the collection again; you must create a new enumerator instance instead. An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined. @@ -1016,7 +1016,7 @@ returns an object, which can be used to synchronize access to the . + returns an object, which can be used to synchronize access to the . Most collection classes in the namespace also implement a `Synchronized` method, which provides a synchronized wrapper around the underlying collection. diff --git a/xml/System.Workflow.ComponentModel/ActivityCondition.xml b/xml/System.Workflow.ComponentModel/ActivityCondition.xml index a6034a5ebab..776ed619c8f 100644 --- a/xml/System.Workflow.ComponentModel/ActivityCondition.xml +++ b/xml/System.Workflow.ComponentModel/ActivityCondition.xml @@ -47,19 +47,19 @@ Represents an abstract class for an expression, which evaluates to a . This class must be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - A condition is an expression, which evaluates to a `Boolean` value. - - Windows Workflow Foundation offers two condition types: and . - - You can create a custom condition type by deriving from this class and implementing the method. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + A condition is an expression, which evaluates to a `Boolean` value. + + Windows Workflow Foundation offers two condition types: and . + + You can create a custom condition type by deriving from this class and implementing the method. + ]]> diff --git a/xml/System.Workflow.ComponentModel/ActivityExecutionContextManager.xml b/xml/System.Workflow.ComponentModel/ActivityExecutionContextManager.xml index 3d5a6391df5..e1e9ed9a9ad 100644 --- a/xml/System.Workflow.ComponentModel/ActivityExecutionContextManager.xml +++ b/xml/System.Workflow.ComponentModel/ActivityExecutionContextManager.xml @@ -23,13 +23,13 @@ Allows a to create and manage execution contexts for its child activities. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + ]]> @@ -66,13 +66,13 @@ The designated . Marks an execution context as completed. - that does not have the `forcePersist` parameter effectively uses a value of `false`, so that by default, completed execution contexts are not persisted. - + that does not have the `forcePersist` parameter effectively uses a value of `false`, so that by default, completed execution contexts are not persisted. + ]]> @@ -107,13 +107,13 @@ that indicates whether the completed context will be persisted. Marks an execution context as completed. - that does not have the `forcePersist` parameter effectively uses a value of `false`, so that by default, completed execution contexts are not persisted. - + that does not have the `forcePersist` parameter effectively uses a value of `false`, so that by default, completed execution contexts are not persisted. + ]]> @@ -198,11 +198,11 @@ Gets the associated with the designated . The associated with the designated . - diff --git a/xml/System.Workflow.ComponentModel/ActivityExecutionStatusChangedEventArgs.xml b/xml/System.Workflow.ComponentModel/ActivityExecutionStatusChangedEventArgs.xml index 80efc496f6b..1ae7583546a 100644 --- a/xml/System.Workflow.ComponentModel/ActivityExecutionStatusChangedEventArgs.xml +++ b/xml/System.Workflow.ComponentModel/ActivityExecutionStatusChangedEventArgs.xml @@ -130,7 +130,7 @@ ## Remarks Contains the following strings in the order of description: -- The of the originating . +- The of the originating . - The as an enumeration converted to string, of the originating . diff --git a/xml/System.Workflow.ComponentModel/CompositeActivity.xml b/xml/System.Workflow.ComponentModel/CompositeActivity.xml index 458213c97b2..389c4d7115c 100644 --- a/xml/System.Workflow.ComponentModel/CompositeActivity.xml +++ b/xml/System.Workflow.ComponentModel/CompositeActivity.xml @@ -50,7 +50,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - A manages the execution of its child activities using class methods and events defined on the class. For example, a child activity is scheduled for execution using the of . A activity can be notified when a child activity completes its execution by subscribing to the event defined on . + A manages the execution of its child activities using class methods and events defined on the class. For example, a child activity is scheduled for execution using the of . A activity can be notified when a child activity completes its execution by subscribing to the event defined on . The workflow runtime enforces certain constraints on execution, the most fundamental of which is that a activity cannot move to the state if any child activities are still in a , , , or , state. @@ -248,7 +248,7 @@ method is called on each activity). When the workflow instance is loaded back into memory, a new .NET object is created for each activity with the state from the corresponding unload. + Throughout an activity's lifetime, several .NET objects may be created or disposed. Every time a workflow instance is unloaded from memory, the .NET objects corresponding to the activities in the workflow tree are disposed (the method is called on each activity). When the workflow instance is loaded back into memory, a new .NET object is created for each activity with the state from the corresponding unload. ]]> diff --git a/xml/System.Workflow.ComponentModel/DependencyObject.xml b/xml/System.Workflow.ComponentModel/DependencyObject.xml index 6b3798a4f36..17a738bf768 100644 --- a/xml/System.Workflow.ComponentModel/DependencyObject.xml +++ b/xml/System.Workflow.ComponentModel/DependencyObject.xml @@ -403,9 +403,9 @@ The represents a non-event override implementation. Typically, the override code invokes the , and then adds additional code. + This method is useful inside the override implementation. Typically, the override code invokes the , and then adds additional code. - For implementing the override, can be used in / calls. + For implementing the override, can be used in / calls. ]]> @@ -626,9 +626,9 @@ The is not an event. sets the value directly to the . Similarly, adds a handler directly to properties of type event. + sets the value directly to the . Similarly, adds a handler directly to properties of type event. - These methods are exclusive when they are called for the same property. If is called, then the values previously set using ( in events) are disregarded. The same is true the other way around: () resets the binding assigned with . + These methods are exclusive when they are called for the same property. If is called, then the values previously set using ( in events) are disregarded. The same is true the other way around: () resets the binding assigned with . ]]> @@ -728,11 +728,11 @@ The is not an event. sets a binding for the dependency property. + sets a binding for the dependency property. - sets a value directly to the (similarly, adds a handler directly to properties of type event). + sets a value directly to the (similarly, adds a handler directly to properties of type event). - These methods are exclusive when they are called for the same property. If is called, then the values previously set using ( in events) are disregarded. The same is true the other way around: () resets the binding assigned with . + These methods are exclusive when they are called for the same property. If is called, then the values previously set using ( in events) are disregarded. The same is true the other way around: () resets the binding assigned with . ]]> @@ -772,9 +772,9 @@ The is not an event. override implementation. Typically, the override code would do some custom logic before calling the method. + This method is useful inside the override implementation. Typically, the override code would do some custom logic before calling the method. - For setting a override, can be used in , , or calls. + For setting a override, can be used in , , or calls. ]]> diff --git a/xml/System.Workflow.ComponentModel/DependencyProperty.xml b/xml/System.Workflow.ComponentModel/DependencyProperty.xml index 278ee51d580..84a78dd73b8 100644 --- a/xml/System.Workflow.ComponentModel/DependencyProperty.xml +++ b/xml/System.Workflow.ComponentModel/DependencyProperty.xml @@ -145,7 +145,7 @@ , and attributes of this . + The hash code computed here is the `bitwise AND` of the hash codes generated by the , and attributes of this . ]]> @@ -175,7 +175,7 @@ has been registered by using the method. + The value returned indicates whether this has been registered by using the method. ]]> diff --git a/xml/System.Workflow.ComponentModel/GetValueOverride.xml b/xml/System.Workflow.ComponentModel/GetValueOverride.xml index 2fefc768d8c..801ea235042 100644 --- a/xml/System.Workflow.ComponentModel/GetValueOverride.xml +++ b/xml/System.Workflow.ComponentModel/GetValueOverride.xml @@ -31,7 +31,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - The implementation of this delegate can be set on the property of while calling or . + The implementation of this delegate can be set on the property of while calling or . ]]> diff --git a/xml/System.Workflow.ComponentModel/PropertyMetadata.xml b/xml/System.Workflow.ComponentModel/PropertyMetadata.xml index 055fe0e1318..61173872602 100644 --- a/xml/System.Workflow.ComponentModel/PropertyMetadata.xml +++ b/xml/System.Workflow.ComponentModel/PropertyMetadata.xml @@ -524,13 +524,13 @@ ## Remarks When the PropertyMetadata.IsSealed is equal to `true`, the following operations cause a to be raised: -- Attempting to set the . +- Attempting to set the . -- Attempting to set the . +- Attempting to set the . -- Attempting to set the . +- Attempting to set the . -- Attempting to set the . +- Attempting to set the . ]]> diff --git a/xml/System.Workflow.ComponentModel/SetValueOverride.xml b/xml/System.Workflow.ComponentModel/SetValueOverride.xml index 05117d0b917..fd57548f1ed 100644 --- a/xml/System.Workflow.ComponentModel/SetValueOverride.xml +++ b/xml/System.Workflow.ComponentModel/SetValueOverride.xml @@ -32,7 +32,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - The implementation of this delegate can be set to the property of while calling or . + The implementation of this delegate can be set to the property of while calling or . ]]> diff --git a/xml/System.Workflow.ComponentModel/SuspendActivity.xml b/xml/System.Workflow.ComponentModel/SuspendActivity.xml index f444fa65e3f..df932d4ef6b 100644 --- a/xml/System.Workflow.ComponentModel/SuspendActivity.xml +++ b/xml/System.Workflow.ComponentModel/SuspendActivity.xml @@ -77,7 +77,7 @@ |Property|Value| |--------------|-----------| -||`Null` (`Nothing` in Visual Basic).| +||`Null` (`Nothing` in Visual Basic).| ]]> diff --git a/xml/System.Workflow.ComponentModel/TerminateActivity.xml b/xml/System.Workflow.ComponentModel/TerminateActivity.xml index 7e0d9ca6a4c..cfe1cdfecac 100644 --- a/xml/System.Workflow.ComponentModel/TerminateActivity.xml +++ b/xml/System.Workflow.ComponentModel/TerminateActivity.xml @@ -71,7 +71,7 @@ |Property|Value| |--------------|-----------| -||null (`Nothing` in Visual Basic).| +||null (`Nothing` in Visual Basic).| ]]> diff --git a/xml/System.Workflow.ComponentModel/WorkflowChanges.xml b/xml/System.Workflow.ComponentModel/WorkflowChanges.xml index dd9e1558ec9..9d177928e4e 100644 --- a/xml/System.Workflow.ComponentModel/WorkflowChanges.xml +++ b/xml/System.Workflow.ComponentModel/WorkflowChanges.xml @@ -32,7 +32,7 @@ All proposed changes to a running workflow instance must be made using a object. - When a object is constructed in application code (outside the workflow instance), the object that is passed to the constructor must be the object that is returned by the method of the class. + When a object is constructed in application code (outside the workflow instance), the object that is passed to the constructor must be the object that is returned by the method of the class. ]]> diff --git a/xml/System.Workflow.Runtime.Configuration/WorkflowRuntimeSection.xml b/xml/System.Workflow.Runtime.Configuration/WorkflowRuntimeSection.xml index 46e7d3a0d67..a2ae1a0bfda 100644 --- a/xml/System.Workflow.Runtime.Configuration/WorkflowRuntimeSection.xml +++ b/xml/System.Workflow.Runtime.Configuration/WorkflowRuntimeSection.xml @@ -23,17 +23,17 @@ Represents a section, within a configuration file, that defines settings for the workflow run-time engine. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - contains settings specified by a `
` of type in a configuration file. The settings specified in a are used to initialize the workflow run-time engine. Your application can call the constructor to initialize the workflow run-time engine from the appropriately named section of the configuration file. - - If your application does not use configuration files, but you still want to initialize the workflow run-time engine from a you can configure a in your application and call the constructor. For example, your application might store configuration parameters in a database or it might operate in a trusted environment where configuration files are not used - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + contains settings specified by a `
` of type in a configuration file. The settings specified in a are used to initialize the workflow run-time engine. Your application can call the constructor to initialize the workflow run-time engine from the appropriately named section of the configuration file. + + If your application does not use configuration files, but you still want to initialize the workflow run-time engine from a you can configure a in your application and call the constructor. For example, your application might store configuration parameters in a database or it might operate in a trusted environment where configuration files are not used + ]]> @@ -82,11 +82,11 @@ Gets the collection of common parameters used by services. The common parameters used by services. The default is a null reference ( in Visual Basic). - can contain, for example, a database connection string that might be shared by durable services. - + can contain, for example, a database connection string that might be shared by durable services. + ]]> @@ -118,11 +118,11 @@ if performance counters are enabled; otherwise . - @@ -153,11 +153,11 @@ Gets or sets the name of the workflow run-time engine. The name of the workflow run-time engine. - . The default is an empty string. - + . The default is an empty string. + ]]> @@ -188,11 +188,11 @@ Gets the collection of services that are added to the workflow run-time engine when it is initialized. The services to be added to the workflow run-time engine. - are initialized by the workflow run-time engine and added to its services when the appropriate constructor is called. Therefore the services specified in the must follow certain rules about the signatures of their constructors. For more information, see . - + are initialized by the workflow run-time engine and added to its services when the appropriate constructor is called. Therefore the services specified in the must follow certain rules about the signatures of their constructors. For more information, see . + ]]> @@ -224,15 +224,15 @@ if validation occurs on creation; otherwise, . - is called. If validation errors are found, a is thrown. - - When this property is set to `false`, creates a workflow instance and skips validation. In this case, the host application must guarantee that the workflow is properly configured or the runtime error occurs. - - The default value for this property is `true`. - + is called. If validation errors are found, a is thrown. + + When this property is set to `false`, creates a workflow instance and skips validation. In this case, the host application must guarantee that the workflow is properly configured or the runtime error occurs. + + The default value for this property is `true`. + ]]> diff --git a/xml/System.Workflow.Runtime.Configuration/WorkflowRuntimeServiceElement.xml b/xml/System.Workflow.Runtime.Configuration/WorkflowRuntimeServiceElement.xml index e1a174bf4e5..74baddba7e2 100644 --- a/xml/System.Workflow.Runtime.Configuration/WorkflowRuntimeServiceElement.xml +++ b/xml/System.Workflow.Runtime.Configuration/WorkflowRuntimeServiceElement.xml @@ -23,23 +23,23 @@ Represents a configuration element for a service to be added to the workflow runtime engine. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - A specifies a host service that should be initialized and activated by the workflow runtime engine. It corresponds to a host service specified in the `` element in a configuration file. Because the service specified in a WorkflowRuntimeServiceElement will be initialized by the workflow runtime engine it must have at least one constructor that matches one of the following four signatures (the workflow runtime engine will try to match these signatures in the order shown): - - Service(WorkflowRuntime runtime, NameValueCollection parameters) - - Service(WorkflowRuntime runtime) - - Service(NameValueCollection parameters) - - Service() - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + A specifies a host service that should be initialized and activated by the workflow runtime engine. It corresponds to a host service specified in the `` element in a configuration file. Because the service specified in a WorkflowRuntimeServiceElement will be initialized by the workflow runtime engine it must have at least one constructor that matches one of the following four signatures (the workflow runtime engine will try to match these signatures in the order shown): + + Service(WorkflowRuntime runtime, NameValueCollection parameters) + + Service(WorkflowRuntime runtime) + + Service(NameValueCollection parameters) + + Service() + ]]> @@ -60,11 +60,11 @@ Initializes a new instance of the class. - . - + . + ]]> @@ -96,11 +96,11 @@ always returns . - collection. Any attributes other than `type` that are specified in an `` element to the `` element in the configuration file are added as a name-value pair to the collection. - + collection. Any attributes other than `type` that are specified in an `` element to the `` element in the configuration file are added as a name-value pair to the collection. + ]]> diff --git a/xml/System.Workflow.Runtime.Configuration/WorkflowRuntimeServiceElementCollection.xml b/xml/System.Workflow.Runtime.Configuration/WorkflowRuntimeServiceElementCollection.xml index ef0595bbbe2..b60e675abd0 100644 --- a/xml/System.Workflow.Runtime.Configuration/WorkflowRuntimeServiceElementCollection.xml +++ b/xml/System.Workflow.Runtime.Configuration/WorkflowRuntimeServiceElementCollection.xml @@ -23,15 +23,15 @@ Represents the collection of services to be added to the workflow runtime engine. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Represents the services specified by the `` element in a configuration file. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Represents the services specified by the `` element in a configuration file. + ]]> @@ -102,11 +102,11 @@ Creates a new . An empty . - is created and returned. - + is created and returned. + ]]> @@ -135,11 +135,11 @@ Returns a key for the specified . The assembly-qualified type name of the service for the specified by . - . The for `settings` is returned. This property holds the assembly-qualified type name of the service specified by the . - + . The for `settings` is returned. This property holds the assembly-qualified type name of the service specified by the . + ]]> diff --git a/xml/System.Workflow.Runtime.Hosting/ChannelManagerService.xml b/xml/System.Workflow.Runtime.Hosting/ChannelManagerService.xml index ec70f7c452e..19c92dc1602 100644 --- a/xml/System.Workflow.Runtime.Hosting/ChannelManagerService.xml +++ b/xml/System.Workflow.Runtime.Hosting/ChannelManagerService.xml @@ -30,7 +30,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - The is responsible for creating a channel for a based on the channel token defined in the activity's . + The is responsible for creating a channel for a based on the channel token defined in the activity's . ]]> @@ -88,7 +88,7 @@ ## Remarks Instances of the class are usually created by the runtime using configuration files. - The endpoints defined in the service's constructor will be used to create channels that match the configuration name in the . The endpoints defined in the configuration take precedence over the endpoints defined in code, so if a service endpoint added through code has the same name and contract type as one in the configuration file, then the endpoint defined in code will not be used. + The endpoints defined in the service's constructor will be used to create channels that match the configuration name in the . The endpoints defined in the configuration take precedence over the endpoints defined in code, so if a service endpoint added through code has the same name and contract type as one in the configuration file, then the endpoint defined in code will not be used. ]]> diff --git a/xml/System.Workflow.Runtime.Hosting/DefaultWorkflowSchedulerService.xml b/xml/System.Workflow.Runtime.Hosting/DefaultWorkflowSchedulerService.xml index 21277cd42d2..d78b1cad654 100644 --- a/xml/System.Workflow.Runtime.Hosting/DefaultWorkflowSchedulerService.xml +++ b/xml/System.Workflow.Runtime.Hosting/DefaultWorkflowSchedulerService.xml @@ -23,15 +23,15 @@ Creates and manages the threads that run workflow instances on the workflow runtime engine. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - is used by the workflow runtime engine by default. It includes default support for having multiple workflow instances queued in the runtime thread pool. If you want to control the thread that is responsible for executing the workflow, use . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + is used by the workflow runtime engine by default. It includes default support for having multiple workflow instances queued in the runtime thread pool. If you want to control the thread that is responsible for executing the workflow, use . + ]]> @@ -83,23 +83,23 @@ A that holds initialization information. Initializes a new instance of the class. - objects also use the .NET thread pool. - - If not specified in a constructor or configuration file, the default value for `maxSimultaneousWorkflows` is 5 for a single-processor machine, and (int)(5 * Environment.ProcessorCount * .8) for a multiple-processor machine. Note that (int)(5 * Environment.ProcessorCount * .8) is not always the same as (int)(4 * Environment.ProcessorCount), because of the rules of integer arithmetic. - + objects also use the .NET thread pool. + + If not specified in a constructor or configuration file, the default value for `maxSimultaneousWorkflows` is 5 for a single-processor machine, and (int)(5 * Environment.ProcessorCount * .8) for a multiple-processor machine. Note that (int)(5 * Environment.ProcessorCount * .8) is not always the same as (int)(4 * Environment.ProcessorCount), because of the rules of integer arithmetic. + ]]> contains a null reference ( in Visual Basic). - One of the key values in the collection contains a null reference (). - - -or- - + One of the key values in the collection contains a null reference (). + + -or- + One of the key values in the collection does not match the default key for . One of the parameters cannot be converted to a double-precision floating point number that matches . @@ -126,13 +126,13 @@ An integer that determines the maximum number of workflow instances that can be stored in the thread pool queue. Initializes a new instance of the class by using the specified maximum number of workflow instances that the service can run simultaneously. - objects also use the .NET thread pool. - - If not specified in a constructor or configuration file, the default value for `maxSimultaneousWorkflows` is 5 for a single-processor machine, and (int)(5 * Environment.ProcessorCount * .8) for a multiple-processor machine. Note that (int)(5 * Environment.ProcessorCount * .8) is not always the same as (int)(4 * Environment.ProcessorCount), because of the rules of integer arithmetic. - + objects also use the .NET thread pool. + + If not specified in a constructor or configuration file, the default value for `maxSimultaneousWorkflows` is 5 for a single-processor machine, and (int)(5 * Environment.ProcessorCount * .8) for a multiple-processor machine. Note that (int)(5 * Environment.ProcessorCount * .8) is not always the same as (int)(4 * Environment.ProcessorCount), because of the rules of integer arithmetic. + ]]> @@ -186,11 +186,11 @@ Gets the maximum number of workflow instances that can be stored in the thread pool queue. An integer that represents the maximum number of workflow instances that can be stored in the thread pool queue. - @@ -215,11 +215,11 @@ Notifies the that a workflow instance has started to run. - creates a thread for the first work item in the list of items waiting to be included in the workflow instance thread pool. - + creates a thread for the first work item in the list of items waiting to be included in the workflow instance thread pool. + ]]> @@ -258,11 +258,11 @@ A that represents the workflow instance. Adds a workflow instance to the pending work items queue using the specified workflow instance using the specified multicast delegate. - constructor to create your delegate method to run in the new thread. - + constructor to create your delegate method to run in the new thread. + ]]> @@ -298,11 +298,11 @@ A that represents the scheduled thread. Adds the specified workflow instance to the pending work item queue using the specified multicast delegate, and GUIDs. - constructor to create your delegate method to run in the new thread. - + constructor to create your delegate method to run in the new thread. + ]]> diff --git a/xml/System.Workflow.Runtime.Hosting/ManualWorkflowSchedulerService.xml b/xml/System.Workflow.Runtime.Hosting/ManualWorkflowSchedulerService.xml index 48e7a3a9f1e..2bc3db21834 100644 --- a/xml/System.Workflow.Runtime.Hosting/ManualWorkflowSchedulerService.xml +++ b/xml/System.Workflow.Runtime.Hosting/ManualWorkflowSchedulerService.xml @@ -23,15 +23,15 @@ Provides a threading service that allows the host application creating a workflow instance to donate the on which the workflow instance is run. Using this threading service, host applications can run a workflow instance on a single in synchronous mode (although if the workflow contains a delay activity, the work is postponed until after the delay activity is executed on a separate thread spawned by ). This mode blocks the execution of the host application until the workflow instance becomes idle. Subsequently, the workflow instance can only be executed using the method of this service. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - does not automatically run a workflow instance that is in the queue. The host must call to run a specified workflow. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + does not automatically run a workflow instance that is in the queue. The host must call to run a specified workflow. + ]]> @@ -180,11 +180,11 @@ if the workflow starts running; otherwise, . - diff --git a/xml/System.Workflow.Runtime.Hosting/SharedConnectionWorkflowCommitWorkBatchService.xml b/xml/System.Workflow.Runtime.Hosting/SharedConnectionWorkflowCommitWorkBatchService.xml index 60ff4ea8675..2b58f657802 100644 --- a/xml/System.Workflow.Runtime.Hosting/SharedConnectionWorkflowCommitWorkBatchService.xml +++ b/xml/System.Workflow.Runtime.Hosting/SharedConnectionWorkflowCommitWorkBatchService.xml @@ -30,7 +30,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - The service is used for database transactions that use a shared connection between different objects. To use the instead of the in your instance, use the method. + The service is used for database transactions that use a shared connection between different objects. To use the instead of the in your instance, use the method. > [!IMPORTANT] > If the SQL server used by the is down such as that caused by SQL cluster failovers or intermittent network issues, the will retry the commit process up to 20 times before raising a event. diff --git a/xml/System.Workflow.Runtime.Hosting/SqlWorkflowPersistenceService.xml b/xml/System.Workflow.Runtime.Hosting/SqlWorkflowPersistenceService.xml index 8bca425b00f..e9654b23caf 100644 --- a/xml/System.Workflow.Runtime.Hosting/SqlWorkflowPersistenceService.xml +++ b/xml/System.Workflow.Runtime.Hosting/SqlWorkflowPersistenceService.xml @@ -36,7 +36,7 @@ The class represents a fully-functional persistence service. You can use this service out-of-box to persist and retrieve workflow state information about a workflow instance when requested to by the workflow runtime engine. - The participates in the workflow transaction batching functionality provided by the . That is, it adds objects that represent pending writes to the SQL database to the and implements the interface. + The participates in the workflow transaction batching functionality provided by the . That is, it adds objects that represent pending writes to the SQL database to the and implements the interface. The supports locking of workflow instances. This feature is used when several workflow runtimes share the same database. A column in the SQL database table is used to mark a workflow instance as locked whenever it is being used by a workflow runtime. The does not load a workflow instance that is marked as "in use" by another runtime. Typically these locks are released when the workflow instance is persisted, for example, on idle, completion, or termination. The locks can also be released automatically after a period of inactivity. This period of inactivity can be set using the constructor of the class. It can also be set through the configuration file. @@ -187,7 +187,7 @@ - Reloading workflow instances when the workflow run-time engine starts. -- Calling . +- Calling . Besides being set programmatically, this functionality can be enabled through a configuration file. For more information about how to set this property through a configuration file, see [Workflow Configuration Files](https://msdn.microsoft.com/library/ada4bb90-6c9d-4f3d-a9d0-b559bb0f9909). @@ -249,7 +249,7 @@ during compensation. should only be called by the workflow run-time engine. + The workflow run-time engine uses during compensation. should only be called by the workflow run-time engine. ]]> @@ -335,7 +335,7 @@ should only be called by the workflow run-time engine. + should only be called by the workflow run-time engine. ]]> @@ -390,7 +390,7 @@ . + `completedScopeActivity` is serialized and added to the . ]]> @@ -425,7 +425,7 @@ . The out-of-box implements locking of the workflow instance state. The user must configure the `instanceOwnershipDuration` parameter in the constructor. This value decides the time interval during which the instance can be locked by a host. If multiple hosts share the same persistence service and database, and another host tries to load the instance during this interval, a occurs. For more information, see the class. + `rootActivity` is serialized and written to the . The out-of-box implements locking of the workflow instance state. The user must configure the `instanceOwnershipDuration` parameter in the constructor. This value decides the time interval during which the instance can be locked by a host. If multiple hosts share the same persistence service and database, and another host tries to load the instance during this interval, a occurs. For more information, see the class. ]]> @@ -483,7 +483,7 @@ must only be called by the workflow run-time engine. + must only be called by the workflow run-time engine. ]]> @@ -582,7 +582,7 @@ ## Remarks In the out-of-box implementation of the , - is a no-op. If you inherit from and extend the class, you may use to perform any actions required on `items` dictated by your implementation. + is a no-op. If you inherit from and extend the class, you may use to perform any actions required on `items` dictated by your implementation. ]]> @@ -678,7 +678,7 @@ . + This method is used by the workflow runtime to unlock a workflow instance state in the data store without persistence and is called by the workflow runtime if the runtime must unlock the state without persisting, for example, in the case of an . ]]> diff --git a/xml/System.Workflow.Runtime.Hosting/WorkflowPersistenceService.xml b/xml/System.Workflow.Runtime.Hosting/WorkflowPersistenceService.xml index fa6efb4632a..ccfcb85a08f 100644 --- a/xml/System.Workflow.Runtime.Hosting/WorkflowPersistenceService.xml +++ b/xml/System.Workflow.Runtime.Hosting/WorkflowPersistenceService.xml @@ -30,15 +30,15 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - When certain conditions occur while the workflow is running, the workflow runtime engine persists state information about the workflow instance. Persistence can occur, for example, when an atomic transaction finishes, when the workflow instance becomes idle, when the host calls on the workflow instance, or when a workflow instance is terminated or finishes. When the workflow runtime engine semantics dictate that persistence should occur, the workflow runtime engine calls methods that are supplied by a persistence service to save state information about the workflow instance. Likewise, when the workflow runtime engine needs to restore a previously persisted workflow instance, it calls methods that are supplied by the persistence service to load this state information. The workflow runtime engine handles all the semantics regarding when to perform persistence. The persistence service handles actually saving and loading the workflow state information to or from a data store. + When certain conditions occur while the workflow is running, the workflow runtime engine persists state information about the workflow instance. Persistence can occur, for example, when an atomic transaction finishes, when the workflow instance becomes idle, when the host calls on the workflow instance, or when a workflow instance is terminated or finishes. When the workflow runtime engine semantics dictate that persistence should occur, the workflow runtime engine calls methods that are supplied by a persistence service to save state information about the workflow instance. Likewise, when the workflow runtime engine needs to restore a previously persisted workflow instance, it calls methods that are supplied by the persistence service to load this state information. The workflow runtime engine handles all the semantics regarding when to perform persistence. The persistence service handles actually saving and loading the workflow state information to or from a data store. - You can create a persistence service by deriving a class from the class. You can add your persistence service to the workflow runtime engine by calling or by making an appropriate entry in the application configuration file. The should only contain one persistence service. Windows Workflow Foundation provides the class, an out-of-box persistence service, which you can use as is or extend. + You can create a persistence service by deriving a class from the class. You can add your persistence service to the workflow runtime engine by calling or by making an appropriate entry in the application configuration file. The should only contain one persistence service. Windows Workflow Foundation provides the class, an out-of-box persistence service, which you can use as is or extend. - The workflow runtime engine has semantics for locking workflow state information for use in environments where persistence services that run in different processes might have access to a single data store. The class provides the capability to support this functionality of the workflow runtime engine by providing a parameter to that specifies whether the state information of a workflow instance should be unlocked in the data store, and by providing a method to unlock previously locked workflow state information. In a persistence service that implements locking, a call to should lock the state information for a workflow instance. + The workflow runtime engine has semantics for locking workflow state information for use in environments where persistence services that run in different processes might have access to a single data store. The class provides the capability to support this functionality of the workflow runtime engine by providing a parameter to that specifies whether the state information of a workflow instance should be unlocked in the data store, and by providing a method to unlock previously locked workflow state information. In a persistence service that implements locking, a call to should lock the state information for a workflow instance. Your persistence service should throw a if it fails to save state information to its data store or load state information from its data store. The workflow runtime engine expects this behavior. - A batching mechanism is provided for services that use a durable store to save workflow state information. It is important in these cases to maintain consistency between the durable store that is used by the persistence service and the internal state of the workflow runtime engine. You can add functionality defined by the interface to your service, and then participate in workflow transaction batching provided by the by adding changes to your data store as work items to the . The durable store itself should implement the interface, so that workflow information is not persisted incorrectly in the event of a transaction rollback. For more information, see or . + A batching mechanism is provided for services that use a durable store to save workflow state information. It is important in these cases to maintain consistency between the durable store that is used by the persistence service and the internal state of the workflow runtime engine. You can add functionality defined by the interface to your service, and then participate in workflow transaction batching provided by the by adding changes to your data store as work items to the . The durable store itself should implement the interface, so that workflow information is not persisted incorrectly in the event of a transaction rollback. For more information, see or . ]]> @@ -196,7 +196,7 @@ to implement compensation. You must restore an identical copy of the completed scope. To do this, you must restore a valid from your representation of the completed scope in the data store. Then you must pass this to one of the overloaded methods of to perform deserialization of the scope. + The workflow runtime engine uses to implement compensation. You must restore an identical copy of the completed scope. To do this, you must restore a valid from your representation of the completed scope in the data store. Then you must pass this to one of the overloaded methods of to perform deserialization of the scope. If your persistence service cannot load the completed scope from its data store, it should throw a with an appropriate message. @@ -231,9 +231,9 @@ from your representation of the workflow instance in the data store; then you must pass this to one of the overloaded methods to deserialize the workflow instance state. If your persistence service cannot load the workflow instance state from its data store, it should throw a with an appropriate message. + You must restore an identical copy of the activity. To do this, you must restore a valid from your representation of the workflow instance in the data store; then you must pass this to one of the overloaded methods to deserialize the workflow instance state. If your persistence service cannot load the workflow instance state from its data store, it should throw a with an appropriate message. - The workflow runtime engine implements locking semantics to restrict access to a workflow instance state that is saved in a data store. This can be accessed by persistence services that run in multiple processes. The locking semantics are designed to prevent persistence services that run in two different processes from loading the same workflow instance into memory at the same time. Depending on the type of environment that your persistence service is designed to support, you may choose whether to support this functionality. If you choose to support the runtime locking semantics, and if this workflow instance state has been previously locked by another process, then you should throw a . Otherwise, you should lock access to the workflow instance state in your data store. The workflow instance state can be unlocked by a call to or a call to with the unlock parameter set to `true`. + The workflow runtime engine implements locking semantics to restrict access to a workflow instance state that is saved in a data store. This can be accessed by persistence services that run in multiple processes. The locking semantics are designed to prevent persistence services that run in two different processes from loading the same workflow instance into memory at the same time. Depending on the type of environment that your persistence service is designed to support, you may choose whether to support this functionality. If you choose to support the runtime locking semantics, and if this workflow instance state has been previously locked by another process, then you should throw a . Otherwise, you should lock access to the workflow instance state in your data store. The workflow instance state can be unlocked by a call to or a call to with the unlock parameter set to `true`. ]]> @@ -293,11 +293,11 @@ methods to serialize `activity` into a ; you may then choose to additionally process the before writing it to your data store. However, when the workflow runtime engine calls , you must restore an identical copy of the activity. + The workflow runtime engine saves the state of completed scope activities in order to implement compensation. You must call one of the overloaded methods to serialize `activity` into a ; you may then choose to additionally process the before writing it to your data store. However, when the workflow runtime engine calls , you must restore an identical copy of the activity. You must be able to associate the completed scope with its enclosing workflow instance to mark the scope as unneeded in your data store when the workflow instance finishes or is terminated. Therefore, you should also save the of the workflow instance that is associated with the completed scope; this can be obtained from the property of the associated with `activity`. - takes the of the completed scope as a parameter. Therefore, you must also save the property associated with `activity`. This property can be referenced through the field of `activity`. + takes the of the completed scope as a parameter. Therefore, you must also save the property associated with `activity`. This property can be referenced through the field of `activity`. If you are implementing a persistence service that uses a durable store, to maintain consistency with the internal state of the workflow runtime engine, you should participate in workflow transaction batching to defer the actual write to your durable store until a workflow commit point. To participate in batching, add a work item to the property that represents the pending changes to the database, and implement the interface in your persistence service. @@ -336,13 +336,13 @@ methods to serialize `rootActivity` into a . You can then choose to additionally process the before writing it to your data store. However, when the workflow runtime engine calls , you must restore an identical copy of the root activity. If you cannot save the workflow instance state to your data store, you should throw a with an appropriate error message. + You must call one of the overloaded methods to serialize `rootActivity` into a . You can then choose to additionally process the before writing it to your data store. However, when the workflow runtime engine calls , you must restore an identical copy of the root activity. If you cannot save the workflow instance state to your data store, you should throw a with an appropriate error message. The workflow runtime engine provides locking semantics to restrict access to a workflow instance state that is saved in the data store. This can be accessed by the persistence services running in multiple hosts and pointing to the same data store. The locking semantics are designed to prevent persistence services that run in two different workflow runtimes from loading the same workflow instance into memory at the same time. Depending on the type of environment your persistence service is designed to support, you can choose whether to support this functionality. If you choose to support the runtime locking semantics, then, if a persistence service tries to save a workflow instance state that has been previously locked by another persistence service, you should throw a . If `unlock` is `true`, you should unlock access to the workflow instance state after you save it. - takes the of the workflow instance as a parameter. Therefore, you should save this . You can also use this to associate the workflow instance with the saved states of its completed scopes. You must do this because you must be able to mark these completed scopes as unneeded when the workflow instance completes. + takes the of the workflow instance as a parameter. Therefore, you should save this . You can also use this to associate the workflow instance with the saved states of its completed scopes. You must do this because you must be able to mark these completed scopes as unneeded when the workflow instance completes. - The workflow runtime engine calls a final time when the workflow instance is completed or terminated. Therefore, if is equal to or , you can safely delete the workflow instance and all its associated completed scopes from your data store. Alternatively, you can subscribe to the or events to determine when it is safe to delete records associated with the workflow instance. Whether you actually delete the records from your data store depends on your implementation. + The workflow runtime engine calls a final time when the workflow instance is completed or terminated. Therefore, if is equal to or , you can safely delete the workflow instance and all its associated completed scopes from your data store. Alternatively, you can subscribe to the or events to determine when it is safe to delete records associated with the workflow instance. Whether you actually delete the records from your data store depends on your implementation. If you implement a persistence service that uses a durable store, then, to maintain consistency with the internal state of the workflow runtime engine, you should participate in workflow transaction batching to defer the actual write to your durable store until a workflow commit point. To participate in batching, add a work item that represents the pending changes to your durable store to the property, and implement the interface in your persistence service. @@ -404,7 +404,7 @@ ## Remarks This method is abstract, so it does not contain a default implementation on locking and unlocking. - While implementing a custom persistence service, if you want to implement a locking scheme you will need to override this method and provide a locking-unlocking mechanism in the method based on the value of the unlock parameter. + While implementing a custom persistence service, if you want to implement a locking scheme you will need to override this method and provide a locking-unlocking mechanism in the method based on the value of the unlock parameter. ]]> diff --git a/xml/System.Workflow.Runtime.Hosting/WorkflowRuntimeService.xml b/xml/System.Workflow.Runtime.Hosting/WorkflowRuntimeService.xml index 82f87917b25..5ff197d05ba 100644 --- a/xml/System.Workflow.Runtime.Hosting/WorkflowRuntimeService.xml +++ b/xml/System.Workflow.Runtime.Hosting/WorkflowRuntimeService.xml @@ -30,9 +30,9 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - Services that derive from the class can be started and stopped by the workflow runtime engine. The order in which the services are started or stopped, however, is indeterminate, and services may require the support of other services in order to properly initialize themselves when they are started, and, conversely, may require the to support of other services in order to properly shut down when they are stopped. To address this problem, the workflow runtime engine provides two-phase mechanisms for starting and stopping services. When is called, the workflow runtime engine invokes the method for each of its services that derive from the class. After all of these services have been started, the workflow runtime engine raises the event, which causes the method to be invoked for each workflow runtime engine service. Your service can override the method to participate in this two phase process. Similarly, when is called, the method, the event, and the method provide this two-phase mechanism. The State property contains a value that indicates whether the service is in the process of starting or stopping or is completely started or stopped. + Services that derive from the class can be started and stopped by the workflow runtime engine. The order in which the services are started or stopped, however, is indeterminate, and services may require the support of other services in order to properly initialize themselves when they are started, and, conversely, may require the to support of other services in order to properly shut down when they are stopped. To address this problem, the workflow runtime engine provides two-phase mechanisms for starting and stopping services. When is called, the workflow runtime engine invokes the method for each of its services that derive from the class. After all of these services have been started, the workflow runtime engine raises the event, which causes the method to be invoked for each workflow runtime engine service. Your service can override the method to participate in this two phase process. Similarly, when is called, the method, the event, and the method provide this two-phase mechanism. The State property contains a value that indicates whether the service is in the process of starting or stopping or is completely started or stopped. - Services that derive from the class can raise the event when they encounter a condition that causes an unhandled exception by calling . + Services that derive from the class can raise the event when they encounter a condition that causes an unhandled exception by calling . Services derived from the class, the class, the class, and the class ultimately derives from the class. @@ -59,7 +59,7 @@ is initialized to . + is initialized to . ]]> @@ -88,12 +88,12 @@ class implements a two-phase starting mechanism so that workflow runtime engine services may perform any initialization that depends on other services after the workflow runtime engine has invoked the method for all of its workflow runtime engine services. After the workflow runtime engine has called the method of all of its workflow runtime engine services, it raises the event. You can override the method to provide any final startup functionality required by your service when the event is raised. The mechanics of subscribing and unsubscribing from the event is handled internally. + The class implements a two-phase starting mechanism so that workflow runtime engine services may perform any initialization that depends on other services after the workflow runtime engine has invoked the method for all of its workflow runtime engine services. After the workflow runtime engine has called the method of all of its workflow runtime engine services, it raises the event. You can override the method to provide any final startup functionality required by your service when the event is raised. The mechanics of subscribing and unsubscribing from the event is handled internally. > [!NOTE] -> If your service is added to the workflow runtime engine by a call to after the workflow runtime engine has already been started, the workflow runtime engine will call on your service. However, in this situation, the event has already occurred, therefore, your service may have to perform any initialization that it would ordinarily perform in from inside the method. You can test to determine whether the workflow runtime engine has been started. +> If your service is added to the workflow runtime engine by a call to after the workflow runtime engine has already been started, the workflow runtime engine will call on your service. However, in this situation, the event has already occurred, therefore, your service may have to perform any initialization that it would ordinarily perform in from inside the method. You can test to determine whether the workflow runtime engine has been started. - is set to before is invoked. The default implementation of performs no action. + is set to before is invoked. The default implementation of performs no action. ]]> @@ -122,12 +122,12 @@ class implements a two-phase stopping mechanism so that workflow runtime engine services may retain some functionality after their method is invoked by the workflow runtime engine in order that they may, if necessary, support the shutdown of other services. After the workflow runtime engine has called the method of all of its workflow runtime engine services, it raises the event. You can override the method to provide any final shutdown functionality required by your service when the event is raised. The mechanics of subscribing and unsubscribing from the event is handled internally. + The class implements a two-phase stopping mechanism so that workflow runtime engine services may retain some functionality after their method is invoked by the workflow runtime engine in order that they may, if necessary, support the shutdown of other services. After the workflow runtime engine has called the method of all of its workflow runtime engine services, it raises the event. You can override the method to provide any final shutdown functionality required by your service when the event is raised. The mechanics of subscribing and unsubscribing from the event is handled internally. > [!NOTE] -> If your is removed from the workflow runtime engine by a call to while the workflow runtime engine is running, the workflow runtime engine will call on your service. However, in this situation, the method will not be called for your service. Therefore, your service may have to perform any final shutdown that it would ordinarily perform in from inside the method. You can test to determine whether the workflow runtime engine is running. +> If your is removed from the workflow runtime engine by a call to while the workflow runtime engine is running, the workflow runtime engine will call on your service. However, in this situation, the method will not be called for your service. Therefore, your service may have to perform any final shutdown that it would ordinarily perform in from inside the method. You can test to determine whether the workflow runtime engine is running. - is set to before is invoked. The default implementation of performs no action. + is set to before is invoked. The default implementation of performs no action. ]]> @@ -161,7 +161,7 @@ to raise the event when it encounters an exception that it cannot handle during its execution. You should pass the of the workflow instance associated with the unhandled exception. For example, a timer service might pass the associated with the timer for which the exception occurred. + Your service can call to raise the event when it encounters an exception that it cannot handle during its execution. You should pass the of the workflow instance associated with the unhandled exception. For example, a timer service might pass the associated with the timer for which the exception occurred. ]]> @@ -190,7 +190,7 @@ on the service. + The workflow runtime engine sets this property before it calls on the service. ]]> @@ -219,16 +219,16 @@ is invoked by the workflow runtime engine on all of its services that derive from the class when is called. + is invoked by the workflow runtime engine on all of its services that derive from the class when is called. - is also invoked by the workflow runtime engine when a workflow runtime engine service is added to the workflow runtime engine by a call to after the workflow runtime engine has already started. The default implementation of tracks whether the service has been started and uses this information to throw the appropriate exception if the service is started while it is already running. + is also invoked by the workflow runtime engine when a workflow runtime engine service is added to the workflow runtime engine by a call to after the workflow runtime engine has already started. The default implementation of tracks whether the service has been started and uses this information to throw the appropriate exception if the service is started while it is already running. - You can provide additional functionality necessary to have your service started by the workflow runtime engine by overriding this method. There is no guarantee about which, if any, services will be running when the workflow runtime engine calls on your service. Therefore, in the method, you should only perform any initialization that does not depend on functionality provided by other services. This includes functionality provided by core services such as the scheduler service. The workflow runtime engine raises the event after it has called the method of all of its workflow runtime engine services. If your service requires additional initialization after all of the workflow runtime engine services have been started, you can override the method in order to perform this initialization when the event is raised. + You can provide additional functionality necessary to have your service started by the workflow runtime engine by overriding this method. There is no guarantee about which, if any, services will be running when the workflow runtime engine calls on your service. Therefore, in the method, you should only perform any initialization that does not depend on functionality provided by other services. This includes functionality provided by core services such as the scheduler service. The workflow runtime engine raises the event after it has called the method of all of its workflow runtime engine services. If your service requires additional initialization after all of the workflow runtime engine services have been started, you can override the method in order to perform this initialization when the event is raised. > [!NOTE] -> If your service is added to the workflow runtime engine by a call to after the workflow runtime engine has already been started, the workflow runtime engine will call on your service. However, in this situation, the event has already occurred, therefore, your service may have to perform any initialization that it would ordinarily perform in from inside the method. You can test to determine whether the workflow runtime engine has been started. +> If your service is added to the workflow runtime engine by a call to after the workflow runtime engine has already been started, the workflow runtime engine will call on your service. However, in this situation, the event has already occurred, therefore, your service may have to perform any initialization that it would ordinarily perform in from inside the method. You can test to determine whether the workflow runtime engine has been started. - should only be called by the workflow runtime engine. + should only be called by the workflow runtime engine. ]]> @@ -263,9 +263,9 @@ class implements two-phase mechanisms for both starting and stopping a workflow runtime engine service. The first phase of the start mechanism begins when the workflow runtime engine calls the implementation of the method for the service. This method should call the base implementation of , which sets to . The second phase occurs after the workflow runtime engine starts all of its workflow runtime engine services when it raises the event. The internally manages a subscription to this event and its handler will set to . + The class implements two-phase mechanisms for both starting and stopping a workflow runtime engine service. The first phase of the start mechanism begins when the workflow runtime engine calls the implementation of the method for the service. This method should call the base implementation of , which sets to . The second phase occurs after the workflow runtime engine starts all of its workflow runtime engine services when it raises the event. The internally manages a subscription to this event and its handler will set to . - The two-phase mechanism for stopping a workflow runtime engine service begins when the workflow runtime engine calls the implementation of the method for the service. This method should call the base implementation of , which sets to . After it has stopped all of its workflow runtime engine services, the workflow runtime engine raises the event. The internally manages a subscription to this event and its handler will set to . + The two-phase mechanism for stopping a workflow runtime engine service begins when the workflow runtime engine calls the implementation of the method for the service. This method should call the base implementation of , which sets to . After it has stopped all of its workflow runtime engine services, the workflow runtime engine raises the event. The internally manages a subscription to this event and its handler will set to . ]]> @@ -294,14 +294,14 @@ is invoked by the workflow runtime engine on all of its services that derive from the class when is called. is also invoked by the workflow runtime engine when a workflow runtime engine service is removed from the workflow runtime engine by a call to . The default implementation of tracks whether the service has been started and uses this information to throw the appropriate exception if the service is stopped before it is started. + is invoked by the workflow runtime engine on all of its services that derive from the class when is called. is also invoked by the workflow runtime engine when a workflow runtime engine service is removed from the workflow runtime engine by a call to . The default implementation of tracks whether the service has been started and uses this information to throw the appropriate exception if the service is stopped before it is started. - You can provide additional functionality necessary to have your service stopped by the workflow runtime engine by overriding this method. There is no guarantee about which, if any, services will be stopped or running when is called on your service. The workflow runtime engine raises the event after it has called the method of all of its workflow runtime engine services. Your service may need to retain some residual functionality to support other services until all the workflow runtime engine services have had their stop methods invoked by the workflow runtime engine. If your service must retain such functionality, you can override the method to perform any additional action required to finish stopping your service when the event is raised. + You can provide additional functionality necessary to have your service stopped by the workflow runtime engine by overriding this method. There is no guarantee about which, if any, services will be stopped or running when is called on your service. The workflow runtime engine raises the event after it has called the method of all of its workflow runtime engine services. Your service may need to retain some residual functionality to support other services until all the workflow runtime engine services have had their stop methods invoked by the workflow runtime engine. If your service must retain such functionality, you can override the method to perform any additional action required to finish stopping your service when the event is raised. > [!NOTE] -> If your is removed from the workflow runtime engine by a call to while the workflow runtime engine is running, the workflow runtime engine will call on your service. However, in this situation, the method will not be called for your service. Therefore, your service may have to perform any additional shutdown functionality that it would ordinarily perform in from inside the method. You can test to determine whether the workflow runtime engine is running. +> If your is removed from the workflow runtime engine by a call to while the workflow runtime engine is running, the workflow runtime engine will call on your service. However, in this situation, the method will not be called for your service. Therefore, your service may have to perform any additional shutdown functionality that it would ordinarily perform in from inside the method. You can test to determine whether the workflow runtime engine is running. - should only be called by the workflow runtime engine. + should only be called by the workflow runtime engine. ]]> diff --git a/xml/System.Workflow.Runtime.Hosting/WorkflowSchedulerService.xml b/xml/System.Workflow.Runtime.Hosting/WorkflowSchedulerService.xml index 266acd97ffe..3798f9d4503 100644 --- a/xml/System.Workflow.Runtime.Hosting/WorkflowSchedulerService.xml +++ b/xml/System.Workflow.Runtime.Hosting/WorkflowSchedulerService.xml @@ -83,7 +83,7 @@ removes from the pending work items queue a previous request to schedule a workflow instance. + removes from the pending work items queue a previous request to schedule a workflow instance. ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/ActivityDataTrackingExtract.xml b/xml/System.Workflow.Runtime.Tracking/ActivityDataTrackingExtract.xml index 683fdfebe6c..cb8ed1aa96f 100644 --- a/xml/System.Workflow.Runtime.Tracking/ActivityDataTrackingExtract.xml +++ b/xml/System.Workflow.Runtime.Tracking/ActivityDataTrackingExtract.xml @@ -27,17 +27,17 @@ Specifies a property or a field to be extracted from an activity and sent to the tracking service together with an associated collection of annotations when a track point is matched. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Each user event or activity status event that occurs during a workflow instance is associated with a specific activity. An specifies a property or a field to be extracted from this activity. You can include an in either or to instruct the runtime tracking infrastructure to extract a field or a property from the associated activity when the infrastructure matches an or a . The runtime tracking infrastructure puts the extracted data and any associated annotations in the or the that it returns to the tracking service. - - Set to specify the field or property for the runtime tracking infrastructure to extract from the activity. You can associate additional information with the extracted data by adding to . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Each user event or activity status event that occurs during a workflow instance is associated with a specific activity. An specifies a property or a field to be extracted from this activity. You can include an in either or to instruct the runtime tracking infrastructure to extract a field or a property from the associated activity when the infrastructure matches an or a . The runtime tracking infrastructure puts the extracted data and any associated annotations in the or the that it returns to the tracking service. + + Set to specify the field or property for the runtime tracking infrastructure to extract from the activity. You can associate additional information with the extracted data by adding to . + ]]> @@ -67,11 +67,11 @@ Initializes a new instance of the class. - to a value different from a null reference (`Nothing` in Visual Basic) elsewhere in your code. - + to a value different from a null reference (`Nothing` in Visual Basic) elsewhere in your code. + ]]> @@ -96,11 +96,11 @@ The dot delineated name of the field or the property that should be extracted and sent to the tracking service. Initializes a new instance of the class by using the specified activity member name. - is initialized to `member`. - + is initialized to `member`. + ]]> @@ -127,11 +127,11 @@ Gets the collection of annotations associated with the extracted data. The associated with the activity property or field to be extracted. The default is an empty collection. - to associate additional information with the extracted data. - + to associate additional information with the extracted data. + ]]> @@ -156,14 +156,14 @@ Gets or sets the field or the property to be extracted from the associated activity when a track point is matched. A dot delineated name that specifies a field or a property of the activity. The default is a null reference ( in Visual Basic). - can be set to specify a field or property of the activity; a member of such a field or property; or a single element of a field or property (or a member of either) that implements the interface. For example, if the activity has a `string` property named MyString and you want the runtime tracking infrastructure to return its length, you can set to "MyString.Length". Alternatively, to return the second char in MyString, you can set to "MyString[1]". - + can be set to specify a field or property of the activity; a member of such a field or property; or a single element of a field or property (or a member of either) that implements the interface. For example, if the activity has a `string` property named MyString and you want the runtime tracking infrastructure to return its length, you can set to "MyString.Length". Alternatively, to return the second char in MyString, you can set to "MyString[1]". + > [!NOTE] -> must be the real name of a property on the activity type. This name may be different from what you see in the designer because the designer supports the ability to localize and map property names. - +> must be the real name of a property on the activity type. This name may be different from what you see in the designer because the designer supports the ability to localize and map property names. + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/ActivityTrackPoint.xml b/xml/System.Workflow.Runtime.Tracking/ActivityTrackPoint.xml index 70beecf94d6..4bf5c8c2f7b 100644 --- a/xml/System.Workflow.Runtime.Tracking/ActivityTrackPoint.xml +++ b/xml/System.Workflow.Runtime.Tracking/ActivityTrackPoint.xml @@ -30,13 +30,13 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - Whenever the execution status of an activity changes, the workflow instance emits an activity status event to the runtime tracking infrastructure. An defines a point of interest in the potential execution path of a workflow, qualified by such an activity status event. An contains locations that are included in matching, locations that are excluded from matching, and the data that should be extracted from the workflow instance when the track point is matched. You can add an to to instruct the runtime tracking infrastructure to send an to the tracking service when the specified set of activity status events occur. A single may be matched at multiple points in the workflow instance. + Whenever the execution status of an activity changes, the workflow instance emits an activity status event to the runtime tracking infrastructure. An defines a point of interest in the potential execution path of a workflow, qualified by such an activity status event. An contains locations that are included in matching, locations that are excluded from matching, and the data that should be extracted from the workflow instance when the track point is matched. You can add an to to instruct the runtime tracking infrastructure to send an to the tracking service when the specified set of activity status events occur. A single may be matched at multiple points in the workflow instance. - An contains match conditions for a location or locations in the potential execution path of a workflow instance. You can add objects to to define locations that should be included in matching by the track point. Similarly, you can add objects to to define locations that should be excluded from matching by the track point. + An contains match conditions for a location or locations in the potential execution path of a workflow instance. You can add objects to to define locations that should be included in matching by the track point. Similarly, you can add objects to to define locations that should be excluded from matching by the track point. - You can add objects and objects to to specify data that should be extracted from the workflow instance when the track point is matched. The extracted data will be included in the . + You can add objects and objects to to specify data that should be extracted from the workflow instance when the track point is matched. The extracted data will be included in the . - You can add to to specify additional information associated with the track point. These annotations will be included in the sent when the track point is matched. + You can add to to specify additional information associated with the track point. These annotations will be included in the sent when the track point is matched. ]]> @@ -61,7 +61,7 @@ to . You may optionally add objects to , , and . + The parameterless constructor initializes an empty track point. No matching locations, excluded locations, data extracts or annotations are specified. You must configure the track point by adding at least one to . You may optionally add objects to , , and . ]]> @@ -90,7 +90,7 @@ to specify annotations to be returned in the sent to the tracking service when the track point is matched. If is empty, no annotations are associated with the track point. + You can add to to specify annotations to be returned in the sent to the tracking service when the track point is matched. If is empty, no annotations are associated with the track point. Annotations are `strings` that you define that contain information associated with the track point. For example, an annotation could contain information about the possible execution path the workflow can take from this track point, or it could contain information to be displayed in a user interface. @@ -121,9 +121,9 @@ in is matched for a particular activity status event, the track point will not be matched and no will be sent to the tracking service. If is empty, there are no excluded locations. + If any in is matched for a particular activity status event, the track point will not be matched and no will be sent to the tracking service. If is empty, there are no excluded locations. - You can use to specifically exclude locations from being tracked by the runtime tracking infrastructure. For example, if you want to track all activities except the activity with an property of "Code1", you can define an that matches all activities and add it to . Then you can define another that matches activities with an property set to "Code1" and add it to . The track point will then match all activities except the "Code1" activity. + You can use to specifically exclude locations from being tracked by the runtime tracking infrastructure. For example, if you want to track all activities except the activity with an property of "Code1", you can define an that matches all activities and add it to . Then you can define another that matches activities with an property set to "Code1" and add it to . The track point will then match all activities except the "Code1" activity. ]]> @@ -152,9 +152,9 @@ objects that it puts in the of the that it sends to the tracking service. If is empty, no data will be extracted. + When a track point is matched, the runtime tracking infrastructure can extract data from the workflow instance. The runtime tracking infrastructure encapsulates the extracted data in objects that it puts in the of the that it sends to the tracking service. If is empty, no data will be extracted. - You can add objects to to specify member data that should be extracted from the activity associated with this track point, and you can add objects to to specify member data that should be extracted from the activity of the workflow. + You can add objects to to specify member data that should be extracted from the activity associated with this track point, and you can add objects to to specify member data that should be extracted from the activity of the workflow. ]]> @@ -183,9 +183,9 @@ is empty, the track point cannot be matched by the runtime tracking infrastructure. You must add at least one to for the to participate in matching. + If is empty, the track point cannot be matched by the runtime tracking infrastructure. You must add at least one to for the to participate in matching. - The track point will be matched if any in is matched by the runtime tracking infrastructure and no in is matched. + The track point will be matched if any in is matched by the runtime tracking infrastructure and no in is matched. ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/ActivityTrackingCondition.xml b/xml/System.Workflow.Runtime.Tracking/ActivityTrackingCondition.xml index f9ffad7112c..1e767ede8df 100644 --- a/xml/System.Workflow.Runtime.Tracking/ActivityTrackingCondition.xml +++ b/xml/System.Workflow.Runtime.Tracking/ActivityTrackingCondition.xml @@ -68,7 +68,7 @@ . You must also set . The default value of is `Equals`. + If you use the parameterless constructor, you must explicitly set . You must also set . The default value of is `Equals`. ]]> @@ -99,7 +99,7 @@ is set to `member`, and is set to `value`. The default value of is `Equals`. + is set to `member`, and is set to `value`. The default value of is `Equals`. ]]> @@ -130,11 +130,11 @@ interface. For example, you can specify a single element of a collection. + You can specify an activity property or field, a member of an activity property or field, or a single element of an activity property or field (or a member of either) that implements the interface. For example, you can specify a single element of a collection. - If you use the parameterless constructor for , you must explicitly set . + If you use the parameterless constructor for , you must explicitly set . - The value of the specified activity member is compared with by applying . + The value of the specified activity member is compared with by applying . ]]> @@ -195,11 +195,11 @@ is compared to the value of + is compared to the value of - by applying . + by applying . - If you use the parameterless constructor for , you must explicitly set . + If you use the parameterless constructor for , you must explicitly set . ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/ActivityTrackingLocation.xml b/xml/System.Workflow.Runtime.Tracking/ActivityTrackingLocation.xml index 2137f8732e2..e1d7c7870f4 100644 --- a/xml/System.Workflow.Runtime.Tracking/ActivityTrackingLocation.xml +++ b/xml/System.Workflow.Runtime.Tracking/ActivityTrackingLocation.xml @@ -39,15 +39,15 @@ > [!NOTE] > A single may refer to more than one actual location in the potential execution path of a workflow instance. - You add objects to and in order to define the match parameters for an in a . + You add objects to and in order to define the match parameters for an in a . - You must specify the reference activity type to be matched by setting either or . + You must specify the reference activity type to be matched by setting either or . - You may set to specify interest in activities derived from the reference activity type. + You may set to specify interest in activities derived from the reference activity type. - You may add values to to specify the activity status events to be matched. + You may add values to to specify the activity status events to be matched. - You may add objects to to specify interest in the reference activity type only for specific conditions. For example, you can specify interest in only a particular named instance of the reference activity type. + You may add objects to to specify interest in the reference activity type only for specific conditions. For example, you can specify interest in only a particular named instance of the reference activity type. ]]> @@ -81,17 +81,17 @@ or in your code, then if a is later used on your tracking profile an exception will be thrown. + If you use the parameterless constructor and you do not explicitly set either or in your code, then if a is later used on your tracking profile an exception will be thrown. The following table shows the initial property values for an instance of . |Property|Value| |--------------|-----------| -||A null reference (`Nothing` in Visual Basic).| -||A null reference (`Nothing`).| -||An empty .| -||An empty .| -||`false`.| +||A null reference (`Nothing` in Visual Basic).| +||A null reference (`Nothing`).| +||An empty .| +||An empty .| +||`false`.| ]]> @@ -120,17 +120,17 @@ activity is "CodeActivity". is set to `activityTypeName`. + You must specify the unqualified name of the reference activity type. For example, the unqualified name of the CLR type of a activity is "CodeActivity". is set to `activityTypeName`. The following table shows the initial property values for an instance of . |Property|Value| |--------------|-----------| -||The unqualified name specified by `activityTypeName` of the reference activity type.| -||A null reference (`Nothing`).| -||An empty .| -||An empty .| -||`false`.| +||The unqualified name specified by `activityTypeName` of the reference activity type.| +||A null reference (`Nothing`).| +||An empty .| +||An empty .| +||`false`.| ]]> @@ -161,17 +161,17 @@ is set to `activityType`. + is set to `activityType`. The following table shows the initial property values for an instance of . |Property|Value| |--------------|-----------| -||A null reference (`Nothing` in Visual Basic).| -||The reference activity type specified by `activityType`.| -||An empty .| -||An empty .| -||`false`.| +||A null reference (`Nothing` in Visual Basic).| +||The reference activity type specified by `activityType`.| +||An empty .| +||An empty .| +||`false`.| ]]> @@ -210,11 +210,11 @@ |Property|Value| |--------------|-----------| -||The unqualified name specified by `activityTypeName` of the reference activity type.| -||A null reference (`Nothing`).| -||An empty .| -||A that contains the values specified by `ExecutionStatusEvents`.| -||`false`.| +||The unqualified name specified by `activityTypeName` of the reference activity type.| +||A null reference (`Nothing`).| +||An empty .| +||A that contains the values specified by `ExecutionStatusEvents`.| +||`false`.| ]]> @@ -255,11 +255,11 @@ |Property|Value| |--------------|-----------| -||A null reference (`Nothing`).| -||The reference activity type specified by `activityType`.| -||An empty .| -||A that contains the values specified by `executionStatusEvents`.| -||`false`.| +||A null reference (`Nothing`).| +||The reference activity type specified by `activityType`.| +||An empty .| +||A that contains the values specified by `executionStatusEvents`.| +||`false`.| ]]> @@ -305,11 +305,11 @@ |Property|Value| |--------------|-----------| -||The unqualified name specified by `activityTypeName` of the reference activity type.| -||A null reference (`Nothing`).| -||An empty .| -||A that contains the values specified by `executionStatusEvents`.| -||The value specified by `matchDerivedTypes`.| +||The unqualified name specified by `activityTypeName` of the reference activity type.| +||A null reference (`Nothing`).| +||An empty .| +||A that contains the values specified by `executionStatusEvents`.| +||The value specified by `matchDerivedTypes`.| ]]> @@ -353,11 +353,11 @@ |Property|Value| |--------------|-----------| -||A null reference (`Nothing`).| -||The reference activity type specified by `activityType`.| -||An empty .| -||A that contains the values specified by `executionStatusEvents`.| -||The value specified by `matchDerivedTypes`.| +||A null reference (`Nothing`).| +||The reference activity type specified by `activityType`.| +||An empty .| +||A that contains the values specified by `executionStatusEvents`.| +||The value specified by `matchDerivedTypes`.| ]]> @@ -392,7 +392,7 @@ or for the . If you want to specify the reference activity type in a version-independent manner, use . + You must specify either the or for the . If you want to specify the reference activity type in a version-independent manner, use . ]]> @@ -421,11 +421,11 @@ activity set to "CodeActivity". + You must specify the unqualified name of the reference activity type. For example, to specify the unqualified name of a activity set to "CodeActivity". - provides a much easier way to specify a reference activity type when you author a profile directly in XML. also provides a version-independent way of referring to a reference activity type. + provides a much easier way to specify a reference activity type when you author a profile directly in XML. also provides a version-independent way of referring to a reference activity type. - You must specify either the or for the . + You must specify either the or for the . ]]> @@ -454,9 +454,9 @@ to more precisely define the instance of the reference activity type to be matched. For example, if you want to match only activities with an equal to "MyCode", you can set to"CodeActivity" and add an to that specifies that the property of the activity instance must be equal to "MyCode". + You can use to more precisely define the instance of the reference activity type to be matched. For example, if you want to match only activities with an equal to "MyCode", you can set to"CodeActivity" and add an to that specifies that the property of the activity instance must be equal to "MyCode". - Every in must be `true` and one of the values in must be matched for the to be matched. + Every in must be `true` and one of the values in must be matched for the to be matched. ]]> @@ -485,7 +485,7 @@ specifies the activity status events for which the can be matched. One of the values in must be matched and every in must be `true` for the to be matched. An empty list specifies that no events are to be matched. + specifies the activity status events for which the can be matched. One of the values in must be matched and every in must be `true` for the to be matched. An empty list specifies that no events are to be matched. ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/ActivityTrackingLocationCollection.xml b/xml/System.Workflow.Runtime.Tracking/ActivityTrackingLocationCollection.xml index d6a4db0c2e4..80a85d852f6 100644 --- a/xml/System.Workflow.Runtime.Tracking/ActivityTrackingLocationCollection.xml +++ b/xml/System.Workflow.Runtime.Tracking/ActivityTrackingLocationCollection.xml @@ -30,15 +30,15 @@ Contains a collection of objects. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - An maintains two objects: specifies parameters used for matching activity status events and specifies parameters used to exclude activity status events from matching. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + An maintains two objects: specifies parameters used for matching activity status events and specifies parameters used to exclude activity status events from matching. + ]]> @@ -68,11 +68,11 @@ Initializes a new instance of the class. - to an empty list. - + to an empty list. + ]]> @@ -97,11 +97,11 @@ An list of objects. Initializes a new instance of the class by using a list of activity locations. - is initialized to contain the objects specified in `locations`. - + is initialized to contain the objects specified in `locations`. + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/ActivityTrackingRecord.xml b/xml/System.Workflow.Runtime.Tracking/ActivityTrackingRecord.xml index c55b30e60a0..84ba09c1fd8 100644 --- a/xml/System.Workflow.Runtime.Tracking/ActivityTrackingRecord.xml +++ b/xml/System.Workflow.Runtime.Tracking/ActivityTrackingRecord.xml @@ -23,15 +23,15 @@ Contains the data sent to a tracking service by the runtime tracking infrastructure when an is matched. It is also used in the return list of the property. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - When the runtime tracking infrastructure matches an in a , it sends an to the tracking service over the associated with that tracking service. The tracking service can perform whatever action is needed on the data in the tracking record. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + When the runtime tracking infrastructure matches an in a , it sends an to the tracking service over the associated with that tracking service. The tracking service can perform whatever action is needed on the data in the tracking record. + ]]> @@ -44,11 +44,11 @@ Initializes a new instance of the class. - @@ -69,11 +69,11 @@ Initializes a new instance of the class. - @@ -134,11 +134,11 @@ Gets or sets the common language runtime (CLR) type of the activity associated with this . The of the activity for which this was created. - is set by the runtime tracking infrastructure. - + is set by the runtime tracking infrastructure. + ]]> @@ -163,11 +163,11 @@ Gets the collection of annotations associated with the that was matched. An that contains the annotations that are associated with the that corresponds to this tracking record. - @@ -192,13 +192,13 @@ Gets a list that contains any data extracted from the workflow for the that was matched. A list of objects each of which contains a single piece of extracted data and its associated annotations. - is matched, the runtime tracking infrastructure can extract data from the workflow instance. The data to be extracted is specified by . can contain two kinds of objects: objects specify member data to be extracted from the activity associated with the activity status event; and, objects specify member data to be extracted from the root activity of the workflow. Both of these extract types can also specify annotations to be returned with the extracted data. The runtime tracking infrastructure encapsulates each piece of extracted data and its associated annotations in a , and adds this to . - - This property is set by the runtime tracking infrastructure. - + is matched, the runtime tracking infrastructure can extract data from the workflow instance. The data to be extracted is specified by . can contain two kinds of objects: objects specify member data to be extracted from the activity associated with the activity status event; and, objects specify member data to be extracted from the root activity of the workflow. Both of these extract types can also specify annotations to be returned with the extracted data. The runtime tracking infrastructure encapsulates each piece of extracted data and its associated annotations in a , and adds this to . + + This property is set by the runtime tracking infrastructure. + ]]> @@ -246,15 +246,15 @@ Always for an . A null reference () for an . - has no meaning for an and is always a null reference (`Nothing`). - - This property is set by the runtime tracking infrastructure. - + has no meaning for an and is always a null reference (`Nothing`). + + This property is set by the runtime tracking infrastructure. + ]]> @@ -279,13 +279,13 @@ Gets or sets the date and time that the activity status event occurred. A value. - is Greenwich Mean Time (UTC). - - is set by the runtime tracking infrastructure. - + is Greenwich Mean Time (UTC). + + is set by the runtime tracking infrastructure. + ]]> @@ -310,11 +310,11 @@ Gets or sets a value that indicates the order in the workflow instance of the activity status event that matched the . A value that indicates the order of the activity status event in the workflow instance. - indicates the relative order of the event that matched the within the workflow instance. is unique within a workflow instance, but it is not guaranteed to be sequential. is set by the runtime tracking infrastructure. - + indicates the relative order of the event that matched the within the workflow instance. is unique within a workflow instance, but it is not guaranteed to be sequential. is set by the runtime tracking infrastructure. + ]]> @@ -339,11 +339,11 @@ Gets or sets the execution status of the activity associated with this . One of the values. - can only be matched when an activity execution status change occurs. contains the that triggered the match and caused the to be sent. It reflects the current status of the activity instance. is set by the runtime tracking infrastructure. - + can only be matched when an activity execution status change occurs. contains the that triggered the match and caused the to be sent. It reflects the current status of the activity instance. is set by the runtime tracking infrastructure. + ]]> @@ -391,11 +391,11 @@ Gets or sets the identifier of the activity associated with this . The of the for which this tracking record was created. - is set by the runtime tracking infrastructure. - + is set by the runtime tracking infrastructure. + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/IProfileNotification.xml b/xml/System.Workflow.Runtime.Tracking/IProfileNotification.xml index 151d8b75722..250d7ce595e 100644 --- a/xml/System.Workflow.Runtime.Tracking/IProfileNotification.xml +++ b/xml/System.Workflow.Runtime.Tracking/IProfileNotification.xml @@ -20,15 +20,15 @@ Provides a notification mechanism for a tracking service to inform the runtime tracking infrastructure about changes to the for a particular workflow . - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Tracking services manage the tracking profiles available to the runtime tracking infrastructure. A tracking service that implements can provide notifications to the runtime tracking infrastructure when a for a particular workflow either changes or is no longer valid. The runtime tracking infrastructure subscribes to the and events and updates its cache when these events are raised. This decreases the number of requests for tracking profiles that the runtime tracking infrastructure makes to a tracking service. Note: the runtime tracking infrastructure still uses the overloaded methods of the tracking service, but it does not call them as frequently. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Tracking services manage the tracking profiles available to the runtime tracking infrastructure. A tracking service that implements can provide notifications to the runtime tracking infrastructure when a for a particular workflow either changes or is no longer valid. The runtime tracking infrastructure subscribes to the and events and updates its cache when these events are raised. This decreases the number of requests for tracking profiles that the runtime tracking infrastructure makes to a tracking service. Note: the runtime tracking infrastructure still uses the overloaded methods of the tracking service, but it does not call them as frequently. + ]]> @@ -52,11 +52,11 @@ Occurs when a for a specific workflow Type is removed. - event to inform the runtime tracking infrastructure that new instances of the workflow specified in should not be tracked. - + event to inform the runtime tracking infrastructure that new instances of the workflow specified in should not be tracked. + ]]> @@ -80,11 +80,11 @@ Occurs when a for a specific workflow is updated. - event to inform the runtime tracking infrastructure that a new is available for the indicated workflow . The workflow and the are passed in a . - + event to inform the runtime tracking infrastructure that a new is available for the indicated workflow . The workflow and the are passed in a . + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/ProfileRemovedEventArgs.xml b/xml/System.Workflow.Runtime.Tracking/ProfileRemovedEventArgs.xml index 75bb0038d0e..de014dc8774 100644 --- a/xml/System.Workflow.Runtime.Tracking/ProfileRemovedEventArgs.xml +++ b/xml/System.Workflow.Runtime.Tracking/ProfileRemovedEventArgs.xml @@ -23,15 +23,15 @@ Provides data for the event. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - A tracking service that implements the interface raises a event to notify the runtime tracking infrastructure that new instances of a particular workflow should no longer be tracked. The tracking service uses a to provide the workflow to the runtime tracking infrastructure. For example, the uses a when it raises the event. After a tracking service raises the event, the runtime tracking infrastructure will no longer associate a with the specified workflow for that tracking service. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + A tracking service that implements the interface raises a event to notify the runtime tracking infrastructure that new instances of a particular workflow should no longer be tracked. The tracking service uses a to provide the workflow to the runtime tracking infrastructure. For example, the uses a when it raises the event. After a tracking service raises the event, the runtime tracking infrastructure will no longer associate a with the specified workflow for that tracking service. + ]]> @@ -61,11 +61,11 @@ Initializes a new instance of the class. - event inside a tracking service, you must explicitly set . - + event inside a tracking service, you must explicitly set . + ]]> @@ -90,11 +90,11 @@ The workflow for which the should be removed. Initializes a new instance of the class that applies to the specified workflow . - is created with set to the specified . - + is created with set to the specified . + ]]> @@ -119,11 +119,11 @@ Gets or sets the workflow for which the should be removed. The of a workflow. - specifies the workflow for which a no longer exists, and which, therefore, should no longer be tracked by the runtime tracking infrastructure. - + specifies the workflow for which a no longer exists, and which, therefore, should no longer be tracked by the runtime tracking infrastructure. + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/ProfileUpdatedEventArgs.xml b/xml/System.Workflow.Runtime.Tracking/ProfileUpdatedEventArgs.xml index 325eb691484..11baa32db78 100644 --- a/xml/System.Workflow.Runtime.Tracking/ProfileUpdatedEventArgs.xml +++ b/xml/System.Workflow.Runtime.Tracking/ProfileUpdatedEventArgs.xml @@ -23,15 +23,15 @@ Provides the data for the event. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - A tracking service that implements the interface raises a event to notify the runtime tracking infrastructure that the for a particular workflow has changed. The tracking service uses a to provide the workflow and the new to the runtime tracking infrastructure. For example, the uses a when it raises the event. When it receives a event, the runtime tracking infrastructure will update the tracking profile for the specified workflow in its profile cache. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + A tracking service that implements the interface raises a event to notify the runtime tracking infrastructure that the for a particular workflow has changed. The tracking service uses a to provide the workflow and the new to the runtime tracking infrastructure. For example, the uses a when it raises the event. When it receives a event, the runtime tracking infrastructure will update the tracking profile for the specified workflow in its profile cache. + ]]> @@ -61,11 +61,11 @@ Initializes a new instance of the class. - event inside a tracking service, you must explicitly set and . - + event inside a tracking service, you must explicitly set and . + ]]> @@ -92,11 +92,11 @@ The new . Initializes a new instance of the class that specifies a new for the specified workflow . - is created with set to the specified and set to the specified profile. - + is created with set to the specified and set to the specified profile. + ]]> @@ -121,11 +121,11 @@ Gets or sets the new for the workflow Type. A for the workflow type. - event it will update its profile cache with the new for the workflow specified by . - + event it will update its profile cache with the new for the workflow specified by . + ]]> @@ -150,11 +150,11 @@ Gets or sets the of the workflow whose should be updated. The of a workflow. - specifies the workflow for which the tracking profile has changed. is set to the new tracking profile. When the runtime tracking infrastructure receives a event it will update its profile cache with the new for the workflow . - + specifies the workflow for which the tracking profile has changed. is set to the new tracking profile. When the runtime tracking infrastructure receives a event it will update its profile cache with the new for the workflow . + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/SqlTrackingQuery.xml b/xml/System.Workflow.Runtime.Tracking/SqlTrackingQuery.xml index 88fb2d871d6..88048dc6600 100644 --- a/xml/System.Workflow.Runtime.Tracking/SqlTrackingQuery.xml +++ b/xml/System.Workflow.Runtime.Tracking/SqlTrackingQuery.xml @@ -30,7 +30,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - provides methods and properties that you can use in order to access certain kinds of tracking data stored in a SQL database by the . Access to this data is provided through objects. You can call to try to get a for a specific workflow instance. You can call to get a collection of objects that correspond workflow instances that have tracking data that matches a set of query parameters contained in a that is passed as a parameter to the method. See the class for more information about the kind of tracking data available and see the class for more information about the kind of queries that can be performed. + provides methods and properties that you can use in order to access certain kinds of tracking data stored in a SQL database by the . Access to this data is provided through objects. You can call to try to get a for a specific workflow instance. You can call to get a collection of objects that correspond workflow instances that have tracking data that matches a set of query parameters contained in a that is passed as a parameter to the method. See the class for more information about the kind of tracking data available and see the class for more information about the kind of queries that can be performed. ]]> @@ -64,7 +64,7 @@ to a null reference (`Nothing` in Visual Basic). You must set before you call or or an will be thrown. + The parameterless constructor initializes to a null reference (`Nothing` in Visual Basic). You must set before you call or or an will be thrown. ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/SqlTrackingQueryOptions.xml b/xml/System.Workflow.Runtime.Tracking/SqlTrackingQueryOptions.xml index 6e73a99f330..a3609cefedd 100644 --- a/xml/System.Workflow.Runtime.Tracking/SqlTrackingQueryOptions.xml +++ b/xml/System.Workflow.Runtime.Tracking/SqlTrackingQueryOptions.xml @@ -30,7 +30,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - A contains properties that are used to constrain the set of objects returned by the method against the tracking data in a database used by the . Each in the collection of objects returned by a call to must correspond to a workflow instance which has tracking data associated with it in the database that meets the conditions specified by the properties of the . + A contains properties that are used to constrain the set of objects returned by the method against the tracking data in a database used by the . Each in the collection of objects returned by a call to must correspond to a workflow instance which has tracking data associated with it in the database that meets the conditions specified by the properties of the . ]]> @@ -59,13 +59,13 @@ |Property|Value| |--------------|-----------| -||.| -||.| -||An empty .| -||A null reference (`Nothing` in Visual Basic).| -||A null reference (`Nothing` in Visual Basic).| +||.| +||.| +||An empty .| +||A null reference (`Nothing` in Visual Basic).| +||A null reference (`Nothing` in Visual Basic).| - These values specify that a call to should return a object for every workflow instance that has tracking data in the database. + These values specify that a call to should return a object for every workflow instance that has tracking data in the database. ]]> @@ -98,13 +98,13 @@ |Property|Value| |--------------|-----------| -||.| -||.| -||An empty .| -||A null reference (`Nothing` in Visual Basic).| -||A null reference (`Nothing` in Visual Basic).| +||.| +||.| +||An empty .| +||A null reference (`Nothing` in Visual Basic).| +||A null reference (`Nothing` in Visual Basic).| - These values specify that a call to should return a object for every workflow instance that has tracking data in the database. + These values specify that a call to should return a object for every workflow instance that has tracking data in the database. ]]> @@ -133,9 +133,9 @@ constrains the set of objects returned by a call to to those workflow instances that have the specified by , that have the status specified by during the period specified by and , and that have extracted data that matches at least one of the objects specified by . + constrains the set of objects returned by a call to to those workflow instances that have the specified by , that have the status specified by during the period specified by and , and that have extracted data that matches at least one of the objects specified by . - The value specified by is inclusive. For more information about how the status of a workflow instance is matched, see the property. + The value specified by is inclusive. For more information about how the status of a workflow instance is matched, see the property. > [!NOTE] > If `WorkflowStatus` is set to null, then `StatusMaxDateTime` and `StatusMinDateTime` are ignored. All workflow instances will be returned when `GetWorkflows` is called. @@ -167,9 +167,9 @@ constrains the set of objects returned by a call to to those workflow instances that have the specified by , that have the status specified by during the period specified by and , and that have extracted data that matches at least one of the objects specified by . + constrains the set of objects returned by a call to to those workflow instances that have the specified by , that have the status specified by during the period specified by and , and that have extracted data that matches at least one of the objects specified by . - The value specified by is inclusive. For more information about how the status of a workflow instance is matched, see the property. + The value specified by is inclusive. For more information about how the status of a workflow instance is matched, see the property. > [!NOTE] > If `WorkflowStatus` is set to null, then `StatusMaxDateTime` and `StatusMinDateTime` are ignored. All workflow instances will be returned when `GetWorkflows` is called. @@ -201,11 +201,11 @@ constrains the set of objects returned by a call to to those workflow instances that have the specified by , that have the status specified by during the period specified by and , and that have extracted data that matches at least one of the objects specified by . + constrains the set of objects returned by a call to to those workflow instances that have the specified by , that have the status specified by during the period specified by and , and that have extracted data that matches at least one of the objects specified by . - or can contain records that contain data that is extracted from the workflow. The property contains objects that specify certain values for this extracted data. If the workflow instance meets the other criteria specified by and is not a null reference (`Nothing`), the extracted data stored in the database for a workflow instance must match one or more of the extracted data values specified by the property for a object to be returned for the workflow instance. + or can contain records that contain data that is extracted from the workflow. The property contains objects that specify certain values for this extracted data. If the workflow instance meets the other criteria specified by and is not a null reference (`Nothing`), the extracted data stored in the database for a workflow instance must match one or more of the extracted data values specified by the property for a object to be returned for the workflow instance. - If is a null reference (`Nothing`), the set of objects returned will not be constrained by the values of the extracted data for any of the workflow instances in the database. + If is a null reference (`Nothing`), the set of objects returned will not be constrained by the values of the extracted data for any of the workflow instances in the database. ]]> @@ -234,9 +234,9 @@ constrains the set of objects returned by a call to to those workflow instances that have the specified by , that have the status specified by during the period specified by and , and that have extracted data that matches at least one of the objects specified by . + constrains the set of objects returned by a call to to those workflow instances that have the specified by , that have the status specified by during the period specified by and , and that have extracted data that matches at least one of the objects specified by . - A workflow instance is considered to have a status that matches if the last received for that workflow instance before or during the specified time period has its property set to a value that maps to the value specified by . Therefore, the for the workflow instance must have a that is configured for the appropriate value. Only values that have been sent in workflow tracking records can be matched. If no workflow tracking records have been sent for the workflow instance, the workflow instance is considered to have a status of . + A workflow instance is considered to have a status that matches if the last received for that workflow instance before or during the specified time period has its property set to a value that maps to the value specified by . Therefore, the for the workflow instance must have a that is configured for the appropriate value. Only values that have been sent in workflow tracking records can be matched. If no workflow tracking records have been sent for the workflow instance, the workflow instance is considered to have a status of . The following table shows the mapping between values and values. @@ -256,7 +256,7 @@ ||| ||| - If is null (`Nothing`), the set of objects returned will not be constrained by status; in other words, a object will be returned for any workflow instance that matches the parameters specified by the other properties of . + If is null (`Nothing`), the set of objects returned will not be constrained by status; in other words, a object will be returned for any workflow instance that matches the parameters specified by the other properties of . ]]> @@ -285,9 +285,9 @@ constrains the set of objects returned by a call to to those workflow instances that have the specified by , that have the status specified by during the period specified by and , and that have extracted data that matches at least one of the objects specified by . + constrains the set of objects returned by a call to to those workflow instances that have the specified by , that have the status specified by during the period specified by and , and that have extracted data that matches at least one of the objects specified by . - If is a null reference (`Nothing`), the set of objects returned will not be constrained by workflow ; in other words, a object will be returned for any workflow instance that matches the parameters specified by the other properties of . + If is a null reference (`Nothing`), the set of objects returned will not be constrained by workflow ; in other words, a object will be returned for any workflow instance that matches the parameters specified by the other properties of . ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/SqlTrackingService.xml b/xml/System.Workflow.Runtime.Tracking/SqlTrackingService.xml index b84e94adcbf..2483dea75bb 100644 --- a/xml/System.Workflow.Runtime.Tracking/SqlTrackingService.xml +++ b/xml/System.Workflow.Runtime.Tracking/SqlTrackingService.xml @@ -36,9 +36,9 @@ The class represents a fully functional tracking service. You can use this service out-of-box to collect and store tracking information, and to store tracking profiles and provide them when requested by the workflow runtime engine. The SQL tracking service writes tracking data sent to it by the runtime tracking infrastructure to a SQL database. - In many scenarios it is important for the to maintain consistency between its database and the state of the workflow runtime engine. Therefore, the `SqlTrackingChannel` class makes use of the interface to participate in the workflow transaction batching functionality provided by the . You can set or pass the appropriate parameters to the constructor to configure the to participate in batching and add objects that represent pending changes to the SQL database to the . + In many scenarios it is important for the to maintain consistency between its database and the state of the workflow runtime engine. Therefore, the `SqlTrackingChannel` class makes use of the interface to participate in the workflow transaction batching functionality provided by the . You can set or pass the appropriate parameters to the constructor to configure the to participate in batching and add objects that represent pending changes to the SQL database to the . - The also maintains tracking profiles in its database. The workflow runtime engine must be kept apprised of changes to any of the tracking profiles that it is using. The implements the interface and periodically examines the tracking profiles in its database in order to notify the workflow runtime engine of changes to a stored in its database. You can set or pass the appropriate parameter to the constructor in order to set the interval at which the examines its tracking profiles to notify the tracking runtime of any profile changes. + The also maintains tracking profiles in its database. The workflow runtime engine must be kept apprised of changes to any of the tracking profiles that it is using. The implements the interface and periodically examines the tracking profiles in its database in order to notify the workflow runtime engine of changes to a stored in its database. You can set or pass the appropriate parameter to the constructor in order to set the interval at which the examines its tracking profiles to notify the tracking runtime of any profile changes. > [!NOTE] > When using both the and the in a workflow application, it is recommended that you use a single database for both persistence and tracking. @@ -85,8 +85,8 @@ |Key|Property Type|Property Description| |---------|-------------------|--------------------------| -|`"IsTransactional"`|`bool`|Specifies whether participates in workflow transactions by using the . The default is `true`, specifying that tracking changes are written to the database in a synchronous manner.| -|`"UseDefaultProfile"`|`bool`|Specifies whether the default tracking profile will be returned if a tracking profile cannot be found for a call. The default is `true`, specifying that the default tracking profile will be used.| +|`"IsTransactional"`|`bool`|Specifies whether participates in workflow transactions by using the . The default is `true`, specifying that tracking changes are written to the database in a synchronous manner.| +|`"UseDefaultProfile"`|`bool`|Specifies whether the default tracking profile will be returned if a tracking profile cannot be found for a call. The default is `true`, specifying that the default tracking profile will be used.| |`"ProfileChangeCheckInterval"`|`double`|Specifies the time in milliseconds at which to examine the database for changes to its tracking profiles. The default is 60000 milliseconds.| |`"ConnectionString"`|`string`|Specifies the database connection string. The default is a null reference (`Nothing` in Visual Basic).| |`"PartitionOnCompletion"`|`bool`|Specifies whether tracking data for a workflow instance should be moved to the currently active partition in the database when the workflow instance is completed.| @@ -167,15 +167,15 @@ property is set to `false` and is set to `true`, then all transaction retries depend on the value of the property. + If the property is set to `false` and is set to `true`, then all transaction retries depend on the value of the property. - If is set to `true`, then certain work is batched and retries of those work batch transactions are handled by a derived type of , such as or . + If is set to `true`, then certain work is batched and retries of those work batch transactions are handled by a derived type of , such as or . - Regardless of whether is set to `true`, the following work items cannot be batched and any transaction retries must be handled through the property. + Regardless of whether is set to `true`, the following work items cannot be batched and any transaction retries must be handled through the property. - Polling for tracking profile changes. -- All writes to a SQL Server database when is set to `false`. +- All writes to a SQL Server database when is set to `false`. Besides being set programmatically, this functionality can be enabled through a configuration file. For more information about how to set this property through a configuration file, see [Workflow Configuration Files](https://msdn.microsoft.com/library/ada4bb90-6c9d-4f3d-a9d0-b559bb0f9909). @@ -289,7 +289,7 @@ is `true`, participates in the workflow transaction. That is, it follows the semantics defined by and adds any changes to its database as work items to the . The service commits these changes when instructed to by the workflow runtime engine. + Ordinarily tracking data is written to the database synchronously, that is, the data is written as soon as it is received on the Tracking Channel. If is `true`, participates in the workflow transaction. That is, it follows the semantics defined by and adds any changes to its database as work items to the . The service commits these changes when instructed to by the workflow runtime engine. ]]> @@ -319,7 +319,7 @@ allows you to partition the database in order to provide an efficient method for archiving and deleting tracking records. If your database experiences long periods between down times or your database has no planned downtime, you can set to move tracking records associated with a workflow instance from the active instance tables to the currently active partition when the workflow instance completes. This allows you to archive or delete these records without having to lock the data in the active instance tables of the database. For more information about partitioning, see [Data Maintenance with SqlTrackingService](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/aa349365(v=vs.90)). + The allows you to partition the database in order to provide an efficient method for archiving and deleting tracking records. If your database experiences long periods between down times or your database has no planned downtime, you can set to move tracking records associated with a workflow instance from the active instance tables to the currently active partition when the workflow instance completes. This allows you to archive or delete these records without having to lock the data in the active instance tables of the database. For more information about partitioning, see [Data Maintenance with SqlTrackingService](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/aa349365(v=vs.90)). ]]> @@ -349,7 +349,7 @@ periodically examines the database to determine whether one or more of its tracking profiles have been changed or have been deleted. When the determines that a has been deleted it raises an event; when it determines that a profile has been changed it raises a event. The runtime tracking infrastructure subscribes to both of these events and updates its tracking profile cache appropriately when they occur. You can also subscribe to either or both of these events if you want to be notified of changes to a tracking profile. You can set to specify the frequency with which the should test for such changes. When you specify a new value for , the timer interval is immediately set to this new value. + The periodically examines the database to determine whether one or more of its tracking profiles have been changed or have been deleted. When the determines that a has been deleted it raises an event; when it determines that a profile has been changed it raises a event. The runtime tracking infrastructure subscribes to both of these events and updates its tracking profile cache appropriately when they occur. You can also subscribe to either or both of these events if you want to be notified of changes to a tracking profile. You can set to specify the frequency with which the should test for such changes. When you specify a new value for , the timer interval is immediately set to this new value. ]]> @@ -381,7 +381,7 @@ periodically examines its database to determine whether one or more of its tracking profiles have been deleted. If it detects that a has been deleted, it raises the event and puts the workflow in the . The runtime tracking infrastructure uses this event to update its profile cache. You can set to specify the frequency at which the examines its database. + The periodically examines its database to determine whether one or more of its tracking profiles have been deleted. If it detects that a has been deleted, it raises the event and puts the workflow in the . The runtime tracking infrastructure uses this event to update its profile cache. You can set to specify the frequency at which the examines its database. ]]> @@ -413,7 +413,7 @@ periodically examines its database to determine whether one or more of its tracking profiles have been changed. If it detects such a change in a , it raises the event with the tracking profile encapsulated in a . The runtime tracking infrastructure uses this event to update its profile cache. You can set to specify the frequency at which the examines its database. + The periodically examines its database to determine whether one or more of its tracking profiles have been changed. If it detects such a change in a , it raises the event with the tracking profile encapsulated in a . The runtime tracking infrastructure uses this event to update its profile cache. You can set to specify the frequency at which the examines its database. ]]> @@ -523,17 +523,17 @@ is `true`, the will return a default whenever the workflow runtime engine tries to get a tracking profile for a workflow for which the tracking service has no associated . + If is `true`, the will return a default whenever the workflow runtime engine tries to get a tracking profile for a workflow for which the tracking service has no associated . The out-of-box default tracking profile matches all activity events, user events, and workflow events emitted by a workflow instance. You can change the default tracking profile by using the `UpdateDefaultProfile` stored procedure. > [!NOTE] > The `UpdateDefaultProfile` stored procedure will change the default tracking profile. This new default profile will be returned when the workflow runtime engine requests a profile for a workflow type for which the tracking service has no associated tracking profile. Workflow types that were previously associated with the old default profile will still be associated with that profile even after `UpdateDefaultProfile` is called; you must explicitly call the `UpdateTrackingProfile` stored procedure on any of these workflow types that you want to associate with the new default profile. - While is true, the will return the default tracking profile to the workflow runtime engine for any workflow type for which it doesn't have a tracking profile associated in its database. If you later set to false, the default profile will still be associated with these workflow types in the database. You can call the `DeleteTrackingProfile` stored procedure on a workflow type to no longer associate a tracking profile with that type, or you can call the `UpdateTrackingProfile` stored procedure on a workflow type to change the tracking profile associated with that type. + While is true, the will return the default tracking profile to the workflow runtime engine for any workflow type for which it doesn't have a tracking profile associated in its database. If you later set to false, the default profile will still be associated with these workflow types in the database. You can call the `DeleteTrackingProfile` stored procedure on a workflow type to no longer associate a tracking profile with that type, or you can call the `UpdateTrackingProfile` stored procedure on a workflow type to change the tracking profile associated with that type. > [!NOTE] -> The workflow runtime engine caches its tracking profiles. Therefore, it must receive a event for any workflow type for which it already has a tracking profile associated in its cache before it will stop using its cached profile for new instances of that workflow type. Likewise, the workflow runtime engine must receive a event for such workflow types before it will load a new tracking profile into its cache to associate with new instances of the workflow type. The raises the appropriate events for applicable workflow types when it examines the database for changes to its tracking profiles. The frequency at which the performs this operation is set by . Therefore, whenever you call the `UpdateTrackingProfile` or `DeleteTrackingProfile` stored procedures there may be a delay of up to the period specified by before the workflow runtime engine will reflect your changes in its profile cache. +> The workflow runtime engine caches its tracking profiles. Therefore, it must receive a event for any workflow type for which it already has a tracking profile associated in its cache before it will stop using its cached profile for new instances of that workflow type. Likewise, the workflow runtime engine must receive a event for such workflow types before it will load a new tracking profile into its cache to associate with new instances of the workflow type. The raises the appropriate events for applicable workflow types when it examines the database for changes to its tracking profiles. The frequency at which the performs this operation is set by . Therefore, whenever you call the `UpdateTrackingProfile` or `DeleteTrackingProfile` stored procedures there may be a delay of up to the period specified by before the workflow runtime engine will reflect your changes in its profile cache. > > For more information about tracking profiles, see [Creating and Using Tracking Profiles](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms735943(v=vs.90)). diff --git a/xml/System.Workflow.Runtime.Tracking/SqlTrackingWorkflowInstance.xml b/xml/System.Workflow.Runtime.Tracking/SqlTrackingWorkflowInstance.xml index c9bff8ed2ae..f6d14024524 100644 --- a/xml/System.Workflow.Runtime.Tracking/SqlTrackingWorkflowInstance.xml +++ b/xml/System.Workflow.Runtime.Tracking/SqlTrackingWorkflowInstance.xml @@ -30,7 +30,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - objects are returned by a call to both and and provide access to the tracking data maintained in a SQL database by the for a specific workflow instance. The class optimizes its access to the database for its properties, which maintain collections. For more information, see . + objects are returned by a call to both and and provide access to the tracking data maintained in a SQL database by the for a specific workflow instance. The class optimizes its access to the database for its properties, which maintain collections. For more information, see . ]]> @@ -59,9 +59,9 @@ is `true`, contains all activity tracking records sent for this workflow instance up to the current time; if is `false`, contains the activity tracking records sent up until the last . + If is `true`, contains all activity tracking records sent for this workflow instance up to the current time; if is `false`, contains the activity tracking records sent up until the last . - contains activity tracking records sent to a database by the run-time tracking infrastructure for this workflow instance. Activity tracking records are sent by the workflow run-time engine tracking infrastructure only when the workflow instance emits an activity status event that corresponds to an specified in the for the instance. + contains activity tracking records sent to a database by the run-time tracking infrastructure for this workflow instance. Activity tracking records are sent by the workflow run-time engine tracking infrastructure only when the workflow instance emits an activity status event that corresponds to an specified in the for the instance. ]]> @@ -91,7 +91,7 @@ , query the database for new elements only when the property is accessed, and the collection for such a property is only updated on an as-required basis when the property is accessed. The class maintains two timestamps for each property: one that indicates the time that tracking data for the collection was last loaded, and another that indicates the last time the was refreshed. When you get one of the collection properties, the loads any tracking data that was added to the database between the last time tracking data for the collection was loaded and the last time the was refreshed and adds this data to the collection maintained by the property. The timestamp that indicates the last time data was loaded for the property is then set to the value of the timestamp that indicates the last refresh. If these two timestamps are equal, additional tracking data is not loaded for the property when it is accessed. Set to `true` to perform a refresh every time a collection property is accessed and ensure that the tracking data returned in the collection maintained by that property is always current. If is `false`, you must call to reset the timestamp that corresponds to the last refresh. + To optimize database performance, properties that maintain collections of queried data, such as , query the database for new elements only when the property is accessed, and the collection for such a property is only updated on an as-required basis when the property is accessed. The class maintains two timestamps for each property: one that indicates the time that tracking data for the collection was last loaded, and another that indicates the last time the was refreshed. When you get one of the collection properties, the loads any tracking data that was added to the database between the last time tracking data for the collection was loaded and the last time the was refreshed and adds this data to the collection maintained by the property. The timestamp that indicates the last time data was loaded for the property is then set to the value of the timestamp that indicates the last refresh. If these two timestamps are equal, additional tracking data is not loaded for the property when it is accessed. Set to `true` to perform a refresh every time a collection property is accessed and ensure that the tracking data returned in the collection maintained by that property is always current. If is `false`, you must call to reset the timestamp that corresponds to the last refresh. ]]> @@ -142,7 +142,7 @@ is `true`, contains a for each of the workflow instances that has been invoked by this workflow instance up to the current time; if is `false`, contains a for each of the workflow instances that has been invoked by this workflow instance up until the last . + If is `true`, contains a for each of the workflow instances that has been invoked by this workflow instance up to the current time; if is `false`, contains a for each of the workflow instances that has been invoked by this workflow instance up until the last . The contents of this property are determined by the tracking data for this workflow instance contained in the SQL database managed by the . This tracking data corresponds to tracking records that are sent by the run-time tracking infrastructure for tracking events that are specified by the track points in the associated with this workflow instance. @@ -202,7 +202,7 @@ does not actually load any data for the . To optimize database performance, the class loads data for its collection properties on an as-required basis. The class maintains two timestamps for each property: one that indicates the time that tracking data for the collection was last loaded, and another that indicates the last time the was refreshed. When you get one of the collection properties, the loads any tracking data that was added to the database between the last time tracking data for the collection was loaded and the last time the was refreshed and adds this data to the collection maintained by the property. The timestamp that indicates the last time data was loaded for the property is then set to the value of the timestamp that indicates the last refresh. If these two timestamps are equal, additional tracking data is not loaded for the property when it is accessed. sets the timestamp that corresponds to the last refresh to . + does not actually load any data for the . To optimize database performance, the class loads data for its collection properties on an as-required basis. The class maintains two timestamps for each property: one that indicates the time that tracking data for the collection was last loaded, and another that indicates the last time the was refreshed. When you get one of the collection properties, the loads any tracking data that was added to the database between the last time tracking data for the collection was loaded and the last time the was refreshed and adds this data to the collection maintained by the property. The timestamp that indicates the last time data was loaded for the property is then set to the value of the timestamp that indicates the last refresh. If these two timestamps are equal, additional tracking data is not loaded for the property when it is accessed. sets the timestamp that corresponds to the last refresh to . ]]> @@ -231,7 +231,7 @@ is determined based on the tracking data for the workflow instance, specifically on the workflow tracking records sent by the run-time tracking infrastructure; therefore depends, in part, on the objects in the for the workflow instance. in each maps to one of the values. If no workflow tracking records have been sent by the run-time tracking infrastructure for this workflow instance, is . + is determined based on the tracking data for the workflow instance, specifically on the workflow tracking records sent by the run-time tracking infrastructure; therefore depends, in part, on the objects in the for the workflow instance. in each maps to one of the values. If no workflow tracking records have been sent by the run-time tracking infrastructure for this workflow instance, is . ]]> @@ -260,9 +260,9 @@ is `true`, contains all user tracking records sent for this workflow instance up to the current time; if is `false`, contains the user tracking records sent up until the last . + If is `true`, contains all user tracking records sent for this workflow instance up to the current time; if is `false`, contains the user tracking records sent up until the last . - contains user tracking records sent to a database by the run-time tracking infrastructure for this workflow instance. User tracking records are sent by the workflow run-time engine tracking infrastructure only when the workflow instance emits a user event that corresponds to a specified in the for the instance. + contains user tracking records sent to a database by the run-time tracking infrastructure for this workflow instance. User tracking records are sent by the workflow run-time engine tracking infrastructure only when the workflow instance emits a user event that corresponds to a specified in the for the instance. ]]> @@ -350,9 +350,9 @@ is `true`, contains all workflow tracking records sent for this workflow instance up to the current time; if is `false`, contains the workflow tracking records sent up until the last . + If is `true`, contains all workflow tracking records sent for this workflow instance up to the current time; if is `false`, contains the workflow tracking records sent up until the last . - contains workflow tracking records sent to a database by the run-time tracking infrastructure for this workflow instance. Workflow tracking records are sent by the workflow run-time engine tracking infrastructure only when the workflow instance emits a workflow status event that corresponds to a specified in the for the instance. + contains workflow tracking records sent to a database by the run-time tracking infrastructure for this workflow instance. Workflow tracking records are sent by the workflow run-time engine tracking infrastructure only when the workflow instance emits a workflow status event that corresponds to a specified in the for the instance. ]]> @@ -403,7 +403,7 @@ provides a more efficient way to access data for a workflow instance in a SQL database than by using a workflow instance . Use to find related records for this workflow instance in separate views. + This is an internal join operation. provides a more efficient way to access data for a workflow instance in a SQL database than by using a workflow instance . Use to find related records for this workflow instance in separate views. ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingAnnotationCollection.xml b/xml/System.Workflow.Runtime.Tracking/TrackingAnnotationCollection.xml index d1f76b1ce3b..1ab8806a839 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingAnnotationCollection.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingAnnotationCollection.xml @@ -30,15 +30,15 @@ Contains a collection of annotations. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Annotations are `strings` that you define that contain information to associate with certain kinds of tracking data. For more information, see , , , , , , , , or . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Annotations are `strings` that you define that contain information to associate with certain kinds of tracking data. For more information, see , , , , , , , , or . + ]]> @@ -68,11 +68,11 @@ Initializes a new instance of the class. - is initialized to an empty list. - + is initialized to an empty list. + ]]> @@ -97,11 +97,11 @@ An list of annotations. Initializes a new instance of the class by using a list of string annotations. - is initialized to contain the strings specified in `annotations`. - + is initialized to contain the strings specified in `annotations`. + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingChannel.xml b/xml/System.Workflow.Runtime.Tracking/TrackingChannel.xml index c7826d95de7..be8cb50e7f0 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingChannel.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingChannel.xml @@ -30,9 +30,9 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - If a is present, the runtime tracking infrastructure calls to get a tracking channel for a workflow instance. The runtime tracking infrastructure uses this tracking channel to send tracking records associated with the workflow instance back to the host application whenever the tracking infrastructure matches a track point in the associated with the workflow instance. Your application can treat this tracking information in any way you choose. For example, the writes tracking information to a SQL database. + If a is present, the runtime tracking infrastructure calls to get a tracking channel for a workflow instance. The runtime tracking infrastructure uses this tracking channel to send tracking records associated with the workflow instance back to the host application whenever the tracking infrastructure matches a track point in the associated with the workflow instance. Your application can treat this tracking information in any way you choose. For example, the writes tracking information to a SQL database. - To create a tracking channel for your tracking service, derive a class from the base class. You can use the object passed by the runtime tracking infrastructure in its call to your implementation of to associate each instance of your tracking channel with a specific workflow instance. The workflow runtime engine requests a tracking channel from each tracking service that has provided a for a workflow instance. + To create a tracking channel for your tracking service, derive a class from the base class. You can use the object passed by the runtime tracking infrastructure in its call to your implementation of to associate each instance of your tracking channel with a specific workflow instance. The workflow runtime engine requests a tracking channel from each tracking service that has provided a for a workflow instance. ]]> @@ -79,7 +79,7 @@ to notify the receiver of data on the tracking channel that the workflow instance associated with this tracking channel has either terminated or completed. No more data will be sent on the tracking channel. When is called, you may perform whatever actions are required by your implementation of the class. + The runtime tracking infrastructure calls to notify the receiver of data on the tracking channel that the workflow instance associated with this tracking channel has either terminated or completed. No more data will be sent on the tracking channel. When is called, you may perform whatever actions are required by your implementation of the class. ]]> @@ -111,7 +111,7 @@ to deliver a on the when it matches a track point in a . You can treat the tracking information sent on the in whatever manner the requirements of your application dictate. + The runtime tracking infrastructure calls to deliver a on the when it matches a track point in a . You can treat the tracking information sent on the in whatever manner the requirements of your application dictate. ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingCondition.xml b/xml/System.Workflow.Runtime.Tracking/TrackingCondition.xml index 14dc8a31ee4..f506ca9cc34 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingCondition.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingCondition.xml @@ -27,17 +27,17 @@ An base class representing a comparison that can be used to constrain an or a . - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - is the abstract base class from which is derived. - - is evaluated by comparing the value of to by applying . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + is the abstract base class from which is derived. + + is evaluated by comparing the value of to by applying . + ]]> @@ -80,11 +80,11 @@ When overridden in a derived class, gets or sets the name of the member whose value will be compared. The name of the member to be compared. - will be compared to by applying the . - + will be compared to by applying the . + ]]> @@ -109,11 +109,11 @@ When overridden in a derived class, gets or sets the operator to use in the comparison. One of the values. - and are supported. - + and are supported. + ]]> @@ -138,11 +138,11 @@ When overridden in a derived class, gets or sets the value to compare. The value to compare. - will be compared to the value of by applying the . - + will be compared to the value of by applying the . + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingDataItem.xml b/xml/System.Workflow.Runtime.Tracking/TrackingDataItem.xml index 5d32b4da3a7..5c34c666435 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingDataItem.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingDataItem.xml @@ -30,7 +30,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - When the runtime tracking infrastructure matches a track point, it sends a tracking record to the tracking service. An or a may contain or objects that specify data to be extracted from the workflow and returned in the or the . A represents a single item of this extracted data in either or . + When the runtime tracking infrastructure matches a track point, it sends a tracking record to the tracking service. An or a may contain or objects that specify data to be extracted from the workflow and returned in the or the . A represents a single item of this extracted data in either or . ]]> @@ -106,7 +106,7 @@ contains the member data, specified by an or a , that was extracted from the workflow instance. + contains the member data, specified by an or a , that was extracted from the workflow instance. ]]> @@ -135,7 +135,7 @@ ; a member of such a field or property; and a single item of a field or a property (or a member of either) that implements the interface, for example a single element in a collection. contains the dot delineated name of the item extracted and is equivalent to or depending on which type of extract specified the data contained by the . + The runtime tracking infrastructure supports data extraction on fields and properties of classes that inherit from ; a member of such a field or property; and a single item of a field or a property (or a member of either) that implements the interface, for example a single element in a collection. contains the dot delineated name of the item extracted and is equivalent to or depending on which type of extract specified the data contained by the . ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingDataItemValue.xml b/xml/System.Workflow.Runtime.Tracking/TrackingDataItemValue.xml index f78ffff2838..db916edf661 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingDataItemValue.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingDataItemValue.xml @@ -30,7 +30,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - A specifies the value of a piece of data extracted from a workflow. It is used to constrain the set of objects returned by in a query of the tracking data base used by a . You can add objects to to specify that the set of objects returned by be constrained to those possessing the specified set of extracted data. + A specifies the value of a piece of data extracted from a workflow. It is used to constrain the set of objects returned by in a query of the tracking data base used by a . You can add objects to to specify that the set of objects returned by be constrained to those possessing the specified set of extracted data. ]]> @@ -64,7 +64,7 @@ , , and to a null reference (`Nothing` in Visual Basic). You must set all of these properties in order to configure the . + The parameterless constructor initializes , , and to a null reference (`Nothing` in Visual Basic). You must set all of these properties in order to configure the . ]]> @@ -97,7 +97,7 @@ , , and properties are set according to the values specified by the equivalent parameters to the constructor. + The , , and properties are set according to the values specified by the equivalent parameters to the constructor. ]]> @@ -126,7 +126,7 @@ can be a null reference (`Nothing`). + can be a null reference (`Nothing`). ]]> @@ -155,7 +155,7 @@ corresponds to the name specified in a . can, therefore, be set to specify an activity field or property; a member of an activity field or property; or a single element of an activity field or property (or a member of either) that implements the interface. For more information see , , or . + corresponds to the name specified in a . can, therefore, be set to specify an activity field or property; a member of an activity field or property; or a single element of an activity field or property (or a member of either) that implements the interface. For more information see , , or . ]]> @@ -184,7 +184,7 @@ is equivalent to the property of the activity from which the data was extracted. + is equivalent to the property of the activity from which the data was extracted. ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingExtract.xml b/xml/System.Workflow.Runtime.Tracking/TrackingExtract.xml index 4073e5630f2..89701b1eeed 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingExtract.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingExtract.xml @@ -27,15 +27,15 @@ The base class representing a field or a property to be extracted from a workflow instance and its associated annotations. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - is the `abstract` base class from which the class and the class are derived. An specifies a field or a property to be extracted from the activity associated with a tracking event and a specifies a field or a property to be extracted from the root activity of the workflow instance. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + is the `abstract` base class from which the class and the class are derived. An specifies a field or a property to be extracted from the activity associated with a tracking event and a specifies a field or a property to be extracted from the root activity of the workflow instance. + ]]> @@ -78,11 +78,11 @@ When implemented in a derived class, gets the annotations associated with the extracted data. The associated with the extracted data. - @@ -107,11 +107,11 @@ When implemented in a derived class, gets or sets the name of the field or property to be extracted. The dot delineated name of a field or a property. - can be set to specify a field or a property; a member of a field or a property; or a single element of a field or a property (or a member of either) that implements the interface. For example, a single element in an `array` may be specified. - + can be set to specify a field or a property; a member of a field or a property; or a single element of a field or a property (or a member of either) that implements the interface. For example, a single element in an `array` may be specified. + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingParameters.xml b/xml/System.Workflow.Runtime.Tracking/TrackingParameters.xml index b587d1a7428..7be4f310839 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingParameters.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingParameters.xml @@ -23,15 +23,15 @@ Contains information about the workflow instance associated with a . This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - The runtime tracking infrastructure passes a object in when it calls on a . You can use these parameters in your tracking service to associate tracking data received on the with a specific workflow instance. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + The runtime tracking infrastructure passes a object in when it calls on a . You can use these parameters in your tracking service to associate tracking data received on the with a specific workflow instance. + ]]> @@ -70,11 +70,11 @@ A number that identifies the parent of the activity that invoked the workflow instance associated with the tracking channel. Initializes a new instance of the class. - @@ -165,11 +165,11 @@ Gets a list of strings, each of which represents the of an activity in the call chain of the workflow instance associated with the tracking channel. A list of strings, each of which represents the of an activity in the call chain of the workflow instance associated with the tracking channel. - of the activity that invoked the workflow instance is included in the list. - + of the activity that invoked the workflow instance is included in the list. + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingProfile.xml b/xml/System.Workflow.Runtime.Tracking/TrackingProfile.xml index ee5179b3a14..c87eef1390b 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingProfile.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingProfile.xml @@ -40,7 +40,7 @@ When the tracking service returns a tracking profile object to the runtime, the workflow starts to execute, and the tracking profile is serialized. If the serialization of the tracking profile fails, an exception is raised to the workflow instance. If the exception is not handled, the workflow instance is terminated. The tracking profile can be validated before passing it to the runtime using the property. - A can be serialized to XML by using the , which formats the XML according to the . This provides a convenient format for profile storage and for authoring a profile in a non-programmatic manner. For example, the SQL Tracking Service stores serialized versions of its tracking profiles, as will any tracking service you create based on the class. + A can be serialized to XML by using the , which formats the XML according to the . This provides a convenient format for profile storage and for authoring a profile in a non-programmatic manner. For example, the SQL Tracking Service stores serialized versions of its tracking profiles, as will any tracking service you create based on the class. ]]> @@ -65,7 +65,7 @@ . You can add track points to , , and to configure the . + The constructor initializes an empty . You can add track points to , , and to configure the . ]]> @@ -125,7 +125,7 @@ , , , or to instrument a workflow or an activity to emit data to the runtime tracking infrastructure at specific points during the execution of a workflow. Such an occurrence is called a user event and the data emitted is called user data. The runtime tracking infrastructure uses the property to filter user events to determine when to send a to the tracking service. You can add a to the property to specify points of interest in the potential execution path of the workflow instance for which you want a sent. + A workflow designer or an activity designer can use , , , or to instrument a workflow or an activity to emit data to the runtime tracking infrastructure at specific points during the execution of a workflow. Such an occurrence is called a user event and the data emitted is called user data. The runtime tracking infrastructure uses the property to filter user events to determine when to send a to the tracking service. You can add a to the property to specify points of interest in the potential execution path of the workflow instance for which you want a sent. A does not actually define a physical point in a workflow instance, but instead defines a set of match parameters that can be used by the runtime tracking infrastructure to match user events. Therefore, the same can be matched many times during the lifespan of a workflow instance. The runtime tracking infrastructure always returns the user data associated with a matched in the , but a can also specify data to be extracted from the workflow instance and returned in the tracking record. @@ -156,7 +156,7 @@ you must update . If you do not, your updated may not be loaded by the workflow runtime engine, even if it is returned by a call to , or sent in the associated with a event. Therefore, to ensure that the updated is loaded by the workflow runtime engine, you should change the for the . You can then explicitly call on any appropriate workflow instances, or, depending on your implementation, you can rely on the tracking service to inform the workflow runtime engine of the change. For more information, see . + Because of the semantics of profile caching in the workflow runtime engine, if you change the contents of a you must update . If you do not, your updated may not be loaded by the workflow runtime engine, even if it is returned by a call to , or sent in the associated with a event. Therefore, to ensure that the updated is loaded by the workflow runtime engine, you should change the for the . You can then explicitly call on any appropriate workflow instances, or, depending on your implementation, you can rely on the tracking service to inform the workflow runtime engine of the change. For more information, see . ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingProfileCache.xml b/xml/System.Workflow.Runtime.Tracking/TrackingProfileCache.xml index 3e24c411836..eade16704df 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingProfileCache.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingProfileCache.xml @@ -23,18 +23,18 @@ Provides a method that a host application can use to clear the tracking profile cache. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - When the workflow runtime engine has one or more tracking services registered with it, the runtime tracking infrastructure must determine whether tracking profiles exist for any workflow that is loaded into memory. The runtime tracking infrastructure maintains a cache of tracking profiles which it checks before it requests a for the workflow from each tracking service. The class provides a static method, , which a host application can use to clear the tracking profile cache. This will force the runtime tracking infrastructure to load tracking profiles from its registered tracking services for any workflow instances that are loaded into memory after the cache is cleared. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + When the workflow runtime engine has one or more tracking services registered with it, the runtime tracking infrastructure must determine whether tracking profiles exist for any workflow that is loaded into memory. The runtime tracking infrastructure maintains a cache of tracking profiles which it checks before it requests a for the workflow from each tracking service. The class provides a static method, , which a host application can use to clear the tracking profile cache. This will force the runtime tracking infrastructure to load tracking profiles from its registered tracking services for any workflow instances that are loaded into memory after the cache is cleared. + > [!NOTE] -> caching is not supported for markup only workflows. - +> caching is not supported for markup only workflows. + ]]> @@ -59,11 +59,11 @@ Clears the tracking profile cache maintained by the runtime tracking infrastructure of all tracking profiles. - diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingProfileDeserializationException.xml b/xml/System.Workflow.Runtime.Tracking/TrackingProfileDeserializationException.xml index ce5caba2908..a72ea32843c 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingProfileDeserializationException.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingProfileDeserializationException.xml @@ -74,9 +74,9 @@ |Property|Value| |--------------|-----------| -||A null reference (`Nothing` in Visual Basic)| -||A system-supplied localized description.| -||An empty .| +||A null reference (`Nothing` in Visual Basic)| +||A system-supplied localized description.| +||An empty .| ]]> @@ -111,9 +111,9 @@ |Property|Value| |--------------|-----------| -||A null reference (`Nothing` in Visual Basic)| -||The error message string.| -||An empty .| +||A null reference (`Nothing` in Visual Basic)| +||The error message string.| +||An empty .| ]]> @@ -150,9 +150,9 @@ |Property|Value| |--------------|-----------| -||The inner exception reference.| -||The error message string.| -||An empty .| +||The inner exception reference.| +||The error message string.| +||An empty .| ]]> @@ -186,7 +186,7 @@ sets a with all the exception object data targeted for serialization. During deserialization the exception object is reconstituted from the transmitted over the stream. + sets a with all the exception object data targeted for serialization. During deserialization the exception object is reconstituted from the transmitted over the stream. For more information see XML and SOAP Serialization. @@ -219,7 +219,7 @@ uses an to deserialize an XML document into a . The collects validation errors and warnings emitted by the . At certain points during deserialization, the determines whether the has encountered any validation errors, and, if it has, the adds these warnings and errors to and throws a . Not all exceptions of this class will have set. + The uses an to deserialize an XML document into a . The collects validation errors and warnings emitted by the . At certain points during deserialization, the determines whether the has encountered any validation errors, and, if it has, the adds these warnings and errors to and throws a . Not all exceptions of this class will have set. ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingProfileSerializer.xml b/xml/System.Workflow.Runtime.Tracking/TrackingProfileSerializer.xml index 3957b21037c..662f06d3e71 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingProfileSerializer.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingProfileSerializer.xml @@ -30,7 +30,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - The uses the tracking profile XSD contained in to serialize objects into valid XML documents and to deserialize valid XML documents into objects. The performs validation during both serialization and deserialization and, if necessary, throws an appropriate exception. + The uses the tracking profile XSD contained in to serialize objects into valid XML documents and to deserialize valid XML documents into objects. The performs validation during both serialization and deserialization and, if necessary, throws an appropriate exception. An XML document provides a convenient format in which to store a tracking profile. It also provides a non-programmatic way of authoring tracking profiles. The out-of-box uses a to serialize and deserialize the tracking profiles that are stored in its database. @@ -83,7 +83,7 @@ uses the tracking profile XSD contained in to deserialize the XML document that is contained in the text reader into a valid . Validation on the XML document is performed during deserialization, and, if the document is not valid, a is thrown. You can catch this exception and examine to determine the cause of the validation error. If there are any unhandled exceptions while deserializing the tracking profile then the workflow instance for which the tracking profile was requested will be terminated. + Deserialization refers to the process of creating an object from a well-formed XML document. uses the tracking profile XSD contained in to deserialize the XML document that is contained in the text reader into a valid . Validation on the XML document is performed during deserialization, and, if the document is not valid, a is thrown. You can catch this exception and examine to determine the cause of the validation error. If there are any unhandled exceptions while deserializing the tracking profile then the workflow instance for which the tracking profile was requested will be terminated. > [!NOTE] > If you want to perform validation without deserializing the XML representation of a tracking profile, you can write your own tracking profile validator. See the property for more information. @@ -153,7 +153,7 @@ . uses the tracking profile to serialize the tracking profile. `profile` must be a valid that contains at least one valid track point. Validation on the tracking profile is performed during serialization, and, if the tracking profile is not valid, an is thrown. You can catch this exception and examine its message property to determine the cause of the validation error. If there are any unhandled exceptions while serializing the tracking profile, then the workflow instance for which the tracking profile was requested is terminated. + Serialization refers to the process of creating a well-formed XML document from a valid . uses the tracking profile to serialize the tracking profile. `profile` must be a valid that contains at least one valid track point. Validation on the tracking profile is performed during serialization, and, if the tracking profile is not valid, an is thrown. You can catch this exception and examine its message property to determine the cause of the validation error. If there are any unhandled exceptions while serializing the tracking profile, then the workflow instance for which the tracking profile was requested is terminated. ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingRecord.xml b/xml/System.Workflow.Runtime.Tracking/TrackingRecord.xml index ba733b24bee..fc818fa2acc 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingRecord.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingRecord.xml @@ -77,7 +77,7 @@ , a or a in a . The runtime tracking infrastructure stores these annotations, and, when it matches the track point, it returns them in . + You can specify annotations to be associated with an , a or a in a . The runtime tracking infrastructure stores these annotations, and, when it matches the track point, it returns them in . ]]> @@ -106,7 +106,7 @@ property of the derived class. For example, when a workflow instance is terminated, the runtime tracking infrastructure sends a with set to a that contains information about the reason for the termination. + Certain kinds of tracking events emitted by a workflow instance have event data associated with them. If a tracking event has event data associated with it, the runtime tracking infrastructure puts the event data in property of the derived class. For example, when a workflow instance is terminated, the runtime tracking infrastructure sends a with set to a that contains information about the reason for the termination. ]]> @@ -164,7 +164,7 @@ indicates the relative order of the tracking event within the workflow instance. will be unique within a workflow instance, but it is not guaranteed to be sequential. + indicates the relative order of the tracking event within the workflow instance. will be unique within a workflow instance, but it is not guaranteed to be sequential. ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingService.xml b/xml/System.Workflow.Runtime.Tracking/TrackingService.xml index d6c4e8e8e2e..2139d1d2f77 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingService.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingService.xml @@ -40,13 +40,13 @@ - The host application can use the tracking record in any way that it chooses. For example, the host application may store the tracking information in a database and use it to implement a sophisticated user interface, or it may use the information to inform an administrator of a condition that requires some action. You can register a tracking service with the workflow run-time engine by calling or by including the appropriate entry in the application configuration file. + The host application can use the tracking record in any way that it chooses. For example, the host application may store the tracking information in a database and use it to implement a sophisticated user interface, or it may use the information to inform an administrator of a condition that requires some action. You can register a tracking service with the workflow run-time engine by calling or by including the appropriate entry in the application configuration file. - All tracking services must inherit from the abstract class. This class defines the basic interface between a tracking service and the run-time tracking infrastructure. The workflow run-time engine requests a for a specific workflow instance or workflow by calling one of the overloaded methods or the method. The workflow run-time engine calls to request a . + All tracking services must inherit from the abstract class. This class defines the basic interface between a tracking service and the run-time tracking infrastructure. The workflow run-time engine requests a for a specific workflow instance or workflow by calling one of the overloaded methods or the method. The workflow run-time engine calls to request a . - The workflow tracking runtime calls the and methods whenever a workflow instance is created or loaded from the persistence store. The overhead associated with these calls can be costly to the tracking service (many database calls, for example). You can implement the interface in your tracking service to circumvent this call-based mechanism and use events to notify the workflow runtime engine of changes to a . For tracking services that implement the interface, the workflow run-time engine subscribes to the and events. Your tracking service can raise the appropriate event when a change to one of its tracking profiles occurs. The class implements this interface. + The workflow tracking runtime calls the and methods whenever a workflow instance is created or loaded from the persistence store. The overhead associated with these calls can be costly to the tracking service (many database calls, for example). You can implement the interface in your tracking service to circumvent this call-based mechanism and use events to notify the workflow runtime engine of changes to a . For tracking services that implement the interface, the workflow run-time engine subscribes to the and events. Your tracking service can raise the appropriate event when a change to one of its tracking profiles occurs. The class implements this interface. - The workflow run-time engine calls the method to test whether a has been updated or removed as a result of an explicit call by a host or a service to on a workflow instance. This process enables a host or service to dynamically change the tracking profile that is being used for a specific workflow instance. + The workflow run-time engine calls the method to test whether a has been updated or removed as a result of an explicit call by a host or a service to on a workflow instance. This process enables a host or service to dynamically change the tracking profile that is being used for a specific workflow instance. ]]> @@ -194,7 +194,7 @@ for each tracking service for each workflow instance. The workflow run-time engine calls on each tracking service to get the for that service. You can use the information passed in to associate tracking data sent on the for your tracking service with a particular root workflow instance. + The run-time tracking infrastructure uses one for each tracking service for each workflow instance. The workflow run-time engine calls on each tracking service to get the for that service. You can use the information passed in to associate tracking data sent on the for your tracking service with a particular root workflow instance. ]]> @@ -268,7 +268,7 @@ is called by the run-time tracking infrastructure to determine whether a new should be loaded for the specified workflow instance. If a new is required, it is returned in `profile`. If you want the run-time tracking infrastructure to stop tracking a workflow instance, your tracking service should return `true` and set `profile` equal to a null reference (`Nothing` in Visual Basic). Your tracking service can use `workflowType` or `workflowInstanceId` in whatever manner you choose to determine whether a tracking profile should be reloaded. For example, the only uses `workflowInstanceId` to decide whether the tracking profile should be reloaded. is called by the run-time tracking infrastructure according to its own tracking semantics, or in response to the host or a service calling on a workflow instance. + is called by the run-time tracking infrastructure to determine whether a new should be loaded for the specified workflow instance. If a new is required, it is returned in `profile`. If you want the run-time tracking infrastructure to stop tracking a workflow instance, your tracking service should return `true` and set `profile` equal to a null reference (`Nothing` in Visual Basic). Your tracking service can use `workflowType` or `workflowInstanceId` in whatever manner you choose to determine whether a tracking profile should be reloaded. For example, the only uses `workflowInstanceId` to decide whether the tracking profile should be reloaded. is called by the run-time tracking infrastructure according to its own tracking semantics, or in response to the host or a service calling on a workflow instance. ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowChangedEventArgs.xml b/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowChangedEventArgs.xml index 403a6985ad0..30b601777a8 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowChangedEventArgs.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowChangedEventArgs.xml @@ -23,18 +23,18 @@ Contains data associated with a workflow change that occurs during the execution of a workflow instance. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - When a workflow change occurs during the execution of a workflow instance and a associated with the workflow instance includes a configured for the event, the runtime tracking infrastructure sets to in the that it sends to the tracking service. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + When a workflow change occurs during the execution of a workflow instance and a associated with the workflow instance includes a configured for the event, the runtime tracking infrastructure sets to in the that it sends to the tracking service. + > [!NOTE] -> is used only by the runtime tracking service to pass information in a . - +> is used only by the runtime tracking service to pass information in a . + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowExceptionEventArgs.xml b/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowExceptionEventArgs.xml index 1e848dce60d..edbec89ff25 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowExceptionEventArgs.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowExceptionEventArgs.xml @@ -34,7 +34,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - When an exception occurs during the execution of a workflow instance and a that is associated with the workflow instance includes a configured for a , the workflow tracking infrastructure sets to an in the that it sends to the tracking service. + When an exception occurs during the execution of a workflow instance and a that is associated with the workflow instance includes a configured for a , the workflow tracking infrastructure sets to an in the that it sends to the tracking service. > [!NOTE] > is used only by the runtime tracking service to pass information in a . @@ -88,7 +88,7 @@ is raised to the runtime tracking infrastructure. refers to the activity that is currently throwing the exception. + Exceptions are passed up the chain of exception handler activities. An exception handler may choose to throw an exception again. When an exception handler throws the exception again, a new exception tracking event containing a new is raised to the runtime tracking infrastructure. refers to the activity that is currently throwing the exception. ]]> @@ -139,7 +139,7 @@ is raised to the runtime tracking infrastructure. refers to the activity that originally threw the exception. + Exceptions are passed up the chain of exception handler activities. An exception handler may choose to throw an exception again. When an exception handler throws an exception again, a new exception tracking event containing a new is raised to the runtime tracking infrastructure. refers to the activity that originally threw the exception. ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowSuspendedEventArgs.xml b/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowSuspendedEventArgs.xml index c6b665f6955..e884c056686 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowSuspendedEventArgs.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowSuspendedEventArgs.xml @@ -34,7 +34,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - A is generated by the runtime tracking infrastructure when a workflow instance is suspended. If the associated with a workflow instance includes a configured for a , then the workflow tracking infrastructure puts a in in the that it sends to the Tracking service. + A is generated by the runtime tracking infrastructure when a workflow instance is suspended. If the associated with a workflow instance includes a configured for a , then the workflow tracking infrastructure puts a in in the that it sends to the Tracking service. > [!NOTE] > is used only by the runtime tracking service to pass information in a . The data for a event is passed in a . diff --git a/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowTerminatedEventArgs.xml b/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowTerminatedEventArgs.xml index f3d9049b229..a7ae05a1cb9 100644 --- a/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowTerminatedEventArgs.xml +++ b/xml/System.Workflow.Runtime.Tracking/TrackingWorkflowTerminatedEventArgs.xml @@ -34,9 +34,9 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - A is generated by the runtime tracking infrastructure when a workflow instance is terminated. If the associated with a workflow instance includes a configured for a , the workflow tracking infrastructure puts the in in the that it sends to the tracking service. + A is generated by the runtime tracking infrastructure when a workflow instance is terminated. If the associated with a workflow instance includes a configured for a , the workflow tracking infrastructure puts the in in the that it sends to the tracking service. - A workflow instance may be terminated in one of three ways: the host may call ; a activity may be invoked from inside the workflow instance; or an unhandled exception may occur. If the workflow is terminated by the host or a activity, the runtime tracking infrastructure sets to a that has its property set to a description of the reason for the termination. If the workflow is terminated because of an unhandled exception, the runtime tracking infrastructure passes the unhandled exception in . + A workflow instance may be terminated in one of three ways: the host may call ; a activity may be invoked from inside the workflow instance; or an unhandled exception may occur. If the workflow is terminated by the host or a activity, the runtime tracking infrastructure sets to a that has its property set to a description of the reason for the termination. If the workflow is terminated because of an unhandled exception, the runtime tracking infrastructure passes the unhandled exception in . > [!NOTE] > is used only by the runtime tracking service to pass information in a . The data for a event is passed in a . @@ -68,9 +68,9 @@ contains the unhandled exception. + When the workflow instance is terminated because of an unhandled exception, contains the unhandled exception. - When the workflow instance is terminated by either a host call to or by a activity, contains a that has its property set to a description of the reason for the termination. If the host terminates the workflow instance, it supplies this description in the `string` parameter to ; if the workflow instance is terminated by a , the description is supplied by . + When the workflow instance is terminated by either a host call to or by a activity, contains a that has its property set to a description of the reason for the termination. If the host terminates the workflow instance, it supplies this description in the `string` parameter to ; if the workflow instance is terminated by a , the description is supplied by . ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/UserTrackPoint.xml b/xml/System.Workflow.Runtime.Tracking/UserTrackPoint.xml index 6c1107dd705..e64b7d5a1bb 100644 --- a/xml/System.Workflow.Runtime.Tracking/UserTrackPoint.xml +++ b/xml/System.Workflow.Runtime.Tracking/UserTrackPoint.xml @@ -23,25 +23,25 @@ Defines a point, associated with a user event, to be tracked in the potential execution path of a root workflow instance. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - An activity designer or a workflow designer may use the overloaded and methods to instrument the workflow to emit data to the runtime tracking infrastructure as a user event. The data emitted is referred to as user data. Unlike activity status events, and workflow status events, which occur only on status changes, user events can occur at any location that is instrumented in a workflow. There are many reasons to instrument a workflow to emit user events. For example, a workflow designer may want to communicate logical state information about the progress of a workflow, or an activity designer might want to provide an opportunity to activity members at times other than an activity status change. - - A defines a point of interest in the potential execution path of a root workflow instance associated with a user event. A contains locations that are included in matching, locations that are excluded from matching, and any additional data that should be extracted from the workflow instance when the track point is matched. You can add a to to instruct the runtime tracking infrastructure to send a to the tracking service when the track point is matched. The user data is returned in . A single may be matched at multiple points in the workflow instance. - - A contains match conditions for a location associated with a user event in the potential execution path of a workflow instance. You can add objects to to define locations that should be included in matching for the track point. Similarly, you can add objects to to define locations that should be excluded from matching for the track point. - - You can add objects and objects to to specify data that should be extracted from the workflow instance when the track point is matched. The extracted data will be returned in . - - You can add to to specify additional information associated with the track point. These annotations will be returned in . - - For an example of how to use this class, see the [Tracking Using User Track Points Sample](https://msdn.microsoft.com/library/d894a18a-a4c6-467e-9a42-8be025ecd4d5). - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + An activity designer or a workflow designer may use the overloaded and methods to instrument the workflow to emit data to the runtime tracking infrastructure as a user event. The data emitted is referred to as user data. Unlike activity status events, and workflow status events, which occur only on status changes, user events can occur at any location that is instrumented in a workflow. There are many reasons to instrument a workflow to emit user events. For example, a workflow designer may want to communicate logical state information about the progress of a workflow, or an activity designer might want to provide an opportunity to activity members at times other than an activity status change. + + A defines a point of interest in the potential execution path of a root workflow instance associated with a user event. A contains locations that are included in matching, locations that are excluded from matching, and any additional data that should be extracted from the workflow instance when the track point is matched. You can add a to to instruct the runtime tracking infrastructure to send a to the tracking service when the track point is matched. The user data is returned in . A single may be matched at multiple points in the workflow instance. + + A contains match conditions for a location associated with a user event in the potential execution path of a workflow instance. You can add objects to to define locations that should be included in matching for the track point. Similarly, you can add objects to to define locations that should be excluded from matching for the track point. + + You can add objects and objects to to specify data that should be extracted from the workflow instance when the track point is matched. The extracted data will be returned in . + + You can add to to specify additional information associated with the track point. These annotations will be returned in . + + For an example of how to use this class, see the [Tracking Using User Track Points Sample](https://msdn.microsoft.com/library/d894a18a-a4c6-467e-9a42-8be025ecd4d5). + ]]> @@ -62,11 +62,11 @@ Initializes a new instance of the class. - to . You may optionally add the appropriate objects to , , and . - + to . You may optionally add the appropriate objects to , , and . + ]]> @@ -91,13 +91,13 @@ Gets the collection of annotations associated with the track point. A . The default is an empty collection. - to specify annotations to be returned in when the track point is matched. If is empty, no annotations are associated with the track point. - - Annotations are `strings` that you define that contain information associated with the track point. For example, an annotation could contain information about the possible execution path the workflow can take from this track point, or it could contain information to be displayed in a user interface. - + to specify annotations to be returned in when the track point is matched. If is empty, no annotations are associated with the track point. + + Annotations are `strings` that you define that contain information associated with the track point. For example, an annotation could contain information about the possible execution path the workflow can take from this track point, or it could contain information to be displayed in a user interface. + ]]> @@ -122,13 +122,13 @@ Gets the collection of locations that should be excluded from the track point by the runtime tracking infrastructure. A that specifies locations to be excluded from the track point. The default is an empty collection. - objects in is matched for a particular user event, the track point will not be matched and no will be sent to the tracking service. If is empty, there are no excluded locations. - - You can use to exclude specific locations from being tracked by the runtime tracking infrastructure. For example, you can exclude a subset of locations that are specified in in order to more precisely refine the locations that should be tracked by the track point. - + objects in is matched for a particular user event, the track point will not be matched and no will be sent to the tracking service. If is empty, there are no excluded locations. + + You can use to exclude specific locations from being tracked by the runtime tracking infrastructure. For example, you can exclude a subset of locations that are specified in in order to more precisely refine the locations that should be tracked by the track point. + ]]> @@ -153,13 +153,13 @@ Gets a collection that specifies data to be extracted from the workflow instance and sent to the tracking service. An that specifies data to be extracted and sent to the tracking service. The default is an empty collection. - to the tracking service. The user data is returned in . The runtime tracking infrastructure can also extract data specified in from the workflow instance and send this in the . The extracted data is encapsulated in records and returned in . - - You can add objects to to specify member data that should be extracted from the activity associated with the user event and you can add objects to to specify member data that should be extracted from the root activity of the workflow. - + to the tracking service. The user data is returned in . The runtime tracking infrastructure can also extract data specified in from the workflow instance and send this in the . The extracted data is encapsulated in records and returned in . + + You can add objects to to specify member data that should be extracted from the activity associated with the user event and you can add objects to to specify member data that should be extracted from the root activity of the workflow. + ]]> @@ -184,13 +184,13 @@ Gets the collection of locations that should be included in matching for the track point by the runtime tracking infrastructure. A that specifies the locations to be matched for the track point. The default is an empty collection. - is empty, the track point cannot be matched by the runtime tracking infrastructure. You must add at least one to for the to participate in matching. - - The track point will be matched if any of the objects in is matched and none of the objects in is matched. - + is empty, the track point cannot be matched by the runtime tracking infrastructure. You must add at least one to for the to participate in matching. + + The track point will be matched if any of the objects in is matched and none of the objects in is matched. + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/UserTrackingLocation.xml b/xml/System.Workflow.Runtime.Tracking/UserTrackingLocation.xml index 52e7b04e52d..35a97368d39 100644 --- a/xml/System.Workflow.Runtime.Tracking/UserTrackingLocation.xml +++ b/xml/System.Workflow.Runtime.Tracking/UserTrackingLocation.xml @@ -34,18 +34,18 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - An activity designer or a workflow designer may use any of the overloaded and methods to instrument the workflow to emit data to the runtime tracking infrastructure as a user event. The data emitted is referred to as user data. Unlike activity status events, and workflow status events, which occur only on activity or workflow status changes, user events can occur at any location that is instrumented in a workflow. A defines the matching parameters for such a location by specifying the type of the user data, the type of the activity from which it must be emitted, a collection of conditions that can more precisely qualify an instance or instances of this activity, an optional key name with which the user data must be associated, whether derived types of the user data should be matched, and whether user data emitted from activities derived from the type of the specified activity should be matched. + An activity designer or a workflow designer may use any of the overloaded and methods to instrument the workflow to emit data to the runtime tracking infrastructure as a user event. The data emitted is referred to as user data. Unlike activity status events, and workflow status events, which occur only on activity or workflow status changes, user events can occur at any location that is instrumented in a workflow. A defines the matching parameters for such a location by specifying the type of the user data, the type of the activity from which it must be emitted, a collection of conditions that can more precisely qualify an instance or instances of this activity, an optional key name with which the user data must be associated, whether derived types of the user data should be matched, and whether user data emitted from activities derived from the type of the specified activity should be matched. > [!NOTE] > A single may refer to more than one actual location in the potential execution path of a workflow instance. - You may add a to either or in order to define the match parameters for a in a . + You may add a to either or in order to define the match parameters for a in a . - There are three general conditions which must be met in the following order for the to be matched by the runtime tracking infrastructure: the activity that has emitted a user event must match the set of activities specified by , , , and ; the key, if one exists, associated with the user data must match ; and, the type of the user data emitted by the user event must match the set of user data types specified by , , and . Only if all three of these conditions are met, does the runtime tracking infrastructure consider the matched. + There are three general conditions which must be met in the following order for the to be matched by the runtime tracking infrastructure: the activity that has emitted a user event must match the set of activities specified by , , , and ; the key, if one exists, associated with the user data must match ; and, the type of the user data emitted by the user event must match the set of user data types specified by , , and . Only if all three of these conditions are met, does the runtime tracking infrastructure consider the matched. - To configure a , you must set either or to specify the type of the user data to be matched and either or to specify the type of the activity from which the user data must be emitted to be matched. You may add objects to to more completely qualify the activity from which the user data must be emitted. You may set to specify that user data derived from the user data type specified by or should be matched, and you may set to specify that user data emitted from activities derived from the activity type specified by or should be matched. + To configure a , you must set either or to specify the type of the user data to be matched and either or to specify the type of the activity from which the user data must be emitted to be matched. You may add objects to to more completely qualify the activity from which the user data must be emitted. You may set to specify that user data derived from the user data type specified by or should be matched, and you may set to specify that user data emitted from activities derived from the activity type specified by or should be matched. - You may set to specify that only user data associated with the specified key name should be matched for this . If is a null reference (`Nothing` in Visual Basic), the runtime tracking structure will not try to match the key associated with the user data. + You may set to specify that only user data associated with the specified key name should be matched for this . If is a null reference (`Nothing` in Visual Basic), the runtime tracking structure will not try to match the key associated with the user data. ]]> @@ -79,7 +79,7 @@ . You must specify both the type of the user data to match and the type of the activity from which it must be emitted in order to be matched. Therefore, to configure the you must explicitly set either or to specify the type of an activity from which user data must be emitted to be matched, and you must also explicitly set either or to specify the type of the user data to be matched. You may further configure the by setting its other properties. + The parameterless constructor initializes an empty . You must specify both the type of the user data to match and the type of the activity from which it must be emitted in order to be matched. Therefore, to configure the you must explicitly set either or to specify the type of an activity from which user data must be emitted to be matched, and you must also explicitly set either or to specify the type of the user data to be matched. You may further configure the by setting its other properties. ]]> @@ -108,7 +108,7 @@ that matches user data of the specified type emitted from the workflow. You must specify the unqualified name of the of the user data to be matched for `argumentTypeName`. You must explicitly set either or in your code to properly configure the . You may further qualify the by setting its other properties. + This constructor initializes a that matches user data of the specified type emitted from the workflow. You must specify the unqualified name of the of the user data to be matched for `argumentTypeName`. You must explicitly set either or in your code to properly configure the . You may further qualify the by setting its other properties. ]]> @@ -137,7 +137,7 @@ that matches user data of the specified type emitted from the workflow. You must explicitly set either or in your code to properly configure the . You may further qualify the by setting its other properties. + This constructor initializes a that matches user data of the specified type emitted from the workflow. You must explicitly set either or in your code to properly configure the . You may further qualify the by setting its other properties. ]]> @@ -290,9 +290,9 @@ . + If you want to specify the type of the activity in a version-independent manner, use . - You must specify either or to properly configure the . + You must specify either or to properly configure the . ]]> @@ -321,11 +321,11 @@ activity, set to "Code". + You must specify the unqualified name of the type of the activity. For example, to specify the unqualified name of a activity, set to "Code". - provides a much easier way to specify the type of the activity that emits the user data when you author a profile directly in XML. also provides a version-independent way of referring to the type of the activity. + provides a much easier way to specify the type of the activity that emits the user data when you author a profile directly in XML. also provides a version-independent way of referring to the type of the activity. - You must specify either or to properly configure the . + You must specify either or to properly configure the . ]]> @@ -354,9 +354,9 @@ . + If you want to specify the type of the user data in a version-independent manner, use . - You must specify either or to properly configure the . + You must specify either or to properly configure the . ]]> @@ -385,9 +385,9 @@ provides a much easier way to specify the type of the user data when you author a profile directly in XML. also provides a version-independent way of referring to the type of the user data. + provides a much easier way to specify the type of the user data when you author a profile directly in XML. also provides a version-independent way of referring to the type of the user data. - You must specify either or to properly configure the . + You must specify either or to properly configure the . ]]> @@ -416,9 +416,9 @@ to more precisely define the instance of the activity type specified by or from which the user event must be emitted to match the tracking location. For example, if you want to match only activities with an equal to "MyCode", you can set to "Code" and add an to that specifies that the ID property of the activity instance must be equal to "MyCode". + You can use to more precisely define the instance of the activity type specified by or from which the user event must be emitted to match the tracking location. For example, if you want to match only activities with an equal to "MyCode", you can set to "Code" and add an to that specifies that the ID property of the activity instance must be equal to "MyCode". - Every in must be true for the activity to be matched. + Every in must be true for the activity to be matched. ]]> @@ -447,7 +447,7 @@ or to associate a string key with the user data that is emitted in a user event. If is not a null reference (`Nothing`), the key associated with the user data must match the value of for the to be matched. If is a null reference (`Nothing`), the runtime tracking infrastructure does not check for a matching key to determine whether the is matched. + An activity designer or a workflow designer can use either or to associate a string key with the user data that is emitted in a user event. If is not a null reference (`Nothing`), the key associated with the user data must match the value of for the to be matched. If is a null reference (`Nothing`), the runtime tracking infrastructure does not check for a matching key to determine whether the is matched. ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/UserTrackingLocationCollection.xml b/xml/System.Workflow.Runtime.Tracking/UserTrackingLocationCollection.xml index f02153ec41a..23d54b1471a 100644 --- a/xml/System.Workflow.Runtime.Tracking/UserTrackingLocationCollection.xml +++ b/xml/System.Workflow.Runtime.Tracking/UserTrackingLocationCollection.xml @@ -30,15 +30,15 @@ Contains a collection of objects. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - A maintains two objects: specifies parameters used for matching activity status events and specifies parameters used to exclude activity status events from matching. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + A maintains two objects: specifies parameters used for matching activity status events and specifies parameters used to exclude activity status events from matching. + ]]> @@ -68,11 +68,11 @@ Initializes a new instance of the class. - to an empty list. - + to an empty list. + ]]> @@ -97,11 +97,11 @@ An list of objects. Initializes a new instance of the class by using a list of user locations. - is initialized to contain the objects specified in `locations`. - + is initialized to contain the objects specified in `locations`. + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/UserTrackingRecord.xml b/xml/System.Workflow.Runtime.Tracking/UserTrackingRecord.xml index bea3338447e..aa40680a0db 100644 --- a/xml/System.Workflow.Runtime.Tracking/UserTrackingRecord.xml +++ b/xml/System.Workflow.Runtime.Tracking/UserTrackingRecord.xml @@ -23,15 +23,15 @@ Contains the data sent to a tracking service by the runtime tracking infrastructure when a is matched. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - When the runtime tracking infrastructure matches a in a , it sends a to the tracking service over the associated with that tracking service. The tracking service can perform whatever action is required on the data in the tracking record. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + When the runtime tracking infrastructure matches a in a , it sends a to the tracking service over the associated with that tracking service. The tracking service can perform whatever action is required on the data in the tracking record. + ]]> @@ -44,11 +44,11 @@ Initializes a new instance of the class. - @@ -69,11 +69,11 @@ Initializes a new instance of the class. - @@ -134,11 +134,11 @@ Gets or sets the common language runtime (CLR) type of the activity that emitted the user data for which this was created. The of the activity that emitted the user data. - @@ -163,18 +163,18 @@ Gets the collection of annotations associated with the user event. A that contains the annotations that are associated with the user event by the that was matched in the . - . When the runtime tracking infrastructure matches the , it returns these annotations in . - - This property is set by the runtime tracking infrastructure. - - - -## Examples - For more information about annotations, see the [Tracking Profile Designer Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742004(v=vs.90)) and the [Using the Tracking Profile Object Model Sample](https://msdn.microsoft.com/library/0b820e0a-8f4b-4276-8452-e985b51d9528). - + . When the runtime tracking infrastructure matches the , it returns these annotations in . + + This property is set by the runtime tracking infrastructure. + + + +## Examples + For more information about annotations, see the [Tracking Profile Designer Sample](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.5/ms742004(v=vs.90)) and the [Using the Tracking Profile Object Model Sample](https://msdn.microsoft.com/library/0b820e0a-8f4b-4276-8452-e985b51d9528). + ]]> @@ -199,13 +199,13 @@ Gets a list containing any additional data extracted from the workflow for the that was matched. A list of objects each of which contains a single piece of extracted data and its associated annotations. - is matched, the runtime tracking infrastructure can extract data from the workflow instance. The data to be extracted is specified by . can contain objects, which specify member data to be extracted from the activity associated with the user event, and objects, which specify member data to be extracted from the root activity of the workflow. Each type of extract can also specify annotations to be returned with the extracted data. The runtime tracking infrastructure encapsulates each piece of extracted data and its associated annotations in a which it adds to . - - Because the user data pushed to the tracking service by the user event is contained in , will frequently be an empty list. This property is set by the runtime tracking infrastructure. - + is matched, the runtime tracking infrastructure can extract data from the workflow instance. The data to be extracted is specified by . can contain objects, which specify member data to be extracted from the activity associated with the user event, and objects, which specify member data to be extracted from the root activity of the workflow. Each type of extract can also specify annotations to be returned with the extracted data. The runtime tracking infrastructure encapsulates each piece of extracted data and its associated annotations in a which it adds to . + + Because the user data pushed to the tracking service by the user event is contained in , will frequently be an empty list. This property is set by the runtime tracking infrastructure. + ]]> @@ -252,15 +252,15 @@ Always a null reference ( in Visual Basic) for a . A null reference () for a . - has no meaning and is always a null reference (`Nothing`). - - The user data that is pushed to the runtime tracking infrastructure by whichever one of the or methods that caused the user event is sent in . Any data extracts that are associated with the user event by the are encapsulated in objects and sent in . - - This property is set by the runtime tracking infrastructure. - + has no meaning and is always a null reference (`Nothing`). + + The user data that is pushed to the runtime tracking infrastructure by whichever one of the or methods that caused the user event is sent in . Any data extracts that are associated with the user event by the are encapsulated in objects and sent in . + + This property is set by the runtime tracking infrastructure. + ]]> @@ -285,13 +285,13 @@ Gets or sets the date and time that the user event occurred. A value. - is Coordinated Universal Time (UTC). - - This property is set by the runtime tracking infrastructure. - + is Coordinated Universal Time (UTC). + + This property is set by the runtime tracking infrastructure. + ]]> @@ -316,13 +316,13 @@ Gets or sets a value that indicates the order of the user event that matched the in the workflow instance. A value that indicates the order of the user event in the workflow instance. - indicates the order of the user event that matched the relative to the other tracking events emitted by the workflow instance. will be unique within a workflow instance, but it is not guaranteed to be sequential. - - This property is set by the runtime tracking infrastructure. - + indicates the order of the user event that matched the relative to the other tracking events emitted by the workflow instance. will be unique within a workflow instance, but it is not guaranteed to be sequential. + + This property is set by the runtime tracking infrastructure. + ]]> @@ -369,11 +369,11 @@ Gets or sets the qualified name of the activity associated with this . The of the from which the user data for this user event was emitted. - @@ -398,13 +398,13 @@ Gets or sets the user data for this user event. The user data for which the was created. - contains the actual data pushed to the runtime tracking infrastructure by whichever one of the overloaded or methods is responsible for the user event. - - This property is set by the runtime tracking infrastructure. - + contains the actual data pushed to the runtime tracking infrastructure by whichever one of the overloaded or methods is responsible for the user event. + + This property is set by the runtime tracking infrastructure. + ]]> @@ -429,11 +429,11 @@ Gets or sets a key associated with the user data for this . A key associated with the user data for this tracking record. - or to specify a key to associate with the user data pushed to the runtime tracking infrastructure. contains this key. If no key is specified, is a null reference (`Nothing` in Visual Basic). - + or to specify a key to associate with the user data pushed to the runtime tracking infrastructure. contains this key. If no key is specified, is a null reference (`Nothing` in Visual Basic). + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/WorkflowDataTrackingExtract.xml b/xml/System.Workflow.Runtime.Tracking/WorkflowDataTrackingExtract.xml index d198a3097b8..34ad8770606 100644 --- a/xml/System.Workflow.Runtime.Tracking/WorkflowDataTrackingExtract.xml +++ b/xml/System.Workflow.Runtime.Tracking/WorkflowDataTrackingExtract.xml @@ -27,17 +27,17 @@ Specifies a property or a field to be extracted from the root activity of the workflow and sent to the tracking service together with and an associated collection of annotations when a track point is matched. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - A specifies a property or a field to be extracted from the root activity of a workflow. You can add a to either or to instruct the runtime tracking infrastructure to extract the member from the root activity of the workflow when the runtime tracking infrastructure matches an or a . The runtime tracking infrastructure puts the extracted data and any associated annotations in the or the that it returns to the tracking service. - - Set to specify the field or property for the runtime tracking infrastructure to extract from the root activity. You can associate additional information with the extracted data by adding to . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + A specifies a property or a field to be extracted from the root activity of a workflow. You can add a to either or to instruct the runtime tracking infrastructure to extract the member from the root activity of the workflow when the runtime tracking infrastructure matches an or a . The runtime tracking infrastructure puts the extracted data and any associated annotations in the or the that it returns to the tracking service. + + Set to specify the field or property for the runtime tracking infrastructure to extract from the root activity. You can associate additional information with the extracted data by adding to . + ]]> @@ -67,11 +67,11 @@ Initializes a new instance of the class. - to a value different from a null reference (`Nothing` in Visual Basic) in your code. - + to a value different from a null reference (`Nothing` in Visual Basic) in your code. + ]]> @@ -96,11 +96,11 @@ The dot delineated name of the field or property of the root activity that should be extracted and sent to the tracking service. Initializes a new instance of the class by using the specified name of a member of the root activity. - is initialized to the `string` specified by `member`. - + is initialized to the `string` specified by `member`. + ]]> @@ -127,11 +127,11 @@ Gets the collection of annotations associated with the extracted data. The associated with the activity property or field to be extracted. The default is an empty collection. - to associate additional information with the extracted data. - + to associate additional information with the extracted data. + ]]> @@ -156,14 +156,14 @@ Gets or sets the field or the property to be extracted from the root activity when a track point is matched. A dot delineated name that specifies a field or a property of the root activity. The default is a null reference ( in Visual Basic). - can be set to specify a field or property of the root activity; a member of such a field or property; or a single element of a field or property (or a member of either) that implements the interface. For example, if the root activity has a `string` property named "MyString" and you want the runtime tracking infrastructure to return its length, you can set to "MyString.length". Alternatively, to return the second char in "MyString", you can set to "MyString[1]". - + can be set to specify a field or property of the root activity; a member of such a field or property; or a single element of a field or property (or a member of either) that implements the interface. For example, if the root activity has a `string` property named "MyString" and you want the runtime tracking infrastructure to return its length, you can set to "MyString.length". Alternatively, to return the second char in "MyString", you can set to "MyString[1]". + > [!NOTE] -> must be the real name of a property on the activity type. This name may be different from what you see in the designer because the designer supports the ability to localize and map property names. - +> must be the real name of a property on the activity type. This name may be different from what you see in the designer because the designer supports the ability to localize and map property names. + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/WorkflowTrackPoint.xml b/xml/System.Workflow.Runtime.Tracking/WorkflowTrackPoint.xml index 22738fa123c..4f121669f59 100644 --- a/xml/System.Workflow.Runtime.Tracking/WorkflowTrackPoint.xml +++ b/xml/System.Workflow.Runtime.Tracking/WorkflowTrackPoint.xml @@ -23,19 +23,19 @@ Defines a point associated with a set of workflow status events that are tracked in the potential execution path of a root workflow instance. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Whenever the status of the workflow instance changes, the workflow instance emits a workflow status event based on one of the values to the runtime tracking infrastructure. A defines an interest in all the points during the execution of a workflow instance at which specific types of workflow status events occur. You can add a to to instruct the runtime tracking infrastructure to send a to the tracking service when a specified set of workflow status events occur. A may be matched at multiple points in the workflow instance. - - Set with an appropriately configured to specify the types of workflow status events that the runtime tracking infrastructure uses to match the . You can add to to specify additional information associated with the track point that should be sent by the runtime tracking infrastructure when the track point is matched. - - This class cannot be inherited. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Whenever the status of the workflow instance changes, the workflow instance emits a workflow status event based on one of the values to the runtime tracking infrastructure. A defines an interest in all the points during the execution of a workflow instance at which specific types of workflow status events occur. You can add a to to instruct the runtime tracking infrastructure to send a to the tracking service when a specified set of workflow status events occur. A may be matched at multiple points in the workflow instance. + + Set with an appropriately configured to specify the types of workflow status events that the runtime tracking infrastructure uses to match the . You can add to to specify additional information associated with the track point that should be sent by the runtime tracking infrastructure when the track point is matched. + + This class cannot be inherited. + ]]> @@ -56,11 +56,11 @@ Initializes a new instance of the class. - is initialized with no annotations and no . You must set a for the track point. - + is initialized with no annotations and no . You must set a for the track point. + ]]> @@ -85,13 +85,13 @@ Gets the collection of annotations associated with the track point. An that contains the annotations associated with the track point. The default is an empty collection; it specifies that no annotations are to be associated with the track point. - to specify annotations to be returned in the sent to the tracking service when the track point is matched. - - Annotations are strings that you define that contain information to associate with the track point. For example, an annotation could contain information about the possible execution path the workflow can take from this track point, or it could contain information to be displayed in a user interface. - + to specify annotations to be returned in the sent to the tracking service when the track point is matched. + + Annotations are strings that you define that contain information to associate with the track point. For example, an annotation could contain information about the possible execution path the workflow can take from this track point, or it could contain information to be displayed in a user interface. + ]]> @@ -116,11 +116,11 @@ Gets or sets the that specifies the workflow status events that should be matched by the runtime tracking infrastructure for the track point. A that specified the workflow status events that should be matched by the runtime tracking infrastructure for the track point. - for the track point. The specifies one or more values that are used by the runtime tracking infrastructure to match the track point. - + for the track point. The specifies one or more values that are used by the runtime tracking infrastructure to match the track point. + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/WorkflowTrackingLocation.xml b/xml/System.Workflow.Runtime.Tracking/WorkflowTrackingLocation.xml index 09791010b01..81208376987 100644 --- a/xml/System.Workflow.Runtime.Tracking/WorkflowTrackingLocation.xml +++ b/xml/System.Workflow.Runtime.Tracking/WorkflowTrackingLocation.xml @@ -27,15 +27,15 @@ Defines an interest in specific workflow status events that occur in a root workflow instance; used for matching by a in a tracking profile. This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Whenever the status of the workflow instance changes, the workflow instance emits a workflow status event based on one of the values to the runtime tracking infrastructure. A expresses an interest in locations of the workflow instance where specific types of workflow status events occur. Add values to to specify the workflow status events to be matched. A single may refer to more than one actual location in the potential execution path of a workflow instance. You can add a to in order to define the match parameters for a . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Whenever the status of the workflow instance changes, the workflow instance emits a workflow status event based on one of the values to the runtime tracking infrastructure. A expresses an interest in locations of the workflow instance where specific types of workflow status events occur. Add values to to specify the workflow status events to be matched. A single may refer to more than one actual location in the potential execution path of a workflow instance. You can add a to in order to define the match parameters for a . + ]]> @@ -65,11 +65,11 @@ Initializes a new instance of the class. - values to for the to match any workflow status events. - + values to for the to match any workflow status events. + ]]> @@ -116,11 +116,11 @@ Gets the list of workflow status events that will be matched for this location. A list of values that specifies the workflow status events for which the location will be matched. The default is an empty list. - contains the list of workflow status events for which this will be matched. You can track the specified workflow status events by adding the to in a that is part of a . - + contains the list of workflow status events for which this will be matched. You can track the specified workflow status events by adding the to in a that is part of a . + ]]> diff --git a/xml/System.Workflow.Runtime.Tracking/WorkflowTrackingRecord.xml b/xml/System.Workflow.Runtime.Tracking/WorkflowTrackingRecord.xml index 7623091cfe1..d22560a607d 100644 --- a/xml/System.Workflow.Runtime.Tracking/WorkflowTrackingRecord.xml +++ b/xml/System.Workflow.Runtime.Tracking/WorkflowTrackingRecord.xml @@ -23,15 +23,15 @@ Contains the data sent to the tracking service by the runtime tracking infrastructure when it matches a . It is also used in the return list of the property. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - When the runtime tracking infrastructure matches a in a , it sends a to the tracking service over the associated with that tracking service. The tracking service can perform whatever action is necessary on the data in the tracking record. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + When the runtime tracking infrastructure matches a in a , it sends a to the tracking service over the associated with that tracking service. The tracking service can perform whatever action is necessary on the data in the tracking record. + ]]> @@ -44,11 +44,11 @@ Initializes a new instance of the class. - @@ -69,11 +69,11 @@ Initializes a new instance of the class. - @@ -104,13 +104,13 @@ Either a , a , a , or a null reference ( in Visual Basic). Initializes a new instance of the class by using the specified value, , number, and . - @@ -135,11 +135,11 @@ Gets the collection of annotations associated with the that was matched. An that contains the annotations that are associated with the . - @@ -164,19 +164,19 @@ Gets or sets an that contains additional data associated with certain types of workflow status events. Either a , a , a , or a null reference ( in Visual Basic). - is a null reference (`Nothing`); however, for certain kinds of workflow status events the runtime tracking infrastructure uses to return additional data about the workflow status event. The following table lists the values that correspond to these special workflow status events and the type of object returned in for each of these workflow status events. - -| Value| Object| -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -||| -||| -||| - - This property is set by the runtime tracking infrastructure. - + is a null reference (`Nothing`); however, for certain kinds of workflow status events the runtime tracking infrastructure uses to return additional data about the workflow status event. The following table lists the values that correspond to these special workflow status events and the type of object returned in for each of these workflow status events. + +| Value| Object| +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +||| +||| +||| + + This property is set by the runtime tracking infrastructure. + ]]> @@ -201,13 +201,13 @@ Gets or sets the date and time that the workflow tracking event occurred. A that indicates the date and time that the workflow status event occurred. - is Coordinated Universal Time (UTC). - - This property is set by the runtime tracking infrastructure. - + is Coordinated Universal Time (UTC). + + This property is set by the runtime tracking infrastructure. + ]]> @@ -232,13 +232,13 @@ Gets or sets a value that indicates the order in the workflow instance of the workflow status event that matched the . A value that indicates the order of the workflow status event in the workflow instance. - indicates the relative order in the workflow instance of the workflow status event that matched the . is unique within a workflow instance, but it is not guaranteed to be sequential. - - This property is set by the runtime tracking infrastructure. - + indicates the relative order in the workflow instance of the workflow status event that matched the . is unique within a workflow instance, but it is not guaranteed to be sequential. + + This property is set by the runtime tracking infrastructure. + ]]> @@ -263,13 +263,13 @@ Gets or sets the type of workflow status event associated with the tracking record. One of the values. - values indicating the kind of workflow status event that was matched by the runtime tracking infrastructure and caused the to be sent. It reflects the current status of the workflow instance. A workflow instance emits workflow status events only when the status of the workflow instance changes, and, therefore, a can be matched only when a workflow status change occurs. - - This property is set by the runtime tracking infrastructure. - + values indicating the kind of workflow status event that was matched by the runtime tracking infrastructure and caused the to be sent. It reflects the current status of the workflow instance. A workflow instance emits workflow status events only when the status of the workflow instance changes, and, therefore, a can be matched only when a workflow status change occurs. + + This property is set by the runtime tracking infrastructure. + ]]> diff --git a/xml/System.Workflow.Runtime/CorrelationToken.xml b/xml/System.Workflow.Runtime/CorrelationToken.xml index a1f6e4df792..f456b09760e 100644 --- a/xml/System.Workflow.Runtime/CorrelationToken.xml +++ b/xml/System.Workflow.Runtime/CorrelationToken.xml @@ -150,7 +150,7 @@ . + To initialize the correlation token, use . ]]> diff --git a/xml/System.Workflow.Runtime/IPendingWork.xml b/xml/System.Workflow.Runtime/IPendingWork.xml index 097cdacb724..50cb4ce6dfa 100644 --- a/xml/System.Workflow.Runtime/IPendingWork.xml +++ b/xml/System.Workflow.Runtime/IPendingWork.xml @@ -20,19 +20,19 @@ Provides methods to participate in a work batch. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - The interface is provided for services that want to participate in the workflow runtime engine batching mechanism. The batching mechanism is especially useful for services that use a durable store. It is often important in these cases to maintain consistency between the durable store used by the service and the internal state of the workflow runtime engine. - - If you want your service to participate in workflow transaction batching provided by the , you must implement the methods defined by the interface. The workflow runtime engine will call the method on your service to commit the batch. - - The class implements the interface. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + The interface is provided for services that want to participate in the workflow runtime engine batching mechanism. The batching mechanism is especially useful for services that use a durable store. It is often important in these cases to maintain consistency between the durable store used by the service and the internal state of the workflow runtime engine. + + If you want your service to participate in workflow transaction batching provided by the , you must implement the methods defined by the interface. The workflow runtime engine will call the method on your service to commit the batch. + + The class implements the interface. + ]]> @@ -62,11 +62,11 @@ The work items to be committed. Commits the list of work items by using the specified object. - method when its semantics dictate that the pending work in the work batch should be committed. When it reaches a commit point, the workflow runtime engine calls the method on each object in its work batch; the workflow runtime engine passes the method the collection of items associated with that object. Either all of the work in a batch succeeds or none of it succeeds. You should throw an exception if any of the work items passed to the method in your implementation cannot be committed. Depending on your implementation, you may want to perform some rollback in your method if it cannot commit its work items. If the workflow runtime engine successfully commits all of the work in the work batch, it calls with the `succeeded` parameter set to `true`; otherwise, it calls with `succeeded` set to `false`. - + method when its semantics dictate that the pending work in the work batch should be committed. When it reaches a commit point, the workflow runtime engine calls the method on each object in its work batch; the workflow runtime engine passes the method the collection of items associated with that object. Either all of the work in a batch succeeds or none of it succeeds. You should throw an exception if any of the work items passed to the method in your implementation cannot be committed. Depending on your implementation, you may want to perform some rollback in your method if it cannot commit its work items. If the workflow runtime engine successfully commits all of the work in the work batch, it calls with the `succeeded` parameter set to `true`; otherwise, it calls with `succeeded` set to `false`. + ]]> @@ -97,11 +97,11 @@ An of work items. Called when the transaction has completed. - @@ -131,11 +131,11 @@ if any item in the collection must be committed immediately; otherwise, . - returns `false`, the work can be postponed to a future commit point. If any of the items must be committed, then return `true` and all items will be committed at the current commit point. For a discussion about possible commit points, see the class. - + returns `false`, the work can be postponed to a future commit point. If any of the items must be committed, then return `true` and all items will be committed at the current commit point. For a discussion about possible commit points, see the class. + ]]> diff --git a/xml/System.Workflow.Runtime/IWorkBatch.xml b/xml/System.Workflow.Runtime/IWorkBatch.xml index 9f0fecda6eb..1f1e3fc5095 100644 --- a/xml/System.Workflow.Runtime/IWorkBatch.xml +++ b/xml/System.Workflow.Runtime/IWorkBatch.xml @@ -20,15 +20,15 @@ Provides methods to add work to a work batch. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - Services use this interface to add pending work to the . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + Services use this interface to add pending work to the . + ]]> @@ -58,11 +58,11 @@ An object on which work is to be performed. Adds a pending work item to a work batch. - interface. Methods provided by this object will be called to handle the eventual commit of the `workItem`. Services use this method to add pending work to the . - + interface. Methods provided by this object will be called to handle the eventual commit of the `workItem`. Services use this method to add pending work to the . + ]]> diff --git a/xml/System.Workflow.Runtime/ServicesExceptionNotHandledEventArgs.xml b/xml/System.Workflow.Runtime/ServicesExceptionNotHandledEventArgs.xml index 8f928aff025..6f53d3cc9ea 100644 --- a/xml/System.Workflow.Runtime/ServicesExceptionNotHandledEventArgs.xml +++ b/xml/System.Workflow.Runtime/ServicesExceptionNotHandledEventArgs.xml @@ -30,7 +30,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - When a service that derives from the class encounters an exception that it cannot handle, it can call the method to tell the workflow runtime engine to raise the event. The service passes the of the workflow instance and the associated with this event in its call to . The workflow runtime engine encapsulates these parameters in a and raises the event. From inside of a subscriber to the event, you can read the property and the property to get the information associated with a particular event. + When a service that derives from the class encounters an exception that it cannot handle, it can call the method to tell the workflow runtime engine to raise the event. The service passes the of the workflow instance and the associated with this event in its call to . The workflow runtime engine encapsulates these parameters in a and raises the event. From inside of a subscriber to the event, you can read the property and the property to get the information associated with a particular event. ]]> @@ -81,7 +81,7 @@ is equivalent to the of the workflow instance associated with the event. + is equivalent to the of the workflow instance associated with the event. ]]> diff --git a/xml/System.Workflow.Runtime/TimerEventSubscription.xml b/xml/System.Workflow.Runtime/TimerEventSubscription.xml index fa612869970..6c4abee2526 100644 --- a/xml/System.Workflow.Runtime/TimerEventSubscription.xml +++ b/xml/System.Workflow.Runtime/TimerEventSubscription.xml @@ -27,15 +27,15 @@ Represents a subscription to a timer event. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - objects are added to the timer queue associated with a workflow instance in order to send a message to a specific at a specified time. When the time specified by is reached, the workflow runtime engine sends a message containing the to the specified by . The timer queue associated with a workflow instance is contained in the . You can examine and the objects returned by to determine which activities are waiting on a specific . The and the both use timer event subscriptions to provide part of their functionality. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + objects are added to the timer queue associated with a workflow instance in order to send a message to a specific at a specified time. When the time specified by is reached, the workflow runtime engine sends a message containing the to the specified by . The timer queue associated with a workflow instance is contained in the . You can examine and the objects returned by to determine which activities are waiting on a specific . The and the both use timer event subscriptions to provide part of their functionality. + ]]> @@ -89,20 +89,20 @@ A that represents the time in Universal Coordinated Time (UTC) at which the timer associated with this subscription is expected to expire. Initializes a new instance of the class by using the specified of a workflow instance and the specified expiration . - . - -|Property|Value| -|--------------|-----------| -||A string representation of the system-supplied for .| -||A system-supplied .| -||The of the workflow instance, specified by `workflowInstanceId`.| -||The specified by `expiresAt`.| - - is initialized to a string representation of by this constructor. - + . + +|Property|Value| +|--------------|-----------| +||A string representation of the system-supplied for .| +||A system-supplied .| +||The of the workflow instance, specified by `workflowInstanceId`.| +||The specified by `expiresAt`.| + + is initialized to a string representation of by this constructor. + ]]> @@ -131,20 +131,20 @@ A that represents the time in Universal Coordinated Time (UTC) at which the timer for this subscription is expected to expire. Initializes a new instance of the class by using the specified subscription Id, the specified of a workflow instance, and the specified expiration . - . - -|Property|Value| -|--------------|-----------| -||A string representation of the specified by `timerId`.| -||The specified by `timerId`.| -||The of the workflow instance, specified by `workflowInstanceId`.| -||The specified by `expiresAt`.| - - is initialized to a string representation of `timerId` by this constructor. - + . + +|Property|Value| +|--------------|-----------| +||A string representation of the specified by `timerId`.| +||The specified by `timerId`.| +||The of the workflow instance, specified by `workflowInstanceId`.| +||The specified by `expiresAt`.| + + is initialized to a string representation of `timerId` by this constructor. + ]]> diff --git a/xml/System.Workflow.Runtime/TimerEventSubscriptionCollection.xml b/xml/System.Workflow.Runtime/TimerEventSubscriptionCollection.xml index 2a7ee7e5a39..592f4ca476f 100644 --- a/xml/System.Workflow.Runtime/TimerEventSubscriptionCollection.xml +++ b/xml/System.Workflow.Runtime/TimerEventSubscriptionCollection.xml @@ -34,15 +34,15 @@ Represents an ordered list of objects. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - A represents the queue of objects associated with a workflow instance and provides methods to manage this queue. Subscriptions are ordered in the queue based on their values; those with smaller values are positioned before those with larger values. You can use the methods provided by this class to manage the collection of active timer event subscriptions exposed by for each workflow instance. You can use or to add or remove subscriptions from the timer queue. Whenever the first element in the timer queue changes, the is called to cancel the timer event that was previously at the beginning of the queue and schedule the new timer event. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + A represents the queue of objects associated with a workflow instance and provides methods to manage this queue. Subscriptions are ordered in the queue based on their values; those with smaller values are positioned before those with larger values. You can use the methods provided by this class to manage the collection of active timer event subscriptions exposed by for each workflow instance. You can use or to add or remove subscriptions from the timer queue. Whenever the first element in the timer queue changes, the is called to cancel the timer event that was previously at the beginning of the queue and schedule the new timer event. + ]]> @@ -70,11 +70,11 @@ The to add to the timer queue. Adds a to the timer queue. - to the timer queue. Subscriptions in the queue are positioned based on their values; those with smaller values are positioned in front of those with larger values. If the new subscription is added at the beginning of the queue, is called to cancel the timer event that was previously at the beginning of the queue and is called to schedule the new timer event. locks the before adding the new subscription and is, therefore, thread safe. - + to the timer queue. Subscriptions in the queue are positioned based on their values; those with smaller values are positioned in front of those with larger values. If the new subscription is added at the beginning of the queue, is called to cancel the timer event that was previously at the beginning of the queue and is called to schedule the new timer event. locks the before adding the new subscription and is, therefore, thread safe. + ]]> @@ -109,11 +109,11 @@ The zero-based index in at which copying begins. Copies the elements to an existing one-dimensional , starting at the specified array index. - is thread safe. - + is thread safe. + ]]> @@ -167,11 +167,11 @@ Returns an enumerator that iterates through the . An for the . - is synchronized; however, enumerating through a collection is intrinsically not a thread safe procedure. An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined. The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread safe procedure. To guarantee thread safety during enumeration, you can lock the during the entire enumeration by using . - + is synchronized; however, enumerating through a collection is intrinsically not a thread safe procedure. An enumerator remains valid as long as the collection remains unchanged. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined. The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread safe procedure. To guarantee thread safety during enumeration, you can lock the during the entire enumeration by using . + ]]> @@ -199,11 +199,11 @@ Gets a value that indicates whether the access to the is synchronized (thread safe). Always returns indicating that access to the is synchronized (thread safe). - is synchronized; however, enumerating through a collection is intrinsically not a thread safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. returns an object, which can be used to synchronize access to the . - + is synchronized; however, enumerating through a collection is intrinsically not a thread safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. returns an object, which can be used to synchronize access to the . + ]]> @@ -229,11 +229,11 @@ Returns the at the beginning of the timer queue without removing it. The at the beginning of the timer queue or a null reference ( in Visual Basic) if the timer queue is empty. - is thread safe. - + is thread safe. + ]]> @@ -270,11 +270,11 @@ The of the to remove. Removes the that has the specified subscription id from the timer queue. - with the specified subscription id from the timer queue. Subscriptions in the queue are positioned based on their values; those with smaller values are positioned in front of those with larger values. If the subscription removed was the subscription at the beginning of the queue, is called to cancel the timer event associated with this subscription and is called to schedule a timer event for the subscription that is now at the beginning of the queue. is thread safe. - + with the specified subscription id from the timer queue. Subscriptions in the queue are positioned based on their values; those with smaller values are positioned in front of those with larger values. If the subscription removed was the subscription at the beginning of the queue, is called to cancel the timer event associated with this subscription and is called to schedule a timer event for the subscription that is now at the beginning of the queue. is thread safe. + ]]> @@ -302,11 +302,11 @@ The to remove from the timer queue. Removes the from the timer queue. - from the timer queue. Subscriptions in the queue are positioned based on their values; those with smaller values are positioned in front of those with larger values. If the subscription removed was the subscription at the beginning of the queue, is called to cancel the timer event associated with this subscription and is called to schedule a timer event for the subscription that is now at the beginning of the queue. is thread safe. - + from the timer queue. Subscriptions in the queue are positioned based on their values; those with smaller values are positioned in front of those with larger values. If the subscription removed was the subscription at the beginning of the queue, is called to cancel the timer event associated with this subscription and is called to schedule a timer event for the subscription that is now at the beginning of the queue. is thread safe. + ]]> @@ -336,13 +336,13 @@ Gets an object that can be used to synchronize access to the . An object used to synchronize access to the . - returns an object, which can be used to synchronize access to the . - - Access to the is synchronized; however, enumerating through a collection is intrinsically not a thread safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the during the entire enumeration by using or catch the exceptions resulting from changes made by other threads. - + returns an object, which can be used to synchronize access to the . + + Access to the is synchronized; however, enumerating through a collection is intrinsically not a thread safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the during the entire enumeration by using or catch the exceptions resulting from changes made by other threads. + ]]> diff --git a/xml/System.Workflow.Runtime/WorkflowCompletedEventArgs.xml b/xml/System.Workflow.Runtime/WorkflowCompletedEventArgs.xml index 1e67303f19f..6603a159620 100644 --- a/xml/System.Workflow.Runtime/WorkflowCompletedEventArgs.xml +++ b/xml/System.Workflow.Runtime/WorkflowCompletedEventArgs.xml @@ -59,7 +59,7 @@ contains the `out` and `ref` parameters of the workflow. + contains the `out` and `ref` parameters of the workflow. ]]> diff --git a/xml/System.Workflow.Runtime/WorkflowEnvironment.xml b/xml/System.Workflow.Runtime/WorkflowEnvironment.xml index 90355ca8973..ef6d22fbad4 100644 --- a/xml/System.Workflow.Runtime/WorkflowEnvironment.xml +++ b/xml/System.Workflow.Runtime/WorkflowEnvironment.xml @@ -59,7 +59,7 @@ property allows hosts or host services to participate in the current transaction by adding pending work items to the current work batch. A host or a host service that wants to participate in the current transaction must implement the interface and use to add pending work items to . Durable services should add items to to keep the state of their data stores consistent with the state of the workflow instance. The out-of-box durable services, and , both implement this functionality. + The property allows hosts or host services to participate in the current transaction by adding pending work items to the current work batch. A host or a host service that wants to participate in the current transaction must implement the interface and use to add pending work items to . Durable services should add items to to keep the state of their data stores consistent with the state of the workflow instance. The out-of-box durable services, and , both implement this functionality. ]]> @@ -88,7 +88,7 @@ contains the of the workflow instance currently running in this thread. Whenever code is run from within a workflow thread, you can get the of the workflow instance through the property. For example, if your code is in a service called by an activity, will provide of the workflow instance for the calling activity. + contains the of the workflow instance currently running in this thread. Whenever code is run from within a workflow thread, you can get the of the workflow instance through the property. For example, if your code is in a service called by an activity, will provide of the workflow instance for the calling activity. ]]> diff --git a/xml/System.Workflow.Runtime/WorkflowInstance.xml b/xml/System.Workflow.Runtime/WorkflowInstance.xml index b8d34180ce6..b49cd0a5715 100644 --- a/xml/System.Workflow.Runtime/WorkflowInstance.xml +++ b/xml/System.Workflow.Runtime/WorkflowInstance.xml @@ -30,10 +30,10 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - The class exposes methods and properties that can be used to control the execution of a workflow instance; it is essentially a proxy to the actual workflow instance used by the workflow runtime engine. A host or a service can instruct the workflow runtime engine to perform actions on a workflow instance by calling the appropriate methods that are contained in the class. If the requested action is not valid, for example, if the host calls on a workflow instance that has already completed, the workflow runtime engine will raise an appropriate exception. + The class exposes methods and properties that can be used to control the execution of a workflow instance; it is essentially a proxy to the actual workflow instance used by the workflow runtime engine. A host or a service can instruct the workflow runtime engine to perform actions on a workflow instance by calling the appropriate methods that are contained in the class. If the requested action is not valid, for example, if the host calls on a workflow instance that has already completed, the workflow runtime engine will raise an appropriate exception. > [!NOTE] -> If a workflow instance becomes unresponsive because a call on the host application does not return, the only way to recover the instance is to restart the runtime. However, if the instance has been forcibly unloaded, aborted, or suspended, it can be continued by calling the method. +> If a workflow instance becomes unresponsive because a call on the host application does not return, the only way to recover the instance is to restart the runtime. However, if the instance has been forcibly unloaded, aborted, or suspended, it can be continued by calling the method. ]]> @@ -63,9 +63,9 @@ . If a persistence service was used by your workflow instance, all work performed since the last persistence point is thrown away. After it aborts the workflow instance, the workflow runtime engine raises the event. You can call to reload the workflow instance and start from its last persistence point. + The workflow instance is aborted in a synchronous manner; that is, the method returns after the workflow instance has been aborted. The workflow runtime engine invalidates the workflow instance in memory and clears the . If a persistence service was used by your workflow instance, all work performed since the last persistence point is thrown away. After it aborts the workflow instance, the workflow runtime engine raises the event. You can call to reload the workflow instance and start from its last persistence point. - `Abort` is different from in that while `Abort` simply clears the in-memory workflow instance and can be restarted from the last persistence point, Terminate clears the in-memory workflow instance and informs the persistence service that the instance has been cleared from memory. For the , this means that all state information for that workflow instance is deleted from the database upon termination. You will not be able to reload the workflow instance from a previously stored persistence point. + `Abort` is different from in that while `Abort` simply clears the in-memory workflow instance and can be restarted from the last persistence point, Terminate clears the in-memory workflow instance and informs the persistence service that the instance has been cleared from memory. For the , this means that all state information for that workflow instance is deleted from the database upon termination. You will not be able to reload the workflow instance from a previously stored persistence point. ]]> @@ -137,12 +137,12 @@ . If you want to be notified when the message is delivered, you can implement in your service and pass a `workItem` and an object to . If you do not want such notification, you can pass a null reference (`Nothing` in Visual Basic) for `pendingWork` and `workItem`. + Sends the `item` to the specified . If you want to be notified when the message is delivered, you can implement in your service and pass a `workItem` and an object to . If you do not want such notification, you can pass a null reference (`Nothing` in Visual Basic) for `pendingWork` and `workItem`. When using this method with a state machine workflow, you might get an exception with the message "Queue '{0}' is not enabled." This happens when the current state of the state machine does not know how to handle a specific event. For example, when some state other than the current state contains the that contains the that is represented by the queue '{0}'. > [!NOTE] -> Messages are not guaranteed to be received by the workflow instance in the order that they were sent. For example, if receiving a message in an existing queue (Queue A) causes a workflow to create another queue (Queue B), which then listens for another message sent after the first message, it is possible that the second message will arrive first, and will not be received due to its queue not being created yet. To prevent this issue, the second message should not be sent until the presence of the second queue is verified (using .) +> Messages are not guaranteed to be received by the workflow instance in the order that they were sent. For example, if receiving a message in an existing queue (Queue A) causes a workflow to create another queue (Queue B), which then listens for another message sent after the first message, it is possible that the second message will arrive first, and will not be received due to its queue not being created yet. To prevent this issue, the second message should not be sent until the presence of the second queue is verified (using .) ]]> @@ -191,7 +191,7 @@ . If you call while the workflow instance is suspended, the workflow runtime engine will throw an . If you want to be notified when the message is delivered, you can implement in your service and pass a `workItem` and an object to . If you do not want such notification, you can pass a null reference (`Nothing` in Visual Basic) for `pendingWork` and `workItem`. + Waits for the workflow instance to become idle and then sends the `item` to the specified . If you call while the workflow instance is suspended, the workflow runtime engine will throw an . If you want to be notified when the message is delivered, you can implement in your service and pass a `workItem` and an object to . If you do not want such notification, you can pass a null reference (`Nothing` in Visual Basic) for `pendingWork` and `workItem`. When you are using this method with a state machine workflow, you might get an exception that contains the message "Queue '{0}' is not enabled." This occurs when the current state of the state machine does not know how to handle a specific event. For example, when some state other than the current state contains the that contains the that is represented by the queue '{0}'. @@ -242,7 +242,7 @@ class and have the same as this . + The object must be an instance of the class and have the same as this . ]]> @@ -272,7 +272,7 @@ returns a hash code based on the value of . + returns a hash code based on the value of . ]]> @@ -358,7 +358,7 @@ returns a collection of objects, each of which contains information about the state of one of the workflow queues associated with this workflow instance. contains the pending items for a and contains a list of the activities that are subscribed for item delivery on a . + returns a collection of objects, each of which contains information about the state of one of the workflow queues associated with this workflow instance. contains the pending items for a and contains a list of the activities that are subscribed for item delivery on a . ]]> @@ -388,7 +388,7 @@ to reference the workflow instance. + You can use to reference the workflow instance. ]]> @@ -417,7 +417,7 @@ is synchronous; if the workflow instance can be loaded, will return after the workflow instance has been loaded into memory and scheduled by the workflow runtime engine. The runtime raises the event after the persistence service has restored the workflow instance in memory, but before the workflow runtime engine schedules the instance. + is synchronous; if the workflow instance can be loaded, will return after the workflow instance has been loaded into memory and scheduled by the workflow runtime engine. The runtime raises the event after the persistence service has restored the workflow instance in memory, but before the workflow runtime engine schedules the instance. ]]> @@ -477,7 +477,7 @@ to resume execution of a workflow instance that has been previously suspended. If the workflow instance is not in the suspended state, no action is taken. The runtime raises the event just before execution of the workflow instance is resumed. + The host can call to resume execution of a workflow instance that has been previously suspended. If the workflow instance is not in the suspended state, no action is taken. The runtime raises the event just before execution of the workflow instance is resumed. ]]> @@ -507,7 +507,7 @@ calls on the root activity of this workflow instance. If encounters an exception, it terminates the workflow instance by calling with the property of the exception passed as the reason for the termination. + calls on the root activity of this workflow instance. If encounters an exception, it terminates the workflow instance by calling with the property of the exception passed as the reason for the termination. ]]> @@ -547,7 +547,7 @@ The workflow instance is suspended in a synchronous manner. If the workflow instance is already suspended, no action is taken; otherwise, the workflow runtime engine suspends the workflow instance, raises the event and passes `reason` in a . > [!NOTE] -> does not unload the workflow instance. +> does not unload the workflow instance. ]]> @@ -580,11 +580,11 @@ to terminate the workflow instance. The workflow runtime engine clears the in-memory workflow instance and informs the persistence service that the instance has been cleared from memory. For the , this means that all state information for that workflow instance is deleted from the database upon termination. You will not be able to reload the workflow instance from a previously stored persistence point. + The workflow instance is terminated in a synchronous manner. The host calls to terminate the workflow instance. The workflow runtime engine clears the in-memory workflow instance and informs the persistence service that the instance has been cleared from memory. For the , this means that all state information for that workflow instance is deleted from the database upon termination. You will not be able to reload the workflow instance from a previously stored persistence point. After the in-memory workflow instance is cleared and the persistence service is informed of the termination, the `Terminate` method raises the event and passes `reason` in the property of a contained in the . - `Terminate` is different from in that while Terminate clears the in-memory workflow instance and informs the persistence service of the termination, `Abort` simply clears the in-memory workflow instance, which can then be restarted from the last persistence point. + `Terminate` is different from in that while Terminate clears the in-memory workflow instance and informs the persistence service of the termination, `Abort` simply clears the in-memory workflow instance, which can then be restarted from the last persistence point. ]]> @@ -616,9 +616,9 @@ uses the persistence service to remove the workflow instance from memory and persist it to a data store. If there is no persistence service registered with the , throws an . If the workflow instance is successfully persisted, the runtime raises the event, and returns `true`. returns `false` if the workflow instance has already been unloaded, has been terminated, has been aborted, or has already completed. + If the workflow instance is idle or suspended, uses the persistence service to remove the workflow instance from memory and persist it to a data store. If there is no persistence service registered with the , throws an . If the workflow instance is successfully persisted, the runtime raises the event, and returns `true`. returns `false` if the workflow instance has already been unloaded, has been terminated, has been aborted, or has already completed. - The host can use to reclaim system resources from an idle workflow. + The host can use to reclaim system resources from an idle workflow. ]]> @@ -648,9 +648,9 @@ is synchronous; that is, it returns after completing any action that it performs. If the workflow instance is not idle, the runtime waits until the instance can be interrupted. An instance can only be interrupted after the currently scheduled work item completes; this is typically when the currently running Activity returns from its method. However, if the instance is executing a , the transaction scope must complete execution before the instance can be interrupted. Unload then uses the persistence service to remove the workflow instance from memory and persists it to a data store. If there is no persistence service registered with the , throws an . If the workflow instance is successfully persisted, the runtime raises the event. + is synchronous; that is, it returns after completing any action that it performs. If the workflow instance is not idle, the runtime waits until the instance can be interrupted. An instance can only be interrupted after the currently scheduled work item completes; this is typically when the currently running Activity returns from its method. However, if the instance is executing a , the transaction scope must complete execution before the instance can be interrupted. Unload then uses the persistence service to remove the workflow instance from memory and persists it to a data store. If there is no persistence service registered with the , throws an . If the workflow instance is successfully persisted, the runtime raises the event. - The host can use to reclaim system resources from an idle workflow. + The host can use to reclaim system resources from an idle workflow. ]]> diff --git a/xml/System.Workflow.Runtime/WorkflowOwnershipException.xml b/xml/System.Workflow.Runtime/WorkflowOwnershipException.xml index f0f96b69dae..7b0d73e0f49 100644 --- a/xml/System.Workflow.Runtime/WorkflowOwnershipException.xml +++ b/xml/System.Workflow.Runtime/WorkflowOwnershipException.xml @@ -76,9 +76,9 @@ |Property|Value| |--------------|-----------| -||A null reference (`Nothing` in Visual Basic)| -||A system-supplied localized description.| -||An empty .| +||A null reference (`Nothing` in Visual Basic)| +||A system-supplied localized description.| +||An empty .| ]]> @@ -113,9 +113,9 @@ |Property|Value| |--------------|-----------| -||A null reference (`Nothing` in Visual Basic)| -||A system-supplied localized description.| -||The of the workflow instance, specified by `instanceId`, for which this exception occurred.| +||A null reference (`Nothing` in Visual Basic)| +||A system-supplied localized description.| +||The of the workflow instance, specified by `instanceId`, for which this exception occurred.| ]]> @@ -144,15 +144,15 @@ before you throw the exception. + The content of the `message` parameter is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture. If you use this constructor you should explicitly set before you throw the exception. The following table shows the initial property values for an instance of . |Property|Value| |--------------|-----------| -||A null reference (`Nothing` in Visual Basic).| -||The error message string.| -||An empty .| +||A null reference (`Nothing` in Visual Basic).| +||The error message string.| +||An empty .| ]]> @@ -189,9 +189,9 @@ |Property|Value| |--------------|-----------| -||A null reference (`Nothing` in Visual Basic)| -||The error message string.| -||The of the workflow instance, specified by `instanceId`, for which this exception occurred.| +||A null reference (`Nothing` in Visual Basic)| +||The error message string.| +||The of the workflow instance, specified by `instanceId`, for which this exception occurred.| ]]> @@ -255,15 +255,15 @@ property. The property returns the same value that is supplied to the constructor or a null reference (Nothing in Visual Basic) if the `innerException` parameter does not supply the inner exception value to the constructor. The content of the `message` parameter is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture. If you use this constructor you should explicitly set before you throw the exception. + An exception that is thrown as a direct result of a previous exception should include a reference to the previous exception in the property. The property returns the same value that is supplied to the constructor or a null reference (Nothing in Visual Basic) if the `innerException` parameter does not supply the inner exception value to the constructor. The content of the `message` parameter is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture. If you use this constructor you should explicitly set before you throw the exception. The following table shows the initial property values for an instance of . |Property|Value| |--------------|-----------| -||The inner exception reference.| -||The error message string.| -||An empty .| +||The inner exception reference.| +||The error message string.| +||An empty .| ]]> @@ -304,9 +304,9 @@ |Property|Value| |--------------|-----------| -||The inner exception reference.| -||The error message string.| -||The of the workflow instance, specified by `instanceId`, for which this exception occurred.| +||The inner exception reference.| +||The error message string.| +||The of the workflow instance, specified by `instanceId`, for which this exception occurred.| ]]> @@ -340,7 +340,7 @@ sets a with all the exception object data targeted for serialization. During deserialization the exception object is reconstituted from the transmitted over the stream. + sets a with all the exception object data targeted for serialization. During deserialization the exception object is reconstituted from the transmitted over the stream. For more information see XML and SOAP Serialization. diff --git a/xml/System.Workflow.Runtime/WorkflowQueue.xml b/xml/System.Workflow.Runtime/WorkflowQueue.xml index f24aee2cb3a..11e4d8b57fa 100644 --- a/xml/System.Workflow.Runtime/WorkflowQueue.xml +++ b/xml/System.Workflow.Runtime/WorkflowQueue.xml @@ -30,7 +30,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - Workflow queues are used to pass messages between a host or host services and activities in a workflow. Any activity can create a by calling , and a host, a service, or another activity can call to add an item to that . You can subscribe to the event to be notified when an item arrives on the . You can use to examine an item at the beginning of the and to remove an item from the . Each is associated with a that you can use to perform other management operations on the , such as deleting the queue. exposes the associated with this . + Workflow queues are used to pass messages between a host or host services and activities in a workflow. Any activity can create a by calling , and a host, a service, or another activity can call to add an item to that . You can subscribe to the event to be notified when an item arrives on the . You can use to examine an item at the beginning of the and to remove an item from the . Each is associated with a that you can use to perform other management operations on the , such as deleting the queue. exposes the associated with this . ]]> @@ -82,7 +82,7 @@ to determine whether the is empty before you call , or you can catch the . + You can check to determine whether the is empty before you call , or you can catch the . ]]> @@ -162,7 +162,7 @@ method, but does not modify the . You can check to determine whether the is empty before you call , or you can catch the . + This method is similar to the method, but does not modify the . You can check to determine whether the is empty before you call , or you can catch the . ]]> @@ -248,7 +248,7 @@ method. + The name of the workflow queue is set by the method. ]]> @@ -312,7 +312,7 @@ methods to register a subscriber for the event. The event is used to notify subscribers that an item has been delivered (in an asynchronous manner) to this . + You can use the overloaded methods to register a subscriber for the event. The event is used to notify subscribers that an item has been delivered (in an asynchronous manner) to this . ]]> @@ -373,7 +373,7 @@ of associated with this queue when is called. + If the qualified name of the subscribing activity is supplied by `subscriberQualifiedName`, it is returned in of associated with this queue when is called. ]]> diff --git a/xml/System.Workflow.Runtime/WorkflowQueueInfo.xml b/xml/System.Workflow.Runtime/WorkflowQueueInfo.xml index d150ea32d9f..3be2e19a9fd 100644 --- a/xml/System.Workflow.Runtime/WorkflowQueueInfo.xml +++ b/xml/System.Workflow.Runtime/WorkflowQueueInfo.xml @@ -23,15 +23,15 @@ Contains information about a . - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - contains information about the state of a . You can call to get a collection of objects that represents the state of the workflow queues associated with a workflow instance. - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + contains information about the state of a . You can call to get a collection of objects that represents the state of the workflow queues associated with a workflow instance. + ]]> diff --git a/xml/System.Workflow.Runtime/WorkflowRuntime.xml b/xml/System.Workflow.Runtime/WorkflowRuntime.xml index dd0bafceb6d..15319b9c45d 100644 --- a/xml/System.Workflow.Runtime/WorkflowRuntime.xml +++ b/xml/System.Workflow.Runtime/WorkflowRuntime.xml @@ -72,14 +72,14 @@ is initialized with the default property values and contains the default core services. To additionally configure the workflow run-time engine, you can add and remove services by using and , and you can set . After the is configured, call to start the workflow run-time engine and its services. + The is initialized with the default property values and contains the default core services. To additionally configure the workflow run-time engine, you can add and remove services by using and , and you can set . After the is configured, call to start the workflow run-time engine and its services. The following table shows initial property values for an instance of class. |Property|Initial Value| |--------------|-------------------| -||"WorkflowRuntime"| -||`false`| +||"WorkflowRuntime"| +||`false`| The default core services are and . @@ -159,7 +159,7 @@ ## Remarks This constructor provides a mechanism to configure the workflow run-time engine using a single method call for hosts that do not use an application configuration file. There are many reasons for not using the application configuration file. A host can run in an environment that does not allow using configuration files; for example, in trusted environments that do not allow reading from the application configuration file for security reasons. Also, a host can use a proprietary configuration mechanism; for example, the host can store the workflow run-time engine configuration settings in a SQL database. - The workflow run-time engine loads and instantiates classes of the types contained in . When the workflow run-time engine constructs these classes it looks for class constructors with the following signatures in the following order: + The workflow run-time engine loads and instantiates classes of the types contained in . When the workflow run-time engine constructs these classes it looks for class constructors with the following signatures in the following order: 1. Service(WorkflowRuntime runtime, NameValueCollection parameters) @@ -204,10 +204,10 @@ class, the class, the class, and the class. Core services can only be added when the workflow run-time engine is not running; that is, when is `false`. The can also be used as a storage container for other services that can be used by other workflows or by applications running on a host. If you add a non-core service that derives from the class after the workflow run-time engine has been started, calls the method implemented by that service. + You can configure the workflow run-time engine by adding core services. Core services are those that derive from any of the following service base classes: the class, the class, the class, and the class. Core services can only be added when the workflow run-time engine is not running; that is, when is `false`. The can also be used as a storage container for other services that can be used by other workflows or by applications running on a host. If you add a non-core service that derives from the class after the workflow run-time engine has been started, calls the method implemented by that service. > [!NOTE] -> enforces the restriction that no two services of the same can be added to the . However, you can add multiple services that derive from the same base class. There can be only one service derived from each of the following service base classes in the : the class, the class, and the class. If you add multiple services derived from one of these classes, for example two persistence services, throws an . +> enforces the restriction that no two services of the same can be added to the . However, you can add multiple services that derive from the same base class. There can be only one service derived from each of the following service base classes in the : the class, the class, and the class. If you add multiple services derived from one of these classes, for example two persistence services, throws an . ]]> @@ -233,7 +233,7 @@ methods call . See for a list of possible exceptions. After you create the workflow instance, call on the object returned by the method to begin its execution. + If the workflow run-time engine has not been started, the methods call . See for a list of possible exceptions. After you create the workflow instance, call on the object returned by the method to begin its execution. ]]> @@ -268,7 +268,7 @@ ## Remarks Before the is created, validation is executed on it. If any validation errors occur, the is thrown. This works well for simple scenarios, but in a server environment, revalidating a workflow for every activation might be unnecessary overhead. - For more information about disabling validation, see . + For more information about disabling validation, see . ]]> @@ -307,7 +307,7 @@ Before the is created, validation is executed on it. If any validation errors occur, the is thrown. This works well for simple scenarios, but in a server environment, revalidating a workflow for every activation might be unnecessary overhead. - For more information about disabling validation, see . + For more information about disabling validation, see . ]]> @@ -347,7 +347,7 @@ ## Remarks Before the is created, validation is executed on it. If any validation errors occur, the is thrown. This works well for simple scenarios, but in a server environment, revalidating a workflow for every activation might be unnecessary overhead. - For more information about disabling validation, see . + For more information about disabling validation, see . For an example of passing in parameters to `CreateWorkflow`, see [Workflow with Parameters Sample](https://go.microsoft.com/fwlink/?LinkId=157403). @@ -390,7 +390,7 @@ ## Remarks Before the is created, validation is executed on it. If any validation errors occur, the is thrown. This works well for simple scenarios, but in a server environment, revalidating a workflow for every activation might be unnecessary overhead. - For more information about disabling validation, see . + For more information about disabling validation, see . The workflow `instanceId` for any running workflows loaded by the must be unique. If you pass an `instanceId` to create a workflow and a running workflow is already using that `instanceId`, an is thrown. @@ -437,7 +437,7 @@ Before the is created, validation is executed on it. If any validation errors occur, the is thrown. This works well for simple scenarios, but in a server environment, revalidating a workflow for every activation might be unnecessary overhead. - For more information about disabling validation, see . + For more information about disabling validation, see . For an example of passing in parameters to `CreateWorkflow`, see [Workflow with Parameters Sample](https://go.microsoft.com/fwlink/?LinkID=157403). @@ -485,7 +485,7 @@ ## Remarks Before the is created, validation is executed on it. If any validation errors occur, the is thrown. This works well for simple scenarios, but in a server environment, revalidating a workflow for every activation might be unnecessary overhead. - For more information about disabling validation, see . + For more information about disabling validation, see . The workflow `instanceId` for any running workflows loaded by the must be unique. If you pass an `instanceId` to create a workflow and a running workflow is already using that `instanceId`, an is thrown. @@ -525,9 +525,9 @@ gracefully, you should only call after you have called . This is because calling the method alone leaves the in an unusable state. frees the resources used by the runtime by closing open file handles, database connections, and so on, but it does not unload workflow instances, stop services, or do any of the other actions that does. + To shut down the gracefully, you should only call after you have called . This is because calling the method alone leaves the in an unusable state. frees the resources used by the runtime by closing open file handles, database connections, and so on, but it does not unload workflow instances, stop services, or do any of the other actions that does. - should be called only when the host application must free the resources used by the before they are automatically freed by the garbage collector. For general information about , see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). + should be called only when the host application must free the resources used by the before they are automatically freed by the garbage collector. For general information about , see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). ]]> @@ -560,7 +560,7 @@ indicates that no services that implement or derive from the specified have been added to the workflow run-time engine. + An empty indicates that no services that implement or derive from the specified have been added to the workflow run-time engine. ]]> @@ -597,7 +597,7 @@ indicates that no services have been added to the workflow run-time engine that implement or derive from the specified generic type. + An empty indicates that no services have been added to the workflow run-time engine that implement or derive from the specified generic type. ]]> @@ -628,7 +628,7 @@ , this method does not throw a if the runtime is not started. + Note that, unlike , this method does not throw a if the runtime is not started. ]]> @@ -665,7 +665,7 @@ throws an if more than one service exists for the specified . Therefore, you should use one of the overloaded methods of if it is possible that multiple services of the specified type are present in the . For example, the workflow run-time engine may have multiple tracking services. If you request a tracking service by specifying the base class, it is possible that an exception will be thrown. + throws an if more than one service exists for the specified . Therefore, you should use one of the overloaded methods of if it is possible that multiple services of the specified type are present in the . For example, the workflow run-time engine may have multiple tracking services. If you request a tracking service by specifying the base class, it is possible that an exception will be thrown. ]]> @@ -703,7 +703,7 @@ throws an if more than one service exists for the specified generic type. Therefore, you should use one of the overloaded methods of if it is possible that multiple services of the generic type are present in the . For example, the workflow run-time engine may have multiple tracking services. If you request a tracking service by specifying the base class, it is possible that an exception will be thrown. + throws an if more than one service exists for the specified generic type. Therefore, you should use one of the overloaded methods of if it is possible that multiple services of the generic type are present in the . For example, the workflow run-time engine may have multiple tracking services. If you request a tracking service by specifying the base class, it is possible that an exception will be thrown. ]]> @@ -738,7 +738,7 @@ to load the workflow instance back into memory. In this case, the last persisted state of the workflow instance is loaded into memory by the persistence service. + If `instanceId` specifies a workflow instance that is not currently in memory, the workflow instance is loaded into memory and scheduled for execution. For example, after a workflow instance is aborted, you can call to load the workflow instance back into memory. In this case, the last persisted state of the workflow instance is loaded into memory by the persistence service. ]]> @@ -769,7 +769,7 @@ indicates that the workflow run-time engine services are running. is `false` until the host calls . It remains `true` until the host calls . + indicates that the workflow run-time engine services are running. is `false` until the host calls . It remains `true` until the host calls . > [!NOTE] > You cannot add core services to the workflow run-time engine while it is running. Core services are services that derive from the class, the class, the class, and the class. @@ -801,7 +801,7 @@ while the workflow run-time engine is running ( is `true`). + You cannot set while the workflow run-time engine is running ( is `true`). ]]> @@ -835,7 +835,7 @@ is `true`). Core services are services that derive from the class, the class, the class, or the class. If `service` derives from the class, calls the method implemented by `service`. + You cannot remove a core service while the workflow run-time engine is running ( is `true`). Core services are services that derive from the class, the class, the class, or the class. If `service` derives from the class, calls the method implemented by `service`. ]]> @@ -872,9 +872,9 @@ class can call the method to inform subscribers to the event that an exception that it was unable to handle occurred during its execution. You can subscribe to this event to implement a recovery mechanism. + A service that is derived from the class can call the method to inform subscribers to the event that an exception that it was unable to handle occurred during its execution. You can subscribe to this event to implement a recovery mechanism. - This event is raised when a workflow instance has not been created yet by the workflow run-time engine and an exception occurs. In this scenario, the only way to inform a host application that an exception occurred is to raise this event. However, the workflow run-time engine does not call this directly. Instead, the workflow run-time engine either delivers an exception to the workflow instance or, if there is no instance, throws back to the caller, which in this case is actually the service that fires this event. If you create your own persistence or scheduler service, you must implement this event yourself through the base method. + This event is raised when a workflow instance has not been created yet by the workflow run-time engine and an exception occurs. In this scenario, the only way to inform a host application that an exception occurred is to raise this event. However, the workflow run-time engine does not call this directly. Instead, the workflow run-time engine either delivers an exception to the workflow instance or, if there is no instance, throws back to the caller, which in this case is actually the service that fires this event. If you create your own persistence or scheduler service, you must implement this event yourself through the base method. For the event, the sender contains the and contains the of the workflow instance that was using the service and the that could not be handled. @@ -907,7 +907,7 @@ method raises the event after it has validated the core service configuration of the workflow run-time engine, has invoked the method implemented by each of its services that derive from the class, and has set to `true`. There is no guarantee about the order in which the services that derive from the class are started by the workflow run-time engine, and some of these workflow run-time engine services may depend on functionality supplied by other of these services to complete their startup tasks. Workflow run-time engine services can override the method to perform any final startup tasks that require the support of other workflow run-time engine services when the event is raised. + The method raises the event after it has validated the core service configuration of the workflow run-time engine, has invoked the method implemented by each of its services that derive from the class, and has set to `true`. There is no guarantee about the order in which the services that derive from the class are started by the workflow run-time engine, and some of these workflow run-time engine services may depend on functionality supplied by other of these services to complete their startup tasks. Workflow run-time engine services can override the method to perform any final startup tasks that require the support of other workflow run-time engine services when the event is raised. For more information about handling events, see [Handling and raising events](/dotnet/standard/events/). @@ -938,9 +938,9 @@ class. There must be one and only one of each of the following core services: a workflow `CommitWorkBatch` service derived from the base class and a scheduler service derived from the base class. If either or both of these core services are missing, the workflow run-time engine supplies the appropriate default service: for the workflow `CommitWorkBatch` service and for the scheduler service. A persistence service is optional, but there can be at most only one persistence service present. After it has validated the service configuration, calls on all of the services that are derived from the class. Finally, the workflow run-time engine sets and raises the event. + This method verifies that a valid set of core services exists and then starts any services that derive from the class. There must be one and only one of each of the following core services: a workflow `CommitWorkBatch` service derived from the base class and a scheduler service derived from the base class. If either or both of these core services are missing, the workflow run-time engine supplies the appropriate default service: for the workflow `CommitWorkBatch` service and for the scheduler service. A persistence service is optional, but there can be at most only one persistence service present. After it has validated the service configuration, calls on all of the services that are derived from the class. Finally, the workflow run-time engine sets and raises the event. - You cannot add or remove core services after the workflow run-time engine is started. Core services are services that derive from the class, the class, the class, or the class. If you call while the workflow run-time engine is running, no action is performed. + You cannot add or remove core services after the workflow run-time engine is started. Core services are services that derive from the class, the class, the class, or the class. If you call while the workflow run-time engine is running, no action is performed. ]]> @@ -979,7 +979,7 @@ method raises the event after it has invoked the method implemented by each of its services that derive from the class. There is no guarantee about the order in which these workflow run-time engine services are stopped, and some of these services may need to preserve some functionality that is relied on by other services until they too are stopped. Such services can override the method to perform any residual shutdown logic when the event is raised. + The method raises the event after it has invoked the method implemented by each of its services that derive from the class. There is no guarantee about the order in which these workflow run-time engine services are stopped, and some of these services may need to preserve some functionality that is relied on by other services until they too are stopped. Such services can override the method to perform any residual shutdown logic when the event is raised. For more information about handling events, see [Handling and raising events](/dotnet/standard/events/). @@ -1010,11 +1010,11 @@ class, set to `false`, and raise the event. + This method causes the workflow run-time engine to unload each of its workflow instances, stop all of its services that are derived from the class, set to `false`, and raise the event. - To shut down the gracefully, call before you call . + To shut down the gracefully, call before you call . - For more information, see the method. + For more information, see the method. ]]> @@ -1044,7 +1044,7 @@ occurs after all pending work for the workflow instance is cleared, but before the workflow instance is invalidated in memory. You can abort a workflow instance by calling . + occurs after all pending work for the workflow instance is cleared, but before the workflow instance is invalidated in memory. You can abort a workflow instance by calling . For this event, the sender contains the and contains the associated with the event. @@ -1207,7 +1207,7 @@ on a workflow instance, or the workflow run-time engine can persist a workflow instance because the instance is idle or because an atomic scope has completed. If a persistence service is present in the , is raised by the runtime after the state of the workflow instance is saved to memory. If a persistence service is not present, the event is still raised but the instance state is not saved. If the event occurs because the workflow instance is being unloaded, it is followed by a event. + The workflow instance can be persisted for many reasons. For example, the host can call on a workflow instance, or the workflow run-time engine can persist a workflow instance because the instance is idle or because an atomic scope has completed. If a persistence service is present in the , is raised by the runtime after the state of the workflow instance is saved to memory. If a persistence service is not present, the event is still raised but the instance state is not saved. If the event occurs because the workflow instance is being unloaded, it is followed by a event. For the event, the sender contains the and contains the associated with the event. @@ -1240,7 +1240,7 @@ event just before the workflow instance is scheduled. The event is usually raised because of an explicit call to . However, the workflow run-time engine can temporarily suspend an instance to perform an operation, for example, to apply a workflow change. In this case, the event is raised when the runtime resumes execution of the workflow instance following the operation. + The workflow run-time engine raises the event just before the workflow instance is scheduled. The event is usually raised because of an explicit call to . However, the workflow run-time engine can temporarily suspend an instance to perform an operation, for example, to apply a workflow change. In this case, the event is raised when the runtime resumes execution of the workflow instance following the operation. For the event, the sender contains the and contains the associated with the event. @@ -1304,7 +1304,7 @@ method, by a activity, or implicitly by the workflow run-time engine. For example, the workflow run-time engine temporarily suspends the instance when it applies dynamic changes to the instance. + The workflow instance can be suspended by the host through a call to the method, by a activity, or implicitly by the workflow run-time engine. For example, the workflow run-time engine temporarily suspends the instance when it applies dynamic changes to the instance. For the event, the sender contains the and contains the and a string that describes the reason the instance was suspended. @@ -1337,7 +1337,7 @@ method, by a activity, or by the workflow run-time engine when an unhandled exception occurs. The workflow run-time engine raises the event after the workflow instance is terminated, but before it is invalidated in memory. + The workflow can be terminated by the host through a call to the method, by a activity, or by the workflow run-time engine when an unhandled exception occurs. The workflow run-time engine raises the event after the workflow instance is terminated, but before it is invalidated in memory. For the event, the sender contains the and contains the and information about the reason the instance was terminated in the property. @@ -1371,7 +1371,7 @@ ## Remarks -A workflow instance can be unloaded from memory by an explicit call to , or implicitly by the workflow run-time engine according to its own semantics. For example, the workflow run-time engine unloads a workflow instance if the instance becomes idle and the runtime has a added for which is `true`. +A workflow instance can be unloaded from memory by an explicit call to , or implicitly by the workflow run-time engine according to its own semantics. For example, the workflow run-time engine unloads a workflow instance if the instance becomes idle and the runtime has a added for which is `true`. The workflow run-time engine raises the `WorkflowUnloaded` event after the state of the workflow instance has been successfully persisted but before the instance is invalidated in memory. Therefore, a event precedes the event. diff --git a/xml/System.Workflow.Runtime/WorkflowRuntimeEventArgs.xml b/xml/System.Workflow.Runtime/WorkflowRuntimeEventArgs.xml index f5e49bb5efb..9a4811c3aa5 100644 --- a/xml/System.Workflow.Runtime/WorkflowRuntimeEventArgs.xml +++ b/xml/System.Workflow.Runtime/WorkflowRuntimeEventArgs.xml @@ -23,13 +23,13 @@ Provides data for the and events. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + ]]> @@ -55,11 +55,11 @@ if the workflow runtime engine is running; otherwise, . - will be `true` for the event and false for the event. - + will be `true` for the event and false for the event. + ]]> diff --git a/xml/System.Workflow.Runtime/WorkflowSuspendedEventArgs.xml b/xml/System.Workflow.Runtime/WorkflowSuspendedEventArgs.xml index 0bd41b217f2..4dd62047be3 100644 --- a/xml/System.Workflow.Runtime/WorkflowSuspendedEventArgs.xml +++ b/xml/System.Workflow.Runtime/WorkflowSuspendedEventArgs.xml @@ -23,15 +23,15 @@ Provides data for the event. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - A workflow instance may be suspended in one of three ways: the host may call , a activity may be invoked from inside the workflow instance, or the workflow runtime engine may suspend the workflow instance. When the workflow instance is suspended, the workflow runtime engine raises the event. The host may subscribe to this event by adding an event handler to . - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + A workflow instance may be suspended in one of three ways: the host may call , a activity may be invoked from inside the workflow instance, or the workflow runtime engine may suspend the workflow instance. When the workflow instance is suspended, the workflow runtime engine raises the event. The host may subscribe to this event by adding an event handler to . + ]]> @@ -56,11 +56,11 @@ Gets the description of why the workflow instance was suspended. The description of why the workflow instance was suspended. - . If the workflow is suspended by a activity, the reason is supplied by . Otherwise, the workflow runtime engine supplies a reason for the suspension. - + . If the workflow is suspended by a activity, the reason is supplied by . Otherwise, the workflow runtime engine supplies a reason for the suspension. + ]]> diff --git a/xml/System.Workflow.Runtime/WorkflowTerminatedEventArgs.xml b/xml/System.Workflow.Runtime/WorkflowTerminatedEventArgs.xml index 6aaacd44f3a..fae37edc454 100644 --- a/xml/System.Workflow.Runtime/WorkflowTerminatedEventArgs.xml +++ b/xml/System.Workflow.Runtime/WorkflowTerminatedEventArgs.xml @@ -30,7 +30,7 @@ > [!NOTE] > [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - A workflow instance may be terminated in one of three ways: the host may call , a activity may be invoked from inside the workflow instance, or the workflow runtime engine may terminate the instance because of an unhandled exception. When the workflow instance is terminated, the workflow runtime engine raises the event. The host may subscribe to this event by adding an event handler to . + A workflow instance may be terminated in one of three ways: the host may call , a activity may be invoked from inside the workflow instance, or the workflow runtime engine may terminate the instance because of an unhandled exception. When the workflow instance is terminated, the workflow runtime engine raises the event. The host may subscribe to this event by adding an event handler to . ]]> @@ -59,9 +59,9 @@ contains the unhandled exception. + When the workflow instance is terminated because of an unhandled exception, contains the unhandled exception. - When the workflow instance is terminated by either a host call to or by a activity, contains a that has its property set to a description of the reason for the termination. If the host terminates the workflow instance, it supplies this description in the `string` parameter to . If the workflow instance is terminated by a , the description is supplied by . + When the workflow instance is terminated by either a host call to or by a activity, contains a that has its property set to a description of the reason for the termination. If the host terminates the workflow instance, it supplies this description in the `string` parameter to . If the workflow instance is terminated by a , the description is supplied by . > [!NOTE] > Although in the case of a event that is not due to an unhandled exception, the workflow runtime engine encapsulates a description of the reason for the termination in the property of a , it does not necessarily throw this exception. From d7c878d8f6599b9e1c43efc67fc894e8c01eadf0 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Mon, 30 Mar 2026 15:59:16 -0700 Subject: [PATCH 3/6] System.ServiceModel --- .../ServiceHostFactory.xml | 74 +-- .../SendMessageChannelCacheElement.xml | 20 +- .../ReceiveContent.xml | 28 +- .../SendMessageChannelCache.xml | 94 ++-- .../WorkflowControlClient.xml | 206 ++++----- .../WorkflowCreationContext.xml | 42 +- .../WorkflowHostingEndpoint.xml | 76 +-- .../WorkflowServiceHost.xml | 142 +++--- .../AddressHeader.xml | 16 +- .../AddressHeaderCollection.xml | 4 +- .../AsymmetricSecurityBindingElement.xml | 6 +- xml/System.ServiceModel.Channels/Binding.xml | 12 +- .../BindingContext.xml | 2 +- .../BindingElement.xml | 8 +- .../BodyWriter.xml | 130 +++--- .../ChannelBase.xml | 170 +++---- .../ChannelFactoryBase.xml | 14 +- .../ChannelFactoryBase`1.xml | 112 ++--- .../ChannelListenerBase.xml | 14 +- .../ChannelListenerBase`1.xml | 40 +- .../ChannelManagerBase.xml | 78 ++-- .../ChannelParameterCollection.xml | 50 +- .../CommunicationObject.xml | 418 ++++++++--------- ...nectionOrientedTransportBindingElement.xml | 2 +- .../ContextExchangeMechanism.xml | 2 +- .../ContextMessageProperty.xml | 28 +- .../CorrelationCallbackMessageProperty.xml | 106 ++--- .../CustomBinding.xml | 2 +- .../FaultConverter.xml | 8 +- .../HttpRequestMessageExtensionMethods.xml | 10 +- .../HttpResponseMessageExtensionMethods.xml | 10 +- .../HttpTransportBindingElement.xml | 2 +- .../IBindingRuntimePreferences.xml | 4 +- xml/System.ServiceModel.Channels/IChannel.xml | 66 +-- .../IChannelFactory.xml | 28 +- .../IChannelFactory`1.xml | 40 +- .../IChannelListener`1.xml | 74 +-- .../IContextManager.xml | 8 +- .../IDuplexSession.xml | 8 +- .../IDuplexSessionChannel.xml | 2 +- .../IInputChannel.xml | 44 +- .../IInputSessionChannel.xml | 2 +- .../IOutputChannel.xml | 14 +- .../IOutputSessionChannel.xml | 2 +- .../IReplyChannel.xml | 26 +- .../IReplySessionChannel.xml | 2 +- .../IRequestChannel.xml | 10 +- .../IRequestSessionChannel.xml | 2 +- xml/System.ServiceModel.Channels/ISession.xml | 2 +- .../ISessionChannel`1.xml | 4 +- .../InvalidChannelBindingException.xml | 2 +- .../LocalClientSecuritySettings.xml | 4 +- .../LocalServiceSecuritySettings.xml | 6 +- xml/System.ServiceModel.Channels/Message.xml | 40 +- .../MessageBuffer.xml | 14 +- .../MessageEncoder.xml | 16 +- .../MessageEncoderFactory.xml | 2 +- .../MessageEncodingBindingElement.xml | 8 +- .../MessageEncodingBindingElementImporter.xml | 24 +- .../MessageFault.xml | 8 +- .../MessageHeader.xml | 80 ++-- .../MessageHeaders.xml | 198 ++++---- .../MessageProperties.xml | 6 +- .../MessageVersion.xml | 4 +- .../MtomMessageEncodingBindingElement.xml | 188 ++++---- .../NamedPipeTransportBindingElement.xml | 206 ++++----- .../OneWayBindingElement.xml | 2 +- .../PnrpPeerResolverBindingElement.xml | 40 +- .../PrivacyNoticeBindingElement.xml | 10 +- .../ReceiveContext.xml | 56 +-- .../ReliableSessionBindingElement.xml | 4 +- .../ReliableSessionBindingElementImporter.xml | 2 +- .../RequestContext.xml | 16 +- .../SecurityBindingElement.xml | 12 +- .../SslStreamSecurityBindingElement.xml | 4 +- .../StandardBindingImporter.xml | 24 +- .../StreamUpgradeAcceptor.xml | 58 +-- .../StreamUpgradeInitiator.xml | 54 +-- .../StreamUpgradeProvider.xml | 84 ++-- .../SymmetricSecurityBindingElement.xml | 6 +- .../TcpTransportBindingElement.xml | 2 +- .../TextMessageEncodingBindingElement.xml | 4 +- .../TransactionFlowBindingElement.xml | 102 ++--- .../TransactionFlowBindingElementImporter.xml | 14 +- .../TransportSecurityBindingElement.xml | 4 +- .../WebContentTypeMapper.xml | 20 +- .../WebMessageEncodingBindingElement.xml | 10 +- .../WindowsStreamSecurityBindingElement.xml | 8 +- ...rviceModelExtensionCollectionElement`1.xml | 2 +- .../WebHttpBindingElement.xml | 4 +- .../WebHttpSecurityElement.xml | 2 +- .../WorkflowRuntimeElement.xml | 4 +- .../ClientCredentials.xml | 12 +- .../ContractDescription.xml | 8 +- ...ataContractSerializerOperationBehavior.xml | 2 +- .../FaultDescriptionCollection.xml | 2 +- .../IContractBehavior.xml | 28 +- .../IEndpointBehavior.xml | 28 +- .../IOperationBehavior.xml | 24 +- .../IOperationContractGenerationExtension.xml | 84 ++-- .../IPolicyExportExtension.xml | 4 +- .../IPolicyImportExtension.xml | 16 +- .../IServiceBehavior.xml | 14 +- .../IServiceContractGenerationExtension.xml | 10 +- .../IWsdlExportExtension.xml | 10 +- .../IWsdlImportExtension.xml | 92 ++-- .../MessageDescriptionCollection.xml | 54 +-- .../MessageDirection.xml | 2 +- .../MetadataConversionError.xml | 60 +-- .../MetadataExchangeBindings.xml | 34 +- .../MetadataExchangeClient.xml | 20 +- .../MetadataExporter.xml | 10 +- .../MetadataImporter.xml | 2 +- .../MetadataResolver.xml | 326 ++++++------- .../MetadataSection.xml | 6 +- .../MetadataSet.xml | 4 +- .../MustUnderstandBehavior.xml | 8 +- .../OperationContractGenerationContext.xml | 6 +- .../OperationDescriptionCollection.xml | 2 +- .../PolicyConversionContext.xml | 20 +- .../ServiceContractGenerationContext.xml | 6 +- .../ServiceCredentials.xml | 6 +- .../ServiceDebugBehavior.xml | 2 +- .../ServiceDescription.xml | 18 +- .../ServiceEndpoint.xml | 2 +- .../ServiceEndpointCollection.xml | 30 +- .../ServiceHealthBehavior.xml | 14 +- .../ServiceThrottlingBehavior.xml | 6 +- .../SynchronousReceiveBehavior.xml | 54 +-- .../WebHttpBehavior.xml | 4 +- .../WebScriptEnablingBehavior.xml | 2 +- .../WebServiceEndpoint.xml | 94 ++-- .../WsdlContractConversionContext.xml | 6 +- .../WsdlEndpointConversionContext.xml | 24 +- .../WsdlExporter.xml | 22 +- .../WsdlImporter.xml | 22 +- .../AnnouncementClient.xml | 30 +- .../DiscoveryClient.xml | 2 +- .../DiscoveryEndpointProvider.xml | 20 +- .../DiscoveryProxy.xml | 50 +- .../DiscoveryService.xml | 20 +- .../DiscoveryServiceExtension.xml | 40 +- .../ActionMessageFilter.xml | 12 +- .../ChannelDispatcher.xml | 4 +- .../ChannelDispatcherBase.xml | 6 +- .../ChannelDispatcherCollection.xml | 4 +- .../ClientOperation.xml | 2 +- .../ClientRuntime.xml | 4 +- .../DispatchOperation.xml | 2 +- .../DispatchRuntime.xml | 8 +- .../EndpointAddressMessageFilter.xml | 92 ++-- .../ExceptionHandler.xml | 10 +- .../FaultContractInfo.xml | 20 +- .../ICallContextInitializer.xml | 2 +- .../IChannelInitializer.xml | 10 +- .../IClientMessageInspector.xml | 128 +++--- .../IClientOperationSelector.xml | 2 +- .../IDispatchMessageInspector.xml | 8 +- .../IErrorHandler.xml | 30 +- .../IInputSessionShutdown.xml | 20 +- .../IInstanceContextInitializer.xml | 2 +- .../IInstanceContextProvider.xml | 10 +- .../IInstanceProvider.xml | 14 +- .../IInteractiveChannelInitializer.xml | 20 +- .../IMessageFilterTable`1.xml | 244 +++++----- .../IOperationInvoker.xml | 4 +- .../IParameterInspector.xml | 2 +- .../InstanceContextIdleCallback.xml | 14 +- .../JsonQueryStringConverter.xml | 4 +- .../MatchAllMessageFilter.xml | 40 +- .../MatchNoneMessageFilter.xml | 50 +- .../MessageFilter.xml | 100 ++-- .../MessageFilterTable`1.xml | 64 +-- .../MessageQuery.xml | 4 +- .../MessageQueryTable`1.xml | 2 +- .../PrefixEndpointAddressMessageFilter.xml | 90 ++-- .../XPathMessageFilter.xml | 16 +- .../XPathMessageFilterTable`1.xml | 74 +-- .../XPathResult.xml | 2 +- .../MsmqIntegrationMessageProperty.xml | 2 +- .../MsmqMessage`1.xml | 2 +- .../PeerResolverMode.xml | 6 +- .../RefreshResponseInfo.xml | 14 +- .../RegisterInfo.xml | 14 +- .../RegisterResponseInfo.xml | 14 +- .../ResolveResponseInfo.xml | 14 +- .../LockingPersistenceProvider.xml | 50 +- .../PersistenceProvider.xml | 34 +- .../SqlPersistenceProviderFactory.xml | 2 +- .../RoutingExtension.xml | 18 +- .../IssuedSecurityTokenParameters.xml | 270 +++++------ .../IssuedSecurityTokenProvider.xml | 100 ++-- .../KerberosSecurityTokenParameters.xml | 150 +++--- .../RsaSecurityTokenParameters.xml | 136 +++--- ...ureConversationSecurityTokenParameters.xml | 8 +- .../SecurityContextSecurityToken.xml | 74 +-- .../SecurityTokenParameters.xml | 6 +- .../ServiceModelSecurityTokenRequirement.xml | 2 +- .../SslSecurityTokenParameters.xml | 6 +- .../SspiSecurityTokenParameters.xml | 10 +- .../UserNameSecurityTokenParameters.xml | 10 +- .../X509SecurityTokenParameters.xml | 140 +++--- .../ChannelProtectionRequirements.xml | 122 ++--- .../DataProtectionSecurityStateEncoder.xml | 32 +- .../IdentityVerifier.xml | 24 +- .../IssuedTokenClientCredential.xml | 172 +++---- .../MessagePartSpecification.xml | 6 +- .../ScopedMessagePartSpecification.xml | 50 +- .../SecureConversationServiceCredential.xml | 2 +- .../SecurityAlgorithmSuite.xml | 358 +++++++-------- .../SecurityMessageProperty.xml | 102 ++--- .../UserNamePasswordServiceCredential.xml | 4 +- .../WSTrustServiceContract.xml | 160 +++---- .../WSTrustServiceHost.xml | 2 +- .../Atom10FeedFormatter.xml | 222 ++++----- .../Atom10ItemFormatter.xml | 158 +++---- .../AtomPub10ServiceDocumentFormatter.xml | 60 +-- .../Rss20FeedFormatter.xml | 232 +++++----- .../Rss20ItemFormatter.xml | 188 ++++---- .../SyndicationContent.xml | 14 +- .../SyndicationFeedFormatter.xml | 432 +++++++++--------- .../SyndicationItemFormatter.xml | 310 ++++++------- .../SyndicationPerson.xml | 2 +- .../WebChannelFactory`1.xml | 18 +- .../ActionNotSupportedException.xml | 6 +- .../AddressAccessDeniedException.xml | 8 +- .../AddressAlreadyInUseException.xml | 6 +- xml/System.ServiceModel/BasicHttpBinding.xml | 280 ++++++------ .../CallbackBehaviorAttribute.xml | 2 +- xml/System.ServiceModel/ChannelFactory.xml | 18 +- xml/System.ServiceModel/ChannelFactory`1.xml | 2 +- .../ChannelTerminatedException.xml | 6 +- xml/System.ServiceModel/ClientBase`1.xml | 28 +- .../CommunicationException.xml | 4 +- .../CommunicationObjectAbortedException.xml | 40 +- .../CommunicationObjectFaultedException.xml | 54 +-- .../CommunicationState.xml | 8 +- .../CorrelationActionMessageFilter.xml | 2 +- xml/System.ServiceModel/CorrelationQuery.xml | 34 +- .../DnsEndpointIdentity.xml | 30 +- .../DuplexChannelFactory`1.xml | 2 +- .../DuplexClientBase`1.xml | 4 +- xml/System.ServiceModel/EndpointAddress.xml | 8 +- xml/System.ServiceModel/EndpointAddress10.xml | 68 +-- .../EndpointAddressAugust2004.xml | 64 +-- .../EndpointAddressBuilder.xml | 4 +- xml/System.ServiceModel/EndpointIdentity.xml | 18 +- .../EndpointNotFoundException.xml | 6 +- xml/System.ServiceModel/EnvelopeVersion.xml | 2 +- .../ExtensionCollection`1.xml | 2 +- .../FaultContractAttribute.xml | 12 +- xml/System.ServiceModel/FaultException.xml | 6 +- xml/System.ServiceModel/FaultException`1.xml | 16 +- xml/System.ServiceModel/FaultReason.xml | 4 +- xml/System.ServiceModel/IClientChannel.xml | 92 ++-- .../ICommunicationObject.xml | 56 +-- .../IExtensibleObject`1.xml | 38 +- .../IExtensionCollection`1.xml | 10 +- xml/System.ServiceModel/IExtension`1.xml | 62 +-- xml/System.ServiceModel/InstanceContext.xml | 2 +- .../InstanceContextMode.xml | 2 +- .../MessageHeaderAttribute.xml | 6 +- .../MessageHeaderException.xml | 6 +- .../NetNamedPipeBinding.xml | 2 +- xml/System.ServiceModel/NetTcpBinding.xml | 4 +- .../OperationBehaviorAttribute.xml | 6 +- xml/System.ServiceModel/OperationContext.xml | 16 +- .../OperationContextScope.xml | 6 +- xml/System.ServiceModel/PeerResolver.xml | 8 +- xml/System.ServiceModel/ProtocolException.xml | 8 +- .../QuotaExceededException.xml | 8 +- .../ReceiveContextEnabledAttribute.xml | 2 +- .../RsaEndpointIdentity.xml | 30 +- .../ServerTooBusyException.xml | 8 +- .../ServiceAuthorizationManager.xml | 20 +- .../ServiceBehaviorAttribute.xml | 10 +- .../ServiceContractAttribute.xml | 2 +- xml/System.ServiceModel/ServiceHost.xml | 14 +- xml/System.ServiceModel/ServiceHostBase.xml | 14 +- .../ServiceKnownTypeAttribute.xml | 2 +- .../ServiceSecurityContext.xml | 4 +- .../UpnEndpointIdentity.xml | 34 +- xml/System.ServiceModel/WSDualHttpBinding.xml | 2 +- .../WSDualHttpSecurityMode.xml | 24 +- xml/System.ServiceModel/WSHttpBinding.xml | 202 ++++---- xml/System.ServiceModel/WSHttpBindingBase.xml | 2 +- xml/System.ServiceModel/WebHttpBinding.xml | 10 +- xml/System.ServiceModel/WebHttpSecurity.xml | 6 +- .../WebHttpSecurityMode.xml | 2 +- .../WorkflowServiceHost.xml | 102 ++--- 290 files changed, 5709 insertions(+), 5709 deletions(-) diff --git a/xml/System.ServiceModel.Activation/ServiceHostFactory.xml b/xml/System.ServiceModel.Activation/ServiceHostFactory.xml index a1deed43af2..362dec4fdd2 100644 --- a/xml/System.ServiceModel.Activation/ServiceHostFactory.xml +++ b/xml/System.ServiceModel.Activation/ServiceHostFactory.xml @@ -29,23 +29,23 @@ Factory that provides instances of in managed hosting environments where the host instance is created dynamically in response to incoming messages. - , consider also implementing a factory that derives from the class. - - If you have implemented a custom derivative of instead, then consider also implementing a factory that derives your factory from directly. - - - -## Examples - This examples show how to use the class: - + , consider also implementing a factory that derives from the class. + + If you have implemented a custom derivative of instead, then consider also implementing a factory that derives your factory from directly. + + + +## Examples + This examples show how to use the class: + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/servicehostfactory/cs/program.cs" id="Snippet0"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/servicehostfactory/vb/program.vb" id="Snippet0"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/servicehostfactory/vb/program.vb" id="Snippet0"::: + ]]> @@ -69,14 +69,14 @@ Initializes a new instance of the class. - : - + : + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/servicehostfactory/cs/program.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/servicehostfactory/vb/program.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/servicehostfactory/vb/program.vb" id="Snippet1"::: + ]]> @@ -119,14 +119,14 @@ Creates a with specific base addresses and initializes it with specified data. A with specific base addresses. - method: - + method: + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/servicehostfactory/cs/program.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/servicehostfactory/vb/program.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/servicehostfactory/vb/program.vb" id="Snippet3"::: + ]]> @@ -163,13 +163,13 @@ Creates a for a specified type of service with a specific base address. A for the type of service specified with a specific base address. - method: - - - + method: + + + ]]> diff --git a/xml/System.ServiceModel.Activities.Configuration/SendMessageChannelCacheElement.xml b/xml/System.ServiceModel.Activities.Configuration/SendMessageChannelCacheElement.xml index 478b78efbc4..46e963584e0 100644 --- a/xml/System.ServiceModel.Activities.Configuration/SendMessageChannelCacheElement.xml +++ b/xml/System.ServiceModel.Activities.Configuration/SendMessageChannelCacheElement.xml @@ -67,11 +67,11 @@ if the workflow instance cache is turned on; otherwise, . - back on which requires them to carefully read the appropriate MSDN document and make a decision that strikes a balance between security and performance. - + back on which requires them to carefully read the appropriate MSDN document and make a decision that strikes a balance between security and performance. + ]]> @@ -171,11 +171,11 @@ Gets or sets the settings of the channel factory cache. The settings of the channel factory cache. - and . - + and . + ]]> diff --git a/xml/System.ServiceModel.Activities/ReceiveContent.xml b/xml/System.ServiceModel.Activities/ReceiveContent.xml index 303b0a9997d..463694dc802 100644 --- a/xml/System.ServiceModel.Activities/ReceiveContent.xml +++ b/xml/System.ServiceModel.Activities/ReceiveContent.xml @@ -16,13 +16,13 @@ An abstract base class for classes that represent the data received by a workflow service. - class to specify the content for a activity. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/contentbasedcorrelation/cs/client.cs" id="Snippet3"::: - + class to specify the content for a activity. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/contentbasedcorrelation/cs/client.cs" id="Snippet3"::: + ]]> @@ -59,13 +59,13 @@ Creates a new instance with the specified message. A instance. - method to specify the content for a activity. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/contentbasedcorrelation/cs/client.cs" id="Snippet3"::: - + method to specify the content for a activity. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/contentbasedcorrelation/cs/client.cs" id="Snippet3"::: + ]]> diff --git a/xml/System.ServiceModel.Activities/SendMessageChannelCache.xml b/xml/System.ServiceModel.Activities/SendMessageChannelCache.xml index 11332097abe..6e0fadb64b7 100644 --- a/xml/System.ServiceModel.Activities/SendMessageChannelCache.xml +++ b/xml/System.ServiceModel.Activities/SendMessageChannelCache.xml @@ -20,22 +20,22 @@ Represents an extension that enables the customization of the cache sharing levels, the settings of the channel factory cache, and the settings of the channel cache for workflows that send messages to service endpoints using messaging activities. - . - - By default, in a workflow hosted by a , the cache used by messaging activities is shared across all workflow instances in the (host-level caching). For a client workflow that is not hosted by a , the cache is available only to the workflow instance (instance-level caching). Caching is disabled by default for any send activity in your workflow that has endpoints defined in configuration. - - For more information about how to change the default cache sharing levels and cache settings for the channel factory and channel cache, see [Changing the Cache Sharing Levels for Send Activities](/dotnet/framework/wcf/feature-details/changing-the-cache-sharing-levels-for-send-activities). - - - -## Examples - The following example shows how to use the class to share a channel cache between two workflow applications in a single app domain. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/channelcache/cs/client.cs" id="Snippet0"::: - + . + + By default, in a workflow hosted by a , the cache used by messaging activities is shared across all workflow instances in the (host-level caching). For a client workflow that is not hosted by a , the cache is available only to the workflow instance (instance-level caching). Caching is disabled by default for any send activity in your workflow that has endpoints defined in configuration. + + For more information about how to change the default cache sharing levels and cache settings for the channel factory and channel cache, see [Changing the Cache Sharing Levels for Send Activities](/dotnet/framework/wcf/feature-details/changing-the-cache-sharing-levels-for-send-activities). + + + +## Examples + The following example shows how to use the class to share a channel cache between two workflow applications in a single app domain. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/channelcache/cs/client.cs" id="Snippet0"::: + ]]> @@ -99,20 +99,20 @@ The cache settings for cached channels. Initializes a new instance of the class with custom factory cache and channel cache settings. - and . - - You can choose to use only the channel factory cache and disable the channel cache by passing the `channelSettings` parameter to this constructor initialized to a instance with a value of 0. To disable the cache completely for both the channel factory cache and the channel cache, pass the `factorySettings` parameter to this constructor initialized to a instance with a value of 0. Note that you cannot turn the channel cache on if the channel factory cache is disabled. - - - -## Examples - The following example shows how to use the class to share a channel cache between two workflow applications in a single app domain. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/channelcache/cs/client.cs" id="Snippet0"::: - + and . + + You can choose to use only the channel factory cache and disable the channel cache by passing the `channelSettings` parameter to this constructor initialized to a instance with a value of 0. To disable the cache completely for both the channel factory cache and the channel cache, pass the `factorySettings` parameter to this constructor initialized to a instance with a value of 0. Note that you cannot turn the channel cache on if the channel factory cache is disabled. + + + +## Examples + The following example shows how to use the class to share a channel cache between two workflow applications in a single app domain. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/channelcache/cs/client.cs" id="Snippet0"::: + ]]> @@ -141,13 +141,13 @@ to turn caching on; otherwise, . Initializes a new instance of the class with custom factory cache settings, custom channel cache settings, and a value that indicates whether to turn caching on. - activities that don't use endpoints defined in configuration. However, if you want to turn caching on in this case call this constructor with the `allowUnsafeCaching` parameter set to `true`. Next, add the new instance of this class as an extension to a workflow service host or a workflow instance. - - For more information about channel factories, see and . - + activities that don't use endpoints defined in configuration. However, if you want to turn caching on in this case call this constructor with the `allowUnsafeCaching` parameter set to `true`. Next, add the new instance of this class as an extension to a workflow service host or a workflow instance. + + For more information about channel factories, see and . + ]]> @@ -178,11 +178,11 @@ to turn caching on; otherwise, . - activity in your workflow has endpoints defined in configuration caching could be unsecure and therefore is disabled by default. However, if you want to turn caching on set this property to `true`. - + activity in your workflow has endpoints defined in configuration caching could be unsecure and therefore is disabled by default. However, if you want to turn caching on set this property to `true`. + ]]> @@ -263,11 +263,11 @@ Gets or sets the settings of the channel factory cache. The settings of the channel factory cache. - and . - + and . + ]]> diff --git a/xml/System.ServiceModel.Activities/WorkflowControlClient.xml b/xml/System.ServiceModel.Activities/WorkflowControlClient.xml index 8504c189117..0334c0eae43 100644 --- a/xml/System.ServiceModel.Activities/WorkflowControlClient.xml +++ b/xml/System.ServiceModel.Activities/WorkflowControlClient.xml @@ -19,11 +19,11 @@ Allows a client to send control operations to a workflow service hosted with . - @@ -79,13 +79,13 @@ The workflow control endpoint. Initializes a new instance of the class with the specified . - instance using this constructor. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet2"::: - + instance using this constructor. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet2"::: + ]]> @@ -115,13 +115,13 @@ The configuration to use. Initializes a new instance of the class with the specified endpoint configuration. - @@ -153,13 +153,13 @@ The workflow control endpoint. Initializes a new instance of the class with the specified binding, and . - @@ -191,13 +191,13 @@ The endpoint address. Initializes a new instance of the class with the specified endpoint configuration and . - @@ -229,13 +229,13 @@ The endpoint address. Initializes a new instance of the class with the specified endpoint configuration and endpoint address. - @@ -277,13 +277,13 @@ The workflow instance to abandon. Abandons the specified workflow instance. - . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet6"::: - + . + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet6"::: + ]]> @@ -312,13 +312,13 @@ The reason to abandon the workflow instance. Abandons the specified workflow instance. - . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet7"::: - + . + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet7"::: + ]]> @@ -797,13 +797,13 @@ The workflow instance to cancel. Cancels the specified workflow instance. - . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet8"::: - + . + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet8"::: + ]]> @@ -1060,13 +1060,13 @@ The workflow instance to run. Runs the specified workflow instance. - . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet9"::: - + . + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet9"::: + ]]> @@ -1188,13 +1188,13 @@ The workflow instance to suspend. Suspends the specified workflow instance. - . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet10"::: - + . + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet10"::: + ]]> @@ -1223,13 +1223,13 @@ The reason to suspend the workflow instance. Suspends the specified workflow instance. - . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet11"::: - + . + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet11"::: + ]]> @@ -1405,13 +1405,13 @@ The workflow instance to terminate. Terminates the specified workflow instance. - . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet12"::: - + . + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet12"::: + ]]> @@ -1440,13 +1440,13 @@ The reason to terminate the workflow instance. Terminates the specified workflow instance with the specified reason. - . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet13"::: - + . + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet13"::: + ]]> @@ -1613,13 +1613,13 @@ The workflow instance to unsuspend. Unsuspends the specified workflow instance. - method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet1"::: - + method. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/managementendpoint/cs/client.cs" id="Snippet1"::: + ]]> diff --git a/xml/System.ServiceModel.Activities/WorkflowCreationContext.xml b/xml/System.ServiceModel.Activities/WorkflowCreationContext.xml index 38f39f92127..b1855c27073 100644 --- a/xml/System.ServiceModel.Activities/WorkflowCreationContext.xml +++ b/xml/System.ServiceModel.Activities/WorkflowCreationContext.xml @@ -138,13 +138,13 @@ Aborts the . - method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wfcreationcontext/cs/program.cs" id="Snippet2"::: - + method. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wfcreationcontext/cs/program.cs" id="Snippet2"::: + ]]> @@ -182,13 +182,13 @@ Begins an asynchronous operation to perform workflow instance completion notification. This method is called when the workflow instance associated with this completes. Derived classes can override this operation to perform custom actions on workflow instance completion. The status of the asynchronous operation. - method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wfcreationcontext/cs/program.cs" id="Snippet0"::: - + method. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wfcreationcontext/cs/program.cs" id="Snippet0"::: + ]]> @@ -215,13 +215,13 @@ The status of the asynchronous operation. Completes an asynchronous operation that notifies workflow instance completion associated with this . - method. Notice that the base class method is called. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wfcreationcontext/cs/program.cs" id="Snippet2"::: - + method. Notice that the base class method is called. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wfcreationcontext/cs/program.cs" id="Snippet2"::: + ]]> diff --git a/xml/System.ServiceModel.Activities/WorkflowHostingEndpoint.xml b/xml/System.ServiceModel.Activities/WorkflowHostingEndpoint.xml index 99625bb200e..412dac59411 100644 --- a/xml/System.ServiceModel.Activities/WorkflowHostingEndpoint.xml +++ b/xml/System.ServiceModel.Activities/WorkflowHostingEndpoint.xml @@ -16,13 +16,13 @@ An abstract implementation of . Derive from this class to expose contracts that support workflow creation and bookmark resumption. - class. - - :::code language="csharp" source="~/snippets/csharp/System.ServiceModel.Activities/WorkflowHostingEndpoint/Overview/CreationEndpoint.cs" id="Snippet2"::: - + class. + + :::code language="csharp" source="~/snippets/csharp/System.ServiceModel.Activities/WorkflowHostingEndpoint/Overview/CreationEndpoint.cs" id="Snippet2"::: + ]]> @@ -113,11 +113,11 @@ Gets a collection of instances . A collection of correlation queries. - . - + . + ]]> @@ -151,13 +151,13 @@ Override to create a new instance. A workflow creation context object. - method. - - - + method. + + + ]]> @@ -187,18 +187,18 @@ Override to return the instance ID for the workflow instance being created. The instance ID for the newly created workflow instance. - method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/creationendpoint/cs/creationendpoint.cs" id="Snippet0"::: - + method. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/creationendpoint/cs/creationendpoint.cs" id="Snippet0"::: + ]]> @@ -232,13 +232,13 @@ Override to return a bookmark to be resumed on the workflow instance. A bookmark. - method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/resumebookmarkendpoint/cs/resumebookmarkendpoint.cs" id="Snippet0"::: - + method. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/resumebookmarkendpoint/cs/resumebookmarkendpoint.cs" id="Snippet0"::: + ]]> diff --git a/xml/System.ServiceModel.Activities/WorkflowServiceHost.xml b/xml/System.ServiceModel.Activities/WorkflowServiceHost.xml index e9442d1ace9..30491de908e 100644 --- a/xml/System.ServiceModel.Activities/WorkflowServiceHost.xml +++ b/xml/System.ServiceModel.Activities/WorkflowServiceHost.xml @@ -16,13 +16,13 @@ Provides a host for workflows. Supports features like messaging activities, multi-instancing, and configuration. - class. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/sendreceiveparameters/cs/echoworkflowservice/program.cs" id="Snippet03"::: - + class. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/sendreceiveparameters/cs/echoworkflowservice/program.cs" id="Snippet03"::: + ]]> @@ -81,12 +81,12 @@ An array of base addresses for the workflow service. Initializes a new instance of the class using the specified activity and base addresses. - @@ -209,12 +209,12 @@ The service endpoint to add. Adds a service endpoint to the workflow service host. - method. - - + method. + + ]]> @@ -246,12 +246,12 @@ Adds a service endpoint to the workflow service host using the specified contract, binding, and address. A service endpoint. - @@ -283,12 +283,12 @@ Adds a service endpoint to the workflow service host using the specified contract, binding, and address. A service endpoint. - @@ -322,12 +322,12 @@ Adds a service endpoint to the workflow service host using the specified contract, binding, endpoint address, and listen URI. A service endpoint. - @@ -361,12 +361,12 @@ Adds a service endpoint to the workflow service host using the specified contract, binding, endpoint address, and listen URI. A service endpoint. - @@ -401,12 +401,12 @@ Adds a service endpoint to the workflow service host using the specified contract, binding, endpoint address, listen URI, and behavior configuration name. A service endpoint. - @@ -441,12 +441,12 @@ Adds a service endpoint to the workflow service host using the specified implemented contract, binding, endpoint address, listen URI, and a behavior configuration name. A service endpoint. - @@ -474,11 +474,11 @@ Creates a service description of the hosted workflow service using the specified key/value pair collection of address, binding, contract and behavior service endpoint information. A service for the hosted workflow service. - @@ -626,11 +626,11 @@ The period of time the close operation has to complete before timing out. Closes down the hosted service, including the channel dispatchers and associated instance contexts and listeners. - is called, but persistence is not guaranteed in this scenario. If important business data is being hosted, the instances should persist frequently (such as after each Send operation, or after an interval of time) to ensure that data is not lost. - + is called, but persistence is not guaranteed in this scenario. If important business data is being hosted, the instances should persist frequently (such as after each Send operation, or after an interval of time) to ensure that data is not lost. + ]]> @@ -753,12 +753,12 @@ Gets a object to add or remove extensions to the workflow service instance. workflow instance extension manager. - diff --git a/xml/System.ServiceModel.Channels/AddressHeader.xml b/xml/System.ServiceModel.Channels/AddressHeader.xml index 8cf2e18621d..986d3fc9e91 100644 --- a/xml/System.ServiceModel.Channels/AddressHeader.xml +++ b/xml/System.ServiceModel.Channels/AddressHeader.xml @@ -102,7 +102,7 @@ to create new objects. + Use the to create new objects. ]]> @@ -469,7 +469,7 @@ ## Remarks This is the string-based implementation. - is suitable for use in hashing algorithms and data structures like a hash table. + is suitable for use in hashing algorithms and data structures like a hash table. @@ -494,7 +494,7 @@ overload if you want to use a customized XML formatter; otherwise use the overload. + Use the overload if you want to use a customized XML formatter; otherwise use the overload. ]]> @@ -542,7 +542,7 @@ ## Remarks When using this overload, you must supply a type for the generic parameter `T`. The type of the return value is determined by the generic type parameter. - Use the overload if you want to use a customized XML formatter. + Use the overload if you want to use a customized XML formatter. @@ -603,7 +603,7 @@ ## Remarks When using this overload, you must supply a type for the generic parameter `T`. The type of the return value is determined by the generic type parameter. - Use this overload only if you want to use a customized XML formatter; otherwise use the overload. + Use this overload only if you want to use a customized XML formatter; otherwise use the overload. @@ -839,7 +839,7 @@ and overloads provide interfaces to use in writing an address header to a stream or file. Both call the abstract method, so users must provide an implementation of this method to use these overloads. + The and overloads provide interfaces to use in writing an address header to a stream or file. Both call the abstract method, so users must provide an implementation of this method to use these overloads. ]]> @@ -885,7 +885,7 @@ ## Remarks This overload calls the abstract - method, so users must provide an implementation of that method to use this method. + method, so users must provide an implementation of that method to use this method. @@ -939,7 +939,7 @@ ## Remarks This overload wraps as a and then the calls the abstract - method. Users must provide an implementation for that abstract method to use this overload. + method. Users must provide an implementation for that abstract method to use this overload. diff --git a/xml/System.ServiceModel.Channels/AddressHeaderCollection.xml b/xml/System.ServiceModel.Channels/AddressHeaderCollection.xml index 7bbd338386f..b764cf67cf4 100644 --- a/xml/System.ServiceModel.Channels/AddressHeaderCollection.xml +++ b/xml/System.ServiceModel.Channels/AddressHeaderCollection.xml @@ -52,7 +52,7 @@ can be initialized with an set of objects and then searched for a header with a specific qualified name using the method. To find all of the headers with a specific qualified name, use the method. The method is used to add headers to the headers of a specified message. + The can be initialized with an set of objects and then searched for a header with a specific qualified name using the method. To find all of the headers with a specific qualified name, use the method. The method is used to add headers to the headers of a specified message. ]]> @@ -292,7 +292,7 @@ method instead. + If you need to find all the address headers in the collection with the specified name and namespace, use the method instead. is not the ideal exception type when there is more than one header in the collection. Callers of this method should take care to handle this exception when the collection contains multiple entries with the same name and namespace. diff --git a/xml/System.ServiceModel.Channels/AsymmetricSecurityBindingElement.xml b/xml/System.ServiceModel.Channels/AsymmetricSecurityBindingElement.xml index 0631295cf1b..3fb111ed17d 100644 --- a/xml/System.ServiceModel.Channels/AsymmetricSecurityBindingElement.xml +++ b/xml/System.ServiceModel.Channels/AsymmetricSecurityBindingElement.xml @@ -32,7 +32,7 @@ 2. Create custom binding elements that is above this binding element in the binding stack, such as the optional and . -3. Add the created elements in the preceding order to the using the method. +3. Add the created elements in the preceding order to the using the method. 4. Create an instance of and add it to the collection. @@ -625,7 +625,7 @@ ## Remarks This method writes binding-related statements into the WSDL information exposed by a particular contract and is used by Windows Communication Foundation (WCF) to communicate to clients the existence of this custom binding element in the binding stack. - This method takes two parameters: the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then use this method to add your own policy assertions to the appropriate collection. + This method takes two parameters: the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then use this method to add your own policy assertions to the appropriate collection. The property exposes the for the endpoint that is being exported. This allows this method to correctly scope their exported policy assertions. For example, security attributes in code may add behaviors to the that indicate where security policy assertions should be added. @@ -659,7 +659,7 @@ includes the , , , and values of the current instance. + Information returned by includes the , , , and values of the current instance. ]]> diff --git a/xml/System.ServiceModel.Channels/Binding.xml b/xml/System.ServiceModel.Channels/Binding.xml index 64fafba94dc..cf167be3ac3 100644 --- a/xml/System.ServiceModel.Channels/Binding.xml +++ b/xml/System.ServiceModel.Channels/Binding.xml @@ -80,7 +80,7 @@ ||1 minute| ||10 minutes| - When you create a binding by inheriting from , you must override . + When you create a binding by inheriting from , you must override . In addition, you can define your own binding elements and insert them between any of the defined layers in the preceding table. For more information, see the class. @@ -687,7 +687,7 @@ and catch the exception generated if it cannot be built. + Use this method if you want to check that the channel factory for channels of type `TChannel` can be build for the `context` provided before attempting to actually build the factory. Alternatively, try to build the channel factory by calling and catch the exception generated if it cannot be built. ]]> @@ -744,7 +744,7 @@ and catch the exception generated if it cannot be built. + Use this method if you want to check that the channel factory for channels of type `TChannel` can be build for the binding `parameters` specified before attempting to actually build the factory. Alternatively, try to build the channel factory by calling and catch the exception generated if it cannot be built. ]]> @@ -794,7 +794,7 @@ and catch the exception generated if it cannot be built. + Use this method if you want to check that the channel factory for channels of type `TChannel` can be build for the binding `parameters` specified before attempting to actually build the factory. Alternatively, try to build the channel factory by calling and catch the exception generated if it cannot be built. ]]> @@ -856,7 +856,7 @@ and catch the exception generated if it cannot be built. + Use this method if you want to check that the channel listener for channels of type `TChannel` can be build for the binding `parameters` specified before attempting to actually build the listener. Alternatively, try to build the channel listener by calling and catch the exception generated if it cannot be built. ]]> @@ -902,7 +902,7 @@ and catch the exception generated if it cannot be built. + Use this method if you want to check that the channel listener for channels of type `TChannel` can be build for the binding `parameters` specified before attempting to actually build the listener. Alternatively, try to build the channel listener by calling and catch the exception generated if it cannot be built. ]]> diff --git a/xml/System.ServiceModel.Channels/BindingContext.xml b/xml/System.ServiceModel.Channels/BindingContext.xml index 57281233ee4..7db9e731b85 100644 --- a/xml/System.ServiceModel.Channels/BindingContext.xml +++ b/xml/System.ServiceModel.Channels/BindingContext.xml @@ -535,7 +535,7 @@ on the next binding element stored in the binding context. + Clones the binding context and calls on the next binding element stored in the binding context. diff --git a/xml/System.ServiceModel.Channels/BindingElement.xml b/xml/System.ServiceModel.Channels/BindingElement.xml index 1b30147b9b3..e84ba24b9e4 100644 --- a/xml/System.ServiceModel.Channels/BindingElement.xml +++ b/xml/System.ServiceModel.Channels/BindingElement.xml @@ -60,7 +60,7 @@ Similarly, on the receiving side a binding is used to build a , which listens for incoming messages. The provides messages to the listening application by creating channel stacks and handing the application a reference to the top channel. The application then uses this channel to receive incoming messages. > [!NOTE] -> If you are adding message headers that must be encrypted you must return a instance with your requirements from the method when asked for . +> If you are adding message headers that must be encrypted you must return a instance with your requirements from the method when asked for . @@ -302,7 +302,7 @@ and catch the exception generated if it cannot be built. + Use this method if you want to check that the channel factory for channels of type `TChannel` can be build for the `context` provided before attempting to build the factory. Alternatively, build the channel factory by calling and catch the exception generated if it cannot be built. @@ -355,7 +355,7 @@ and catch the exception generated if it cannot be built. + Use this method if you want to check that the channel listener for channels of type `TChannel` can be build for the `context` provided before attempting to build the listener. Alternatively, build the channel listener by calling and catch the exception generated if it cannot be built. @@ -404,7 +404,7 @@ method to return a deep clone of your binding element. Returning a clone enables the runtime to support the case in which multiple custom bindings share a custom binding element. If a clone is not returned, the run-time behavior is undefined. + Implement the method to return a deep clone of your binding element. Returning a clone enables the runtime to support the case in which multiple custom bindings share a custom binding element. If a clone is not returned, the run-time behavior is undefined. A deep clone of an object creates a copy of the object and a copy of everything directly or indirectly referenced by that object. (This is also called copying the entire object graph.) A shallow clone of an object, by contrast, is a copy of the object only. If the object contains references to other objects, the shallow copy does not create copies of the referred objects; instead, it copies only the references to the original objects. diff --git a/xml/System.ServiceModel.Channels/BodyWriter.xml b/xml/System.ServiceModel.Channels/BodyWriter.xml index d3dcdbd035f..7d3f3b2666a 100644 --- a/xml/System.ServiceModel.Channels/BodyWriter.xml +++ b/xml/System.ServiceModel.Channels/BodyWriter.xml @@ -46,19 +46,19 @@ Represents the writer of the message body. - to the . A message calls the class derived from whenever it requires the body to be written using an . - - - -## Examples - The following example shows how to derive a class from . This override takes in an array of strings and writes them to a . - + to the . A message calls the class derived from whenever it requires the body to be written using an . + + + +## Examples + The following example shows how to derive a class from . This override takes in an array of strings and writes them to a . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uebodywriter/cs/program.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebodywriter/vb/module1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebodywriter/vb/module1.vb" id="Snippet1"::: + ]]> @@ -96,11 +96,11 @@ if the body writer can be called multiple times; otherwise . Initializes a new instance of the class that explicitly indicates whether to buffer. - @@ -178,19 +178,19 @@ Creates a buffered copy of the body. A that contains a copy of this object. - is `true` then the object is returned. If is `false` then the contents of the up to `maxBufferSize` is returned. This also calls as an extensibility point. - - - -## Examples - The following sample shows how to create a buffered copy of an existing instance. - + is `true` then the object is returned. If is `false` then the contents of the up to `maxBufferSize` is returned. This also calls as an extensibility point. + + + +## Examples + The following sample shows how to create a buffered copy of an existing instance. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uebodywriter/cs/snippets.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebodywriter/vb/snippets.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebodywriter/vb/snippets.vb" id="Snippet2"::: + ]]> The is less than zero. @@ -268,11 +268,11 @@ if the body writer can be called multiple times; otherwise . - @@ -350,13 +350,13 @@ Provides an extensibility point when the body contents are written. The with the specified maximum buffer size. - can override this method to create a buffered copy of the . But the default implementation of calls , so overriding just should be easier and work for most scenarios. - - Note that the returned must be buffered, that is must be `true`. - + can override this method to create a buffered copy of the . But the default implementation of calls , so overriding just should be easier and work for most scenarios. + + Note that the returned must be buffered, that is must be `true`. + ]]> @@ -428,19 +428,19 @@ The used to write out the message body. When implemented, provides an extensibility point when the body contents are written. - . This is the key method that writes the body. If the is buffered then this method is called only once. - - - -## Examples - The following example illustrates an override of the method. - + . This is the key method that writes the body. If the is buffered then this method is called only once. + + + +## Examples + The following example illustrates an override of the method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uebodywriter/cs/program.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebodywriter/vb/module1.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebodywriter/vb/module1.vb" id="Snippet3"::: + ]]> @@ -480,19 +480,19 @@ The used to write out the message body. Writes out the contents of the message body. - calls , so overriding provides the best point of extension. - - - -## Examples - The following sample shows how to call the method. - + calls , so overriding provides the best point of extension. + + + +## Examples + The following sample shows how to call the method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uebodywriter/cs/program.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebodywriter/vb/module1.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebodywriter/vb/module1.vb" id="Snippet4"::: + ]]> diff --git a/xml/System.ServiceModel.Channels/ChannelBase.xml b/xml/System.ServiceModel.Channels/ChannelBase.xml index 220019eab38..7925419d425 100644 --- a/xml/System.ServiceModel.Channels/ChannelBase.xml +++ b/xml/System.ServiceModel.Channels/ChannelBase.xml @@ -56,24 +56,24 @@ Provides the base implementation for custom channels. - class provides an abstract base class implementation of the interface. It also requires that each channel be associated with a channel manager. Note that the only constructor available for creating instances of requires a `channelManager` input parameter. - - State changes are managed by inheriting from the implementation of the state machine. - - The gets its default communication timeouts for the open, close, send and receive operations from the associated with it. - - The also manages the manager for you. In addition to exposing a reference to the manager, the base class also notifies the manager when channels are created and destroyed. But the reference to the manager is only good until the channel is destroyed. - - Even if you do use the base class, you must still provide behaviors for opening and closing the channel. The default implementations of these methods do not provide useful information. - - You must also make sure to override whenever you implement a channel. is an excellent way to communicate information along the channel stack without having to know what channels are below you, or what channels above you may perform queries. Define interfaces that can be queried for available information. Whenever you do not recognize the type argument for , delegate down to the next channel in the stack or return `null` if you are creating a new transport channel at the bottom of the stack. - + The class provides an abstract base class implementation of the interface. It also requires that each channel be associated with a channel manager. Note that the only constructor available for creating instances of requires a `channelManager` input parameter. + + State changes are managed by inheriting from the implementation of the state machine. + + The gets its default communication timeouts for the open, close, send and receive operations from the associated with it. + + The also manages the manager for you. In addition to exposing a reference to the manager, the base class also notifies the manager when channels are created and destroyed. But the reference to the manager is only good until the channel is destroyed. + + Even if you do use the base class, you must still provide behaviors for opening and closing the channel. The default implementations of these methods do not provide useful information. + + You must also make sure to override whenever you implement a channel. is an excellent way to communicate information along the channel stack without having to know what channels are below you, or what channels above you may perform queries. Define interfaces that can be queried for available information. Whenever you do not recognize the type argument for , delegate down to the next channel in the stack or return `null` if you are creating a new transport channel at the bottom of the stack. + ]]> @@ -110,11 +110,11 @@ The that provides default timeouts for the channel operations (send, receive, open, and close). Initializes a new instance of the class. - requires a `channelManager` input parameter. - + requires a `channelManager` input parameter. + ]]> @@ -153,13 +153,13 @@ Gets the default interval of time provided for a close operation to complete. The default that specifies how long the close operation has to complete before timing out. - associated with for the channel. - - All operations that are potentially lengthy must have a timeout. Methods that do not take explicit timeouts, must delegate to those methods with default timeouts or must not do any work that blocks. Timeouts are the total limit for high-level operations for which they are to complete, so any retries must be limited to the time not already accessed by earlier tries. - + associated with for the channel. + + All operations that are potentially lengthy must have a timeout. Methods that do not take explicit timeouts, must delegate to those methods with default timeouts or must not do any work that blocks. Timeouts are the total limit for high-level operations for which they are to complete, so any retries must be limited to the time not already accessed by earlier tries. + ]]> @@ -196,13 +196,13 @@ Gets the default interval of time provided for an open operation to complete. The default that specifies how long the open operation has to complete before timing out. - associated with for the channel. - - All operations that are potentially lengthy must have a timeout. Methods that do not take explicit timeouts, must delegate to those methods with default timeouts or must not do any work that blocks. Timeouts are the total limit for high-level operations for which they are to complete, so any retries must be limited to the time not already accessed by earlier tries. - + associated with for the channel. + + All operations that are potentially lengthy must have a timeout. Methods that do not take explicit timeouts, must delegate to those methods with default timeouts or must not do any work that blocks. Timeouts are the total limit for high-level operations for which they are to complete, so any retries must be limited to the time not already accessed by earlier tries. + ]]> @@ -239,13 +239,13 @@ Gets the default interval of time provided for a receive operation to complete. The default that specifies how long the receive operation has to complete before timing out. - associated with for the channel. - - All operations that are potentially lengthy must have a timeout. Methods that do not take explicit timeouts, must delegate to those methods with default timeouts or must not do any work that blocks. Timeouts are the total limit for high-level operations for which they are to complete, so any retries must be limited to the time not already accessed by earlier tries. - + associated with for the channel. + + All operations that are potentially lengthy must have a timeout. Methods that do not take explicit timeouts, must delegate to those methods with default timeouts or must not do any work that blocks. Timeouts are the total limit for high-level operations for which they are to complete, so any retries must be limited to the time not already accessed by earlier tries. + ]]> @@ -282,13 +282,13 @@ Gets the default interval of time provided for a send operation to complete. The default that specifies how long the send operation has to complete before timing out. - associated with for the channel. - - All operations that are potentially lengthy must have a timeout. Methods that do not take explicit timeouts, must delegate to those methods with default timeouts or must not do any work that blocks. Timeouts are the total limit for high-level operations for which they are to complete, so any retries must be limited to the time not already accessed by earlier tries. - + associated with for the channel. + + All operations that are potentially lengthy must have a timeout. Methods that do not take explicit timeouts, must delegate to those methods with default timeouts or must not do any work that blocks. Timeouts are the total limit for high-level operations for which they are to complete, so any retries must be limited to the time not already accessed by earlier tries. + ]]> @@ -337,13 +337,13 @@ Returns the typed object requested, if present, from the appropriate layer in the channel stack. The typed object requested, if it is present, or , if it is not. - whenever you implement a channel. is an excellent way to communicate information along the channel stack without having to know what channels are below you, or what channels above you may perform queries. Define interfaces that can be queried for available information. Whenever you do not recognize the type argument for , delegate down to the next channel in the stack or return `null` if you are creating a new transport channel at the bottom of the stack. - + whenever you implement a channel. is an excellent way to communicate information along the channel stack without having to know what channels are below you, or what channels above you may perform queries. Define interfaces that can be queried for available information. Whenever you do not recognize the type argument for , delegate down to the next channel in the stack or return `null` if you are creating a new transport channel at the bottom of the stack. + ]]> @@ -386,11 +386,11 @@ Gets the channel manager that is associated with the current channel. The that is associated with the current channel. - must have a associated with it. - + must have a associated with it. + ]]> @@ -427,11 +427,11 @@ Uses diagnostic tracing during the transition into the closing state. - @@ -471,11 +471,11 @@ Gets the interval of time after which the close method, invoked by a communication object, times out. The that specifies the interval of time to wait for the close method to time out. - calls . - + calls . + ]]> @@ -515,11 +515,11 @@ Gets the interval of time after which the open method, invoked by a communication object, times out. The that specifies the interval of time to wait for the open method to time out. - calls . - + calls . + ]]> @@ -565,11 +565,11 @@ Gets the interval of time after which the receive method, invoked by a communication object, times out. The that specifies the interval of time to wait for the receive method to time out. - calls . - + calls . + ]]> @@ -615,11 +615,11 @@ Gets the interval of time after which the send method, invoked by a communication object, times out. The that specifies the interval of time to wait for the send method to time out. - calls . - + calls . + ]]> diff --git a/xml/System.ServiceModel.Channels/ChannelFactoryBase.xml b/xml/System.ServiceModel.Channels/ChannelFactoryBase.xml index 109dc368e82..18a0c799e72 100644 --- a/xml/System.ServiceModel.Channels/ChannelFactoryBase.xml +++ b/xml/System.ServiceModel.Channels/ChannelFactoryBase.xml @@ -78,7 +78,7 @@ constructor initializes timeout properties with the service model timeout values when exchanging messages. The default value is 1 minute for open, send, and close operations and 10 minutes for the receive operation. Use if you want to specify other values for these operation timeouts. + The default constructor initializes timeout properties with the service model timeout values when exchanging messages. The default value is 1 minute for open, send, and close operations and 10 minutes for the receive operation. Use if you want to specify other values for these operation timeouts. ]]> @@ -115,7 +115,7 @@ if you want to specify other values for these operation timeouts. + The parameterless constructor initializes timeout properties with the service model timeout values when exchanging messages. The default value is 1 minute for open, send, and close operations and 10 minutes for the receive operation. Use if you want to specify other values for these operation timeouts. ]]> @@ -156,7 +156,7 @@ instead of the parameterless constructor if you want to specify custom values for the open, send, receive, and close operation timeouts instead of using the service model default values. + Use instead of the parameterless constructor if you want to specify custom values for the open, send, receive, and close operation timeouts instead of using the service model default values. ]]> @@ -203,7 +203,7 @@ object. The default constructor sets the property to a value of 1 minute. Use if you want to specify another value for this timeout. + This value is set when creating a new object. The default constructor sets the property to a value of 1 minute. Use if you want to specify another value for this timeout. ]]> @@ -250,7 +250,7 @@ object. The default constructor sets the property to a value of 1 minute. Use if you want to specify another value for this timeout. + This value is set when creating a new object. The default constructor sets the property to a value of 1 minute. Use if you want to specify another value for this timeout. ]]> @@ -297,7 +297,7 @@ object. The default constructor sets the property to a value of 10 minutes. Use if you want to specify another value for this timeout. + This value is set when creating a new object. The default constructor sets the property to a value of 10 minutes. Use if you want to specify another value for this timeout. ]]> @@ -344,7 +344,7 @@ object. The default constructor sets the property to a value of 1 minute. Use if you want to specify another value for this timeout. + This value is set when creating a new object. The default constructor sets the property to a value of 1 minute. Use if you want to specify another value for this timeout. ]]> diff --git a/xml/System.ServiceModel.Channels/ChannelFactoryBase`1.xml b/xml/System.ServiceModel.Channels/ChannelFactoryBase`1.xml index 9831199803a..a648b4a1255 100644 --- a/xml/System.ServiceModel.Channels/ChannelFactoryBase`1.xml +++ b/xml/System.ServiceModel.Channels/ChannelFactoryBase`1.xml @@ -61,13 +61,13 @@ The type of channel the factory produces. Provides a common base implementation for channel factories on the client to create channels of a specified type connected to a specified address. - uses the specified address as the destination for outgoing messages. The ServiceAddress.Uri property is used as the To header in the message. The ServiceReference.Via property is used as the physical destination to send messages to. This is typically the same as the ServiceAddress.Uri value. - + uses the specified address as the destination for outgoing messages. The ServiceAddress.Uri property is used as the To header in the message. The ServiceReference.Via property is used as the physical destination to send messages to. This is typically the same as the ServiceAddress.Uri value. + ]]> @@ -81,11 +81,11 @@ Initializes a new instance of the class. - constructor initializes timeout properties with the service model timeout values when exchanging messages. The default value is 1 minute for open, send, and close operations and 10 minutes for the receive operation. Use if you want to specify other values for these operation timeouts. - + constructor initializes timeout properties with the service model timeout values when exchanging messages. The default value is 1 minute for open, send, and close operations and 10 minutes for the receive operation. Use if you want to specify other values for these operation timeouts. + ]]> @@ -124,11 +124,11 @@ Initializes a new instance of the class. - if you want to specify other values for these operation timeouts. - + if you want to specify other values for these operation timeouts. + ]]> @@ -165,11 +165,11 @@ The that specifies the default timeouts for open, send, receive, and close operations when exchanging messages. Initializes a new instance of the class with the default communication timeouts specified. - instead of the parameterless constructor if you want to specify custom values for the open, send, receive, and close operation timeouts instead of using the service model default values. - + instead of the parameterless constructor if you want to specify custom values for the open, send, receive, and close operation timeouts instead of using the service model default values. + ]]> @@ -223,13 +223,13 @@ Creates a particular type of channel with a specified endpoint address. A channel of type with the specified . - when invoked. This method cannot be overridden by a derived class. - - This uses as the transport address to which messages are sent on the output channel. - + when invoked. This method cannot be overridden by a derived class. + + This uses as the transport address to which messages are sent on the output channel. + ]]> @@ -277,11 +277,11 @@ Creates a particular type of channel with specified transport and endpoint addresses. A channel of type with the specified remote and transport addresses. - when invoked. - + when invoked. + ]]> @@ -318,11 +318,11 @@ Aborts each channel managed by the channel factory. - . - + . + ]]> @@ -404,13 +404,13 @@ The that specifies how long the on-close operation has to complete before timing out. Closes all the channels associated with the channel factory within a specified interval of time. - . - + . + ]]> @@ -453,11 +453,11 @@ When implemented in a derived class, provides an extensibility point when creating channels. A channel of type with the specified addresses. - when invoked. - + when invoked. + ]]> @@ -531,11 +531,11 @@ Confirms that the channel factory is opened and ready to create channels. - The communication object is in a or state. diff --git a/xml/System.ServiceModel.Channels/ChannelListenerBase.xml b/xml/System.ServiceModel.Channels/ChannelListenerBase.xml index 6768c48b6e1..d99055b024d 100644 --- a/xml/System.ServiceModel.Channels/ChannelListenerBase.xml +++ b/xml/System.ServiceModel.Channels/ChannelListenerBase.xml @@ -44,7 +44,7 @@ constructor initializes timeout properties with the service model timeout values when exchanging messages. The default value is 1 minute for open, send, and close operations and 10 minutes for the receive operation. Use if you want to specify other values for these operation timeouts. + The default constructor initializes timeout properties with the service model timeout values when exchanging messages. The default value is 1 minute for open, send, and close operations and 10 minutes for the receive operation. Use if you want to specify other values for these operation timeouts. ]]> @@ -69,7 +69,7 @@ if you want to specify other values for these operation timeouts. + The parameterless constructor initializes timeout properties with the service model timeout values when exchanging messages. The default value is 1 minute for open, send, and close operations and 10 minutes for the receive operation. Use if you want to specify other values for these operation timeouts. ]]> @@ -98,7 +98,7 @@ instead of the parameterless constructor if you want to specify custom values for the open, send, receive, and close operation timeouts instead of using the service model default values. + Use instead of the parameterless constructor if you want to specify custom values for the open, send, receive, and close operation timeouts instead of using the service model default values. ]]> @@ -167,7 +167,7 @@ object. The default constructor sets the property to a value of 1 minute. Use if you want to specify another value for this timeout. + This value is set when creating a new object. The default constructor sets the property to a value of 1 minute. Use if you want to specify another value for this timeout. ]]> @@ -202,7 +202,7 @@ object. The default constructor sets the property to a value of 1 minute. Use if you want to specify another value for this timeout. + This value is set when creating a new object. The default constructor sets the property to a value of 1 minute. Use if you want to specify another value for this timeout. ]]> @@ -237,7 +237,7 @@ object. The default constructor sets the property to a value of 10 minutes. Use if you want to specify another value for this timeout. + This value is set when creating a new object. The default constructor sets the property to a value of 10 minutes. Use if you want to specify another value for this timeout. ]]> @@ -272,7 +272,7 @@ object. The default constructor sets the property to a value of 1 minute. Use if you want to specify another value for this timeout. + This value is set when creating a new object. The default constructor sets the property to a value of 1 minute. Use if you want to specify another value for this timeout. ]]> diff --git a/xml/System.ServiceModel.Channels/ChannelListenerBase`1.xml b/xml/System.ServiceModel.Channels/ChannelListenerBase`1.xml index 51e12a0c578..81adef3bd68 100644 --- a/xml/System.ServiceModel.Channels/ChannelListenerBase`1.xml +++ b/xml/System.ServiceModel.Channels/ChannelListenerBase`1.xml @@ -36,11 +36,11 @@ The type of channel the channel listeners accept. Provides a common base implementation for channel listeners on a service to accept channels produced by the client factories. - @@ -53,11 +53,11 @@ Initializes a new instance of the class. - constructor initializes timeout properties with the service model timeout values when exchanging messages. The default value is 1 minute for open, send, and close operations and 10 minutes for the receive operation. Use if you want to specify other values for these operation timeouts. - + constructor initializes timeout properties with the service model timeout values when exchanging messages. The default value is 1 minute for open, send, and close operations and 10 minutes for the receive operation. Use if you want to specify other values for these operation timeouts. + ]]> @@ -84,11 +84,11 @@ Initializes a new instance of the class. - if you want to specify other values for these operation timeouts. - + if you want to specify other values for these operation timeouts. + ]]> @@ -119,11 +119,11 @@ The that specify the default timeouts for open, send, receive, and close operations when exchanging messages. Initializes a new instance of the class with specified default communication timeouts. - instead of the parameterless constructor if you want to specify custom values for the open, send, receive, and close operation timeouts instead of using the service model default values. - + instead of the parameterless constructor if you want to specify custom values for the open, send, receive, and close operation timeouts instead of using the service model default values. + ]]> diff --git a/xml/System.ServiceModel.Channels/ChannelManagerBase.xml b/xml/System.ServiceModel.Channels/ChannelManagerBase.xml index 593687e9da5..71f15a41e28 100644 --- a/xml/System.ServiceModel.Channels/ChannelManagerBase.xml +++ b/xml/System.ServiceModel.Channels/ChannelManagerBase.xml @@ -50,15 +50,15 @@ Provides a base implementation for managing the default timeouts that are associated with channel and listener factories. - and channel manager classes for managing the default timeouts that are associated with the channel factories and listeners. Channels are added to the list maintained by the manager by using one of the methods. Abstract properties for send and receive timeouts used by the channels and listeners that are produced are specified to coordinate the values set for the derived channel and listener factories. - - The , which provides the base implementation for custom channels, gets its default communication timeouts for the open, close, send and receive operations from the associated with it. - - The also takes care of managing the manager for you. In addition to exposing a reference to the manager, the base class also notifies the manager when channels are created and destroyed. But the reference to the manager is only good until the channel is destroyed. - + and channel manager classes for managing the default timeouts that are associated with the channel factories and listeners. Channels are added to the list maintained by the manager by using one of the methods. Abstract properties for send and receive timeouts used by the channels and listeners that are produced are specified to coordinate the values set for the derived channel and listener factories. + + The , which provides the base implementation for custom channels, gets its default communication timeouts for the open, close, send and receive operations from the associated with it. + + The also takes care of managing the manager for you. In addition to exposing a reference to the manager, the base class also notifies the manager when channels are created and destroyed. But the reference to the manager is only good until the channel is destroyed. + ]]> @@ -131,11 +131,11 @@ When overridden in a derived class, gets the default interval of time a channel has to complete the reception of a message. The default that specifies how long the channel has to complete the reception of a message before timing out once the receive method has been invoked. - @@ -172,11 +172,11 @@ When overridden in a derived class, gets the default interval of time a channel has to complete the sending of a message. The default that specifies how long the channel has to complete the sending of a message before timing out once the send method has been invoked. - @@ -216,11 +216,11 @@ Gets the interval of time after which the close method, invoked by a communication object, times out. The that specifies the interval of time to wait for the close method to time out. - @@ -260,11 +260,11 @@ Gets the interval of time after which the open method, invoked by a communication object, times out. The that specifies the interval of time to wait for the open method to time out. - @@ -310,11 +310,11 @@ Gets the interval of time after which the receive method, invoked by a communication object, times out. The that specifies the interval of time to wait for the receive method to time out. - calls . - + calls . + ]]> @@ -360,11 +360,11 @@ Gets the interval of time after which the send method, invoked by a communication object, times out. The that specifies the interval of time to wait for the send method to time out. - calls . - + calls . + ]]> diff --git a/xml/System.ServiceModel.Channels/ChannelParameterCollection.xml b/xml/System.ServiceModel.Channels/ChannelParameterCollection.xml index a4697d81f7b..b1f842f97b9 100644 --- a/xml/System.ServiceModel.Channels/ChannelParameterCollection.xml +++ b/xml/System.ServiceModel.Channels/ChannelParameterCollection.xml @@ -49,11 +49,11 @@ Represents a collection of channel parameters. - @@ -67,11 +67,11 @@ Initializes a new instance of the class. - to `channel` by calling , or simply invoke the parent constructor by calling . - + to `channel` by calling , or simply invoke the parent constructor by calling . + ]]> @@ -110,11 +110,11 @@ Initializes a new instance of the class. - @@ -157,11 +157,11 @@ The channel whose parameters are in this collection. Initializes a new instance of the class. - set to `channel`. - + set to `channel`. + ]]> @@ -204,11 +204,11 @@ Gets the channel whose parameters are in this collection. The whose parameters are in this collection. - is called. - + is called. + ]]> diff --git a/xml/System.ServiceModel.Channels/CommunicationObject.xml b/xml/System.ServiceModel.Channels/CommunicationObject.xml index 2f140e40b52..cd5ff7890e6 100644 --- a/xml/System.ServiceModel.Channels/CommunicationObject.xml +++ b/xml/System.ServiceModel.Channels/CommunicationObject.xml @@ -50,11 +50,11 @@ Provides a common base implementation for the basic state machine common to all communication-oriented objects in the system, including channels, listeners, and the channel and listener factories. - class implements the interface for all communication objects in Windows Communication Foundation (WCF). The method implementations handle parameter validation, raise events that notify the occurrence of state transitions, provide the means to associated additional processing with these state transitions, and ensure that such state changes are coordinated. - + class implements the interface for all communication objects in Windows Communication Foundation (WCF). The method implementations handle parameter validation, raise events that notify the occurrence of state transitions, provide the means to associated additional processing with these state transitions, and ensure that such state changes are coordinated. + ]]> @@ -168,13 +168,13 @@ Causes a communication object to transition immediately from its current state into the closing state. - method can be used to cancel any outstanding operations, including outstanding calls to . - - To gracefully transition a from any state other than into the state, call or one of its asynchronous versions, . - + method can be used to cancel any outstanding operations, including outstanding calls to . + + To gracefully transition a from any state other than into the state, call or one of its asynchronous versions, . + ]]> @@ -230,11 +230,11 @@ Begins an asynchronous operation to close a communication object. The that references the asynchronous close operation. - to gracefully transition from any state, other than the state, into the state within a default interval of time. The method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages). This method calls if the communication object was initially in the state. - + to gracefully transition from any state, other than the state, into the state within a default interval of time. The method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages). This method calls if the communication object was initially in the state. + ]]> The communication object is not in a or state and cannot be modified. @@ -286,11 +286,11 @@ Begins an asynchronous operation to close a communication object with a specified timeout. The that references the asynchronous close operation. - to gracefully transition from any state, other than the state, into the state with in a specified interval of time. The method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages). This method calls if the communication object was initially in the state. - + to gracefully transition from any state, other than the state, into the state with in a specified interval of time. The method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages). This method calls if the communication object was initially in the state. + ]]> The communication object is not in a or state and cannot be modified. @@ -350,13 +350,13 @@ Begins an asynchronous operation to open a communication object. The that references the asynchronous open operation. - method calls and if the communication object is initially in the state. - - To insert processing after a communication object transitions to a closing state due to the invocation of a synchronous operation, use the method. - + method calls and if the communication object is initially in the state. + + To insert processing after a communication object transitions to a closing state due to the invocation of a synchronous operation, use the method. + ]]> The communication object is not in a or state and cannot be modified. @@ -408,13 +408,13 @@ Begins an asynchronous operation to open a communication object within a specified interval of time. The that references the asynchronous open operation. - method calls and if the communication object is initially in the state. - - To insert processing after a communication object transitions to a closing state due to the invocation of a synchronous operation, use the method. - + method calls and if the communication object is initially in the state. + + To insert processing after a communication object transitions to a closing state due to the invocation of a synchronous operation, use the method. + ]]> The communication object is not in a or state and cannot be modified. @@ -468,15 +468,15 @@ Causes a communication object to transition from its current state into the closed state. - to gracefully transition from any state, other than the state, into the state. The method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages. - - The enters the state and remains in it after the method is called until the transition to the state is completed. The transition consists of making successive calls to , , and . - - There is also an asynchronous version of the close method that is initiated by calling . - + to gracefully transition from any state, other than the state, into the state. The method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages. + + The enters the state and remains in it after the method is called until the transition to the state is completed. The transition consists of making successive calls to , , and . + + There is also an asynchronous version of the close method that is initiated by calling . + ]]> The communication object is not in a or state and cannot be modified. @@ -523,15 +523,15 @@ The that specifies how long the close operation has to complete before timing out. Causes a communication object to transition from its current state into the closed state within a specified interval of time. - to gracefully transition from any state, other than the state, into the state within a specified interval of time. The method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages. - - The enters the state and remains in it after the method is called until the transition to the state is completed. The transition consists of making successive calls to , and . - - There is also an asynchronous version of the close method that is initiated by calling . - + to gracefully transition from any state, other than the state, into the state within a specified interval of time. The method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages. + + The enters the state and remains in it after the method is called until the transition to the state is completed. The transition consists of making successive calls to , and . + + There is also an asynchronous version of the close method that is initiated by calling . + ]]> The communication object is not in a or state and cannot be modified. @@ -575,11 +575,11 @@ Occurs when a communication object transitions into the closed state. - event is raised by the method which is called by the and methods. - + event is raised by the method which is called by the and methods. + ]]> @@ -619,11 +619,11 @@ Occurs when a communication object transitions into the closing state. - event is raised by the method which is called by the and methods. - + event is raised by the method which is called by the and methods. + ]]> @@ -734,11 +734,11 @@ The that is returned by a call to the method. Completes an asynchronous operation to close a communication object. - method. - + method. + ]]> The communication object is not in a or state and cannot be modified. @@ -785,11 +785,11 @@ The that is returned by a call to the method. Completes an asynchronous operation to open a communication object. - method. - + method. + ]]> The communication object is not in a or state and cannot be modified. @@ -830,11 +830,11 @@ Causes a communication object to transition from its current state into the faulted state. - event is raised by the method which is called by the method. - + event is raised by the method which is called by the method. + ]]> @@ -874,11 +874,11 @@ Occurs when a communication object transitions into the faulted state. - event is raised by the method which is called by the method. - + event is raised by the method which is called by the method. + ]]> @@ -951,11 +951,11 @@ if the communication object is in a closed state; otherwise, . - event occurs. - + event occurs. + ]]> @@ -992,11 +992,11 @@ Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous abort operation. - method calls if the communication object is not already in a state. - + method calls if the communication object is not already in a state. + ]]> @@ -1041,13 +1041,13 @@ Inserts processing after a communication object transitions to the closing state due to the invocation of an asynchronous close operation. The that references the asynchronous on close operation. - method calls if the communication object is initially in the state. - - To insert processing after a communication object transitions to a closing state due to the invocation of a synchronous operation, use the method. - + method calls if the communication object is initially in the state. + + To insert processing after a communication object transitions to a closing state due to the invocation of a synchronous operation, use the method. + ]]> The communication object is not in a or state and cannot be modified. @@ -1096,11 +1096,11 @@ Inserts processing on a communication object after it transitions to the opening state due to the invocation of an asynchronous open operation. The that references the asynchronous on open operation. - operation, use the method. - + operation, use the method. + ]]> The communication object is not in a or state and cannot be modified. @@ -1144,13 +1144,13 @@ The that specifies how long the on close operation has to complete before timing out. Inserts processing on a communication object after it transitions to the closing state due to the invocation of a synchronous close operation. - method calls if the communication object is initially in the state. - - To insert processing after a communication object transitions to a closing state due to the invocation of an asynchronous operation, use the method. - + method calls if the communication object is initially in the state. + + To insert processing after a communication object transitions to a closing state due to the invocation of an asynchronous operation, use the method. + ]]> @@ -1191,13 +1191,13 @@ Invoked during the transition of a communication object into the closing state. - method calls if the communication object is initially in the state. - - The method calls (and if the communication object is not already in a state. - + method calls if the communication object is initially in the state. + + The method calls (and if the communication object is not already in a state. + ]]> @@ -1234,11 +1234,11 @@ Invoked during the transition of a communication object into the closing state. - method calls if the communication object is initially in the state. - + method calls if the communication object is initially in the state. + ]]> @@ -1278,11 +1278,11 @@ The that is returned by a call to the method. Completes an asynchronous operation on the close of a communication object. - method calls if the communication object is not already in a state. - + method calls if the communication object is not already in a state. + ]]> The communication object is not in a or state and cannot be modified. @@ -1326,11 +1326,11 @@ The that is returned by a call to the method. Completes an asynchronous operation on the open of a communication object. - method calls (and ). - + method calls (and ). + ]]> The communication object is not in a or state and cannot be modified. @@ -1371,11 +1371,11 @@ Inserts processing on a communication object after it transitions to the faulted state due to the invocation of a synchronous fault operation. - event is raised by the method which is called by the method. - + event is raised by the method which is called by the method. + ]]> @@ -1415,13 +1415,13 @@ The that specifies how long the on open operation has to complete before timing out. Inserts processing on a communication object after it transitions into the opening state which must complete within a specified interval of time. - method calls (after calling and before calling ) if the communication object is initially in the state. - - To insert processing as a communication object transitions to a opening state due to the invocation of an asynchronous operation, use the method. - + method calls (after calling and before calling ) if the communication object is initially in the state. + + To insert processing as a communication object transitions to a opening state due to the invocation of an asynchronous operation, use the method. + ]]> The communication object is not in a or state and cannot be modified. @@ -1462,11 +1462,11 @@ Invoked during the transition of a communication object into the opened state. - and methods. - + and methods. + ]]> @@ -1503,11 +1503,11 @@ Invoked during the transition of a communication object into the opening state. - and methods. - + and methods. + ]]> @@ -1521,11 +1521,11 @@ Causes a communication object to transition from the created state into the opened state. - method causes a to enter into the state and calls , , and . The method completes the method by setting the state of the object to the state. - + method causes a to enter into the state and calls , , and . The method completes the method by setting the state of the object to the state. + ]]> @@ -1565,23 +1565,23 @@ Causes a communication object to transition from the created state into the opened state. - is instantiated, it begins in the state. In the state, the object can be configured (for example, properties can be set, or events can be registered), but it is not yet usable to send or receive messages. When called, the method causes a to enter into the state and calls , , and . The method completes the method by setting the state of the object to the state. - - In the - - state, the is usable (for example, messages can be received), but it is no longer configurable. - - There is also an asynchronous version of the open method that is initiated by calling and completed by calling . - -### Credentials Capture with Windows Authentication - When using Windows authentication, credentials used by the service are based on the current context thread. The credentials are obtained when the `Open` method is called. - + is instantiated, it begins in the state. In the state, the object can be configured (for example, properties can be set, or events can be registered), but it is not yet usable to send or receive messages. When called, the method causes a to enter into the state and calls , , and . The method completes the method by setting the state of the object to the state. + + In the + + state, the is usable (for example, messages can be received), but it is no longer configurable. + + There is also an asynchronous version of the open method that is initiated by calling and completed by calling . + +### Credentials Capture with Windows Authentication + When using Windows authentication, credentials used by the service are based on the current context thread. The credentials are obtained when the `Open` method is called. + > [!NOTE] -> For asynchronous calls, credentials are captured when the is invoked. However, the actual credentials cannot be guaranteed. That is, the credentials of the caller may be switched to another identity. For more information, see [Message Security with a Windows Client](/dotnet/framework/wcf/feature-details/message-security-with-a-windows-client). - +> For asynchronous calls, credentials are captured when the is invoked. However, the actual credentials cannot be guaranteed. That is, the credentials of the caller may be switched to another identity. For more information, see [Message Security with a Windows Client](/dotnet/framework/wcf/feature-details/message-security-with-a-windows-client). + ]]> The communication object is not in a or state and cannot be modified. @@ -1630,17 +1630,17 @@ The that specifies how long the open operation has to complete before timing out. Causes a communication object to transition from the created state into the opened state within a specified interval of time. - is instantiated, it begins in the state. In the state, the object can be configured (for example, properties can be set, or events can be registered), but it is not yet usable to send or receive messages. When called, the method causes a to enter into the state and calls , , and . The method completes the method by setting the state of the object to the state. - - In the - - state, the is usable (for example, messages can be received), but it is no longer configurable. - - There is also an asynchronous version of the open method that is initiated by calling and completed by calling . - + is instantiated, it begins in the state. In the state, the object can be configured (for example, properties can be set, or events can be registered), but it is not yet usable to send or receive messages. When called, the method causes a to enter into the state and calls , , and . The method completes the method by setting the state of the object to the state. + + In the + + state, the is usable (for example, messages can be received), but it is no longer configurable. + + There is also an asynchronous version of the open method that is initiated by calling and completed by calling . + ]]> The communication object is not in a or state and cannot be modified. @@ -1684,11 +1684,11 @@ Occurs when a communication object transitions into the opened state. - event is raised by the method which is called by the and methods. - + event is raised by the method which is called by the and methods. + ]]> @@ -1728,11 +1728,11 @@ Occurs when a communication object transitions into the opening state. - event is raised by the method which is called by the and methods. - + event is raised by the method which is called by the and methods. + ]]> @@ -1848,11 +1848,11 @@ Throws an exception if the communication object is disposed. - , or state. A communication object is disposed once is called on it. - + , or state. A communication object is disposed once is called on it. + ]]> The communication object is in a or state. @@ -1887,11 +1887,11 @@ Throws an exception if the communication object the property is not set to the state. - is called on it, the only state that is both mutable and not disposed is the state. - + is called on it, the only state that is both mutable and not disposed is the state. + ]]> The communication object is in a or state. diff --git a/xml/System.ServiceModel.Channels/ConnectionOrientedTransportBindingElement.xml b/xml/System.ServiceModel.Channels/ConnectionOrientedTransportBindingElement.xml index 8fbbe0058df..3180d6711bb 100644 --- a/xml/System.ServiceModel.Channels/ConnectionOrientedTransportBindingElement.xml +++ b/xml/System.ServiceModel.Channels/ConnectionOrientedTransportBindingElement.xml @@ -783,7 +783,7 @@ ## Remarks This method writes binding-related statements into the WSDL information exposed by a particular contract and is used by Windows Communication Foundation (WCF) to communicate to clients the existence of this custom binding element in the binding stack. - This method takes two parameters: the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then use this method to add your own policy assertions to the appropriate collection. + This method takes two parameters: the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then use this method to add your own policy assertions to the appropriate collection. The property exposes the for the endpoint that is being exported. This allows this method to correctly scope their exported policy assertions. For example, security attributes in code may add behaviors to the that indicate where security policy assertions should be added. diff --git a/xml/System.ServiceModel.Channels/ContextExchangeMechanism.xml b/xml/System.ServiceModel.Channels/ContextExchangeMechanism.xml index b701be14dda..ab10f48c124 100644 --- a/xml/System.ServiceModel.Channels/ContextExchangeMechanism.xml +++ b/xml/System.ServiceModel.Channels/ContextExchangeMechanism.xml @@ -31,7 +31,7 @@ property or the constructor to specify the value of the for a conversation between a client and service. + Use the property or the constructor to specify the value of the for a conversation between a client and service. Service endpoints that require support for the context exchange protocol can make this requirement explicit in their published policy. Policy assertions that represent the requirement for the client to support the context exchange protocol at the SOAP level or that require the enabling of HTTP cookie support can be published by an endpoint. The generation of these assertions into the policy on the service is controlled by the value of the property as follows: diff --git a/xml/System.ServiceModel.Channels/ContextMessageProperty.xml b/xml/System.ServiceModel.Channels/ContextMessageProperty.xml index ae22b96c67f..68766a3765b 100644 --- a/xml/System.ServiceModel.Channels/ContextMessageProperty.xml +++ b/xml/System.ServiceModel.Channels/ContextMessageProperty.xml @@ -37,15 +37,15 @@ A property used to communicate context between the application and channel layers on either the client or the service. - that correlates messages that form part of a conversation between a client and a service. - - If is `true`, context is established at the channel layer, and all incoming messages on the client and the service have this context property attached by the context channel. If is `false` the is used to attach context to an outgoing message on the client or the service at the application layer. - - The can be used on the client or on the service. Alternatively, on the client only, the current context can be obtained or a new context can be set on channel instance using and properties. - + that correlates messages that form part of a conversation between a client and a service. + + If is `true`, context is established at the channel layer, and all incoming messages on the client and the service have this context property attached by the context channel. If is `false` the is used to attach context to an outgoing message on the client or the service at the application layer. + + The can be used on the client or on the service. Alternatively, on the client only, the current context can be obtained or a new context can be set on channel instance using and properties. + ]]> @@ -134,11 +134,11 @@ The whose context message property is to be set. Sets the value of the property in a specified from the current instance of . - method overwrites the value of the `ContextMessageProperty` property if a value is already set. - + method overwrites the value of the `ContextMessageProperty` property if a value is already set. + ]]> diff --git a/xml/System.ServiceModel.Channels/CorrelationCallbackMessageProperty.xml b/xml/System.ServiceModel.Channels/CorrelationCallbackMessageProperty.xml index 29a72d7e7d7..55d24045dd3 100644 --- a/xml/System.ServiceModel.Channels/CorrelationCallbackMessageProperty.xml +++ b/xml/System.ServiceModel.Channels/CorrelationCallbackMessageProperty.xml @@ -20,11 +20,11 @@ Provides an abstract base class for deferring correlation key calculation until all of the correlation data is available. - @@ -104,11 +104,11 @@ Provides the value of the correlation data. Adds required correlation data to the property. - list. When all required data has been added, the list is empty and returns `true`. - + list. When all required data has been added, the list is empty and returns `true`. + ]]> @@ -142,15 +142,15 @@ Called by a correlation protocol when all of the correlation information is available to asynchronously construct the correlation. A reference to the current asynchronous operation. - to construct the correlation. Applications must provide an implementation of , which asynchronously performs the correlation calculation of the specified message. - - To be notified when the asynchronous operation is complete, call from the `callback` method. If is called before the asynchronous operation is complete, it blocks until the operation completes. If the operation does not complete within the specified time-out interval a is thrown. - - This method is an asynchronous version of using the asynchronous design pattern. For more information, see [Asynchronous Programming Overview](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-model-apm). - + to construct the correlation. Applications must provide an implementation of , which asynchronously performs the correlation calculation of the specified message. + + To be notified when the asynchronous operation is complete, call from the `callback` method. If is called before the asynchronous operation is complete, it blocks until the operation completes. If the operation does not complete within the specified time-out interval a is thrown. + + This method is an asynchronous version of using the asynchronous design pattern. For more information, see [Asynchronous Programming Overview](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-model-apm). + ]]> @@ -203,15 +203,15 @@ Returns the message that was prepared asynchronously for correlation. The message that was prepared for correlation. - to retrieve the message. Applications must provide an implementation of , which returns the message that was prepared for correlation. - - If is called before the asynchronous operation is complete, it blocks until the operation completes. If the operation did not complete within the time-out interval specified in the call to a is thrown when this method is called. - - This method completes the asynchronous version of using the asynchronous design pattern. For more information, see [Asynchronous Programming Overview](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-model-apm). - + to retrieve the message. Applications must provide an implementation of , which returns the message that was prepared for correlation. + + If is called before the asynchronous operation is complete, it blocks until the operation completes. If the operation did not complete within the time-out interval specified in the call to a is thrown when this method is called. + + This method completes the asynchronous version of using the asynchronous design pattern. For more information, see [Asynchronous Programming Overview](/dotnet/standard/asynchronous-programming-patterns/asynchronous-programming-model-apm). + ]]> @@ -241,11 +241,11 @@ Called by a correlation protocol when all of the correlation information is available to construct the correlation. The correlated message. - to construct the correlation. Applications must provide an implementation of , which performs the correlation calculation of the specified message. - + to construct the correlation. Applications must provide an implementation of , which performs the correlation calculation of the specified message. + ]]> @@ -270,11 +270,11 @@ if all of the required correlation data is present; otherwise, . - list is empty and returns `true`. - + list is empty and returns `true`. + ]]> @@ -350,11 +350,11 @@ When overridden in a derived class, asynchronously performs the correlation calculation for the specified message. A reference to the current asynchronous operation. - . - + . + ]]> @@ -382,11 +382,11 @@ When overridden in a derived class, returns the message that was prepared asynchronously for correlation. The correlated message. - . - + . + ]]> @@ -416,11 +416,11 @@ When overridden in a derived class, performs the correlation calculation for the specified message. The correlated message. - . - + . + ]]> diff --git a/xml/System.ServiceModel.Channels/CustomBinding.xml b/xml/System.ServiceModel.Channels/CustomBinding.xml index 4193f3e720c..4c4c871733e 100644 --- a/xml/System.ServiceModel.Channels/CustomBinding.xml +++ b/xml/System.ServiceModel.Channels/CustomBinding.xml @@ -57,7 +57,7 @@ ## Remarks Use a custom binding when one of the system-provided bindings does not meet the requirements of your service. A custom binding could be used, for example, to enable the use of a new transport or a new encoder at a service endpoint. - A custom binding is constructed using one of the from a collection of binding elements that are "stacked" in a specific order: + A custom binding is constructed using one of the from a collection of binding elements that are "stacked" in a specific order: - At the top is an optional that allows flowing transactions. diff --git a/xml/System.ServiceModel.Channels/FaultConverter.xml b/xml/System.ServiceModel.Channels/FaultConverter.xml index 03b3de043eb..d2ca541277e 100644 --- a/xml/System.ServiceModel.Channels/FaultConverter.xml +++ b/xml/System.ServiceModel.Channels/FaultConverter.xml @@ -181,7 +181,7 @@ - If not recognized, convert it by a call to `GetProperty` on the inner channel. - Transport channels should delegate to to get the default SOAP/WS-Addressing fault converter. + Transport channels should delegate to to get the default SOAP/WS-Addressing fault converter. ]]> @@ -229,7 +229,7 @@ ` and override this method to do the following. If a layer can convert the exception it does; otherwise it calls `GetProperty` on its inner channel. Transport channels should delegate to to get the default SOAP/WS-Addressing fault converter. + Channels that support fault conversion implement `GetProperty` and override this method to do the following. If a layer can convert the exception it does; otherwise it calls `GetProperty` on its inner channel. Transport channels should delegate to to get the default SOAP/WS-Addressing fault converter. ]]> @@ -279,7 +279,7 @@ is an abstract class that you must implement. The current method wraps several parameter error tests around a call to that method. + is an abstract class that you must implement. The current method wraps several parameter error tests around a call to that method. ]]> @@ -333,7 +333,7 @@ is an abstract class that you must implement. The current method wraps several error tests around a call to that method. + is an abstract class that you must implement. The current method wraps several error tests around a call to that method. ]]> diff --git a/xml/System.ServiceModel.Channels/HttpRequestMessageExtensionMethods.xml b/xml/System.ServiceModel.Channels/HttpRequestMessageExtensionMethods.xml index 2425d442d87..6cb64f1125f 100644 --- a/xml/System.ServiceModel.Channels/HttpRequestMessageExtensionMethods.xml +++ b/xml/System.ServiceModel.Channels/HttpRequestMessageExtensionMethods.xml @@ -122,11 +122,11 @@ Creates a instance from an instance. The new instance. - instance can be read, written and copied just as a traditional instance. The instance can also "read" to retrieve the original instance by calling the extension method. - + instance can be read, written and copied just as a traditional instance. The instance can also "read" to retrieve the original instance by calling the extension method. + ]]> diff --git a/xml/System.ServiceModel.Channels/HttpResponseMessageExtensionMethods.xml b/xml/System.ServiceModel.Channels/HttpResponseMessageExtensionMethods.xml index afbdde83fbd..746cc40c868 100644 --- a/xml/System.ServiceModel.Channels/HttpResponseMessageExtensionMethods.xml +++ b/xml/System.ServiceModel.Channels/HttpResponseMessageExtensionMethods.xml @@ -41,11 +41,11 @@ Creates a instance from an instance. The new instance. - instance can be read, written and copied just as a traditional instance. The instance can also "read" to retrieve the original instance by calling the extension method. - + instance can be read, written and copied just as a traditional instance. The instance can also "read" to retrieve the original instance by calling the extension method. + ]]> diff --git a/xml/System.ServiceModel.Channels/HttpTransportBindingElement.xml b/xml/System.ServiceModel.Channels/HttpTransportBindingElement.xml index 2a8ae1c6053..03183926af7 100644 --- a/xml/System.ServiceModel.Channels/HttpTransportBindingElement.xml +++ b/xml/System.ServiceModel.Channels/HttpTransportBindingElement.xml @@ -1417,7 +1417,7 @@ Console.WriteLine("The scheme of the binding is {0}.",httpBinding.Scheme); ## Remarks This method writes binding-related statements into the WSDL information exposed by a particular contract and is used by Windows Communication Foundation (WCF) to communicate to clients the existence of this custom binding element in the binding stack. - This method takes two parameters: the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then use this method to add your own policy assertions to the appropriate collection. + This method takes two parameters: the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then use this method to add your own policy assertions to the appropriate collection. The property exposes the for the endpoint that is being exported. This allows this method to correctly scope their exported policy assertions. For example, security attributes in code may add behaviors to the that indicate where security policy assertions should be added. diff --git a/xml/System.ServiceModel.Channels/IBindingRuntimePreferences.xml b/xml/System.ServiceModel.Channels/IBindingRuntimePreferences.xml index 07720d3b368..cec4ab60706 100644 --- a/xml/System.ServiceModel.Channels/IBindingRuntimePreferences.xml +++ b/xml/System.ServiceModel.Channels/IBindingRuntimePreferences.xml @@ -28,9 +28,9 @@ or methods. A class can optionally implement to indicate to callers that this is preferred. + In some cases it may be more efficient for a binding to process messages with the synchronous or methods. A class can optionally implement to indicate to callers that this is preferred. - If a binding does not implement , the Windows Communication Foundation (WCF) Service Model Runtime layer defaults to using the asynchronous versions of the `Receive` and `Request` methods. If a binding does implement , the WCF Service Model Runtime layer checks the value of and uses that to determine whether to call the synchronous versions of these methods ( or ) or the asynchronous versions ( and or and ). If is implemented by the binding and returns `true` from the property, it is recommended that you use the synchronous and methods to receive messages from the channel. If the binding does not implement or returns `false` from the property, it is recommended that you use the asynchronous and or and methods. + If a binding does not implement , the Windows Communication Foundation (WCF) Service Model Runtime layer defaults to using the asynchronous versions of the `Receive` and `Request` methods. If a binding does implement , the WCF Service Model Runtime layer checks the value of and uses that to determine whether to call the synchronous versions of these methods ( or ) or the asynchronous versions ( and or and ). If is implemented by the binding and returns `true` from the property, it is recommended that you use the synchronous and methods to receive messages from the channel. If the binding does not implement or returns `false` from the property, it is recommended that you use the asynchronous and or and methods. Regardless of the value returned by the property, all bindings must still provide valid implementations of both the synchronous and asynchronous versions of the `Receive` methods for the specific channel types implemented. For more information about implementing custom channels, see [Developing Channels](/dotnet/framework/wcf/extending/developing-channels). diff --git a/xml/System.ServiceModel.Channels/IChannel.xml b/xml/System.ServiceModel.Channels/IChannel.xml index 837dd250404..bacc3f629f9 100644 --- a/xml/System.ServiceModel.Channels/IChannel.xml +++ b/xml/System.ServiceModel.Channels/IChannel.xml @@ -48,30 +48,30 @@ Defines the basic interface that all channel objects must implement. It requires that they implement the state machine interface shared by all communication objects and that they implement a method to retrieve objects from the channel stack. - interface. - - The interface adds the - - method to the interface. This method provides a mechanism for retrieving properties from the channel stack regardless of where in the stack those properties live. The term "property" in the method name refers to a piece of information that belongs to one of the channels in the stack. The CLR type for that property is determined by `T`. This method of retrieval is also used on channel factories and channel listeners. - - `IChannel` is inherited by each of the channel interfaces associated with the basic message-exchange patterns: - -- for receiving messages. - -- for sending messages. - -- for sending a request. - -- for sending a reply. - -- for bi-directional messaging. - + Channels must satisfy the contract of a state machine as defined by the interface. + + The interface adds the + + method to the interface. This method provides a mechanism for retrieving properties from the channel stack regardless of where in the stack those properties live. The term "property" in the method name refers to a piece of information that belongs to one of the channels in the stack. The CLR type for that property is determined by `T`. This method of retrieval is also used on channel factories and channel listeners. + + `IChannel` is inherited by each of the channel interfaces associated with the basic message-exchange patterns: + +- for receiving messages. + +- for sending messages. + +- for sending a request. + +- for sending a reply. + +- for bi-directional messaging. + ]]> @@ -117,18 +117,18 @@ Returns a typed object requested, if present, from the appropriate layer in the channel stack. The typed object requested if it is present or if it is not. - diff --git a/xml/System.ServiceModel.Channels/IChannelFactory.xml b/xml/System.ServiceModel.Channels/IChannelFactory.xml index a65406150e1..8061a0d43d6 100644 --- a/xml/System.ServiceModel.Channels/IChannelFactory.xml +++ b/xml/System.ServiceModel.Channels/IChannelFactory.xml @@ -48,13 +48,13 @@ Defines the interface that must be implemented by a channel factory to produce channels. - interface represents the base interface for channel factories. - - Channel factories and their associated channels are generally used by the clients of a service that initiate communication. Listener factories that implement the interface and their associated listeners, by contrast, provide the mechanisms used to accept the channels through which communications with a service is initiated. - + interface represents the base interface for channel factories. + + Channel factories and their associated channels are generally used by the clients of a service that initiate communication. Listener factories that implement the interface and their associated listeners, by contrast, provide the mechanisms used to accept the channels through which communications with a service is initiated. + ]]> @@ -100,13 +100,13 @@ Returns a typed object requested, if present, from the appropriate layer in the channel stack. The typed object requested, if it is present, or if it is not. - whenever you implement a channel factory. is an excellent way to communicate information along the channel factory stack without having to know what channel factories are below you, or what channel factories above you are interested in performing queries. Define interfaces for people to query on for any interesting information you have. Whenever you do not recognize the type argument for , delegate down to the next channel factory in the stack or return `null` if you are creating a new transport channel at the bottom of the stack. - + whenever you implement a channel factory. is an excellent way to communicate information along the channel factory stack without having to know what channel factories are below you, or what channel factories above you are interested in performing queries. Define interfaces for people to query on for any interesting information you have. Whenever you do not recognize the type argument for , delegate down to the next channel factory in the stack or return `null` if you are creating a new transport channel at the bottom of the stack. + ]]> diff --git a/xml/System.ServiceModel.Channels/IChannelFactory`1.xml b/xml/System.ServiceModel.Channels/IChannelFactory`1.xml index 6a52605199c..75919e2956a 100644 --- a/xml/System.ServiceModel.Channels/IChannelFactory`1.xml +++ b/xml/System.ServiceModel.Channels/IChannelFactory`1.xml @@ -55,11 +55,11 @@ The type of channel that the channel factory creates. Defines the interface that must be implemented by channel factories that create type-specific channels. - contract allows users to create multiple channels of a given type without having to specify the channel type each time. In other words, defining the channel type as a generic parameter for the channel factory implementing the interface means that it is not necessary to pass the type into the methods. If users want to create different channel types, they can create additional channel factories for each type of channel required. The overload allows you to distinguish the address to which the message is initially sent from the ultimate destination. For a discussion of addressing, see the [Addresses](/dotnet/framework/wcf/feature-details/endpoint-addresses) topic. - + contract allows users to create multiple channels of a given type without having to specify the channel type each time. In other words, defining the channel type as a generic parameter for the channel factory implementing the interface means that it is not necessary to pass the type into the methods. If users want to create different channel types, they can create additional channel factories for each type of channel required. The overload allows you to distinguish the address to which the message is initially sent from the ultimate destination. For a discussion of addressing, see the [Addresses](/dotnet/framework/wcf/feature-details/endpoint-addresses) topic. + ]]> @@ -73,11 +73,11 @@ Creates a channel of a specified type to a specified endpoint address. - overload to distinguish the address to which the message is initially sent from the ultimate destination when you want to do manual routing. Note that any channels created by this channel factory are closed when the channel factory is closed. For a discussion of addressing, see the [Addresses](/dotnet/framework/wcf/feature-details/endpoint-addresses) topic. - + overload to distinguish the address to which the message is initially sent from the ultimate destination when you want to do manual routing. Note that any channels created by this channel factory are closed when the channel factory is closed. For a discussion of addressing, see the [Addresses](/dotnet/framework/wcf/feature-details/endpoint-addresses) topic. + ]]> @@ -118,11 +118,11 @@ Creates a channel of a specified type to a specified endpoint address. A channel of type to the specified endpoint address. - overload to distinguish the address to which the message is initially sent from the ultimate destination when you want to do manual routing. Note that any channels created by this channel factory are closed when the channel factory is closed. - + overload to distinguish the address to which the message is initially sent from the ultimate destination when you want to do manual routing. Note that any channels created by this channel factory are closed when the channel factory is closed. + ]]> @@ -165,11 +165,11 @@ Creates a channel of a specified type to a specified endpoint address and transport address to which messages are sent. A channel of type to the specified endpoint address and transport address. - of the final `to` address of the service. You only distinguish between these two addresses when you want to do some kind of manual routing. Note that any channels created by this channel factory are closed when the channel factory is closed. For a discussion of addressing, see the [Addresses](/dotnet/framework/wcf/feature-details/endpoint-addresses) topic. - + of the final `to` address of the service. You only distinguish between these two addresses when you want to do some kind of manual routing. Note that any channels created by this channel factory are closed when the channel factory is closed. For a discussion of addressing, see the [Addresses](/dotnet/framework/wcf/feature-details/endpoint-addresses) topic. + ]]> diff --git a/xml/System.ServiceModel.Channels/IChannelListener`1.xml b/xml/System.ServiceModel.Channels/IChannelListener`1.xml index 5b192b261f9..a68c6eab21a 100644 --- a/xml/System.ServiceModel.Channels/IChannelListener`1.xml +++ b/xml/System.ServiceModel.Channels/IChannelListener`1.xml @@ -40,13 +40,13 @@ The type of channel that the channel listener accepts. Defines the interface that must be implemented by channel listeners to accept type-specific channels. - or interfaces provide services with the mechanisms used to accept the channels produced by clients that initiate and enable communication with a service. - - Implementing the contract allows users to accept multiple channels of a given type without having to specify the channel type each time. In other words, defining the channel type as a generic parameter for the interface means that it is not necessary to pass the type into the methods. If users want to accept different channel types, they can create additional channel listeners for each type of channel required. - + or interfaces provide services with the mechanisms used to accept the channels produced by clients that initiate and enable communication with a service. + + Implementing the contract allows users to accept multiple channels of a given type without having to specify the channel type each time. In other words, defining the channel type as a generic parameter for the interface means that it is not necessary to pass the type into the methods. If users want to accept different channel types, they can create additional channel listeners for each type of channel required. + ]]> @@ -59,11 +59,11 @@ Accepts a channel of a specified type for communication with a client. - overload with the explicit timeout be used. The `timeout` specified for that method overrides any default timeouts set by the system for the service. - + overload with the explicit timeout be used. The `timeout` specified for that method overrides any default timeouts set by the system for the service. + ]]> @@ -97,11 +97,11 @@ Accepts a channel of a specified type for communication with a client. A channel of type accepted by the listener. - overload with the explicit timeout be used. The `timeout` specified for that method overrides any default timeouts set by the system for the service. - + overload with the explicit timeout be used. The `timeout` specified for that method overrides any default timeouts set by the system for the service. + ]]> @@ -138,11 +138,11 @@ Accepts a channel of a specified type for communication with a client within a specified interval of time. A channel of type accepted by the listener. - . The `timeout` specified for this method overrides any default timeouts set by the system for the service. - + . The `timeout` specified for this method overrides any default timeouts set by the system for the service. + ]]> @@ -155,11 +155,11 @@ Begins an asynchronous operation to accept a channel within a specified or default interval of time. - overload with the explicit timeout be used. The `timeout` specified for that method overrides any default timeouts set by the system for the service. - + overload with the explicit timeout be used. The `timeout` specified for that method overrides any default timeouts set by the system for the service. + ]]> @@ -198,11 +198,11 @@ Begins an asynchronous operation to accept a channel. The that references the asynchronous acceptance of a channel operation. - overload with the explicit timeout be used. The `timeout` specified for that method overrides any default timeouts set by the system for the service. - + overload with the explicit timeout be used. The `timeout` specified for that method overrides any default timeouts set by the system for the service. + ]]> @@ -243,11 +243,11 @@ Begins an asynchronous operation to accept a channel within a specified interval of time. The that references the asynchronous acceptance of a channel operation. - . The `timeout` specified for this method overrides any default timeouts set by the system for the service. - + . The `timeout` specified for this method overrides any default timeouts set by the system for the service. + ]]> diff --git a/xml/System.ServiceModel.Channels/IContextManager.xml b/xml/System.ServiceModel.Channels/IContextManager.xml index 599f57f8e05..1049ece8e4a 100644 --- a/xml/System.ServiceModel.Channels/IContextManager.xml +++ b/xml/System.ServiceModel.Channels/IContextManager.xml @@ -29,7 +29,7 @@ with the value set, the context cannot be retrieved on the client using because a new channel that establishes a session is created each time is called to enforce semantics on a channel. This means that even though the context is properly propagated back to the client in this case, it cannot be retrieved using . You can still retrieve it using as shown in the following code. + For channels that use with the value set, the context cannot be retrieved on the client using because a new channel that establishes a session is created each time is called to enforce semantics on a channel. This means that even though the context is properly propagated back to the client in this case, it cannot be retrieved using . You can still retrieve it using as shown in the following code. ```csharp using (new OperationContextScope((IContextChannel)channel)) @@ -75,11 +75,11 @@ using (new OperationContextScope((IContextChannel)channel)) method on it. The channel can also be pre-initialized with context before being opened by calling the method on the channel property. Once the channel is initialized with context it cannot be reset. + When context management is enabled the context channel caches the context in its lifetime. Context can be retrieved from the channel through the `IContextManager` channel property by calling method on it. The channel can also be pre-initialized with context before being opened by calling the method on the channel property. Once the channel is initialized with context it cannot be reset. The following are invariants in this mode: -- Any call to after the channel is open throws an `InvalidOperationException`. +- Any call to after the channel is open throws an `InvalidOperationException`. - Any attempt to send context through the `ContextMessageProperty` in an outgoing message throws `InvalidOperationException`. @@ -87,7 +87,7 @@ using (new OperationContextScope((IContextChannel)channel)) - The `ContextMessageProperty` on an incoming message is always `null`. - When context management is not enabled, the context channel does not manage context. It is the application's responsibility to retrieve, manage and apply context through the `ContextMessageProperty`. Any attempt to call or using through the `IContextManager` channel property results in `InvalidOperationException`. + When context management is not enabled, the context channel does not manage context. It is the application's responsibility to retrieve, manage and apply context through the `ContextMessageProperty`. Any attempt to call or using through the `IContextManager` channel property results in `InvalidOperationException`. All HTTP cookies, except for context HTTP cookies, are handled at the channel level. Context HTTP cookies are managed at the application level. This can have unexpected consequences when channels are shared to talk to different instances targeted by . The following table shows how HTTP cookies are affected when is set to either `true` or `false`. diff --git a/xml/System.ServiceModel.Channels/IDuplexSession.xml b/xml/System.ServiceModel.Channels/IDuplexSession.xml index 41ea64ea293..9227ea2ed6b 100644 --- a/xml/System.ServiceModel.Channels/IDuplexSession.xml +++ b/xml/System.ServiceModel.Channels/IDuplexSession.xml @@ -58,9 +58,9 @@ interface is the union of the inbound session, defined by the interface, and the outbound session, defined by the interface. Either the inbound session or outbound session can be terminated independently of the other. The outbound session can be terminated synchronously by calling or asynchronously by calling . + The interface is the union of the inbound session, defined by the interface, and the outbound session, defined by the interface. Either the inbound session or outbound session can be terminated independently of the other. The outbound session can be terminated synchronously by calling or asynchronously by calling . - The inbound session can be remotely terminated. The associated with the inbound session starts returning `null` when that session is shutdown. + The inbound session can be remotely terminated. The associated with the inbound session starts returning `null` when that session is shutdown. ]]> @@ -217,7 +217,7 @@ signals to the other side of the session that it should return `null` from any outstanding or subsequent calls made to . is idempotent, so calling it again has no effect. + Calling signals to the other side of the session that it should return `null` from any outstanding or subsequent calls made to . is idempotent, so calling it again has no effect. Terminating the outbound session does not affect the incoming session and so makes no statement about the ability to receive messages on the session associated with the input channel. @@ -277,7 +277,7 @@ signals to the other side of the session that it should return `null` from any outstanding or subsequent calls made to . is idempotent, so calling it again has no effect. + Calling signals to the other side of the session that it should return `null` from any outstanding or subsequent calls made to . is idempotent, so calling it again has no effect. Terminating the outbound session does not affect the incoming session and so makes no statement about the ability to receive messages on the session associated with the input channel. diff --git a/xml/System.ServiceModel.Channels/IDuplexSessionChannel.xml b/xml/System.ServiceModel.Channels/IDuplexSessionChannel.xml index 1e7d79f361b..16c5297c59c 100644 --- a/xml/System.ServiceModel.Channels/IDuplexSessionChannel.xml +++ b/xml/System.ServiceModel.Channels/IDuplexSessionChannel.xml @@ -74,7 +74,7 @@ The interface indicates that an implements semantics. - Given an , its associated can be retrieved through the property. + Given an , its associated can be retrieved through the property. ]]> diff --git a/xml/System.ServiceModel.Channels/IInputChannel.xml b/xml/System.ServiceModel.Channels/IInputChannel.xml index 475d54a9942..d300a638b65 100644 --- a/xml/System.ServiceModel.Channels/IInputChannel.xml +++ b/xml/System.ServiceModel.Channels/IInputChannel.xml @@ -59,7 +59,7 @@ The contract includes synchronous and asynchronous variants of receive, try-to-receive and wait-for-a-message functionality. - The pull model is used typically with an to receive messages: you call (to "pull" a message out of the channel) and then wait for a message to arrive. An alternative usage pattern is to call or , and then call . This approach is common for transactional usages where you start the transaction between the calls to and . + The pull model is used typically with an to receive messages: you call (to "pull" a message out of the channel) and then wait for a message to arrive. An alternative usage pattern is to call or , and then call . This approach is common for transactional usages where you start the transaction between the calls to and . An is not necessarily bound to a single sender. Other channels and channel interfaces can provide a correlation between particular senders and an , but the base contract makes no such restriction. An implementation can create a new for each message or reuse the same for multiple messages and senders. @@ -79,7 +79,7 @@ method when you want the application processing to continue without waiting for the request to be received. Use the synchronous method when it is acceptable for the current thread to be blocked until the request message is received or the interval of time specified by the `timeout` has been exceeded. The asynchronous operation is available with or without an explicit timeout. + Use the asynchronous method when you want the application processing to continue without waiting for the request to be received. Use the synchronous method when it is acceptable for the current thread to be blocked until the request message is received or the interval of time specified by the `timeout` has been exceeded. The asynchronous operation is available with or without an explicit timeout. ]]> @@ -126,7 +126,7 @@ method when you want the application processing to continue without waiting for the request to be received. Use the synchronous method when it is acceptable for the current thread to be blocked until the request message is received or the interval of time specified by the `timeout` has been exceeded. The asynchronous operation is available with or without an explicit timeout. + Use the asynchronous method when you want the application processing to continue without waiting for the request to be received. Use the synchronous method when it is acceptable for the current thread to be blocked until the request message is received or the interval of time specified by the `timeout` has been exceeded. The asynchronous operation is available with or without an explicit timeout. This method receives notification, through a callback, of the identity of the event handler for the operation. The operation is not complete until a message becomes available in the channel. @@ -184,7 +184,7 @@ method when you want the application processing to continue without waiting for the request to be received. Use the synchronous method when it is acceptable for the current thread to be blocked until the request message is received or the interval of time specified by the `timeout` has been exceeded. The asynchronous operation is available with or without an explicit timeout. + Use the asynchronous method when you want the application processing to continue without waiting for the request to be received. Use the synchronous method when it is acceptable for the current thread to be blocked until the request message is received or the interval of time specified by the `timeout` has been exceeded. The asynchronous operation is available with or without an explicit timeout. The operation is not complete until either a message becomes available in the channel or the time out occurs. @@ -247,13 +247,13 @@ method when you want the application processing to continue without waiting. Use the synchronous method when it is acceptable for the current thread to be blocked while it replies to the request message or until the timeout interval is exceeded. + Use the asynchronous method when you want the application processing to continue without waiting. Use the synchronous method when it is acceptable for the current thread to be blocked while it replies to the request message or until the timeout interval is exceeded. The operation is not complete until either a message becomes available in the channel or the timeout occurs. - If you are going to handle timeouts and not just re-throw or wrap the , then you should call instead of . + If you are going to handle timeouts and not just re-throw or wrap the , then you should call instead of . - If you are not going to treat timeouts specially then just call , otherwise you lose error information. + If you are not going to treat timeouts specially then just call , otherwise you lose error information. @@ -314,7 +314,7 @@ method if you need the application processing to continue without waiting for the message to arrive. Use the synchronous method when it is acceptable for the current thread to be blocked while it waits for a message to arrive in the queue. The thread is blocked up to the specified `timeout`. + Use the asynchronous method if you need the application processing to continue without waiting for the message to arrive. Use the synchronous method when it is acceptable for the current thread to be blocked while it waits for a message to arrive in the queue. The thread is blocked up to the specified `timeout`. This method receives notification, through a callback, of the identity of the event handler for the operation. The operation is not complete until either a message becomes available in the channel or the time out occurs. @@ -545,9 +545,9 @@ method when it is acceptable for the current thread to be blocked until it receives the request message or exceeds the interval of time specified by `timeout`. Use the asynchronous method when you need the application processing to continue without waiting for the request to be received. + Use the synchronous method when it is acceptable for the current thread to be blocked until it receives the request message or exceeds the interval of time specified by `timeout`. Use the asynchronous method when you need the application processing to continue without waiting for the request to be received. - The synchronous operation is available with or without an explicit timeout. + The synchronous operation is available with or without an explicit timeout. If a message is not available, it blocks until one is available or until the timeout is exceeded. @@ -591,13 +591,13 @@ method when it is acceptable for the current thread to be blocked until it receives the request message or exceeds the interval of time specified by `timeout`. Use the asynchronous method when you want the application processing to continue without waiting for the request to be received. + Use the synchronous method when it is acceptable for the current thread to be blocked until it receives the request message or exceeds the interval of time specified by `timeout`. Use the asynchronous method when you want the application processing to continue without waiting for the request to be received. - The synchronous operation is available with or without an explicit timeout. + The synchronous operation is available with or without an explicit timeout. If a message is not available, it blocks until one is available or until the timeout is exceeded. - can be called multiple times or concurrently. Only one call can complete for each message received. + can be called multiple times or concurrently. Only one call can complete for each message received. @@ -649,13 +649,13 @@ method when it is acceptable for the current thread to be blocked until it receives the request message or exceeds the interval of time specified by `timeout`. Use the asynchronous method when you want the application processing to continue without waiting for the request to be received. + Use the synchronous method when it is acceptable for the current thread to be blocked until it receives the request message or exceeds the interval of time specified by `timeout`. Use the asynchronous method when you want the application processing to continue without waiting for the request to be received. - The synchronous operation is available with or without an explicit timeout. + The synchronous operation is available with or without an explicit timeout. If a message is not available, it blocks until one is available or until the timeout is exceeded. - can be called multiple times or concurrently. Only one call can complete for each message received. + can be called multiple times or concurrently. Only one call can complete for each message received. @@ -712,9 +712,9 @@ , then you should call instead of . + If you are going to handle timeouts and not just re-throw or wrap the , then you should call instead of . - If you are not going to treat timeouts specially then just call , otherwise you will lose error information. + If you are not going to treat timeouts specially then just call , otherwise you will lose error information. @@ -769,13 +769,13 @@ does not result in a message being received or processed in any other way. + Calling does not result in a message being received or processed in any other way. - The method exists primarily for transacted scenarios where the user wants to receive the message using a transaction. When using just normally for this, the user must create the transaction and then call and hope the message arrives before the transaction times out, which may not be possible. + The method exists primarily for transacted scenarios where the user wants to receive the message using a transaction. When using just normally for this, the user must create the transaction and then call and hope the message arrives before the transaction times out, which may not be possible. - Instead, the user can call with whatever time out they want (even infinite), then when a message arrives they can open the transaction, call and be confident that they can get the message back before the transaction expires. + Instead, the user can call with whatever time out they want (even infinite), then when a message arrives they can open the transaction, call and be confident that they can get the message back before the transaction expires. - This method is synchronous, so it blocks the current thread until a message is available or the time out occurs. Use when it is acceptable for the current thread to be blocked while it waits for a message to arrive in the queue. The thread is blocked up to the specified `timeout`. If you need the application processing to continue without waiting, use the asynchronous method. + This method is synchronous, so it blocks the current thread until a message is available or the time out occurs. Use when it is acceptable for the current thread to be blocked while it waits for a message to arrive in the queue. The thread is blocked up to the specified `timeout`. If you need the application processing to continue without waiting, use the asynchronous method. diff --git a/xml/System.ServiceModel.Channels/IInputSessionChannel.xml b/xml/System.ServiceModel.Channels/IInputSessionChannel.xml index d772caa4fdb..2584cda630b 100644 --- a/xml/System.ServiceModel.Channels/IInputSessionChannel.xml +++ b/xml/System.ServiceModel.Channels/IInputSessionChannel.xml @@ -67,7 +67,7 @@ The interface indicates that an implements semantics. - The associated with an can be retrieved through the property. + The associated with an can be retrieved through the property. ]]> diff --git a/xml/System.ServiceModel.Channels/IOutputChannel.xml b/xml/System.ServiceModel.Channels/IOutputChannel.xml index 83d26eca48f..4859503ac20 100644 --- a/xml/System.ServiceModel.Channels/IOutputChannel.xml +++ b/xml/System.ServiceModel.Channels/IOutputChannel.xml @@ -57,7 +57,7 @@ [!INCLUDE [untrusted-data-interface-note](~/includes/untrusted-data-interface-note.md)] - The interface defines synchronous and asynchronous variants of the operation. It provides a for the destination of the messages sent out on the channel. + The interface defines synchronous and asynchronous variants of the operation. It provides a for the destination of the messages sent out on the channel. ]]> @@ -118,7 +118,7 @@ ## Remarks The destination for messages sent out on an output channel is specified at channel creation time. - The method does not guarantee the delivery of message to the remote endpoint. If delivery guarantees are required, use the . + The method does not guarantee the delivery of message to the remote endpoint. If delivery guarantees are required, use the . If the message sent is larger that the maximum message size allowed by the binding being used, a is thrown. The maximum message size is set by the property. The default value is 65536 bytes. @@ -180,7 +180,7 @@ ## Remarks The destination for messages sent out on an output channel is specified at channel creation time. - The method does not guarantee the delivery of message to the remote endpoint. If delivery guarantees are required, use . + The method does not guarantee the delivery of message to the remote endpoint. If delivery guarantees are required, use . If the message sent is larger that the maximum message size allowed by the binding being used, a is thrown. The maximum message size is set by the property. The default value is 65536 bytes. @@ -347,9 +347,9 @@ ## Remarks The destination for messages sent out on an output channel is specified at channel creation time. - The method does not guarantee the delivery of message to the remote endpoint. An implementation of can silently drop messages for a variety of reasons. There may be no more buffer room, for example. If delivery guarantees are required, use . + The method does not guarantee the delivery of message to the remote endpoint. An implementation of can silently drop messages for a variety of reasons. There may be no more buffer room, for example. If delivery guarantees are required, use . - Passing the message into the output channel causes the message to be consumed. After you call , you can no longer inspect the message or call on the message. + Passing the message into the output channel causes the message to be consumed. After you call , you can no longer inspect the message or call on the message. @@ -404,9 +404,9 @@ ## Remarks The destination for messages sent out on an output channel is specified at channel creation time. - The method does not guarantee the delivery of message to the remote endpoint. An implementation of can silently drop messages for a variety of reasons. There may be no more buffer room, for example. If delivery guarantees are required, use . + The method does not guarantee the delivery of message to the remote endpoint. An implementation of can silently drop messages for a variety of reasons. There may be no more buffer room, for example. If delivery guarantees are required, use . - Passing the message into the output channel causes the message to be consumed. After you call , you can no longer inspect the message or call on the message. + Passing the message into the output channel causes the message to be consumed. After you call , you can no longer inspect the message or call on the message. diff --git a/xml/System.ServiceModel.Channels/IOutputSessionChannel.xml b/xml/System.ServiceModel.Channels/IOutputSessionChannel.xml index ac27455af97..80513c9de3c 100644 --- a/xml/System.ServiceModel.Channels/IOutputSessionChannel.xml +++ b/xml/System.ServiceModel.Channels/IOutputSessionChannel.xml @@ -67,7 +67,7 @@ The interface indicates that an implements semantics. - The associated with an can be retrieved through the property. + The associated with an can be retrieved through the property. ]]> diff --git a/xml/System.ServiceModel.Channels/IReplyChannel.xml b/xml/System.ServiceModel.Channels/IReplyChannel.xml index 122789ba927..b6044d5fc69 100644 --- a/xml/System.ServiceModel.Channels/IReplyChannel.xml +++ b/xml/System.ServiceModel.Channels/IReplyChannel.xml @@ -37,13 +37,13 @@ [!INCLUDE [untrusted-data-interface-note](~/includes/untrusted-data-interface-note.md)] - The interface includes synchronous and asynchronous variants of a method return an that can be used to construct replies to received requests. + The interface includes synchronous and asynchronous variants of a method return an that can be used to construct replies to received requests. The contract includes synchronous and asynchronous variants of receive, try-to-receive and wait-for-a-message functionality. An is not necessarily bound to a single sender. Other channels and channel interfaces provide correlation between the sender and the reply channel, but the base contract makes no such restriction. - The pull model is used with an to receive messages. This model consists of calling (or one of its variants) and then waiting for a message to arrive. + The pull model is used with an to receive messages. This model consists of calling (or one of its variants) and then waiting for a message to arrive. ]]> @@ -95,7 +95,7 @@ method implements the standard pattern for invoking asynchronously. The default timeout is 1 minute. If a receive timeout is set on the binding used to configure the connection, then that value is used. Use if you want to specify an explicit timeout with the call that overrides these other values. + The method implements the standard pattern for invoking asynchronously. The default timeout is 1 minute. If a receive timeout is set on the binding used to configure the connection, then that value is used. Use if you want to specify an explicit timeout with the call that overrides these other values. If the request message received is larger that the maximum message size allowed by the binding being used, a is thrown. The maximum message size is set by the property. The default value is 65536 bytes. @@ -149,7 +149,7 @@ method implements the standard pattern for invoking asynchronously. The timeout set on this method overrides a receive timeout set on the binding that is used to configure the connection. + The method implements the standard pattern for invoking asynchronously. The timeout set on this method overrides a receive timeout set on the binding that is used to configure the connection. If the request message received is larger that the maximum message size allowed by the binding being used, a is thrown. The maximum message size is set by the property. The default value is 65536 bytes. @@ -203,7 +203,7 @@ method when you need the application processing to continue without waiting. Use one of the synchronous methods when it is acceptable for the current thread to be blocked while it replies to the request message or until the timeout interval is exceeded. + Use the asynchronous method when you need the application processing to continue without waiting. Use one of the synchronous methods when it is acceptable for the current thread to be blocked while it replies to the request message or until the timeout interval is exceeded. This method receives notification, through a callback, of the identity of the event handler for the operation. The operation is not complete until either a message becomes available in the channel or the time out occurs. @@ -260,7 +260,7 @@ method when it is acceptable for the current thread to be blocked while it waits for a request message to arrive in the queue. The thread is blocked up to the specified `timeout`. + Use the synchronous method when it is acceptable for the current thread to be blocked while it waits for a request message to arrive in the queue. The thread is blocked up to the specified `timeout`. This method receives notification, through a callback, of the identity of the event handler for the operation. The operation is not complete until either a request message becomes available in the channel or the time out occurs. @@ -501,7 +501,7 @@ ## Remarks encapsulates the request message and a mechanism for replying to that message. - can be called multiple times or concurrently. Only one call completes per request received. + can be called multiple times or concurrently. Only one call completes per request received. If the request message received is larger that the maximum message size allowed by the binding being used, a is thrown. The maximum message size is set by the property. The default value is 65536 bytes. @@ -553,7 +553,7 @@ ## Remarks encapsulates the request message and a mechanism for replying to that message. - can be called multiple times or concurrently. Only one call completes per request received. + can be called multiple times or concurrently. Only one call completes per request received. If the request message received is larger that the maximum message size allowed by the binding being used, a is thrown. The maximum message size is set by the property. The default value is 65536 bytes. @@ -606,7 +606,7 @@ when it is acceptable for the current thread to be blocked while it waits for a request message to arrive in the queue. The thread is blocked up to the specified `timeout`. If you need the application processing to continue without waiting, use the asynchronous method. + Use when it is acceptable for the current thread to be blocked while it waits for a request message to arrive in the queue. The thread is blocked up to the specified `timeout`. If you need the application processing to continue without waiting, use the asynchronous method. @@ -658,13 +658,13 @@ does not result in a request message being received or processed in any way. + Calling does not result in a request message being received or processed in any way. - The method exists primarily for transacted scenarios where the user wants to receive the message using a transaction. When using just normally for this, the user must create the transaction, and then call and hope the message arrives before the transaction times out, which may not be possible. + The method exists primarily for transacted scenarios where the user wants to receive the message using a transaction. When using just normally for this, the user must create the transaction, and then call and hope the message arrives before the transaction times out, which may not be possible. - Instead, the user can call and specify the time out (even infinite), then when a message arrives they can open the transaction, call and be confident that they can get the message back before the transaction expires. + Instead, the user can call and specify the time out (even infinite), then when a message arrives they can open the transaction, call and be confident that they can get the message back before the transaction expires. - Use when it is acceptable for the current thread to be blocked while it waits for a message to arrive in the queue. The thread is blocked up to the specified `timeout`. If you need the application processing to continue without waiting, use the asynchronous method. + Use when it is acceptable for the current thread to be blocked while it waits for a message to arrive in the queue. The thread is blocked up to the specified `timeout`. If you need the application processing to continue without waiting, use the asynchronous method. diff --git a/xml/System.ServiceModel.Channels/IReplySessionChannel.xml b/xml/System.ServiceModel.Channels/IReplySessionChannel.xml index 76d927a7ba0..8975aca8912 100644 --- a/xml/System.ServiceModel.Channels/IReplySessionChannel.xml +++ b/xml/System.ServiceModel.Channels/IReplySessionChannel.xml @@ -45,7 +45,7 @@ The interface indicates that an implements semantics. - The associated with its can be retrieved through the property. + The associated with its can be retrieved through the property. ]]> diff --git a/xml/System.ServiceModel.Channels/IRequestChannel.xml b/xml/System.ServiceModel.Channels/IRequestChannel.xml index c9ad952b776..7caa53c7f03 100644 --- a/xml/System.ServiceModel.Channels/IRequestChannel.xml +++ b/xml/System.ServiceModel.Channels/IRequestChannel.xml @@ -57,7 +57,7 @@ [!INCLUDE [untrusted-data-interface-note](~/includes/untrusted-data-interface-note.md)] - The defines synchronous and asynchronous variants of a method that returns a response message. It also provides a and properties to retrieve the endpoint address and URI to which the request message is sent. + The defines synchronous and asynchronous variants of a method that returns a response message. It also provides a and properties to retrieve the endpoint address and URI to which the request message is sent. ]]> @@ -347,9 +347,9 @@ Generally, if an implementation of receives a message that is not correlated to an outstanding request, it is dropped. - The method can be called concurrently across multiple threads. + The method can be called concurrently across multiple threads. - Passing the message into the request channel causes the message to be accessed. After you call , you can no longer inspect the message or call on the message. + Passing the message into the request channel causes the message to be accessed. After you call , you can no longer inspect the message or call on the message. If the request message is larger that the maximum message size allowed by the binding being used, a is thrown. The maximum message size is set by the property. The default value is 65536 bytes. @@ -409,9 +409,9 @@ Generally, if an implementation of receives a message that is not correlated to an outstanding request, it is dropped. - The method can be called concurrently across multiple threads. + The method can be called concurrently across multiple threads. - Passing the message into the request channel causes the message to be accessed. After you call , you can no longer inspect the message or call on the message. + Passing the message into the request channel causes the message to be accessed. After you call , you can no longer inspect the message or call on the message. If the request message is larger that the maximum message size allowed by the binding being used, a is thrown. The maximum message size is set by the property. The default value is 65536 bytes. diff --git a/xml/System.ServiceModel.Channels/IRequestSessionChannel.xml b/xml/System.ServiceModel.Channels/IRequestSessionChannel.xml index 41f4c739f69..6a4dbf3ce6a 100644 --- a/xml/System.ServiceModel.Channels/IRequestSessionChannel.xml +++ b/xml/System.ServiceModel.Channels/IRequestSessionChannel.xml @@ -67,7 +67,7 @@ The interface indicates that an implements semantics. - The associated with its can be retrieved through the property. + The associated with its can be retrieved through the property. ]]> diff --git a/xml/System.ServiceModel.Channels/ISession.xml b/xml/System.ServiceModel.Channels/ISession.xml index bf70d6f9167..fd461bfc863 100644 --- a/xml/System.ServiceModel.Channels/ISession.xml +++ b/xml/System.ServiceModel.Channels/ISession.xml @@ -67,7 +67,7 @@ - -- of type +- of type ]]> diff --git a/xml/System.ServiceModel.Channels/ISessionChannel`1.xml b/xml/System.ServiceModel.Channels/ISessionChannel`1.xml index 5e5ce6ee62a..be5ec14f82d 100644 --- a/xml/System.ServiceModel.Channels/ISessionChannel`1.xml +++ b/xml/System.ServiceModel.Channels/ISessionChannel`1.xml @@ -55,9 +55,9 @@ interface is the base interface for session-based channels. It associates the type of session with the channel by setting the generic type parameter `TSession` to a type that implements the interface in a way that reflects its role in the message exchange. For example, the `TSession` is set to for an incoming session on the receiving side of a one-way communication, to for an outgoing session on the sending side of a one-way communication, and to for a duplex session for a bi-directional communication pattern. + The interface is the base interface for session-based channels. It associates the type of session with the channel by setting the generic type parameter `TSession` to a type that implements the interface in a way that reflects its role in the message exchange. For example, the `TSession` is set to for an incoming session on the receiving side of a one-way communication, to for an outgoing session on the sending side of a one-way communication, and to for a duplex session for a bi-directional communication pattern. - The interface provides a property to retrieve the session with which the channel is associated. + The interface provides a property to retrieve the session with which the channel is associated. ]]> diff --git a/xml/System.ServiceModel.Channels/InvalidChannelBindingException.xml b/xml/System.ServiceModel.Channels/InvalidChannelBindingException.xml index f5e847ed5b5..32c53473c01 100644 --- a/xml/System.ServiceModel.Channels/InvalidChannelBindingException.xml +++ b/xml/System.ServiceModel.Channels/InvalidChannelBindingException.xml @@ -89,7 +89,7 @@ ## Remarks Use this constructor when you want to pass an error message to the user. The content of the message parameter should be understandable to the user. The caller of this constructor is required to ensure that this string has been localized for the current system culture. - If you also want to pass a reference to the inner exception that is the cause of the exception as well as a specified error message to the user, use the constructor. + If you also want to pass a reference to the inner exception that is the cause of the exception as well as a specified error message to the user, use the constructor. ]]> diff --git a/xml/System.ServiceModel.Channels/LocalClientSecuritySettings.xml b/xml/System.ServiceModel.Channels/LocalClientSecuritySettings.xml index 6058bc79e50..3d9fb756c2c 100644 --- a/xml/System.ServiceModel.Channels/LocalClientSecuritySettings.xml +++ b/xml/System.ServiceModel.Channels/LocalClientSecuritySettings.xml @@ -779,7 +779,7 @@ - If [\ element](https://learn.microsoft.com/previous-versions/ms731375(v=vs.90)) is enabled. -- If [\ element](https://learn.microsoft.com/previous-versions/ms731375(v=vs.90)) is not enabled, on with = `true` or = `true`. +- If [\ element](https://learn.microsoft.com/previous-versions/ms731375(v=vs.90)) is not enabled, on with = `true` or = `true`. Session settings such as this one are not applicable under any of the following conditions: @@ -850,7 +850,7 @@ - If [\ element](https://learn.microsoft.com/previous-versions/ms731375(v=vs.90)) is enabled. -- If [\ element](https://learn.microsoft.com/previous-versions/ms731375(v=vs.90)) is not enabled, on with = `true` or = `true`. +- If [\ element](https://learn.microsoft.com/previous-versions/ms731375(v=vs.90)) is not enabled, on with = `true` or = `true`. Session settings such as this one are not applicable under any of the following conditions: diff --git a/xml/System.ServiceModel.Channels/LocalServiceSecuritySettings.xml b/xml/System.ServiceModel.Channels/LocalServiceSecuritySettings.xml index 95d6263103d..78771a2baab 100644 --- a/xml/System.ServiceModel.Channels/LocalServiceSecuritySettings.xml +++ b/xml/System.ServiceModel.Channels/LocalServiceSecuritySettings.xml @@ -175,7 +175,7 @@ - If [\ element](https://learn.microsoft.com/previous-versions/ms731375(v=vs.90)) is enabled. -- If [\ element](https://learn.microsoft.com/previous-versions/ms731375(v=vs.90)) is not enabled, on with = `true` or = `true`. +- If [\ element](https://learn.microsoft.com/previous-versions/ms731375(v=vs.90)) is not enabled, on with = `true` or = `true`. Session settings such as this one are not applicable under any of the following conditions: @@ -651,7 +651,7 @@ - If [\ element](https://learn.microsoft.com/previous-versions/ms731375(v=vs.90)) is enabled. -- If [\ element](https://learn.microsoft.com/previous-versions/ms731375(v=vs.90)) is not enabled, on with = `true` or = `true`. +- If [\ element](https://learn.microsoft.com/previous-versions/ms731375(v=vs.90)) is not enabled, on with = `true` or = `true`. Session settings such as this one are not applicable under any of the following conditions: @@ -711,7 +711,7 @@ - If [\ element](https://learn.microsoft.com/previous-versions/ms731375(v=vs.90)) is enabled. -- If [\ element](https://learn.microsoft.com/previous-versions/ms731375(v=vs.90)) is not enabled, on with = `true` or = `true`. +- If [\ element](https://learn.microsoft.com/previous-versions/ms731375(v=vs.90)) is not enabled, on with = `true` or = `true`. Session settings such as this one are not applicable under any of the following conditions: diff --git a/xml/System.ServiceModel.Channels/Message.xml b/xml/System.ServiceModel.Channels/Message.xml index af14fdee57f..b7a14947638 100644 --- a/xml/System.ServiceModel.Channels/Message.xml +++ b/xml/System.ServiceModel.Channels/Message.xml @@ -59,7 +59,7 @@ Messages are received and sent in particular formats. Support is provided for two formats: the standard text-based XML format and a binary-based XML format. The object can be used to represent both SOAP 1.1 and SOAP 1.2 envelopes. Note that an instance of is fixed upon creation and is bound to a specific SOAP version. The property represents the SOAP version of the message. - A object can be serialized to an external store by using the method. Properties of the message can also be serialized, but they have to be individually identified and serialized separately. Deserializing a message to create an in-memory object can be done using . Properties must also be deserialized individually and manually added to the property collection for the specific instance. + A object can be serialized to an external store by using the method. Properties of the message can also be serialized, but they have to be individually identified and serialized separately. Deserializing a message to create an in-memory object can be done using . Properties must also be deserialized individually and manually added to the property collection for the specific instance. The size of a object is fixed to the size of data it is transmitting. Every body is modeled as an instance of , with no predefined limit on the size of the stream that the instance is wrapping. However, specific channel providers can have a limit on the size of messages that they process. @@ -67,16 +67,16 @@ The property represents the set of processing-level annotations on the message. Because information in headers is transmitted on the wire, an entity that examines a header must support the underlying version(s) of the protocols used by the header. However, properties provide a more version-independent way of annotating a message. - To create a instance, use one of the methods. + To create a instance, use one of the methods. - It is recommended that a consumer of a message always call when the consumer is finished accessing the contents of the message. This action frees finite system resources (for example, sockets, named pipes) that are tied to the lifetime of the message. + It is recommended that a consumer of a message always call when the consumer is finished accessing the contents of the message. This action frees finite system resources (for example, sockets, named pipes) that are tied to the lifetime of the message. Special note for Managed C++ users deriving from this class: - Put your cleanup code in (On)(Begin)Close (and/or OnAbort), not in a destructor. - Avoid destructors: they cause the compiler to auto-generate . - Avoid non-reference members: they can cause the compiler to auto-generate . -- Avoid finalizers; but if you include one, suppress the build warning and call and the finalizer itself from (On)(Begin)Close (and/or OnAbort) to emulate what would have been the auto-generated behavior. +- Avoid finalizers; but if you include one, suppress the build warning and call and the finalizer itself from (On)(Begin)Close (and/or OnAbort) to emulate what would have been the auto-generated behavior. ## Examples The following code example shows a client that uses the channel factory to send a message and read the reply. @@ -236,7 +236,7 @@ does have a finalizer, which causes to be called for you when the message is garbage-collected. This is non-optimal, as the .NET Framework's Garbage Collection (GC) mechanism does not necessarily run when you run out of system resources other than memory. For this reason, you should always call this method when finished with the contents of the message. The method is a synonym for (which also implements). The message also disposes the object that was used to construct the body when it is disposed. + The does have a finalizer, which causes to be called for you when the message is garbage-collected. This is non-optimal, as the .NET Framework's Garbage Collection (GC) mechanism does not necessarily run when you run out of system resources other than memory. For this reason, you should always call this method when finished with the contents of the message. The method is a synonym for (which also implements). The message also disposes the object that was used to construct the body when it is disposed. An is thrown if you call any method or access any properties of the message once it is closed. Calling any method or accessing any properties of other objects related to the message once it is closed, (such as message header collection, message property values, or instances returned for the body or for a header) has undefined behavior. @@ -291,7 +291,7 @@ instance can only be accessed or written once. If you want to access a instance more than once, you should use the class to completely store an entire instance into memory. A instance is constructed by calling of a instance. + The body of a instance can only be accessed or written once. If you want to access a instance more than once, you should use the class to completely store an entire instance into memory. A instance is constructed by calling of a instance. > [!NOTE] > If is equal to , this method only stores the body of the message, not the entire message into the memory buffer. @@ -318,7 +318,7 @@ ## Remarks This method is used to create a new copy of a message ready for sending. - When working with JSON messages use the method, the method does not work with JSON messages. + When working with JSON messages use the method, the method does not work with JSON messages. @@ -473,7 +473,7 @@ ## Remarks This static method is used to create a new copy of message ready for sending. - When working with JSON messages use the method, the method does not work with JSON messages. + When working with JSON messages use the method, the method does not work with JSON messages. ]]> @@ -683,7 +683,7 @@ The body of the returned message can then be either read or written. - The message body can be read using the methods on the returned message. The returned object encapsulates all the child elements within the `Body` element. The message body can be written using or . Once written, it cannot be read. + The message body can be read using the methods on the returned message. The returned object encapsulates all the child elements within the `Body` element. The message body can be written using or . Once written, it cannot be read. Closing the message closes the underlying envelope reader. @@ -742,7 +742,7 @@ The body of the returned message can then be either read or written. - The message body can be read using the methods on the returned message. The returned object encapsulates all the child elements within the `Body` element. The message body can be written using or . Once written, it cannot be read. + The message body can be read using the methods on the returned message. The returned object encapsulates all the child elements within the `Body` element. The message body can be written using or . Once written, it cannot be read. Closing the message closes the underlying envelope reader. @@ -849,7 +849,7 @@ ## Remarks This static method is used to create a new copy of message ready for sending. - When working with JSON messages use the method, the method does not work with JSON messages. + When working with JSON messages use the method, the method does not work with JSON messages. ]]> @@ -985,9 +985,9 @@ methods on the returned message. The returned object encapsulates all the child elements within the `Body` element. Because the body of a message is a stream, it can only be written once, or read once. + After a message is created, the message body can be read using the methods on the returned message. The returned object encapsulates all the child elements within the `Body` element. Because the body of a message is a stream, it can only be written once, or read once. - Use the overload when working with JSON messages; the overload does not work. + Use the overload when working with JSON messages; the overload does not work. @@ -1041,9 +1041,9 @@ instance has a body that corresponds to the SOAP body. It can be accessed as an by calling . It is initially positioned directly after the `` element, and it returns `EOF` on reaching the `` element. Alternatively, if you expect the body to contain a serialized object, you can call instead. You should be aware that a message body can only be accessed once and a message can only be written once. If you want to access the `Body` multiple times, use to create a instance. + A instance has a body that corresponds to the SOAP body. It can be accessed as an by calling . It is initially positioned directly after the `` element, and it returns `EOF` on reaching the `` element. Alternatively, if you expect the body to contain a serialized object, you can call instead. You should be aware that a message body can only be accessed once and a message can only be written once. If you want to access the `Body` multiple times, use to create a instance. - Use the overload when working with JSON messages; the overload does not work. + Use the overload when working with JSON messages; the overload does not work. ]]> @@ -1092,9 +1092,9 @@ instance has a body that corresponds to the SOAP body. It can be accessed as an by calling . It is initially positioned directly after the `` element, and it returns `EOF` on reaching the `` element. Alternatively, if you expect the body to contain a serialized object, you can call instead. You should be aware that a message body can only be accessed once and a message can only be written once. If you want to access the body multiple times, use to create a instance. + A instance has a body that corresponds to the SOAP body. It can be accessed as an by calling . It is initially positioned directly after the `` element, and it returns `EOF` on reaching the `` element. Alternatively, if you expect the body to contain a serialized object, you can call instead. You should be aware that a message body can only be accessed once and a message can only be written once. If you want to access the body multiple times, use to create a instance. - Use the overload when working with JSON messages; the overload does not work. + Use the overload when working with JSON messages; the overload does not work. ]]> @@ -1147,7 +1147,7 @@ instance has a body that corresponds to the SOAP body. It can be accessed as an by calling . It is initially positioned directly after the `` element, and it returns `EOF` on reaching the `` element. Alternatively, if you expect the body to contain a serialized object, you can call instead. You should be aware that a message body can only be accessed once and a message can only be written once. If you want to access the body multiple times, use to create a instance. + A instance has a body that corresponds to the SOAP body. It can be accessed as an by calling . It is initially positioned directly after the `` element, and it returns `EOF` on reaching the `` element. Alternatively, if you expect the body to contain a serialized object, you can call instead. You should be aware that a message body can only be accessed once and a message can only be written once. If you want to access the body multiple times, use to create a instance. ]]> @@ -1193,7 +1193,7 @@ instance has a body that corresponds to the SOAP body. It can be accessed as an by calling . It is initially positioned directly after the `` element. Alternatively, if you expect the body to contain a serialized object, you can call instead. You should be aware that a message body can only be accessed once and a message can only be written once. If you want to access the body multiple times, use to create a instance. + A instance has a body that corresponds to the SOAP body. It can be accessed as an by calling . It is initially positioned directly after the `` element. Alternatively, if you expect the body to contain a serialized object, you can call instead. You should be aware that a message body can only be accessed once and a message can only be written once. If you want to access the body multiple times, use to create a instance. ]]> @@ -1236,7 +1236,7 @@ can have zero or more headers that are used as an extension mechanism to pass information in messages that is application-specific. You can use to add message headers to a message by calling the method. + A can have zero or more headers that are used as an extension mechanism to pass information in messages that is application-specific. You can use to add message headers to a message by calling the method. Windows Communication Foundation (WCF) provides a number of predefined message headers, as shown in the following table. diff --git a/xml/System.ServiceModel.Channels/MessageBuffer.xml b/xml/System.ServiceModel.Channels/MessageBuffer.xml index 8d356bf1d74..1255f09b3d9 100644 --- a/xml/System.ServiceModel.Channels/MessageBuffer.xml +++ b/xml/System.ServiceModel.Channels/MessageBuffer.xml @@ -63,20 +63,20 @@ ## Remarks The body of a instance can only be consumed or written once. If you wish to consume a instance more than once, you should use the class to completely store an entire instance into memory. - A instance is constructed by calling of a instance. A new is then created and returned, which assumes ownership of the and reads the entire content into memory. + A instance is constructed by calling of a instance. A new is then created and returned, which assumes ownership of the and reads the entire content into memory. - In order to retrieve a copy of a from the , you must call the method of the . This returns an identical copy of the original instance you provided. + In order to retrieve a copy of a from the , you must call the method of the . This returns an identical copy of the original instance you provided. You can control the maximum size of the buffer by setting to the maximum number of bytes desired. This number does not necessarily cover any transient allocations related to building the buffer, or properties attached to the message. - You should always close a instance by calling when finished working with it. This allows system resources to potentially be freed sooner. + You should always close a instance by calling when finished working with it. This allows system resources to potentially be freed sooner. Special note for Managed C++ users deriving from this class: - Put your cleanup code in (On)(Begin)Close (and/or OnAbort), not in a destructor. - Avoid destructors: they cause the compiler to auto-generate . - Avoid non-reference members: they can cause the compiler to auto-generate . -- Avoid finalizers; but if you include one, you should suppress the build warning and call and the finalizer itself from (On)(Begin)Close (and/or OnAbort) in order to emulate what would have been the auto-generated behavior. +- Avoid finalizers; but if you include one, you should suppress the build warning and call and the finalizer itself from (On)(Begin)Close (and/or OnAbort) in order to emulate what would have been the auto-generated behavior. ]]> @@ -194,9 +194,9 @@ instance by calling when finished working with it. This allows system resources to potentially be freed sooner. + You should always close a instance by calling when finished working with it. This allows system resources to potentially be freed sooner. - If you have called to create a message buffer of a message, and inspected the message using , you will get a when you attempt to close the buffer using this method. To avoid this problem, you need to recreate the message from the buffer before closing. See the code sample in the Example section for a demonstration of the previous scenario and a way to resolve this problem. + If you have called to create a message buffer of a message, and inspected the message using , you will get a when you attempt to close the buffer using this method. To avoid this problem, you need to recreate the message from the buffer before closing. See the code sample in the Example section for a demonstration of the previous scenario and a way to resolve this problem. @@ -263,7 +263,7 @@ public void AfterReceiveReply(ref Message reply, object correlationState) instance you previously provided to the method of a instance. You can then save the message to a durable storage. + Calling this method creates an identical copy of the original instance you previously provided to the method of a instance. You can then save the message to a durable storage. ]]> diff --git a/xml/System.ServiceModel.Channels/MessageEncoder.xml b/xml/System.ServiceModel.Channels/MessageEncoder.xml index 83994f8731f..bad0db0a7e7 100644 --- a/xml/System.ServiceModel.Channels/MessageEncoder.xml +++ b/xml/System.ServiceModel.Channels/MessageEncoder.xml @@ -59,11 +59,11 @@ - - Override the to return an instance of your custom . Then wire up your custom to the binding element stack used to configure the service or client by overriding the method to return an instance of this factory. + Override the to return an instance of your custom . Then wire up your custom to the binding element stack used to configure the service or client by overriding the method to return an instance of this factory. The task of converting between the in-memory representation of a message and an XML Information Set (Infoset) representation that can be written to a stream is encapsulated within the class, which most commonly serves as a factory for XML readers and XML writers that support specific types of XML encodings. - The key methods on are and . takes a object and writes it into a object. takes a object and a maximum header size and returns a object. + The key methods on are and . takes a object and writes it into a object. takes a object and a maximum header size and returns a object. @@ -578,7 +578,7 @@ method. + The following code example shows how to implement the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ue_customtextmessageencoder/cs/customtextmessageencoder.cs" id="Snippet4"::: @@ -629,7 +629,7 @@ method. + The following code example shows how to implement the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ue_customtextmessageencoder/cs/customtextmessageencoder.cs" id="Snippet5"::: @@ -800,7 +800,7 @@ method. + The following code shows how to implement the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ue_customtextmessageencoder/cs/customtextmessageencoder.cs" id="Snippet7"::: @@ -857,7 +857,7 @@ with `messageOffset` = 0. + This method calls the abstract method with `messageOffset` = 0. ]]> @@ -908,12 +908,12 @@ . + This method is called by . ## Examples - The following code shows how to implement the method. + The following code shows how to implement the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ue_customtextmessageencoder/cs/customtextmessageencoder.cs" id="Snippet6"::: diff --git a/xml/System.ServiceModel.Channels/MessageEncoderFactory.xml b/xml/System.ServiceModel.Channels/MessageEncoderFactory.xml index 2a0e70400e6..a793455ea40 100644 --- a/xml/System.ServiceModel.Channels/MessageEncoderFactory.xml +++ b/xml/System.ServiceModel.Channels/MessageEncoderFactory.xml @@ -59,7 +59,7 @@ - - Override the to return an instance of your custom . Then wire up your custom to the binding element stack used to configure the service or client by overriding the method to return an instance of this factory. For more information about custom encoders, see [Data Transfer and Serialization](/dotnet/framework/wcf/feature-details/data-transfer-and-serialization). + Override the to return an instance of your custom . Then wire up your custom to the binding element stack used to configure the service or client by overriding the method to return an instance of this factory. For more information about custom encoders, see [Data Transfer and Serialization](/dotnet/framework/wcf/feature-details/data-transfer-and-serialization). diff --git a/xml/System.ServiceModel.Channels/MessageEncodingBindingElement.xml b/xml/System.ServiceModel.Channels/MessageEncodingBindingElement.xml index 9da3a52eb81..37ea53b86a4 100644 --- a/xml/System.ServiceModel.Channels/MessageEncodingBindingElement.xml +++ b/xml/System.ServiceModel.Channels/MessageEncodingBindingElement.xml @@ -59,9 +59,9 @@ - - Override the to return an instance of your custom . Override the method to return an instance of this factory. + Override the to return an instance of your custom . Override the method to return an instance of this factory. - Any type that derives from is responsible for updating the version of the SOAP binding in the WSDL document generated for the service. This is done by implementing the method to modify the generated WSDL. + Any type that derives from is responsible for updating the version of the SOAP binding in the WSDL document generated for the service. This is done by implementing the method to modify the generated WSDL. Windows Communication Foundation (WCF) provides three types of binding elements derived from the class that can provide for text, binary and Message Transmission Optimization Mechanism (MTOM) encoding. @@ -213,7 +213,7 @@ : + The following code illustrates how to implement the : :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ue_customtextmessageencoder/cs/customtextmessageencodingbindingelement.cs" id="Snippet13"::: @@ -273,7 +273,7 @@ ## Examples - The following code illustrates how to implement the method: + The following code illustrates how to implement the method: :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ue_customtextmessageencoder/cs/customtextmessageencodingbindingelement.cs" id="Snippet15"::: diff --git a/xml/System.ServiceModel.Channels/MessageEncodingBindingElementImporter.xml b/xml/System.ServiceModel.Channels/MessageEncodingBindingElementImporter.xml index 9cdca8ed946..58d292cacbb 100644 --- a/xml/System.ServiceModel.Channels/MessageEncodingBindingElementImporter.xml +++ b/xml/System.ServiceModel.Channels/MessageEncodingBindingElementImporter.xml @@ -24,13 +24,13 @@ Converts WSDL-based policies and contracts about message encoding into descriptions of the binding elements that can implement these policies for the service. - method to directly modify the metadata that is then imported into message encoding binding elements. - + method to directly modify the metadata that is then imported into message encoding binding elements. + ]]> @@ -121,11 +121,11 @@ The of type that contains the policy elements. Called prior to importing the metadata documents associated with the encoding. - does the import. - + does the import. + ]]> diff --git a/xml/System.ServiceModel.Channels/MessageFault.xml b/xml/System.ServiceModel.Channels/MessageFault.xml index be8a4b88227..5ca566bbf5e 100644 --- a/xml/System.ServiceModel.Channels/MessageFault.xml +++ b/xml/System.ServiceModel.Channels/MessageFault.xml @@ -56,9 +56,9 @@ ## Examples - The following code example shows the most common use of . Both the and pass in a object that can be modified and returned to the system (in the case of ) or used to perform some custom fault-related behavior (in the case of ). + The following code example shows the most common use of . Both the and pass in a object that can be modified and returned to the system (in the case of ) or used to perform some custom fault-related behavior (in the case of ). - In this example, the method converts all objects into a object that contains a object of type `GreetingFault` and returns that customized to WCF. + In this example, the method converts all objects into a object that contains a object of type `GreetingFault` and returns that customized to WCF. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/ierrorhandler/cs/ierrorhandler.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/ierrorhandler/vb/ierrorhandler.vb" id="Snippet6"::: @@ -770,7 +770,7 @@ method to participate in the detail writing process. The default behavior is to call followed by . + Override the method to participate in the detail writing process. The default behavior is to call followed by . ]]> @@ -814,7 +814,7 @@ method is called subsequent to and prior to writing the end element. + The method is called subsequent to and prior to writing the end element. ]]> diff --git a/xml/System.ServiceModel.Channels/MessageHeader.xml b/xml/System.ServiceModel.Channels/MessageHeader.xml index 1cca7644a8c..b91b6c7c5e0 100644 --- a/xml/System.ServiceModel.Channels/MessageHeader.xml +++ b/xml/System.ServiceModel.Channels/MessageHeader.xml @@ -46,26 +46,26 @@ Represents the content of a SOAP header. - class. - - A can have zero or more headers that are used as an extension mechanism to pass information in messages that are application-specific. You can use to add message headers to a message by calling the method. - - Windows Communication Foundation (WCF) provides a number of predefined message headers, as shown in the following table. - -|Header Name|Description| -|-----------------|-----------------| -|To|Contains the role that the message is targeting.| -|Action|Provides a description of how the message should be processed.| -|FaultTo|Contains the address of the node to which faults should be sent.| -|From|Contains the address of the node that sent the message.| -|Request|Indicates whether the message is a request.| -|MessageID|Contains the unique ID of the message.| -|RelatesTo|Contains the IDs of messages that are related to this message.| -|ReplyTo|Contains the address of the node to which a reply should be sent for a request.| - + class. + + A can have zero or more headers that are used as an extension mechanism to pass information in messages that are application-specific. You can use to add message headers to a message by calling the method. + + Windows Communication Foundation (WCF) provides a number of predefined message headers, as shown in the following table. + +|Header Name|Description| +|-----------------|-----------------| +|To|Contains the role that the message is targeting.| +|Action|Provides a description of how the message should be processed.| +|FaultTo|Contains the address of the node to which faults should be sent.| +|From|Contains the address of the node that sent the message.| +|Request|Indicates whether the message is a request.| +|MessageID|Contains the unique ID of the message.| +|RelatesTo|Contains the IDs of messages that are related to this message.| +|ReplyTo|Contains the address of the node to which a reply should be sent for a request.| + ]]> @@ -138,11 +138,11 @@ Gets or sets the targeted recipient of the message header. The targeted recipient of the message header. The default is an empty string (""). - @@ -633,11 +633,11 @@ if this message header contains reference parameters of an endpoint reference; otherwise, . - ` element described in the [WS-Addressing specification](https://www.w3.org/Submission/ws-addressing/). - + ` element described in the [WS-Addressing specification](https://www.w3.org/Submission/ws-addressing/). + ]]> @@ -675,11 +675,11 @@ if the header must be understood; otherwise, . - @@ -795,11 +795,11 @@ if the header should be relayed; otherwise, . - diff --git a/xml/System.ServiceModel.Channels/MessageHeaders.xml b/xml/System.ServiceModel.Channels/MessageHeaders.xml index 495f97baafa..6f37d266a02 100644 --- a/xml/System.ServiceModel.Channels/MessageHeaders.xml +++ b/xml/System.ServiceModel.Channels/MessageHeaders.xml @@ -53,34 +53,34 @@ Represents a collection of message headers for a message. This class cannot be inherited. - class. - - A can have zero or more headers that are used as an extension mechanism to pass information in messages that are application-specific. You can use to add message headers to a message by calling the method. - - Windows Communication Foundation (WCF) provides a number of predefined message headers: - -|Header Name|Description| -|-----------------|-----------------| -|To|Contains the role that the message is targeting.| -|Action|Provides a description of how the message should be processed.| -|FaultTo|Contains the address of the node to which faults should be sent.| -|From|Contains the address of the node that sent the message.| -|Request|Indicates whether the message is a request.| -|MessageID|Contains the unique ID of the message.| -|RelatesTo|Contains the IDs of messages that are related to this message.| -|ReplyTo|Contains the address of the node to which a reply should be sent for a request.| - - - -## Examples - The following code example demonstrates a basic client using the channel factory to send a message and read the action header from the reply. - + class. + + A can have zero or more headers that are used as an extension mechanism to pass information in messages that are application-specific. You can use to add message headers to a message by calling the method. + + Windows Communication Foundation (WCF) provides a number of predefined message headers: + +|Header Name|Description| +|-----------------|-----------------| +|To|Contains the role that the message is targeting.| +|Action|Provides a description of how the message should be processed.| +|FaultTo|Contains the address of the node to which faults should be sent.| +|From|Contains the address of the node that sent the message.| +|Request|Indicates whether the message is a request.| +|MessageID|Contains the unique ID of the message.| +|RelatesTo|Contains the IDs of messages that are related to this message.| +|ReplyTo|Contains the address of the node to which a reply should be sent for a request.| + + + +## Examples + The following code example demonstrates a basic client using the channel factory to send a message and read the action header from the reply. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/message/cs/client.cs" id="Snippet0"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/message/vb/client.vb" id="Snippet0"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/message/vb/client.vb" id="Snippet0"::: + ]]> @@ -237,19 +237,19 @@ Gets or sets a description of how the message should be processed. A description of how the message should be processed. - ` element described in the [WS-Addressing specification](https://www.w3.org/Submission/ws-addressing/). - - - -## Examples - The following code example demonstrates a simple client using the channel factory to send a message and read the action header from the reply. - + ` element described in the [WS-Addressing specification](https://www.w3.org/Submission/ws-addressing/). + + + +## Examples + The following code example demonstrates a simple client using the channel factory to send a message and read the action header from the reply. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/message/cs/client.cs" id="Snippet0"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/message/vb/client.vb" id="Snippet0"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/message/vb/client.vb" id="Snippet0"::: + ]]> @@ -608,11 +608,11 @@ Gets or sets the address of the node to which faults should be sent. An of the node to which faults should be sent. - ` element described in the [WS-Addressing specification](https://www.w3.org/Submission/ws-addressing/). - + ` element described in the [WS-Addressing specification](https://www.w3.org/Submission/ws-addressing/). + ]]> @@ -752,11 +752,11 @@ Gets or sets the address of the node that sent the message. An of the node that sent the message. - ` element described in the [WS-Addressing specification](https://www.w3.org/Submission/ws-addressing/). - + ` element described in the [WS-Addressing specification](https://www.w3.org/Submission/ws-addressing/). + ]]> @@ -849,11 +849,11 @@ Retrieves a message header at a specific position in this collection. A message header at the specified index. - . It does not try to detect from the type whether it should use the or `DataContractSerializer`. To use the XML serializer, call or obtain the reader at the contents and call directly into the serializer. - + . It does not try to detect from the type whether it should use the or `DataContractSerializer`. To use the XML serializer, call or obtain the reader at the contents and call directly into the serializer. + ]]> @@ -944,11 +944,11 @@ Finds a message header in this collection by the specified LocalName and namespace URI of the header element. A message header with the specified name. - . It does not try to detect from the type whether it should use the or the `DataContractSerializer`. To use the XML serializer, call or obtain the reader at the contents and call directly into the serializer. - + . It does not try to detect from the type whether it should use the or the `DataContractSerializer`. To use the XML serializer, call or obtain the reader at the contents and call directly into the serializer. + ]]> @@ -1050,11 +1050,11 @@ Retrieves a message header in this collection by the specified LocalName, namespace URI and actors of the header element. A message header with the specified name. - . It does not try to detect from the type whether it should use the or `DataContractSerializer`. To use the XML serializer, call or obtain the reader at the contents and call directly into the serializer. - + . It does not try to detect from the type whether it should use the or `DataContractSerializer`. To use the XML serializer, call or obtain the reader at the contents and call directly into the serializer. + ]]> @@ -1141,11 +1141,11 @@ if the recipients specified by have properly interpreted and processed all the message headers marked with ; otherwise, . - @@ -1194,11 +1194,11 @@ if the recipients specified by have properly interpreted and processed all the message headers marked with ; otherwise, . - @@ -1312,11 +1312,11 @@ Gets or sets the unique ID of the message. The unique ID of the message. - ` element described in the [WS-Addressing specification](https://www.w3.org/Submission/ws-addressing/). - + ` element described in the [WS-Addressing specification](https://www.w3.org/Submission/ws-addressing/). + ]]> @@ -1393,11 +1393,11 @@ Gets the IDs of messages that are related to this message. The IDs of messages that are related to this message. - ` element described in the [WS-Addressing specification](https://www.w3.org/Submission/ws-addressing/). - + ` element described in the [WS-Addressing specification](https://www.w3.org/Submission/ws-addressing/). + ]]> @@ -1510,11 +1510,11 @@ Gets or sets the address of the node to which a reply should be sent for a request. An of the node to which a reply should be sent for a request. - ` element described in the [WS-Addressing specification](https://www.w3.org/Submission/ws-addressing/). - + ` element described in the [WS-Addressing specification](https://www.w3.org/Submission/ws-addressing/). + ]]> @@ -1640,11 +1640,11 @@ This member is an explicit interface member implementation. It can be used only Gets or sets the destination endpoint of a message. A URI that contains the destination endpoint of a message. - ` element described in the [WS-Addressing specification](https://www.w3.org/Submission/ws-addressing/). - + ` element described in the [WS-Addressing specification](https://www.w3.org/Submission/ws-addressing/). + ]]> @@ -1678,11 +1678,11 @@ This member is an explicit interface member implementation. It can be used only Gets all the message headers that must be understood, according to SOAP 1.1/1.2 specification. A that represents the message headers that must be understood. - diff --git a/xml/System.ServiceModel.Channels/MessageProperties.xml b/xml/System.ServiceModel.Channels/MessageProperties.xml index 54e62e147c6..e6de8d87eca 100644 --- a/xml/System.ServiceModel.Channels/MessageProperties.xml +++ b/xml/System.ServiceModel.Channels/MessageProperties.xml @@ -434,10 +434,10 @@ when you are finished using the . The method leaves the in an unusable state. After calling , you must release all references to the so the garbage collector can reclaim the memory that the occupied. + Call when you are finished using the . The method leaves the in an unusable state. After calling , you must release all references to the so the garbage collector can reclaim the memory that the occupied. > [!NOTE] -> Always call before you release your last reference to the . Otherwise, the resources it is using are not freed until the garbage collector calls the object's `Finalize` method. +> Always call before you release your last reference to the . Otherwise, the resources it is using are not freed until the garbage collector calls the object's `Finalize` method. ]]> @@ -1104,7 +1104,7 @@ This member is an explicit interface member implementation. It can be used only property and it overwrites whatever value you set for the message headers. You do have one opportunity to set the channel's `Via`, which is during the creation of the channel from the channel factory, for example, with . + The transport channel owns the property and it overwrites whatever value you set for the message headers. You do have one opportunity to set the channel's `Via`, which is during the creation of the channel from the channel factory, for example, with . ]]> diff --git a/xml/System.ServiceModel.Channels/MessageVersion.xml b/xml/System.ServiceModel.Channels/MessageVersion.xml index 89b4121ea6d..d6f109ce643 100644 --- a/xml/System.ServiceModel.Channels/MessageVersion.xml +++ b/xml/System.ServiceModel.Channels/MessageVersion.xml @@ -56,7 +56,7 @@ contains the versioning information both about the SOAP envelope and the addressing protocol that is used by a message. An instance of is bound upon creation to a specific by passing the version as a parameter into one of the overloads. + The contains the versioning information both about the SOAP envelope and the addressing protocol that is used by a message. An instance of is bound upon creation to a specific by passing the version as a parameter into one of the overloads. All the static "get" properties in this class, such as and have enumeration-like semantics. They provide an enumeration of the possible message versions supported by the Windows Communication Foundation (WCF) runtime. A message has an envelope structure and an addressing structure. is just a shortcut for supplying {, } together. @@ -66,7 +66,7 @@ provides support for using "plain old XML" (POX)-style messaging. Enabling basic POX messaging is now a matter of setting up an HTTP binding on your service with a text encoder that uses . - Message version objects can be created using specified versions of WS-Addressing and SOAP using one of the overloads. + Message version objects can be created using specified versions of WS-Addressing and SOAP using one of the overloads. ]]> diff --git a/xml/System.ServiceModel.Channels/MtomMessageEncodingBindingElement.xml b/xml/System.ServiceModel.Channels/MtomMessageEncodingBindingElement.xml index a62eacbf8b8..2dd8851e8ff 100644 --- a/xml/System.ServiceModel.Channels/MtomMessageEncodingBindingElement.xml +++ b/xml/System.ServiceModel.Channels/MtomMessageEncodingBindingElement.xml @@ -50,19 +50,19 @@ The binding element that specifies the encoding and versioning used for Message Transmission Optimization Mechanism (MTOM) messages. - represents the binding element that specifies the character encoding and message versioning and other settings used for messages using a Message Transmission Optimization Mechanism (MTOM) encoding. MTOM is an efficient technology for transmitting binary data in WCF messages. The MTOM encoder attempts to create a balance between efficiency and interoperability. The MTOM encoding transmits most XML in textual form, but optimizes large blocks of binary data by transmitting them as-is, without conversion to their base64 encoded format. - - For more information about the binding element that specifies that messages are encoded using a textual representation of XML, see . - - For more information about the binding element that specifies messages are encoded using the .NET Binary Format for XML, see . - - To implement a custom message encoder, use the class. - + represents the binding element that specifies the character encoding and message versioning and other settings used for messages using a Message Transmission Optimization Mechanism (MTOM) encoding. MTOM is an efficient technology for transmitting binary data in WCF messages. The MTOM encoder attempts to create a balance between efficiency and interoperability. The MTOM encoding transmits most XML in textual form, but optimizes large blocks of binary data by transmitting them as-is, without conversion to their base64 encoded format. + + For more information about the binding element that specifies that messages are encoded using a textual representation of XML, see . + + For more information about the binding element that specifies messages are encoded using the .NET Binary Format for XML, see . + + To implement a custom message encoder, use the class. + ]]> @@ -100,11 +100,11 @@ Initializes a new instance of the class. - used consists of the version of WS-Addressing 1.0 and SOAP1.2. The default character encoding is UTF-8. - + used consists of the version of WS-Addressing 1.0 and SOAP1.2. The default character encoding is UTF-8. + ]]> @@ -139,11 +139,11 @@ The that is used to format the message characters. Initializes a new instance of the class with a specified message version and character encoding. - used consists of the version of WS-Addressing 1.0 and SOAP1.2. The default character encoding is UTF-8. The character encodings supported by default are UTF-8, Unicode, and Big Endian Unicode. - + used consists of the version of WS-Addressing 1.0 and SOAP1.2. The default character encoding is UTF-8. The character encodings supported by default are UTF-8, Unicode, and Big Endian Unicode. + ]]> @@ -335,11 +335,11 @@ Creates a new object initialized from the current one. A object with property values equal to those of the current element. - @@ -415,11 +415,11 @@ Returns a typed object requested, if present, from the appropriate layer in the binding element stack. The typed object requested if it is present or if it is not. - @@ -462,11 +462,11 @@ Gets or sets the maximum buffer size. The maximum size of the buffer. The default value is 65536 (0x10000) bytes. - quota is intended to cap the amount of memory that can be allocated when reading MTOM messages and so limit the excessive consumption of memory due to the buffering requirements. - + quota is intended to cap the amount of memory that can be allocated when reading MTOM messages and so limit the excessive consumption of memory due to the buffering requirements. + ]]> The value set is less than or equal to zero. @@ -510,11 +510,11 @@ Gets or sets the maximum number of XML readers that is allocated to a pool and is ready for use to process incoming messages. The maximum number of readers to be kept in the pool. The default value is 64 readers. - The value is less than or equal to zero. @@ -558,11 +558,11 @@ Gets or sets the maximum number of XML writers that is allocated to a pool and are ready for use to process outgoing messages. The maximum number of writers to be kept in the pool. The default value is 16 writers. - The value is less than or equal to zero. @@ -602,11 +602,11 @@ Gets or sets the SOAP message and WS-Addressing versions that are used or expected. The that is used for the SOAP message. - used consists of the version of WS-Addressing 1.0 and SOAP1.2. - + used consists of the version of WS-Addressing 1.0 and SOAP1.2. + ]]> The value is . @@ -647,23 +647,23 @@ Gets or sets constraints on the complexity of XML messages that can be processed by endpoints configured with this binding element. The that specifies the complexity constraints on SOAP messages exchanged. The default values for these constraints are provided in the following Remarks section. - = 32 - -- = 8192 - -- = 16384 - -- = 4096 - -- = 16384 - - For more information, see . - + = 32 + +- = 8192 + +- = 16384 + +- = 4096 + +- = 16384 + + For more information, see . + ]]> @@ -795,15 +795,15 @@ A object that provides mappings from exported WSDL elements to the contract description. Inserts a policy assertion into the WSDL, when it is generated, which indicates that an MTOM encoding is being used. - -``` - + +``` + ]]> @@ -841,11 +841,11 @@ A object that provides mappings from exported WSDL elements to the contract description. Modifies the WSDL contract for MTOM-specific information. - method puts the SOAP message version into the WSDL. - + method puts the SOAP message version into the WSDL. + ]]> @@ -881,11 +881,11 @@ A object that provides mappings from exported WSDL elements to the endpoint description. Puts the SOAP message version into the WSDL. - @@ -930,11 +930,11 @@ Gets or sets the encoding that is used to format the characters in the text message. The that is used to format the characters in the text message. - The value is . diff --git a/xml/System.ServiceModel.Channels/NamedPipeTransportBindingElement.xml b/xml/System.ServiceModel.Channels/NamedPipeTransportBindingElement.xml index a698b2455ea..a326d38192c 100644 --- a/xml/System.ServiceModel.Channels/NamedPipeTransportBindingElement.xml +++ b/xml/System.ServiceModel.Channels/NamedPipeTransportBindingElement.xml @@ -33,29 +33,29 @@ Represents the binding element for the named pipe transport. - class is the starting point for creating a custom binding that implements the named pipes transport protocol. This transport is used for on-machine WCF communication. - - The WCF service model uses this class to create factory objects that implement the and interfaces. These factory objects then create and accept the channels that transmit SOAP messages using the named pipes protocol. - - You configure the factories that this class creates by setting its properties, such as: . - - You can also set properties on the base class, , such as: , , and . For a complete list of properties, see . - - Finally, you can set properties on the base class of , which is , such as . For a complete list of properties, see . - - - -## Examples - This example shows how to use this class: - + class is the starting point for creating a custom binding that implements the named pipes transport protocol. This transport is used for on-machine WCF communication. + + The WCF service model uses this class to create factory objects that implement the and interfaces. These factory objects then create and accept the channels that transmit SOAP messages using the named pipes protocol. + + You configure the factories that this class creates by setting its properties, such as: . + + You can also set properties on the base class, , such as: , , and . For a complete list of properties, see . + + Finally, you can set properties on the base class of , which is , such as . For a complete list of properties, see . + + + +## Examples + This example shows how to use this class: + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uenamedpipetransportbindingelement/cs/program.cs" id="Snippet0"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uenamedpipetransportbindingelement/vb/module1.vb" id="Snippet0"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uenamedpipetransportbindingelement/vb/module1.vb" id="Snippet0"::: + ]]> @@ -89,14 +89,14 @@ Initializes a new instance of the class. - @@ -125,19 +125,19 @@ An instance of the class. Initializes a new instance of the class. - . - - - -## Examples - This example shows how to initialize a new instance of the class: - + . + + + +## Examples + This example shows how to initialize a new instance of the class: + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uenamedpipetransportbindingelement/cs/program.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uenamedpipetransportbindingelement/vb/module1.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uenamedpipetransportbindingelement/vb/module1.vb" id="Snippet2"::: + ]]> @@ -195,19 +195,19 @@ Creates a channel factory of the specified type that can be used to create channels. Returns a channel factory of the specified type. - @@ -248,19 +248,19 @@ Creates a channel listener of the specified type. Returns a channel listener of the specified type. - @@ -293,14 +293,14 @@ Creates a copy of the current binding element. Returns a copy of the current binding element. - @@ -335,14 +335,14 @@ Gets a collection of connection pool settings. A object that contains various properties related to connection pooling. - @@ -383,19 +383,19 @@ Gets a specified object from the . The specified object from the , or if the object isn't found. - . - - - -## Examples - This example shows how to get a specified object from the : - + . + + + +## Examples + This example shows how to get a specified object from the : + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uenamedpipetransportbindingelement/cs/program.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uenamedpipetransportbindingelement/vb/module1.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uenamedpipetransportbindingelement/vb/module1.vb" id="Snippet8"::: + ]]> @@ -445,19 +445,19 @@ Returns the URI scheme for the transport. Returns the URI scheme for the transport, which is "net.pipe". - diff --git a/xml/System.ServiceModel.Channels/OneWayBindingElement.xml b/xml/System.ServiceModel.Channels/OneWayBindingElement.xml index ab7131c507f..00378c9a5cd 100644 --- a/xml/System.ServiceModel.Channels/OneWayBindingElement.xml +++ b/xml/System.ServiceModel.Channels/OneWayBindingElement.xml @@ -468,7 +468,7 @@ ## Remarks This method writes binding-related statements into the WSDL information exposed by a particular contract and is used by WCF to communicate to clients the existence of this custom binding element in the binding stack. - This method takes two parameters: the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then use this method to add your own policy assertions to the appropriate collection. + This method takes two parameters: the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then use this method to add your own policy assertions to the appropriate collection. The property exposes the for the endpoint that is being exported. This enables this method to correctly scope their exported policy assertions. For example, security attributes in code can add behaviors to the that indicate where security policy assertions should be added. diff --git a/xml/System.ServiceModel.Channels/PnrpPeerResolverBindingElement.xml b/xml/System.ServiceModel.Channels/PnrpPeerResolverBindingElement.xml index 41e27a56ee5..5cfc93fbacd 100644 --- a/xml/System.ServiceModel.Channels/PnrpPeerResolverBindingElement.xml +++ b/xml/System.ServiceModel.Channels/PnrpPeerResolverBindingElement.xml @@ -17,11 +17,11 @@ Defines the binding element used to create a Peer Name Resolution Protocol (PNRP) peer resolver. - after the instance has been constructed. - + after the instance has been constructed. + ]]> @@ -118,11 +118,11 @@ that contains the new channel factory of the specified type. - @@ -163,11 +163,11 @@ that contains the new channel listener of the specified type. - @@ -264,11 +264,11 @@ Creates a new instance that is a copy of the current binding element. A new that contains a copy of the current binding element. - type. - + type. + ]]> diff --git a/xml/System.ServiceModel.Channels/PrivacyNoticeBindingElement.xml b/xml/System.ServiceModel.Channels/PrivacyNoticeBindingElement.xml index 40a068e1511..ce10e3d0e37 100644 --- a/xml/System.ServiceModel.Channels/PrivacyNoticeBindingElement.xml +++ b/xml/System.ServiceModel.Channels/PrivacyNoticeBindingElement.xml @@ -127,11 +127,11 @@ Queries the binding element stack to see whether it supports a particular interface. The interface whose support is being tested. - on the next binding element in the binding context. - + on the next binding element in the binding context. + ]]> diff --git a/xml/System.ServiceModel.Channels/ReceiveContext.xml b/xml/System.ServiceModel.Channels/ReceiveContext.xml index 99cf5417eb2..cfd59c87b5e 100644 --- a/xml/System.ServiceModel.Channels/ReceiveContext.xml +++ b/xml/System.ServiceModel.Channels/ReceiveContext.xml @@ -16,11 +16,11 @@ Derive from this class to implement a custom state machine for receive context functionality. - @@ -50,29 +50,29 @@ Causes the state machine to transition to the abandoned state. - may stop responding when there is an ambient transaction and is called and afterwards the transaction is rolled back. If is called prior to the transaction rollback completing, a race condition will exist, causing the call to to stop responding. This can be illustrated by the following pseudo-code example - -``` -using (TransactionScope ts = new TransactionScope()) -{ - try - { - rc.Complete(); - ... - } - Catch (Exception) - { - rc.Abandon() - } -} - -``` - - This is not the recommended pattern for working with . Instead the try/catch block should be placed outside of the transaction scope. - + may stop responding when there is an ambient transaction and is called and afterwards the transaction is rolled back. If is called prior to the transaction rollback completing, a race condition will exist, causing the call to to stop responding. This can be illustrated by the following pseudo-code example + +``` +using (TransactionScope ts = new TransactionScope()) +{ + try + { + rc.Complete(); + ... + } + Catch (Exception) + { + rc.Abandon() + } +} + +``` + + This is not the recommended pattern for working with . Instead the try/catch block should be placed outside of the transaction scope. + ]]> diff --git a/xml/System.ServiceModel.Channels/ReliableSessionBindingElement.xml b/xml/System.ServiceModel.Channels/ReliableSessionBindingElement.xml index 9560890a174..25aa9a236e6 100644 --- a/xml/System.ServiceModel.Channels/ReliableSessionBindingElement.xml +++ b/xml/System.ServiceModel.Channels/ReliableSessionBindingElement.xml @@ -355,7 +355,7 @@ . + This method returns `true` or `false` for a `TChannel` in accordance with the table of values provided in . ]]> @@ -403,7 +403,7 @@ ## Remarks Channel stacks are typically created using a factory pattern where a binding creates the channel stack. When sending messages, a binding is used to build a channel factory which in turn builds a channel stack and returns a reference to the top channel in the stack. The application can then use this channel to send messages. Similarly when receiving messages, a binding is used to build a channel listener which listens for incoming messages. The channel listener provides messages to the listening application by creating channel stacks and handing the application a reference to the top channel. - This method returns `true` or `false` for a `TChannel` in accordance with the table of values provided in . + This method returns `true` or `false` for a `TChannel` in accordance with the table of values provided in . ]]> diff --git a/xml/System.ServiceModel.Channels/ReliableSessionBindingElementImporter.xml b/xml/System.ServiceModel.Channels/ReliableSessionBindingElementImporter.xml index 3add5c8b37f..96756fce651 100644 --- a/xml/System.ServiceModel.Channels/ReliableSessionBindingElementImporter.xml +++ b/xml/System.ServiceModel.Channels/ReliableSessionBindingElementImporter.xml @@ -91,7 +91,7 @@ method. + Implements the method. ]]> diff --git a/xml/System.ServiceModel.Channels/RequestContext.xml b/xml/System.ServiceModel.Channels/RequestContext.xml index facb59308a9..ef4ac32b60c 100644 --- a/xml/System.ServiceModel.Channels/RequestContext.xml +++ b/xml/System.ServiceModel.Channels/RequestContext.xml @@ -64,7 +64,7 @@ - Put your cleanup code in (On)(Begin)Close (and/or OnAbort), not in a destructor. - Avoid destructors: they cause the compiler to auto-generate . - Avoid non-reference members: they can cause the compiler to auto-generate . -- Avoid finalizers; but if you include one, you should suppress the build warning and call and the finalizer itself from (On)(Begin)Close (and/or OnAbort) to emulate what would have been the auto-generated behavior. +- Avoid finalizers; but if you include one, you should suppress the build warning and call and the finalizer itself from (On)(Begin)Close (and/or OnAbort) to emulate what would have been the auto-generated behavior. ]]> @@ -201,7 +201,7 @@ method when the application processing must continue without waiting. Use one of the synchronous methods when it is acceptable for the current thread to be blocked while it replies to the request message or until the time-out interval is exceeded. + Use the asynchronous method when the application processing must continue without waiting. Use one of the synchronous methods when it is acceptable for the current thread to be blocked while it replies to the request message or until the time-out interval is exceeded. This method receives notification, through a callback, of the identity of the event handler for the operation. The operation is not complete until either the reply is sent or the time-out occurs. @@ -257,9 +257,9 @@ method to allow the application processing to continue without waiting for the request to complete. + Use the asynchronous method to allow the application processing to continue without waiting for the request to complete. - Use one of the synchronous methods when it is acceptable for the current thread to be blocked while it replies to the request message or until the time-out interval is exceeded. This method receives notification, through a callback, of the identity of the event handler for the operation. The operation is not complete until either the reply is sent or the time-out occurs. + Use one of the synchronous methods when it is acceptable for the current thread to be blocked while it replies to the request message or until the time-out interval is exceeded. This method receives notification, through a callback, of the identity of the event handler for the operation. The operation is not complete until either the reply is sent or the time-out occurs. ]]> @@ -475,9 +475,9 @@ when it is acceptable for the current thread to be blocked while it replies to the request message. The thread is blocked up to the specified `timeout`. + Use when it is acceptable for the current thread to be blocked while it replies to the request message. The thread is blocked up to the specified `timeout`. - If the application processing must continue without waiting for the reply to complete, use the asynchronous method. This method receives notification, through a callback, of the identity of the event handler for the operation. The operation is not complete until either a message becomes available in the channel or the time-out occurs. + If the application processing must continue without waiting for the reply to complete, use the asynchronous method. This method receives notification, through a callback, of the identity of the event handler for the operation. The operation is not complete until either a message becomes available in the channel or the time-out occurs. ]]> @@ -523,9 +523,9 @@ when it is acceptable for the current thread to be blocked while it replies to the request message. The thread is blocked up to the specified `timeout`. + Use when it is acceptable for the current thread to be blocked while it replies to the request message. The thread is blocked up to the specified `timeout`. - If the application processing must continue without waiting for the reply to complete, use the asynchronous method. This method receives notification, through a callback, of the identity of the event handler for the operation. The operation is not complete until either a message becomes available in the channel or the time-out occurs. + If the application processing must continue without waiting for the reply to complete, use the asynchronous method. This method receives notification, through a callback, of the identity of the event handler for the operation. The operation is not complete until either a message becomes available in the channel or the time-out occurs. ]]> diff --git a/xml/System.ServiceModel.Channels/SecurityBindingElement.xml b/xml/System.ServiceModel.Channels/SecurityBindingElement.xml index da76c3d2fa1..2fc0a7a4489 100644 --- a/xml/System.ServiceModel.Channels/SecurityBindingElement.xml +++ b/xml/System.ServiceModel.Channels/SecurityBindingElement.xml @@ -65,7 +65,7 @@ 2. Create a custom binding element that is above this binding element in the binding stack, such as the optional and . -3. Add these elements in the order previously described to the using the method. +3. Add these elements in the order previously described to the using the method. 4. Create an instance of a security binding element derived from , such as , , or . @@ -177,7 +177,7 @@ ## Remarks The channel factory created is a SOAP message security channel factory, which internally has a reference to the channel factory that corresponds to the binding context, (which includes the transport channel factory). - This method does parameter error-checking, and then calls . That method, when implemented in a derived class, creates a channel factory, which is used to create a channel that processes outgoing messages for this binding. + This method does parameter error-checking, and then calls . That method, when implemented in a derived class, creates a channel factory, which is used to create a channel that processes outgoing messages for this binding. ]]> @@ -238,7 +238,7 @@ , which does error checking, calls this method. When this method is implemented in a derived class, it creates a channel factory, which is used to create a channel that processes outgoing messages for this binding. + , which does error checking, calls this method. When this method is implemented in a derived class, it creates a channel factory, which is used to create a channel that processes outgoing messages for this binding. ]]> @@ -291,7 +291,7 @@ ## Remarks The channel factory created is a SOAP message security channel listener, which internally has a reference to the channel listener that corresponds to the binding context, which includes the transport channel listener. - This method does parameter error-checking, and then calls . That method, when implemented in a derived class, creates a channel listener, which is used to create a channel that processes incoming messages for this binding. + This method does parameter error-checking, and then calls . That method, when implemented in a derived class, creates a channel listener, which is used to create a channel that processes incoming messages for this binding. ]]> @@ -342,7 +342,7 @@ , which does error checking, calls this method. When this method is implemented in a derived class, it creates a channel listener, which is used to create a channel that processes outgoing messages for this binding. + , which does error checking, calls this method. When this method is implemented in a derived class, it creates a channel listener, which is used to create a channel that processes outgoing messages for this binding. ]]> @@ -2839,7 +2839,7 @@ includes the , , , , , , and values of the current instance. + Information returned by includes the , , , , , , and values of the current instance. ]]> diff --git a/xml/System.ServiceModel.Channels/SslStreamSecurityBindingElement.xml b/xml/System.ServiceModel.Channels/SslStreamSecurityBindingElement.xml index 7ce8e6a51d0..70858873fcf 100644 --- a/xml/System.ServiceModel.Channels/SslStreamSecurityBindingElement.xml +++ b/xml/System.ServiceModel.Channels/SslStreamSecurityBindingElement.xml @@ -85,7 +85,7 @@ 2. Create custom binding elements that are above this binding element in the binding stack, such as the optional and . -3. Add the created elements in the order described previously to the using the method. +3. Add the created elements in the order described previously to the using the method. 4. Create an instance of and add it to the collection. @@ -991,7 +991,7 @@ cf.Credentials.ClientCertificate.SetCertificate( ## Remarks This method writes binding-related statements into the WSDL information exposed by a particular contract and is used by WCF to communicate to clients the existence of this custom binding element in the binding stack. - This method takes two parameters: the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then use this method to add your own policy assertions to the appropriate collection. + This method takes two parameters: the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then use this method to add your own policy assertions to the appropriate collection. The property exposes the for the endpoint that is being exported. This enables this method to correctly scope their exported policy assertions. For example, security attributes in code can add behaviors to the that indicate where security policy assertions should be added. diff --git a/xml/System.ServiceModel.Channels/StandardBindingImporter.xml b/xml/System.ServiceModel.Channels/StandardBindingImporter.xml index aadcc8b902c..4167edff42d 100644 --- a/xml/System.ServiceModel.Channels/StandardBindingImporter.xml +++ b/xml/System.ServiceModel.Channels/StandardBindingImporter.xml @@ -21,13 +21,13 @@ Provides an extensibility point for mapping WSDL contracts and policy assertions into Windows Communication Foundation (WCF) standard bindings. - either programmatically or by using an application configuration file. You can also attach your custom object to the internal used by the [ServiceModel Metadata Utility Tool (Svcutil.exe)](/dotnet/framework/wcf/servicemodel-metadata-utility-tool-svcutil-exe) using an application configuration file. - - Use the method to directly modify the metadata that is then imported into standard binding objects. - + either programmatically or by using an application configuration file. You can also attach your custom object to the internal used by the [ServiceModel Metadata Utility Tool (Svcutil.exe)](/dotnet/framework/wcf/servicemodel-metadata-utility-tool-svcutil-exe) using an application configuration file. + + Use the method to directly modify the metadata that is then imported into standard binding objects. + ]]> @@ -86,11 +86,11 @@ The of type that contains the policy elements. Called prior to importing the metadata documents associated with the standard binding. - methods of all registered objects is called before anything is imported from the supplied metadata. At this point, you can directly modify the metadata that is subsequently imported into standard binding objects. - + methods of all registered objects is called before anything is imported from the supplied metadata. At this point, you can directly modify the metadata that is subsequently imported into standard binding objects. + ]]> diff --git a/xml/System.ServiceModel.Channels/StreamUpgradeAcceptor.xml b/xml/System.ServiceModel.Channels/StreamUpgradeAcceptor.xml index 273108eb94d..eff5453fe37 100644 --- a/xml/System.ServiceModel.Channels/StreamUpgradeAcceptor.xml +++ b/xml/System.ServiceModel.Channels/StreamUpgradeAcceptor.xml @@ -17,15 +17,15 @@ To implement a custom upgrade acceptor, inherited from this base class. - and to implement a custom stream upgrade. - - For a detailed description of the upgrade process, see . - + and to implement a custom stream upgrade. + + For a detailed description of the upgrade process, see . + ]]> Custom Stream Upgrades @@ -79,11 +79,11 @@ Upgrades the transport stream and returns the upgraded stream. Returns the upgraded stream. - @@ -116,11 +116,11 @@ Asynchronous version of . Returns a result code that is passed into EndAcceptUpgrade to access the upgraded stream. - . - + . + ]]> @@ -150,11 +150,11 @@ if this kind of upgrade is supported; otherwise, . - @@ -183,11 +183,11 @@ Asynchronous version of . Returns the upgraded stream. - . - + . + ]]> diff --git a/xml/System.ServiceModel.Channels/StreamUpgradeInitiator.xml b/xml/System.ServiceModel.Channels/StreamUpgradeInitiator.xml index b051ae06439..d5ab92ad6f4 100644 --- a/xml/System.ServiceModel.Channels/StreamUpgradeInitiator.xml +++ b/xml/System.ServiceModel.Channels/StreamUpgradeInitiator.xml @@ -31,13 +31,13 @@ To implement a custom upgrade initiator, inherit from this base class. - and to implement a custom stream upgrade. - - For a detailed description of the upgrade process, see . - + and to implement a custom stream upgrade. + + For a detailed description of the upgrade process, see . + ]]> Custom Stream Upgrades @@ -103,11 +103,11 @@ This method can be implemented to do asynchronous processing that initiates an upgrade. Returns an to be passed into the method. - and returns. - + and returns. + ]]> @@ -136,11 +136,11 @@ This method is the asynchronous callback method that is called after has completed. Returns the upgraded stream. - . - + . + ]]> @@ -174,11 +174,11 @@ Returns the content type of the next upgrade to be performed. Returns the content type of the next upgrade. - @@ -211,11 +211,11 @@ Initiates the upgrade of the stream by requesting the other end of its connection to upgrade the channel transport layer. Returns the upgraded stream. - diff --git a/xml/System.ServiceModel.Channels/StreamUpgradeProvider.xml b/xml/System.ServiceModel.Channels/StreamUpgradeProvider.xml index 15062052d13..907da84d2b3 100644 --- a/xml/System.ServiceModel.Channels/StreamUpgradeProvider.xml +++ b/xml/System.ServiceModel.Channels/StreamUpgradeProvider.xml @@ -32,23 +32,23 @@ Implements a custom upgrade provider, inherited from this base class. - . You can implement multiple upgrades, each wrapping the preceding one. - - The upgrade process has the following steps: - -1. Implement a class that derives from . - -2. Register it. You do this by creating a binding element for it, and registering the provider in a custom binding. - -3. The derived class that you implement creates an instance of , which at run time initiates a request to the other end of its connection to upgrade the channel transport layer. - -4. The derived class that you implement creates an instance of , which at run time receives the upgrade request from the preceding step and, if possible, accepts the upgrade and returns the upgraded stream to the other side of its connection. - -5. If there are additional upgrade requests, they are processed sequentially, as described in the preceding two steps. - + . You can implement multiple upgrades, each wrapping the preceding one. + + The upgrade process has the following steps: + +1. Implement a class that derives from . + +2. Register it. You do this by creating a binding element for it, and registering the provider in a custom binding. + +3. The derived class that you implement creates an instance of , which at run time initiates a request to the other end of its connection to upgrade the channel transport layer. + +4. The derived class that you implement creates an instance of , which at run time receives the upgrade request from the preceding step and, if possible, accepts the upgrade and returns the upgraded stream to the other side of its connection. + +5. If there are additional upgrade requests, they are processed sequentially, as described in the preceding two steps. + ]]> Custom Stream Upgrades @@ -62,11 +62,11 @@ Initializes a new instance of the class. - . Otherwise, use , which will set the time-out properties to `null`. - + . Otherwise, use , which will set the time-out properties to `null`. + ]]> @@ -101,11 +101,11 @@ Initializes a new instance of the class. - @@ -138,11 +138,11 @@ The default communication time-outs. Initializes a new instance of the class. - @@ -168,11 +168,11 @@ Creates an instance of . Returns an instance of . - @@ -211,11 +211,11 @@ Creates an instance of . Returns an instance of . - for this upgrade provider that creates upgrade requests for the matching at the endpoint provided. - + for this upgrade provider that creates upgrade requests for the matching at the endpoint provided. + ]]> diff --git a/xml/System.ServiceModel.Channels/SymmetricSecurityBindingElement.xml b/xml/System.ServiceModel.Channels/SymmetricSecurityBindingElement.xml index c3cb8db1a8b..99904f79f1a 100644 --- a/xml/System.ServiceModel.Channels/SymmetricSecurityBindingElement.xml +++ b/xml/System.ServiceModel.Channels/SymmetricSecurityBindingElement.xml @@ -32,7 +32,7 @@ 2. Create custom binding elements that is above this binding element in the binding stack, such as the optional and . -3. Add the created elements, in the order mentioned previously, to the using the method. +3. Add the created elements, in the order mentioned previously, to the using the method. 4. Create an instance of and add it to the collection. @@ -443,7 +443,7 @@ ## Remarks This method writes binding-related statements into the WSDL information exposed by a particular contract and is used by Windows Communication Foundation (WCF) to communicate to clients of the existence of this custom binding element in the binding stack. - This method takes two parameters: the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then use this method to add your own policy assertions to the appropriate collection. + This method takes two parameters: the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then use this method to add your own policy assertions to the appropriate collection. The property exposes the for the endpoint that is being exported. This allows this method to correctly scope their exported policy assertions. For example, security attributes in code may add behaviors to the that indicate where security policy assertions should be added. @@ -477,7 +477,7 @@ includes the , , and values of the current instance. + Information returned by includes the , , and values of the current instance. ]]> diff --git a/xml/System.ServiceModel.Channels/TcpTransportBindingElement.xml b/xml/System.ServiceModel.Channels/TcpTransportBindingElement.xml index 9c765cf0ea9..c21a6cd76c2 100644 --- a/xml/System.ServiceModel.Channels/TcpTransportBindingElement.xml +++ b/xml/System.ServiceModel.Channels/TcpTransportBindingElement.xml @@ -156,7 +156,7 @@ . + This method is a copy constructor used to clone the binding element, and is exposed so that derived classes can implement . ]]> diff --git a/xml/System.ServiceModel.Channels/TextMessageEncodingBindingElement.xml b/xml/System.ServiceModel.Channels/TextMessageEncodingBindingElement.xml index 4b814e1229e..97425bbd688 100644 --- a/xml/System.ServiceModel.Channels/TextMessageEncodingBindingElement.xml +++ b/xml/System.ServiceModel.Channels/TextMessageEncodingBindingElement.xml @@ -756,7 +756,7 @@ is responsible for setting information about the message version in the WSDL. But this is done by the method, not by , which is implemented but empty. + The is responsible for setting information about the message version in the WSDL. But this is done by the method, not by , which is implemented but empty. ]]> @@ -796,7 +796,7 @@ is responsible for setting information about the message version in the WSDL. But this is done by the method. + The is responsible for setting information about the message version in the WSDL. But this is done by the method. ]]> diff --git a/xml/System.ServiceModel.Channels/TransactionFlowBindingElement.xml b/xml/System.ServiceModel.Channels/TransactionFlowBindingElement.xml index b591fa64abc..76f1f8f4eb0 100644 --- a/xml/System.ServiceModel.Channels/TransactionFlowBindingElement.xml +++ b/xml/System.ServiceModel.Channels/TransactionFlowBindingElement.xml @@ -21,14 +21,14 @@ Represents the configuration element that specifies transaction flow support for a binding. This class cannot be inherited. - [!CAUTION] -> When using the protocol to flow transactions from endpoint to endpoint, the transaction timeout can be lost if the destination endpoint attempts to flow again using any protocol other than . This can cause all down-level nodes after the hop to timeout later than expected. - +> When using the protocol to flow transactions from endpoint to endpoint, the transaction timeout can be lost if the destination endpoint attempts to flow again using any protocol other than . This can cause all down-level nodes after the hop to timeout later than expected. + ]]> Enabling Transaction Flow @@ -87,11 +87,11 @@ A value that contains the transaction protocol used in flowing a transaction. Initializes a new instance of the class with the specified protocol that is used to flow a transaction. - @@ -160,11 +160,11 @@ Initializes a channel factory for producing channels of a specified type from a binding context. The of type initialized from . - @@ -205,13 +205,13 @@ Initializes a channel listener for accepting channels of a specified type from the binding context. The of type initialized from . - @@ -248,11 +248,11 @@ if a channel factory for the specified type of channel can be built from ; otherwise, . - throws an exception if it cannot build a channel factory for the specified channel type. - + throws an exception if it cannot build a channel factory for the specified channel type. + ]]> @@ -293,11 +293,11 @@ if a channel listener for the specified type of channel can be built from ; otherwise, . - throws an exception if it cannot build a channel listener for the specified channel type. - + throws an exception if it cannot build a channel listener for the specified channel type. + ]]> @@ -325,11 +325,11 @@ Creates a duplicate of this element. A that is a duplicate of this element. - @@ -362,17 +362,17 @@ The typed object for which the method is querying. - The - + The + that should be used to get the requested property. Gets the typed object requested, if present, from the appropriate layer in the binding stack. The typed object requested if it is present; if it is not. - @@ -466,11 +466,11 @@ Gets or sets the transaction protocol used in flowing a transaction. A that specifies the transaction protocol to be used for transaction flow. The default is . - diff --git a/xml/System.ServiceModel.Channels/TransactionFlowBindingElementImporter.xml b/xml/System.ServiceModel.Channels/TransactionFlowBindingElementImporter.xml index 137505b4a77..f1d6392de81 100644 --- a/xml/System.ServiceModel.Channels/TransactionFlowBindingElementImporter.xml +++ b/xml/System.ServiceModel.Channels/TransactionFlowBindingElementImporter.xml @@ -21,13 +21,13 @@ Imports the transaction policy (WS-Policy assertions) of a service endpoint, adds implementing binding elements to the binding on the client, and transaction flow attributes to the appropriate operations on the service's proxy. This class cannot be inherited. - method adds a instance to the collection of binding elements. This also adds instances, as appropriate, on the `Operations` collection present in the conversion context's contract. - + method adds a instance to the collection of binding elements. This also adds instances, as appropriate, on the `Operations` collection present in the conversion context's contract. + ]]> diff --git a/xml/System.ServiceModel.Channels/TransportSecurityBindingElement.xml b/xml/System.ServiceModel.Channels/TransportSecurityBindingElement.xml index 9aa524e6cca..f895a8f3ac3 100644 --- a/xml/System.ServiceModel.Channels/TransportSecurityBindingElement.xml +++ b/xml/System.ServiceModel.Channels/TransportSecurityBindingElement.xml @@ -72,7 +72,7 @@ 2. Create custom binding elements that will be above this binding element in the binding stack, such as the optional and . -3. Add these elements in the previously mentioned order to the using the method. +3. Add these elements in the previously mentioned order to the using the method. 4. Create an instance of and add it to the collection. @@ -369,7 +369,7 @@ ## Remarks This method writes binding-related statements into the WSDL information exposed by a particular contract and is used by Windows Communication Foundation (WCF) to communicate to clients the existence of this custom binding element in the binding stack. - This method takes two parameters: the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then use this method to add your own policy assertions to the appropriate collection. + This method takes two parameters: the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then use this method to add your own policy assertions to the appropriate collection. The property exposes the for the endpoint that is being exported. This allows this method to correctly scope their exported policy assertions. For example, security attributes in code may add behaviors to the that indicate where security policy assertions should be added. diff --git a/xml/System.ServiceModel.Channels/WebContentTypeMapper.xml b/xml/System.ServiceModel.Channels/WebContentTypeMapper.xml index 081854a2edd..902c8cb8f39 100644 --- a/xml/System.ServiceModel.Channels/WebContentTypeMapper.xml +++ b/xml/System.ServiceModel.Channels/WebContentTypeMapper.xml @@ -18,11 +18,11 @@ Specifies the format to which the content type of an incoming message is mapped. - method. - + method. + ]]> @@ -69,11 +69,11 @@ When overridden in a derived class, returns the message format used for a specified content type. The that specifies the format to which the message content type is mapped. - that always returned regardless of the content type that was passed in. - + that always returned regardless of the content type that was passed in. + ]]> diff --git a/xml/System.ServiceModel.Channels/WebMessageEncodingBindingElement.xml b/xml/System.ServiceModel.Channels/WebMessageEncodingBindingElement.xml index 66173a79dd0..eb2cb12a79d 100644 --- a/xml/System.ServiceModel.Channels/WebMessageEncodingBindingElement.xml +++ b/xml/System.ServiceModel.Channels/WebMessageEncodingBindingElement.xml @@ -29,13 +29,13 @@ This binding element and its composite encoder are used to control the encoding in scenarios that do not use SOAP messaging used by the . These scenarios include "Plain Old XML" (POX), Representational State Transfer (REST), Really Simple Syndication (RSS) and Atom syndication, and Asynchronous JavaScript and XML (AJAX). The composite message encoder does not support SOAP or WS-Addressing, and so always returns . - The binding element can be configured with a write character encoding at construction time using the constructor. The value specifies the behavior on write for the JSON and Textual XML cases. On read, any valid message encoding and text encoding is understood. + The binding element can be configured with a write character encoding at construction time using the constructor. The value specifies the behavior on write for the JSON and Textual XML cases. On read, any valid message encoding and text encoding is understood. This constructor sets default values on the maximum number of readers and writers that are allocated to pools and that are respectively available to process incoming and outgoing messages without allocating new readers or writers. The properties and can also be used to set the maximum number of readers and writers to be allocated respectively. By default 64 readers and 16 writers are allocated. Default complexity constraints are also set by this constructor on the associated with this encoding by the property to protect against a class of denial of service (DOS) attacks that attempt to use message complexity to tie up endpoint processing resources. - The has a method that creates a message encoder factory that produces JSON, XML or Raw message decoders and encoders as appropriate depending on the content type specified. + The has a method that creates a message encoder factory that produces JSON, XML or Raw message decoders and encoders as appropriate depending on the content type specified. The also provides the methods to build the factories and listeners for the channels through which the HTTP requests flow. @@ -74,7 +74,7 @@ as the default character encoding. So use this constructor when you want this character encoding. If you want another character encoding, use the constructor. + This constructor uses as the default character encoding. So use this constructor when you want this character encoding. If you want another character encoding, use the constructor. This constructor sets default values on the maximum number of readers and writers that are allocated to pools and that are respectively available to process incoming and outgoing messages without allocating new readers or writers. There are 64 readers allocated by default for the property and there are 16 writers allocated by default for the property. @@ -387,7 +387,7 @@ implementation: when `T` is , the property is returned. + This override adds one property to the base implementation: when `T` is , the property is returned. ]]> @@ -596,7 +596,7 @@ is responsible for setting information about the message version in the WSDL. But this is done by the method. + The is responsible for setting information about the message version in the WSDL. But this is done by the method. ]]> diff --git a/xml/System.ServiceModel.Channels/WindowsStreamSecurityBindingElement.xml b/xml/System.ServiceModel.Channels/WindowsStreamSecurityBindingElement.xml index 6ccbf4f2a01..b9c540bd4d9 100644 --- a/xml/System.ServiceModel.Channels/WindowsStreamSecurityBindingElement.xml +++ b/xml/System.ServiceModel.Channels/WindowsStreamSecurityBindingElement.xml @@ -85,7 +85,7 @@ 2. Create any required custom binding elements that are above this binding element in the binding stack, such as the optional and . -3. Add the created elements in the order described previously to the using the method. +3. Add the created elements in the order described previously to the using the method. 4. Create an instance of and add it to the collection. @@ -434,7 +434,7 @@ method. + A channel factory is used to create a channel that processes outgoing messages for this binding. This method delegates to the method. ]]> @@ -485,7 +485,7 @@ method. + A channel listener is used to create a channel that processes incoming messages for this binding. This method delegates to the method. ]]> @@ -732,7 +732,7 @@ ## Remarks This method writes binding-related statements into the WSDL information exposed by a particular contract and is used by WCF to communicate to clients the existence of this custom binding element in the binding stack. - This method takes two parameters: the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then use this method to add your own policy assertions to the appropriate collection. + This method takes two parameters: the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then use this method to add your own policy assertions to the appropriate collection. The property exposes the for the endpoint that is being exported. This enables this method to correctly scope their exported policy assertions. For example, security attributes in code can add behaviors to the that indicate where security policy assertions should be added. diff --git a/xml/System.ServiceModel.Configuration/ServiceModelExtensionCollectionElement`1.xml b/xml/System.ServiceModel.Configuration/ServiceModelExtensionCollectionElement`1.xml index d93cb5f46ec..ae5c8ebf7fc 100644 --- a/xml/System.ServiceModel.Configuration/ServiceModelExtensionCollectionElement`1.xml +++ b/xml/System.ServiceModel.Configuration/ServiceModelExtensionCollectionElement`1.xml @@ -133,7 +133,7 @@ property to 0. + This method empties the collection and resets its property to 0. ]]> diff --git a/xml/System.ServiceModel.Configuration/WebHttpBindingElement.xml b/xml/System.ServiceModel.Configuration/WebHttpBindingElement.xml index 7b36929d7e5..a5094f90e81 100644 --- a/xml/System.ServiceModel.Configuration/WebHttpBindingElement.xml +++ b/xml/System.ServiceModel.Configuration/WebHttpBindingElement.xml @@ -303,7 +303,7 @@ that sets the values of the open, close, send and receive timeouts that are set in the specified `binding`. + This method includes a call to the base that sets the values of the open, close, send and receive timeouts that are set in the specified `binding`. ]]> @@ -591,7 +591,7 @@ constructor. + To use a non-default type of security, use the constructor. ]]> diff --git a/xml/System.ServiceModel.Configuration/WebHttpSecurityElement.xml b/xml/System.ServiceModel.Configuration/WebHttpSecurityElement.xml index ac67f9bacf2..0849420bade 100644 --- a/xml/System.ServiceModel.Configuration/WebHttpSecurityElement.xml +++ b/xml/System.ServiceModel.Configuration/WebHttpSecurityElement.xml @@ -130,7 +130,7 @@ object returned by this property to set the transport security parameters. The must be set to the or value for the settings provided by the property to become effective for the service endpoint. This value can be set in configuration or in the constructor. + Use the object returned by this property to set the transport security parameters. The must be set to the or value for the settings provided by the property to become effective for the service endpoint. This value can be set in configuration or in the constructor. ]]> diff --git a/xml/System.ServiceModel.Configuration/WorkflowRuntimeElement.xml b/xml/System.ServiceModel.Configuration/WorkflowRuntimeElement.xml index e003460bba5..adeade0d152 100644 --- a/xml/System.ServiceModel.Configuration/WorkflowRuntimeElement.xml +++ b/xml/System.ServiceModel.Configuration/WorkflowRuntimeElement.xml @@ -370,9 +370,9 @@ is called. If validation errors are found, a error is thrown. + When this property is set to `true`, the workflow validation is executed every time is called. If validation errors are found, a error is thrown. - When this property is set to `false`, creates a workflow instance and skips validation. In this case, the host application must ensure that the workflow is properly configured, or the runtime error occurs. + When this property is set to `false`, creates a workflow instance and skips validation. In this case, the host application must ensure that the workflow is properly configured, or the runtime error occurs. The default value for this property is `true`. diff --git a/xml/System.ServiceModel.Description/ClientCredentials.xml b/xml/System.ServiceModel.Description/ClientCredentials.xml index 9cf78a5f848..f4d49b1938b 100644 --- a/xml/System.ServiceModel.Description/ClientCredentials.xml +++ b/xml/System.ServiceModel.Description/ClientCredentials.xml @@ -59,9 +59,9 @@ is accessed through the property of the class. + The is accessed through the property of the class. - A object is added to the collection. The property is a *Facade* (a well-known design pattern) over an entry in that collection. Many properties in this class return objects that consist mainly of properties. These objects can be used for configuration: once you `get` the object, you can use it to `set` properties by calling its members. + A object is added to the collection. The property is a *Facade* (a well-known design pattern) over an entry in that collection. Many properties in this class return objects that consist mainly of properties. These objects can be used for configuration: once you `get` the object, you can use it to `set` properties by calling its members. @@ -69,7 +69,7 @@ The following code sample shows how to override this class and implement your own custom client credentials that includes a custom security token manager. > [!IMPORTANT] -> It is important to note that the method is overridden to create a custom security token manager. The security token manager, derived from . must return a custom security token provider, derived from , to create the actual security token. If you do not follow this pattern for creating security tokens, your application will be at risk for security attacks, specifically elevation of privileges. This coding pattern ensures that the correct credentials are used when channel factories are cached. +> It is important to note that the method is overridden to create a custom security token manager. The security token manager, derived from . must return a custom security token provider, derived from , to create the actual security token. If you do not follow this pattern for creating security tokens, your application will be at risk for security attacks, specifically elevation of privileges. This coding pattern ensures that the correct credentials are used when channel factories are cached. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customcredentials/cs/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/c_customcredentials/vb/client/client.vb" id="Snippet1"::: @@ -355,9 +355,9 @@ and methods follow the Core design pattern. can be overridden in derived classes if they add new fields that must be cloned. + The and methods follow the Core design pattern. can be overridden in derived classes if they add new fields that must be cloned. - The method calls the constructor. + The method calls the constructor. ]]> @@ -731,7 +731,7 @@ method. + An explicit implementation of the method. ]]> diff --git a/xml/System.ServiceModel.Description/ContractDescription.xml b/xml/System.ServiceModel.Description/ContractDescription.xml index d6226b17286..ac5186778c9 100644 --- a/xml/System.ServiceModel.Description/ContractDescription.xml +++ b/xml/System.ServiceModel.Description/ContractDescription.xml @@ -459,7 +459,7 @@ overloads is that the ones with two arguments allow you to find attributes from the service (for example, ). + The difference between the overloads is that the ones with two arguments allow you to find attributes from the service (for example, ). ]]> @@ -501,7 +501,7 @@ overloads is that the ones with two arguments allow you to find attributes from the service (for example, ). + The difference between the overloads is that the ones with two arguments allow you to find attributes from the service (for example, ). @@ -550,7 +550,7 @@ overloads is that the ones with two arguments allow you to find attributes from the service (for example, ). + The difference between the overloads is that the ones with two arguments allow you to find attributes from the service (for example, ). @@ -599,7 +599,7 @@ overloads is that the ones with two arguments allow you to find attributes from the service (for example, ). + The difference between the overloads is that the ones with two arguments allow you to find attributes from the service (for example, ). diff --git a/xml/System.ServiceModel.Description/DataContractSerializerOperationBehavior.xml b/xml/System.ServiceModel.Description/DataContractSerializerOperationBehavior.xml index 32cbb33e65b..d97f0314a0d 100644 --- a/xml/System.ServiceModel.Description/DataContractSerializerOperationBehavior.xml +++ b/xml/System.ServiceModel.Description/DataContractSerializerOperationBehavior.xml @@ -61,7 +61,7 @@ enables the control of options, such as the and properties. Some of these properties can be set only using the constructor of the class. In that case, the can be replaced using the method. For more information about data contracts, see [Using Data Contracts](/dotnet/framework/wcf/feature-details/using-data-contracts). + The enables the control of options, such as the and properties. Some of these properties can be set only using the constructor of the class. In that case, the can be replaced using the method. For more information about data contracts, see [Using Data Contracts](/dotnet/framework/wcf/feature-details/using-data-contracts). For more information about using the to replace the returned by the property, see [Data Contract Surrogates](/dotnet/framework/wcf/extending/data-contract-surrogates). diff --git a/xml/System.ServiceModel.Description/FaultDescriptionCollection.xml b/xml/System.ServiceModel.Description/FaultDescriptionCollection.xml index 7426a56f9dc..40fbee1b676 100644 --- a/xml/System.ServiceModel.Description/FaultDescriptionCollection.xml +++ b/xml/System.ServiceModel.Description/FaultDescriptionCollection.xml @@ -52,7 +52,7 @@ and methods to retrieve a or group of objects. + Use the and methods to retrieve a or group of objects. ]]> diff --git a/xml/System.ServiceModel.Description/IContractBehavior.xml b/xml/System.ServiceModel.Description/IContractBehavior.xml index 9d7e4cc6cfc..05b38fc3a3a 100644 --- a/xml/System.ServiceModel.Description/IContractBehavior.xml +++ b/xml/System.ServiceModel.Description/IContractBehavior.xml @@ -51,22 +51,22 @@ For more information about choosing between service, endpoint, and contract behaviors, see [Configuring and Extending the Runtime with Behaviors](/dotnet/framework/wcf/extending/configuring-and-extending-the-runtime-with-behaviors). -- Use the method to provide binding elements with custom data to support the behavior. +- Use the method to provide binding elements with custom data to support the behavior. -- Use the method to modify, examine, or insert extensions to a contract in a client application. +- Use the method to modify, examine, or insert extensions to a contract in a client application. -- Use the method to modify, examine, or insert extensions to a contract in a service application. +- Use the method to modify, examine, or insert extensions to a contract in a service application. -- Use the method to ensure that a contract can support a particular feature. +- Use the method to ensure that a contract can support a particular feature. objects can make use of any of these methods, but often only one is important; in such cases, the unused methods can return without any value. > [!NOTE] > All of the methods pass and as parameters. These parameters are for examination; if you modify the objects the execution behavior is undefined. - types can be used on either the service or the client, or both. To perform a customization task on the service, the object must be added to the property prior to the construction of the service runtime, which occurs when the method is called on the object. There are two ways to do this. + types can be used on either the service or the client, or both. To perform a customization task on the service, the object must be added to the property prior to the construction of the service runtime, which occurs when the method is called on the object. There are two ways to do this. - The first method is to programmatically add the custom contract behavior to the property prior to the point when the method is called on the object. When applied this way, the behavior is applied for all messages flowing through that contract on any endpoint. + The first method is to programmatically add the custom contract behavior to the property prior to the point when the method is called on the object. When applied this way, the behavior is applied for all messages flowing through that contract on any endpoint. > [!NOTE] > The behavior is applied to all contracts of the same type. For example, if you programmatically add the same contract type to more than one endpoint, the behavior modifies all endpoints that refer to the same contract object. @@ -87,9 +87,9 @@ - A callback class. In this case, the behavior is applied to the duplex client's endpoint and WCF ignores the value of the property. - To perform the customization task on the client for which it is intended, the object must be added to the property prior to the construction of the client runtime, which occurs when is called. There are two ways to do this: + To perform the customization task on the client for which it is intended, the object must be added to the property prior to the construction of the client runtime, which occurs when is called. There are two ways to do this: -- Programmatically add the custom contract behavior to the property prior to the point when the is called. +- Programmatically add the custom contract behavior to the property prior to the point when the is called. - Create a custom attribute that also implements . @@ -151,7 +151,7 @@ method to provide binding elements with the extra objects they require to support the contract behavior. + Implement the method to provide binding elements with the extra objects they require to support the contract behavior. This method is called once for each endpoint that uses the specified service contract. @@ -201,9 +201,9 @@ method to view, modify, or add custom extensions to the client runtime across all messages or for one specific operation. For details about what customizations you can do with a client run-time object, see and . + Implement the method to view, modify, or add custom extensions to the client runtime across all messages or for one specific operation. For details about what customizations you can do with a client run-time object, see and . - The method can throw a exception if the behavior is only intended for use in a service application. + The method can throw a exception if the behavior is only intended for use in a service application. This method is called once for each endpoint that uses the specified service contract. @@ -267,9 +267,9 @@ to view, modify, or add custom extensions to the service runtime across all messages in a specific contract or for one specific operation in that contract. For details about what customizations you can perform in a service application, see and . + Implement the to view, modify, or add custom extensions to the service runtime across all messages in a specific contract or for one specific operation in that contract. For details about what customizations you can perform in a service application, see and . - The method can throw a exception if the behavior is only intended for use in a client application. + The method can throw a exception if the behavior is only intended for use in a client application. This method is called once for each endpoint that uses the specified service contract. @@ -331,7 +331,7 @@ method to confirm that the contract description is sufficient to support the custom contract behavior. Implementations can inspect the description and either throw or return no value. + Implement the method to confirm that the contract description is sufficient to support the custom contract behavior. Implementations can inspect the description and either throw or return no value. This method is called once for each endpoint that uses the specified service contract. diff --git a/xml/System.ServiceModel.Description/IEndpointBehavior.xml b/xml/System.ServiceModel.Description/IEndpointBehavior.xml index 9eb098a80c2..cc27948c3f1 100644 --- a/xml/System.ServiceModel.Description/IEndpointBehavior.xml +++ b/xml/System.ServiceModel.Description/IEndpointBehavior.xml @@ -49,13 +49,13 @@ ## Remarks Implement the interface to modify, examine, or extend some aspect of endpoint-wide execution at the application level for either client or service applications. -- Use the method to pass custom data at runtime to enable bindings to support custom behavior. +- Use the method to pass custom data at runtime to enable bindings to support custom behavior. -- Use the method to modify, examine, or insert extensions to an endpoint in a client application. +- Use the method to modify, examine, or insert extensions to an endpoint in a client application. -- Use the method to modify, examine, or insert extensions to endpoint-wide execution in a service application. +- Use the method to modify, examine, or insert extensions to endpoint-wide execution in a service application. -- Use the method to confirm that a meets specific requirements. This can be used to ensure that an endpoint has a certain configuration setting enabled, supports a particular feature and other requirements. +- Use the method to confirm that a meets specific requirements. This can be used to ensure that an endpoint has a certain configuration setting enabled, supports a particular feature and other requirements. objects can make use of any of these methods, but often only one is important; in such cases, the unused methods can return, performing no action. @@ -74,7 +74,7 @@ - Configure the behavior using an application configuration file. For details, see [<behaviorExtensions>](/dotnet/framework/configure-apps/file-schema/wcf/behaviorextensions). - To perform the service customization task for which it is intended, the object must be added to the property prior to the construction of the service runtime, which occurs when method is called on . To perform a client customization task, the object must be added to the property before calling the method or the method on . + To perform the service customization task for which it is intended, the object must be added to the property prior to the construction of the service runtime, which occurs when method is called on . To perform a client customization task, the object must be added to the property before calling the method or the method on . @@ -85,7 +85,7 @@ [!code-csharp[IEndpointBehavior#2](~/snippets/csharp/VS_Snippets_CFX/iendpointbehavior/cs/iendpointbehaviormessageinspector.cs#2)] - The next code example shows the use of the method to add the message inspector to the property. + The next code example shows the use of the method to add the message inspector to the property. [!code-csharp[IEndpointBehavior#4](~/snippets/csharp/VS_Snippets_CFX/iendpointbehavior/cs/iendpointbehaviormessageinspector.cs#4)] @@ -141,7 +141,7 @@ method to provide binding elements with the extra objects they require to support the endpoint behavior. When binding parameters are added here the binding can locate these objects when the channel listener or channel factory is created. Typically, you implement the method to pass information about the endpoint to a custom binding element so that it can build a supporting channel correctly. Return no value if no modifications are required. + Implement the method to provide binding elements with the extra objects they require to support the endpoint behavior. When binding parameters are added here the binding can locate these objects when the channel listener or channel factory is created. Typically, you implement the method to pass information about the endpoint to a custom binding element so that it can build a supporting channel correctly. Return no value if no modifications are required. ]]> @@ -187,9 +187,9 @@ method to view, modify, or add custom extension to the client runtime across all messages used with an endpoint or for specific operations. For details about what customizations you can do with a client run-time object, see and . + Implement the method to view, modify, or add custom extension to the client runtime across all messages used with an endpoint or for specific operations. For details about what customizations you can do with a client run-time object, see and . - It is recommended that the method throw a if the behavior is only intended for use in a service application. + It is recommended that the method throw a if the behavior is only intended for use in a service application. Because other behaviors may have already added or removed some operations from the runtime there is no guarantee that there are the same number of operations in the description as there are objects in the property. @@ -237,9 +237,9 @@ method to view, modify, or extend the service runtime across all messages or for specific operations in an endpoint. For details about what customizations you can do in a service application, see and . + Implement the method to view, modify, or extend the service runtime across all messages or for specific operations in an endpoint. For details about what customizations you can do in a service application, see and . - It is recommended that the method throw a exception if the behavior is only intended for use in a client application. + It is recommended that the method throw a exception if the behavior is only intended for use in a client application. Note that there can be two operations with the same name in the description when using a callback contract (one operation in each direction). If you are iterating through operations, you must correlate the message direction between the endpoint and what is returned by the property. @@ -254,7 +254,7 @@ [!code-csharp[IEndpointBehavior#2](~/snippets/csharp/VS_Snippets_CFX/iendpointbehavior/cs/iendpointbehaviormessageinspector.cs#2)] - The next code example shows the use of the method to add the message inspector to the property. + The next code example shows the use of the method to add the message inspector to the property. [!code-csharp[IEndpointBehavior#4](~/snippets/csharp/VS_Snippets_CFX/iendpointbehavior/cs/iendpointbehaviormessageinspector.cs#4)] @@ -308,9 +308,9 @@ method to examine the structure to confirm any set of criteria. It is not necessary to perform any customizations in or to make use of this method. If the endpoint passes validation, return; otherwise, throw an exception. + Implement the method to examine the structure to confirm any set of criteria. It is not necessary to perform any customizations in or to make use of this method. If the endpoint passes validation, return; otherwise, throw an exception. - For example, the method can be use to ensure that all endpoints use an approved corporate binding. + For example, the method can be use to ensure that all endpoints use an approved corporate binding. ]]> diff --git a/xml/System.ServiceModel.Description/IOperationBehavior.xml b/xml/System.ServiceModel.Description/IOperationBehavior.xml index 56a7c71c721..17566c83ecc 100644 --- a/xml/System.ServiceModel.Description/IOperationBehavior.xml +++ b/xml/System.ServiceModel.Description/IOperationBehavior.xml @@ -49,13 +49,13 @@ ## Remarks Implement the interface to modify, examine, or extend some aspect of operation-wide execution at the application level for either client or service applications. -- Use the method to pass custom data at runtime to enable bindings to support custom behavior. +- Use the method to pass custom data at runtime to enable bindings to support custom behavior. -- Use the method to modify, examine, or insert extensions to a client dispatcher in a client application. +- Use the method to modify, examine, or insert extensions to a client dispatcher in a client application. -- Use the method to modify, examine, or insert extensions to operation-wide execution in a service application. +- Use the method to modify, examine, or insert extensions to operation-wide execution in a service application. -- Use the method to confirm that a meets specific requirements. This can be used to ensure that an operation has a certain configuration setting enabled, supports a particular feature and other requirements. +- Use the method to confirm that a meets specific requirements. This can be used to ensure that an operation has a certain configuration setting enabled, supports a particular feature and other requirements. objects can make use of any of these methods, but often only one is important; in such cases, the unused methods can return, performing no action. @@ -74,7 +74,7 @@ - Add the behavior using a custom attribute. - To perform the service customization task for which it is intended, the object must be added to the property prior to the construction of the service runtime, which occurs when method is called on . To perform a client customization task, the object must be added to the property before calling the method or the method on . + To perform the service customization task for which it is intended, the object must be added to the property prior to the construction of the service runtime, which occurs when method is called on . To perform a client customization task, the object must be added to the property before calling the method or the method on . Although the operation behavior is designed for easy access to the runtime at the scope of an individual operation, you can access the runtime at a larger scope by accessing the parent runtime object. @@ -135,7 +135,7 @@ method to provide binding elements with the extra objects they require to support the operation behavior. When binding parameters are added here, the binding can locate and process these objects when the channel listener or channel factory is created. Typically, you implement the method to pass information about the operation to a custom binding element so that it can build a supporting channel correctly. Return no value if no modifications are required. + Implement the method to provide binding elements with the extra objects they require to support the operation behavior. When binding parameters are added here, the binding can locate and process these objects when the channel listener or channel factory is created. Typically, you implement the method to pass information about the operation to a custom binding element so that it can build a supporting channel correctly. Return no value if no modifications are required. ]]> @@ -181,9 +181,9 @@ method to view, modify, or add a custom extension to the client runtime across all messages used with a specific operation. For details about what customizations you can do with a client run-time object, see and . + Implement the method to view, modify, or add a custom extension to the client runtime across all messages used with a specific operation. For details about what customizations you can do with a client run-time object, see and . - It is recommended that the method throw a if the behavior is only intended for use in a service application. + It is recommended that the method throw a if the behavior is only intended for use in a service application. @@ -242,9 +242,9 @@ method to view, modify, or extend the service runtime across all messages or for a specific operation. For details about what customizations you can do in a service application, see and . + Implement the method to view, modify, or extend the service runtime across all messages or for a specific operation. For details about what customizations you can do in a service application, see and . - It is recommended that the method throw a exception if the behavior is only intended for use in a client application. + It is recommended that the method throw a exception if the behavior is only intended for use in a client application. @@ -301,9 +301,9 @@ method to examine the structure to confirm any set of criteria. It is not necessary to perform any customizations in or to make use of this method. If the operation passes validation, return; otherwise, throw an exception. + Implement the method to examine the structure to confirm any set of criteria. It is not necessary to perform any customizations in or to make use of this method. If the operation passes validation, return; otherwise, throw an exception. - For example, the method can be use to ensure that an operation is authorized. + For example, the method can be use to ensure that an operation is authorized. ]]> diff --git a/xml/System.ServiceModel.Description/IOperationContractGenerationExtension.xml b/xml/System.ServiceModel.Description/IOperationContractGenerationExtension.xml index 379a3556b4d..6849cc55a29 100644 --- a/xml/System.ServiceModel.Description/IOperationContractGenerationExtension.xml +++ b/xml/System.ServiceModel.Description/IOperationContractGenerationExtension.xml @@ -14,27 +14,27 @@ Defines the methods called during contract generation that can be used to modify the generated code for an operation. - interface on an operation behavior (a type) to enable you to modify the code generated when a contract or endpoint is compiled into code. Typically, a custom inserts a custom operation behavior into the collection during the call to or . - - - -## Examples - The following code example shows the implementation of the method that adds a string to the comments section of the operation using the namespace. - - - - The following code example shows how the operation behavior that implements is inserted into the collection during the call to . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationimporter.cs" id="Snippet4"::: - - Finally, the following code example shows the operation generated in both Visual Basic and C#. - + interface on an operation behavior (a type) to enable you to modify the code generated when a contract or endpoint is compiled into code. Typically, a custom inserts a custom operation behavior into the collection during the call to or . + + + +## Examples + The following code example shows the implementation of the method that adds a string to the comments section of the operation using the namespace. + + + + The following code example shows how the operation behavior that implements is inserted into the collection during the call to . + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationimporter.cs" id="Snippet4"::: + + Finally, the following code example shows the operation generated in both Visual Basic and C#. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/newgeneratedcontract.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/newgeneratedcontract.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/newgeneratedcontract.vb" id="Snippet3"::: + ]]> @@ -62,29 +62,29 @@ The working context that contains the types necessary to modify the generated operation. Implement to modify the code document object model prior to the contract generation process. - inserts a custom operation behavior into the collection during the call to or . - - The method is called once for each contract. - - - -## Examples - The following code example shows the implementation of the method that adds a string to the comments section of the operation using the namespace. - - - - The following code example shows how the operation behavior that implements is inserted into the collection during the call to . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationimporter.cs" id="Snippet4"::: - - Finally, the following code example shows the operation generated in both Visual Basic and C#. - + inserts a custom operation behavior into the collection during the call to or . + + The method is called once for each contract. + + + +## Examples + The following code example shows the implementation of the method that adds a string to the comments section of the operation using the namespace. + + + + The following code example shows how the operation behavior that implements is inserted into the collection during the call to . + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationimporter.cs" id="Snippet4"::: + + Finally, the following code example shows the operation generated in both Visual Basic and C#. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/newgeneratedcontract.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/newgeneratedcontract.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/newgeneratedcontract.vb" id="Snippet3"::: + ]]> diff --git a/xml/System.ServiceModel.Description/IPolicyExportExtension.xml b/xml/System.ServiceModel.Description/IPolicyExportExtension.xml index 5cb61c67599..77986ff6fad 100644 --- a/xml/System.ServiceModel.Description/IPolicyExportExtension.xml +++ b/xml/System.ServiceModel.Description/IPolicyExportExtension.xml @@ -22,7 +22,7 @@ The policy exporter is used by Windows Communication Foundation (WCF) to use policy assertions to communicate to clients the existence of that custom binding requirement or endpoint capability. - The method takes the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then add your custom policy assertion object to the appropriate collection. + The method takes the and objects. Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then add your custom policy assertion object to the appropriate collection. The property exposes the for the endpoint that is being exported. This allows the extension to correctly scope their exported policy assertions. For example, security attributes in code may add behaviors to the that indicate where security policy assertions should be added. @@ -83,7 +83,7 @@ , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then add your object to the appropriate collection. + Use the , , and methods to obtain collections of policy assertions that have already been exported at various scopes. Then add your object to the appropriate collection. diff --git a/xml/System.ServiceModel.Description/IPolicyImportExtension.xml b/xml/System.ServiceModel.Description/IPolicyImportExtension.xml index 31ad933d0a6..74623d2eca6 100644 --- a/xml/System.ServiceModel.Description/IPolicyImportExtension.xml +++ b/xml/System.ServiceModel.Description/IPolicyImportExtension.xml @@ -22,13 +22,13 @@ Unlike its counterpart, , does not require implementation by a object; you can load it using the client configuration section shown in the Examples section or programmatically by adding it to the constructor. - Windows Communication Foundation (WCF) passes two objects to the method, a and a . Typically the object already contains the policy assertions for each binding scope. + Windows Communication Foundation (WCF) passes two objects to the method, a and a . Typically the object already contains the policy assertions for each binding scope. An implementation performs the following steps: -1. Locates the custom policy assertion for which it is responsible by calling either the , , or methods, depending upon the scope. +1. Locates the custom policy assertion for which it is responsible by calling either the , , or methods, depending upon the scope. -2. Removes the policy assertion from the assertion collection. The method locates, returns, and removes the assertion in one step. +2. Removes the policy assertion from the assertion collection. The method locates, returns, and removes the assertion in one step. 3. Modify the binding stack or the contract by either adding a required custom to the property or by modifying the property. @@ -47,7 +47,7 @@ ## Examples - The following code example shows the use of the method to locate, return, and remove the assertion in one step. + The following code example shows the use of the method to locate, return, and remove the assertion in one step. [!code-csharp[CustomPolicySample#1](~/snippets/csharp/VS_Snippets_CFX/custompolicysample/cs/policyimporter.cs#1)] [!code-vb[CustomPolicySample#1](~/snippets/visualbasic/VS_Snippets_CFX/custompolicysample/vb/policyimporter.vb#1)] @@ -95,13 +95,13 @@ ## Remarks Implement the `ImportPolicy` method to obtain policy assertions and perform some modification of the imported contract or binding to support the assertion. Typically, a policy importer responds to finding a custom policy assertion by configuring or inserting a binding element into the binding being imported. - Windows Communication Foundation (WCF) passes two objects to the method, a and a . Typically the object already contains the policy assertions for each binding scope. + Windows Communication Foundation (WCF) passes two objects to the method, a and a . Typically the object already contains the policy assertions for each binding scope. An implementation performs the following steps: -1. Locates the custom policy assertion for which it is responsible by calling either the , , or methods, depending upon the scope. +1. Locates the custom policy assertion for which it is responsible by calling either the , , or methods, depending upon the scope. -2. Removes the policy assertion from the assertion collection. The method locates, returns, and removes the assertion in one step. +2. Removes the policy assertion from the assertion collection. The method locates, returns, and removes the assertion in one step. 3. Modifies the binding stack or the contract by either adding a required custom to the property or by modifying the property. @@ -110,7 +110,7 @@ ## Examples - The following code example shows the use of the method to locate, return, and remove the assertion in one step. + The following code example shows the use of the method to locate, return, and remove the assertion in one step. [!code-csharp[CustomPolicySample#1](~/snippets/csharp/VS_Snippets_CFX/custompolicysample/cs/policyimporter.cs#1)] [!code-vb[CustomPolicySample#1](~/snippets/visualbasic/VS_Snippets_CFX/custompolicysample/vb/policyimporter.vb#1)] diff --git a/xml/System.ServiceModel.Description/IServiceBehavior.xml b/xml/System.ServiceModel.Description/IServiceBehavior.xml index d8fca8c0366..0fddc9df4dd 100644 --- a/xml/System.ServiceModel.Description/IServiceBehavior.xml +++ b/xml/System.ServiceModel.Description/IServiceBehavior.xml @@ -19,11 +19,11 @@ ## Remarks Implement to modify, examine, or extend some aspect of service-wide execution at the application level: -- Use the method to change run-time property values or insert custom extension objects such as error handlers, message or parameter interceptors, security extensions, and other custom extension objects. +- Use the method to change run-time property values or insert custom extension objects such as error handlers, message or parameter interceptors, security extensions, and other custom extension objects. -- Use the method to examine the description before Windows Communication Foundation (WCF) constructs the executing service to confirm that it can execute properly. +- Use the method to examine the description before Windows Communication Foundation (WCF) constructs the executing service to confirm that it can execute properly. -- Use the method to pass to a binding element the custom information for the service so that it can support the service correctly. +- Use the method to pass to a binding element the custom information for the service so that it can support the service correctly. objects can make use of any of these methods, but often only one is important; in such cases the unused methods can return without a value. @@ -32,7 +32,7 @@ To perform the customization task for which it is intended, the object must be added to the property prior to the construction of the service runtime. There are three ways to do this: -- Programmatically add the custom service behavior to the property prior to the point where the method is called on the object. +- Programmatically add the custom service behavior to the property prior to the point where the method is called on the object. - Create a custom attribute that implements and use it to mark service classes that are to be modified. When a object is constructed, WCF uses reflection to discover the attributes on the service type. If any attributes implement , they are added to the behaviors collection on . @@ -90,7 +90,7 @@ method to add custom data objects to the `parameters` collection that binding elements can use to acquire extra information to enable them to support the contract. + Use the method to add custom data objects to the `parameters` collection that binding elements can use to acquire extra information to enable them to support the contract. This method is called once for each listen URI. For example, if a service has four endpoints, and two of them have the same listen URI, then this method gets called three times. The reason is that the `bindingParameters` target each channel stack and there is one channel stack for each listen URI. Because each call receives those endpoints at that listen URI, two calls each get a single , and one call gets a collection of two objects. @@ -129,7 +129,7 @@ method to inspect or modify the object that is being constructed in order to support some custom execution scenario. + Implement the method to inspect or modify the object that is being constructed in order to support some custom execution scenario. > [!NOTE] > All of the methods pass and objects as a parameters. The parameter is for examination and insertion of customizations only; if you otherwise modify these objects the execution behavior is undefined. @@ -180,7 +180,7 @@ method to confirm whether the current service can execute properly according to your scenario. + Use the method to confirm whether the current service can execute properly according to your scenario. > [!NOTE] > All of the methods pass and objects as a parameters. The parameter is for examination and insertion of customizations only; if you otherwise modify these objects the execution behavior is undefined. diff --git a/xml/System.ServiceModel.Description/IServiceContractGenerationExtension.xml b/xml/System.ServiceModel.Description/IServiceContractGenerationExtension.xml index 023b191ca65..4dba8dd84cb 100644 --- a/xml/System.ServiceModel.Description/IServiceContractGenerationExtension.xml +++ b/xml/System.ServiceModel.Description/IServiceContractGenerationExtension.xml @@ -19,16 +19,16 @@ ## Remarks Implement the interface on a contract behavior (a type) to enable you to modify the code generated when a contract or endpoint is compiled into code. - Typically, a custom inserts a custom contract behavior into the collection during the call to or . + Typically, a custom inserts a custom contract behavior into the collection during the call to or . ## Examples - The following code example shows how to add an to the property during the call to . + The following code example shows how to add an to the property during the call to . :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationimporter.cs" id="Snippet4"::: - The following code examples show the implementation of that adds comments to the code generated for a service contract. + The following code examples show the implementation of that adds comments to the code generated for a service contract. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationimporter.cs" id="Snippet12"::: @@ -72,11 +72,11 @@ ## Examples - The following code example shows how to add an to the property during the call to . + The following code example shows how to add an to the property during the call to . :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationimporter.cs" id="Snippet4"::: - The following code examples show the implementation of that adds comments to the code generated for a service contract. + The following code examples show the implementation of that adds comments to the code generated for a service contract. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationimporter.cs" id="Snippet12"::: diff --git a/xml/System.ServiceModel.Description/IWsdlExportExtension.xml b/xml/System.ServiceModel.Description/IWsdlExportExtension.xml index 65f9a11e89b..79d644f3df5 100644 --- a/xml/System.ServiceModel.Description/IWsdlExportExtension.xml +++ b/xml/System.ServiceModel.Description/IWsdlExportExtension.xml @@ -25,13 +25,13 @@ does not export custom policy assertions even though Windows Communication Foundation (WCF) exports custom binding policy assertions to the appropriate element inside WSDL. If you want to export custom policy assertions, implement the interface. - The metadata publication process begins by calling which in turn calls for each endpoint. + The metadata publication process begins by calling which in turn calls for each endpoint. - The endpoint is exported by first exporting its contract.When exporting a contract the calls the method on all implementations on the contract, and operation behaviors for that contract. Operations that use wildcard actions are not exported in metadata, so implementations on operation behaviors for these operations are not exported. + The endpoint is exported by first exporting its contract.When exporting a contract the calls the method on all implementations on the contract, and operation behaviors for that contract. Operations that use wildcard actions are not exported in metadata, so implementations on operation behaviors for these operations are not exported. After exporting the contract, the port and binding are exported and exported policy expressions are attached. - Both the and the methods provide access to the so that implementations can report recoverable errors and warnings through the property. The context objects passed into both methods provide convenient mappings from exported WSDL elements to properties of and objects. + Both the and the methods provide access to the so that implementations can report recoverable errors and warnings through the property. The context objects passed into both methods provide convenient mappings from exported WSDL elements to properties of and objects. If an implementation throws an exception on export, the generated metadata is in an inconsistent state and the object should be discarded. @@ -78,7 +78,7 @@ method is called when the metadata export system is exporting the contract. Only contract and operation behaviors implementing get the call. All behaviors implementing get the call. + The method is called when the metadata export system is exporting the contract. Only contract and operation behaviors implementing get the call. All behaviors implementing get the call. Use the `context` parameter to modify the WSDL to be exported. For an example, see the Example section. @@ -122,7 +122,7 @@ method to modify the WSDL exported for an endpoint. This method is called after the contract has been exported by . + Implement the method to modify the WSDL exported for an endpoint. This method is called after the contract has been exported by . diff --git a/xml/System.ServiceModel.Description/IWsdlImportExtension.xml b/xml/System.ServiceModel.Description/IWsdlImportExtension.xml index 650871e743c..4c36daf4f93 100644 --- a/xml/System.ServiceModel.Description/IWsdlImportExtension.xml +++ b/xml/System.ServiceModel.Description/IWsdlImportExtension.xml @@ -15,26 +15,26 @@ Implement and attach to a object to control how the importer maps Web Services Description Language (WSDL) parts to those of a object. - interface to control the mapping between WSDL and and objects, especially when reading custom WSDL extensions to modify your contract or endpoint information. Then attach your custom object to a either programmatically or by using an application configuration file. You can also attach your custom object to the internal used by the [ServiceModel Metadata Utility Tool (Svcutil.exe)](/dotnet/framework/wcf/servicemodel-metadata-utility-tool-svcutil-exe) using an application configuration file. - - The method is called to import a contract. - - Use the method to modify the metadata that is then imported into and objects. - - - -## Examples - The following code example shows the use of to add an and an (the `WsdlDocumentationImporter`, in this case) to modify generated WCF client code at the interface and operation level. - - [!code-csharp[C_CustomWSDLExtensions#4](~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationimporter.cs#4)] - - The following code example shows how to configure the client metadata system to use the custom from an application configuration file. - - [!code-xml[C_CustomWSDLExtensions#9](~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/client.exe.config#9)] - + interface to control the mapping between WSDL and and objects, especially when reading custom WSDL extensions to modify your contract or endpoint information. Then attach your custom object to a either programmatically or by using an application configuration file. You can also attach your custom object to the internal used by the [ServiceModel Metadata Utility Tool (Svcutil.exe)](/dotnet/framework/wcf/servicemodel-metadata-utility-tool-svcutil-exe) using an application configuration file. + + The method is called to import a contract. + + Use the method to modify the metadata that is then imported into and objects. + + + +## Examples + The following code example shows the use of to add an and an (the `WsdlDocumentationImporter`, in this case) to modify generated WCF client code at the interface and operation level. + + [!code-csharp[C_CustomWSDLExtensions#4](~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationimporter.cs#4)] + + The following code example shows how to configure the client metadata system to use the custom from an application configuration file. + + [!code-xml[C_CustomWSDLExtensions#9](~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/client.exe.config#9)] + ]]> @@ -66,11 +66,11 @@ The policy assertions used when importing. Called prior to importing metadata documents. - methods of all registered objects is called before anything is imported from the supplied metadata. - + methods of all registered objects is called before anything is imported from the supplied metadata. + ]]> @@ -100,22 +100,22 @@ The import context to be modified. Called when importing a contract. - method is called when a contract is being imported. You can modify the contract or insert other exporting behaviors such as and an objects to modify the code that is generated for the contract. - - - -## Examples - The following code example shows the use of to add an and an (the `WsdlDocumentationImporter`, in this case) to modify generated WCF client code at the interface and operation level. - - [!code-csharp[C_CustomWSDLExtensions#4](~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationimporter.cs#4)] - - The following code example shows how to configure the client metadata system to use the custom from an application configuration file. - - [!code-xml[C_CustomWSDLExtensions#9](~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/client.exe.config#9)] - + method is called when a contract is being imported. You can modify the contract or insert other exporting behaviors such as and an objects to modify the code that is generated for the contract. + + + +## Examples + The following code example shows the use of to add an and an (the `WsdlDocumentationImporter`, in this case) to modify generated WCF client code at the interface and operation level. + + [!code-csharp[C_CustomWSDLExtensions#4](~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationimporter.cs#4)] + + The following code example shows how to configure the client metadata system to use the custom from an application configuration file. + + [!code-xml[C_CustomWSDLExtensions#9](~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/client.exe.config#9)] + ]]> @@ -145,11 +145,11 @@ The import context to modify. Called when importing an endpoint. - method is called when importing an endpoint. Modify the context properties to customize the imported endpoint. - + method is called when importing an endpoint. Modify the context properties to customize the imported endpoint. + ]]> diff --git a/xml/System.ServiceModel.Description/MessageDescriptionCollection.xml b/xml/System.ServiceModel.Description/MessageDescriptionCollection.xml index 9f6c5ae92db..87b4a13358c 100644 --- a/xml/System.ServiceModel.Description/MessageDescriptionCollection.xml +++ b/xml/System.ServiceModel.Description/MessageDescriptionCollection.xml @@ -49,15 +49,15 @@ Provides a collection that is used to store descriptions of the messages that make up an operation that belongs to a contract. - is used to describe contracts and their associated operations. Each contract operation has a corresponding that describes aspects of the operation, such as whether the operation is one-way or request/reply. Each in turn describes the messages that make up the operation using a collection of . - - - -## Examples - + is used to describe contracts and their associated operations. Each contract operation has a corresponding that describes aspects of the operation, such as whether the operation is one-way or request/reply. Each in turn describes the messages that make up the operation using a collection of . + + + +## Examples + ]]> @@ -98,15 +98,15 @@ Finds and returns the first message description in a collection for a message with a specified action. The first from the collection whose message has the specified and if no matching is found. - objects in the collection that match the specified `action`, use the method instead. - - - -## Examples - + objects in the collection that match the specified `action`, use the method instead. + + + +## Examples + ]]> @@ -147,15 +147,15 @@ Finds and returns all of the message descriptions in a collection whose messages have a specified action. A that contains the collection message descriptions from the current collection whose messages have the specified . If no matching objects are found, an empty collection is returned. - in the collection that match the specified `action`, use the method instead. - - - -## Examples - + in the collection that match the specified `action`, use the method instead. + + + +## Examples + ]]> diff --git a/xml/System.ServiceModel.Description/MessageDirection.xml b/xml/System.ServiceModel.Description/MessageDirection.xml index 24b12627468..bf7b010489a 100644 --- a/xml/System.ServiceModel.Description/MessageDirection.xml +++ b/xml/System.ServiceModel.Description/MessageDirection.xml @@ -50,7 +50,7 @@ ## Remarks The direction of a message indicates whether the message is coming into an endpoint or going out from an endpoint. Input is incoming to the server and Output is outgoing from the server. For a basic request/response message pattern, a request is incoming to the server and the response is outgoing from the server. On callbacks from the server to client, however, a request is outgoing from the server and a response is incoming to the server. - Use the constructor to specify the direction of a message. + Use the constructor to specify the direction of a message. Retrieve the direction of a message using the property. diff --git a/xml/System.ServiceModel.Description/MetadataConversionError.xml b/xml/System.ServiceModel.Description/MetadataConversionError.xml index c35184c155c..4b5c9154c39 100644 --- a/xml/System.ServiceModel.Description/MetadataConversionError.xml +++ b/xml/System.ServiceModel.Description/MetadataConversionError.xml @@ -27,11 +27,11 @@ Represents an error or warning event that occurred during the use of a or . - objects to determine whether classes that extend and have encountered an error or warning condition by checking the and properties after importing or exporting the metadata. Tools can use these error and warning messages to report metadata import and export problems to the user. - + objects to determine whether classes that extend and have encountered an error or warning condition by checking the and properties after importing or exporting the metadata. Tools can use these error and warning messages to report metadata import and export problems to the user. + ]]> @@ -44,11 +44,11 @@ Initializes a new instance of the class. - @@ -87,11 +87,11 @@ The error or warning message. Initializes a new instance of the class using the specified message. - @@ -126,11 +126,11 @@ Whether the is an error or a warning. Initializes a new instance of the class using the specified message and value. - @@ -168,11 +168,11 @@ if the two objects have value equality; otherwise, . - . - + . + ]]> @@ -206,11 +206,11 @@ Returns a value that serves as a hash function for a object. A value suitable for use in hashing algorithms and data structures, such as a hash table. - . - + . + ]]> diff --git a/xml/System.ServiceModel.Description/MetadataExchangeBindings.xml b/xml/System.ServiceModel.Description/MetadataExchangeBindings.xml index 68e4b113801..46bd5229946 100644 --- a/xml/System.ServiceModel.Description/MetadataExchangeBindings.xml +++ b/xml/System.ServiceModel.Description/MetadataExchangeBindings.xml @@ -17,13 +17,13 @@ Used to create system-provided bindings for WS-Transfer metadata exchange using the contract. - methods and properties to create system-provided bindings to support WS-Transfer GET metadata exchanges. For more information and examples, see [How to: Publish Metadata for a Service Using a Configuration File](/dotnet/framework/wcf/feature-details/how-to-publish-metadata-for-a-service-using-a-configuration-file). - - See the individual members for details about the composition of the bindings they return. - + methods and properties to create system-provided bindings to support WS-Transfer GET metadata exchanges. For more information and examples, see [How to: Publish Metadata for a Service Using a Configuration File](/dotnet/framework/wcf/feature-details/how-to-publish-metadata-for-a-service-using-a-configuration-file). + + See the individual members for details about the composition of the bindings they return. + ]]> @@ -55,11 +55,11 @@ Returns a with security disabled. A with security disabled. - method to return a binding that supports most metadata requests. - + method to return a binding that supports most metadata requests. + ]]> @@ -91,11 +91,11 @@ Returns a that supports transport-level security. A that supports transport-level security. - method to return a binding that can be secured at the transport level using certificates. For more information about configuring and using such a metadata endpoint, see [How to: Configure a Custom WS-Metadata Exchange Binding](/dotnet/framework/wcf/extending/how-to-configure-a-custom-ws-metadata-exchange-binding), [How to: Retrieve Metadata Over a non-MEX Binding](/dotnet/framework/wcf/extending/how-to-retrieve-metadata-over-a-non-mex-binding), and the sample [Custom Secure Metadata Endpoint](/dotnet/framework/wcf/samples/custom-secure-metadata-endpoint). - + method to return a binding that can be secured at the transport level using certificates. For more information about configuring and using such a metadata endpoint, see [How to: Configure a Custom WS-Metadata Exchange Binding](/dotnet/framework/wcf/extending/how-to-configure-a-custom-ws-metadata-exchange-binding), [How to: Retrieve Metadata Over a non-MEX Binding](/dotnet/framework/wcf/extending/how-to-retrieve-metadata-over-a-non-mex-binding), and the sample [Custom Secure Metadata Endpoint](/dotnet/framework/wcf/samples/custom-secure-metadata-endpoint). + ]]> diff --git a/xml/System.ServiceModel.Description/MetadataExchangeClient.xml b/xml/System.ServiceModel.Description/MetadataExchangeClient.xml index 5ece351c852..f1a939c9dbf 100644 --- a/xml/System.ServiceModel.Description/MetadataExchangeClient.xml +++ b/xml/System.ServiceModel.Description/MetadataExchangeClient.xml @@ -20,7 +20,7 @@ to download metadata. Typically, a is configured for a metadata request and then passed to the or method for the to use to download metadata. + Use the to download metadata. Typically, a is configured for a metadata request and then passed to the or method for the to use to download metadata. However, you can use the directly to retrieve metadata as a that contains objects. @@ -38,13 +38,13 @@ - Use the property to specify whether to locate and retrieve other metadata documents referred to by the metadata downloaded from the original metadata endpoint. -- Use the methods to begin the downloading process. +- Use the methods to begin the downloading process. In addition, you can create a derived class that can override the following two protected methods: -- Override the method to modify the channel that makes a metadata request using WS-Transfer. +- Override the method to modify the channel that makes a metadata request using WS-Transfer. -- Override the method to modify the that makes a metadata request using HTTP/GET. +- Override the method to modify the that makes a metadata request using HTTP/GET. @@ -242,7 +242,7 @@ methods. + Begins an asynchronous implementation of the methods. ]]> @@ -277,7 +277,7 @@ method. + An asynchronous implementation of the method. ]]> @@ -314,7 +314,7 @@ method. + An asynchronous implementation of the method. ]]> @@ -353,7 +353,7 @@ method. + An asynchronous implementation of the method. ]]> @@ -386,7 +386,7 @@ methods to return the downloaded metadata. + Ends one of the asynchronous methods to return the downloaded metadata. ]]> @@ -699,7 +699,7 @@ method is called: + The method is called: - When there is an attempt to resolve a . diff --git a/xml/System.ServiceModel.Description/MetadataExporter.xml b/xml/System.ServiceModel.Description/MetadataExporter.xml index f133878b38f..ff31487fed1 100644 --- a/xml/System.ServiceModel.Description/MetadataExporter.xml +++ b/xml/System.ServiceModel.Description/MetadataExporter.xml @@ -33,7 +33,7 @@ ## Examples - The following code example is an method that demonstrates how the property of the class is used to attach a custom that modifies the export of data contracts in the endpoint. + The following code example is an method that demonstrates how the property of the class is used to attach a custom that modifies the export of data contracts in the endpoint. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationattribute.cs" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationattribute.cs" id="Snippet5"::: @@ -103,7 +103,7 @@ to convert a contract description into metadata. + Override and implement to convert a contract description into metadata. ]]> @@ -135,7 +135,7 @@ to convert a contract description into metadata. + Override and implement to convert a contract description into metadata. ]]> @@ -191,7 +191,7 @@ method to retrieve the metadata generated from earlier calls. Check the property prior to retrieving the metadata to ensure that you have the metadata you want. + Use the method to retrieve the metadata generated from earlier calls. Check the property prior to retrieving the metadata to ensure that you have the metadata you want. ]]> @@ -266,7 +266,7 @@ ## Examples - The following code example is an method that demonstrates how the property of the derived class is used to attach a custom that modifies the export of data contracts in the endpoint. + The following code example is an method that demonstrates how the property of the derived class is used to attach a custom that modifies the export of data contracts in the endpoint. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationattribute.cs" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationattribute.cs" id="Snippet5"::: diff --git a/xml/System.ServiceModel.Description/MetadataImporter.xml b/xml/System.ServiceModel.Description/MetadataImporter.xml index 86e8f18991b..e7060f8addb 100644 --- a/xml/System.ServiceModel.Description/MetadataImporter.xml +++ b/xml/System.ServiceModel.Description/MetadataImporter.xml @@ -126,7 +126,7 @@ method to return all endpoints in the imported metadata. Metadata that has been imported as service endpoints cannot be used to create a runtime or export metadata because the imported endpoints contain no managed type information. To use the metadata to create a client or service runtime or to generate metadata, you must first generate and compile code from the metadata and use that type information to create a new object using . + Implement the method to return all endpoints in the imported metadata. Metadata that has been imported as service endpoints cannot be used to create a runtime or export metadata because the imported endpoints contain no managed type information. To use the metadata to create a client or service runtime or to generate metadata, you must first generate and compile code from the metadata and use that type information to create a new object using . ]]> diff --git a/xml/System.ServiceModel.Description/MetadataResolver.xml b/xml/System.ServiceModel.Description/MetadataResolver.xml index 0a75c14eea1..548806d7372 100644 --- a/xml/System.ServiceModel.Description/MetadataResolver.xml +++ b/xml/System.ServiceModel.Description/MetadataResolver.xml @@ -17,22 +17,22 @@ Retrieves and imports metadata as objects. - class to quickly import endpoints for a service from metadata. This class downloads and converts metadata into objects. To download metadata and process that information as a , see . - - - -## Examples - The following code example shows the use of the class to return metadata as a collection of objects that are then used to connect to a service instance. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/metadataresolver/cs/client.cs" id="Snippet1"::: - - The following code example shows the use of the to download and return metadata as a collection of objects using an HTTP GET request rather than WS-Transfer. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/metadataresolver/cs/client.cs" id="Snippet2"::: - + class to quickly import endpoints for a service from metadata. This class downloads and converts metadata into objects. To download metadata and process that information as a , see . + + + +## Examples + The following code example shows the use of the class to return metadata as a collection of objects that are then used to connect to a service instance. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/metadataresolver/cs/client.cs" id="Snippet1"::: + + The following code example shows the use of the to download and return metadata as a collection of objects using an HTTP GET request rather than WS-Transfer. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/metadataresolver/cs/client.cs" id="Snippet2"::: + ]]> @@ -45,11 +45,11 @@ Begins an asynchronous call that resolves a metadata address into a collection of objects for that service. - methods. - + methods. + ]]> @@ -84,16 +84,16 @@ Begins an asynchronous call that resolves a metadata address into the objects for the specified contracts, using the specified address and asynchronous state and delegate. The that references the asynchronous resolve operation. - are used to retrieve the metadata and the default is . - - To download metadata but not resolve the information into objects, use the directly. - + are used to retrieve the metadata and the default is . + + To download metadata but not resolve the information into objects, use the directly. + > [!NOTE] -> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. - +> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. + ]]> The address, contract, or callback is . @@ -131,20 +131,20 @@ Begins an asynchronous call that resolves a metadata address into the objects for the specified contract using the specified address and asynchronous state and delegate. The that references the asynchronous resolve operation. - are used to retrieve the metadata and the default is . - - To download metadata but not resolve the information into objects, use the directly. - + are used to retrieve the metadata and the default is . + + To download metadata but not resolve the information into objects, use the directly. + > [!NOTE] -> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. - - This method requires that you specify a contract type. You can specify the contract by declaring the service interface in the client code or by using a WCF client generated by Svcutil.exe. If the interface changes (adding a new operation, for example) you must update the interface in the client code or generate a new WCF client. If you do not, an exception is thrown. For example, you have a service that implements a service contract called ICalculator that defines Add(), Sub(), Mult(), and Div(). You create a client application and generate WCF client. You then add a method to ICalculator called Echo(). If you then write an application that calls without generating a new WCF client you get the following exception. - - `Unhandled Exception: System.ServiceModel.Description.WsdlImporter+WsdlImportException: Cannot locate operation Echo in Contract ICalculator`. - +> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. + + This method requires that you specify a contract type. You can specify the contract by declaring the service interface in the client code or by using a WCF client generated by Svcutil.exe. If the interface changes (adding a new operation, for example) you must update the interface in the client code or generate a new WCF client. If you do not, an exception is thrown. For example, you have a service that implements a service contract called ICalculator that defines Add(), Sub(), Mult(), and Div(). You create a client application and generate WCF client. You then add a method to ICalculator called Echo(). If you then write an application that calls without generating a new WCF client you get the following exception. + + `Unhandled Exception: System.ServiceModel.Description.WsdlImporter+WsdlImportException: Cannot locate operation Echo in Contract ICalculator`. + ]]> The address, contract, or callback is . @@ -182,16 +182,16 @@ Begins an asynchronous call that resolves a metadata address into the objects for the specified contracts, using the specified address, , asynchronous state and delegate. The that references the asynchronous resolve operation. - is . - - To download metadata but not resolve the information into objects, use the directly. - + is . + + To download metadata but not resolve the information into objects, use the directly. + > [!NOTE] -> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. - +> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. + ]]> The address, contract, client, or callback is . @@ -231,16 +231,16 @@ Begins an asynchronous call that resolves a metadata address into the objects for the specified contracts, using the specified address, value, asynchronous state and delegate. The that references the asynchronous resolve operation. - are used to retrieve the metadata. - - To download metadata but not resolve the information into objects, use the directly. - + are used to retrieve the metadata. + + To download metadata but not resolve the information into objects, use the directly. + > [!NOTE] -> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. - +> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. + ]]> The address, contract, or callback is . @@ -280,16 +280,16 @@ Begins an asynchronous call that resolves a metadata address into the objects for the specified contract, using the specified address, , asynchronous state and delegate. The that references the asynchronous resolve operation. - are used to retrieve the metadata. - - To download metadata but not resolve the information into objects, use the directly. - + are used to retrieve the metadata. + + To download metadata but not resolve the information into objects, use the directly. + > [!NOTE] -> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. - +> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. + ]]> The address, contract, or callback is . @@ -329,14 +329,14 @@ Begins an asynchronous call that resolves a metadata address into the objects for the specified contracts, using the specified address, , , asynchronous state, and delegate. The that references the asynchronous resolve operation. - objects, use the directly. - + objects, use the directly. + > [!NOTE] -> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. - +> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. + ]]> The address, contract, or callback is . @@ -368,11 +368,11 @@ Completes an asynchronous call to resolve metadata into a collection of endpoints. A collection of objects for the endpoints contained in the metadata. - methods. - + methods. + ]]> @@ -385,13 +385,13 @@ Downloads and resolves a metadata address into the objects for that service. - objects, use the directly. - - For all synchronous and asynchronous `Resolve` methods, an empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. - + objects, use the directly. + + For all synchronous and asynchronous `Resolve` methods, an empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. + ]]> @@ -422,16 +422,16 @@ Resolves a metadata address into the objects for the specified contracts using the specified metadata address. A collection of objects for the specified contract. - are used to retrieve the metadata and the default is . - - To download metadata but not resolve the information into objects, use the directly. - + are used to retrieve the metadata and the default is . + + To download metadata but not resolve the information into objects, use the directly. + > [!NOTE] -> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. - +> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. + ]]> The address or contracts collection is . @@ -465,29 +465,29 @@ Downloads and resolves a metadata address into a collection of objects for a specified contract at a specified address. A collection of objects for the specified contract. - method to specify the contract and the metadata address to use when downloading and resolving metadata. - - The default settings on the are used to retrieve the metadata and the default is . - - To download metadata but not resolve the information into objects, use the directly. - + method to specify the contract and the metadata address to use when downloading and resolving metadata. + + The default settings on the are used to retrieve the metadata and the default is . + + To download metadata but not resolve the information into objects, use the directly. + > [!NOTE] -> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. - - This method requires that you specify a contract type. You can specify the contract by declaring the service interface in the client code or by using a WCF client generated by Svcutil.exe. If the interface changes (adding a new operation, for example) you must update the interface in the client code or generate a new WCF client. If you do not, an exception is thrown. For example, you have a service that implements a service contract called ICalculator that defines Add(), Sub(), Mult(), and Div(). You create a client application and generate WCF client. You then add a method to ICalculator called Echo(). If you then write an application that calls without generating a new WCF client you get the following exception. - - `Unhandled Exception: System.ServiceModel.Description.WsdlImporter+WsdlImportException: Cannot locate operation Echo in Contract ICalculator`. - - - -## Examples - The following code example shows the use of the class to return metadata as a collection of objects that are then used to connect to a service instance. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/metadataresolver/cs/client.cs" id="Snippet1"::: - +> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. + + This method requires that you specify a contract type. You can specify the contract by declaring the service interface in the client code or by using a WCF client generated by Svcutil.exe. If the interface changes (adding a new operation, for example) you must update the interface in the client code or generate a new WCF client. If you do not, an exception is thrown. For example, you have a service that implements a service contract called ICalculator that defines Add(), Sub(), Mult(), and Div(). You create a client application and generate WCF client. You then add a method to ICalculator called Echo(). If you then write an application that calls without generating a new WCF client you get the following exception. + + `Unhandled Exception: System.ServiceModel.Description.WsdlImporter+WsdlImportException: Cannot locate operation Echo in Contract ICalculator`. + + + +## Examples + The following code example shows the use of the class to return metadata as a collection of objects that are then used to connect to a service instance. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/metadataresolver/cs/client.cs" id="Snippet1"::: + ]]> The address or the contract is . @@ -521,16 +521,16 @@ Resolves a metadata address into the objects for the specified contracts using the specified metadata address and . A collection of objects for the specified contract. - is . - - To download metadata but not resolve the information into objects, use the directly. - + is . + + To download metadata but not resolve the information into objects, use the directly. + > [!NOTE] -> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. - +> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. + ]]> The address, contracts collection, or client is . @@ -566,16 +566,16 @@ Resolves a metadata address into the objects for the specified contracts using the specified address and transfer mode. A collection of objects for the specified contract. - are used to retrieve the metadata. - - To download metadata but not resolve the information into objects, use the directly. - + are used to retrieve the metadata. + + To download metadata but not resolve the information into objects, use the directly. + > [!NOTE] -> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. - +> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. + ]]> The address or contracts collection is . @@ -611,25 +611,25 @@ Resolves a metadata address into the objects for the specified contract using the specified address and transfer mode. A collection of objects for the specified contract. - method to specify a contract, and address, and the download mechanism to use. - - The default settings on the are used to retrieve the metadata. - - To download metadata but not resolve the information into objects, use the directly. - + method to specify a contract, and address, and the download mechanism to use. + + The default settings on the are used to retrieve the metadata. + + To download metadata but not resolve the information into objects, use the directly. + > [!NOTE] -> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. - - - -## Examples - The following code example shows the use of the to download and return metadata as a collection of objects using an HTTP GET request rather than WS-Transfer. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/metadataresolver/cs/client.cs" id="Snippet2"::: - +> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. + + + +## Examples + The following code example shows the use of the to download and return metadata as a collection of objects using an HTTP GET request rather than WS-Transfer. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/metadataresolver/cs/client.cs" id="Snippet2"::: + ]]> The address or contract is . @@ -665,14 +665,14 @@ Resolves a metadata address into the objects for the specified contracts using the specified address, transfer mode, and transfer client. A collection of objects for the specified contract. - objects, use the directly. - + objects, use the directly. + > [!NOTE] -> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. - +> An empty collection is returned if no endpoints were imported or if no endpoints matched the contract. If an empty collection is returned, a warning trace is written. + ]]> The address, contracts collection, or client is . diff --git a/xml/System.ServiceModel.Description/MetadataSection.xml b/xml/System.ServiceModel.Description/MetadataSection.xml index 035d48f5a30..7a27020c6a9 100644 --- a/xml/System.ServiceModel.Description/MetadataSection.xml +++ b/xml/System.ServiceModel.Description/MetadataSection.xml @@ -30,7 +30,7 @@ A object contains one dialect of metadata in XML form (such as a Web Services Description Language or WSDL file). You can add a to a collection of XML metadata represented by a object. Much of the Windows Communication Foundation (WCF) metadata system, such as the class, use the class to import or export service metadata in XML form. - For example, to export WCF contract or endpoint objects to a object that contains the equivalent metadata in XML form, call the appropriate Export methods on the class, passing either or objects, and then call the method. + For example, to export WCF contract or endpoint objects to a object that contains the equivalent metadata in XML form, call the appropriate Export methods on the class, passing either or objects, and then call the method. To import XML-based metadata from a object into WCF, , and objects, pass a object to the constructor of the class and call one of the import methods. @@ -105,7 +105,7 @@ constructor to specify the metadata to be included in this , its dialect and its identifier. The metadata object must be serializable using the class so that the object can be serialized. If it is not serializable, an exception is thrown when the object is serialized. Use a or object for the `metadata` parameter if you want to include a reference to the metadata instead of the metadata itself. + Use the constructor to specify the metadata to be included in this , its dialect and its identifier. The metadata object must be serializable using the class so that the object can be serialized. If it is not serializable, an exception is thrown when the object is serialized. Use a or object for the `metadata` parameter if you want to include a reference to the metadata instead of the metadata itself. ]]> @@ -182,7 +182,7 @@ method to create a for a WS-Policy policy expression. The property is set to and the `identifier` is assigned to the property. The recommend identifier is the `wsp:Name` attribute for the policy expression. + Use method to create a for a WS-Policy policy expression. The property is set to and the `identifier` is assigned to the property. The recommend identifier is the `wsp:Name` attribute for the policy expression. ]]> diff --git a/xml/System.ServiceModel.Description/MetadataSet.xml b/xml/System.ServiceModel.Description/MetadataSet.xml index b78679005a9..5f7b65cd876 100644 --- a/xml/System.ServiceModel.Description/MetadataSet.xml +++ b/xml/System.ServiceModel.Description/MetadataSet.xml @@ -32,9 +32,9 @@ ## Remarks The class contains a collection of objects, each of which contains one dialect of metadata in XML form. Typically, the class is used to pass a group of XML metadata documents to and from and objects, such as and . - To create a from a object of type , use the constructor. To obtain a object of type , use the property. + To create a from a object of type , use the constructor. To obtain a object of type , use the property. - In addition, you can use the method to load a from XML data and the method to write the internal metadata to an XML format. + In addition, you can use the method to load a from XML data and the method to write the internal metadata to an XML format. This type implements the structure defined in the WS-MetadataExchange specification. diff --git a/xml/System.ServiceModel.Description/MustUnderstandBehavior.xml b/xml/System.ServiceModel.Description/MustUnderstandBehavior.xml index 90c01d324fd..f65ce56b5ce 100644 --- a/xml/System.ServiceModel.Description/MustUnderstandBehavior.xml +++ b/xml/System.ServiceModel.Description/MustUnderstandBehavior.xml @@ -98,7 +98,7 @@ to support behavior functionality. + Implements to support behavior functionality. ]]> @@ -135,7 +135,7 @@ method to support behavior functionality. + Implements the method to support behavior functionality. ]]> @@ -172,7 +172,7 @@ to support behavior functionality. + Implements the to support behavior functionality. ]]> @@ -207,7 +207,7 @@ method to support behavior functionality. + Implements the method to support behavior functionality. ]]> diff --git a/xml/System.ServiceModel.Description/OperationContractGenerationContext.xml b/xml/System.ServiceModel.Description/OperationContractGenerationContext.xml index ee6b45f9f73..2e3b6162abd 100644 --- a/xml/System.ServiceModel.Description/OperationContractGenerationContext.xml +++ b/xml/System.ServiceModel.Description/OperationContractGenerationContext.xml @@ -20,12 +20,12 @@ object passed to the method to modify the code document object model prior to the generation of code. Typically, the interface is implemented on a custom implementation that is used to import custom WSDL elements or otherwise modify the code at the service or operation level. To modify the code at the service level, see . + Use the object passed to the method to modify the code document object model prior to the generation of code. Typically, the interface is implemented on a custom implementation that is used to import custom WSDL elements or otherwise modify the code at the service or operation level. To modify the code at the service level, see . ## Examples - The following example shows the use of the object passed to the method to add code comments extracted from custom WSDL elements. + The following example shows the use of the object passed to the method to add code comments extracted from custom WSDL elements. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationimporter.cs" id="Snippet14"::: @@ -466,7 +466,7 @@ ## Examples - The following example shows the use of the object passed to the method to add code comments extracted from custom WSDL elements. + The following example shows the use of the object passed to the method to add code comments extracted from custom WSDL elements. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationimporter.cs" id="Snippet14"::: diff --git a/xml/System.ServiceModel.Description/OperationDescriptionCollection.xml b/xml/System.ServiceModel.Description/OperationDescriptionCollection.xml index 45ced65edf1..c65352d157c 100644 --- a/xml/System.ServiceModel.Description/OperationDescriptionCollection.xml +++ b/xml/System.ServiceModel.Description/OperationDescriptionCollection.xml @@ -99,7 +99,7 @@ in the collection with the name specified. If you need to find all of the objects in the collection use the method instead. + This method returns the first occurrence of the in the collection with the name specified. If you need to find all of the objects in the collection use the method instead. ]]> diff --git a/xml/System.ServiceModel.Description/PolicyConversionContext.xml b/xml/System.ServiceModel.Description/PolicyConversionContext.xml index caef339e4d2..a35fa8185d2 100644 --- a/xml/System.ServiceModel.Description/PolicyConversionContext.xml +++ b/xml/System.ServiceModel.Description/PolicyConversionContext.xml @@ -22,13 +22,13 @@ ## Remarks An implementation of the is passed to and objects to export and import, respectively, custom policy assertions to and from metadata. On export, a collection of policy assertions are retrieved in order to add custom assertions. On import, the assertions are retrieved in order to import specific ones and configure binding elements appropriately. -- The method returns all policy assertions that are for the binding. +- The method returns all policy assertions that are for the binding. -- The method returns all policy assertions for a specific fault message. +- The method returns all policy assertions for a specific fault message. -- The method returns all policy assertions for a specific message. +- The method returns all policy assertions for a specific message. -- The method returns all policy assertions for a specific operation. +- The method returns all policy assertions for a specific operation. - The property gets the binding elements for the binding being described or configured. @@ -37,7 +37,7 @@ ## Examples - The following code example shows an implementation of the method that writes all policy assertions to the console. The code comments describe how to locate a specific custom policy assertion, create and insert an implementing binding element, and remove the assertion from the collection. + The following code example shows an implementation of the method that writes all policy assertions to the console. The code comments describe how to locate a specific custom policy assertion, create and insert an implementing binding element, and remove the assertion from the collection. [!code-csharp[S_UEPolicyConversionContext#0](~/snippets/csharp/VS_Snippets_CFX/s_uepolicyconversioncontext/cs/program.cs#0)] @@ -149,12 +149,12 @@ is not a copy. You can add and remove assertions as necessary. + The collection returned from is not a copy. You can add and remove assertions as necessary. ## Examples - The following code example shows an implementation of the method that writes all policy assertions to the console. The code comments describe how to locate a specific custom policy assertion, create and insert an implementing binding element, and remove the assertion from the collection. + The following code example shows an implementation of the method that writes all policy assertions to the console. The code comments describe how to locate a specific custom policy assertion, create and insert an implementing binding element, and remove the assertion from the collection. [!code-csharp[S_UEPolicyConversionContext#0](~/snippets/csharp/VS_Snippets_CFX/s_uepolicyconversioncontext/cs/program.cs#0)] @@ -197,7 +197,7 @@ is not a copy. You can add and remove assertions as necessary. + The collection returned from is not a copy. You can add and remove assertions as necessary. ]]> @@ -230,7 +230,7 @@ is not a copy. You can add and remove assertions as needed. + The collection returned from is not a copy. You can add and remove assertions as needed. ]]> @@ -263,7 +263,7 @@ is not a copy. You can add and remove assertions as necessary. + The collection returned from is not a copy. You can add and remove assertions as necessary. ]]> diff --git a/xml/System.ServiceModel.Description/ServiceContractGenerationContext.xml b/xml/System.ServiceModel.Description/ServiceContractGenerationContext.xml index 02d88c10dde..6936c51c842 100644 --- a/xml/System.ServiceModel.Description/ServiceContractGenerationContext.xml +++ b/xml/System.ServiceModel.Description/ServiceContractGenerationContext.xml @@ -20,12 +20,12 @@ object passed to the method to modify the code document object model prior to the generation of code. Typically, the interface is implemented on a custom implementation that is used to import custom WSDL elements or otherwise modify the code at the service or operation level. To modify the code at the operation level, see . + Use the object passed to the method to modify the code document object model prior to the generation of code. Typically, the interface is implemented on a custom implementation that is used to import custom WSDL elements or otherwise modify the code at the service or operation level. To modify the code at the operation level, see . ## Examples - The following example shows the use of the object passed to the method to add code comments extracted from custom WSDL elements. + The following example shows the use of the object passed to the method to add code comments extracted from custom WSDL elements. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationimporter.cs" id="Snippet12"::: @@ -176,7 +176,7 @@ ## Examples - The following example shows the use of the object passed to the method to add code comments extracted from custom WSDL elements. + The following example shows the use of the object passed to the method to add code comments extracted from custom WSDL elements. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationimporter.cs" id="Snippet12"::: diff --git a/xml/System.ServiceModel.Description/ServiceCredentials.xml b/xml/System.ServiceModel.Description/ServiceCredentials.xml index fb66f8088e7..4f4feb3a8da 100644 --- a/xml/System.ServiceModel.Description/ServiceCredentials.xml +++ b/xml/System.ServiceModel.Description/ServiceCredentials.xml @@ -24,7 +24,7 @@ method, by methods of the , and is returned by the property. + This class is used as a parameter in the method, by methods of the , and is returned by the property. @@ -187,7 +187,7 @@ method calls the constructor. + The method calls the constructor. ]]> @@ -411,7 +411,7 @@ - The instance then invokes . -- The property returns a object, on which the method is then called. +- The property returns a object, on which the method is then called. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ueservicecredentials/cs/program.cs" id="Snippet4"::: diff --git a/xml/System.ServiceModel.Description/ServiceDebugBehavior.xml b/xml/System.ServiceModel.Description/ServiceDebugBehavior.xml index e75edd6fa37..82249e43e04 100644 --- a/xml/System.ServiceModel.Description/ServiceDebugBehavior.xml +++ b/xml/System.ServiceModel.Description/ServiceDebugBehavior.xml @@ -485,7 +485,7 @@ method. + Modifies the bindings to support the behavior. For more information, see the method. ]]> diff --git a/xml/System.ServiceModel.Description/ServiceDescription.xml b/xml/System.ServiceModel.Description/ServiceDescription.xml index e1762e59cb9..af8ff416f3b 100644 --- a/xml/System.ServiceModel.Description/ServiceDescription.xml +++ b/xml/System.ServiceModel.Description/ServiceDescription.xml @@ -28,11 +28,11 @@ ## Remarks The information contained in the is used by the Windows Communication Foundation (WCF) system to building the run-time components for the service. - Use this method when adding custom behaviors to extend . Programmatically, you must the custom service behavior to the prior to when you call the method on the object. + Use this method when adding custom behaviors to extend . Programmatically, you must the custom service behavior to the prior to when you call the method on the object. - The and methods are available to reflect on behaviors using the Windows Communication Foundation (WCF) programming model when replacing with you own hosting mechanism. + The and methods are available to reflect on behaviors using the Windows Communication Foundation (WCF) programming model when replacing with you own hosting mechanism. - Export metadata about a service endpoint by passing as a parameter to . After calling this method, or one of the other export methods provided by , use the property to return the collection of objects. + Export metadata about a service endpoint by passing as a parameter to . After calling this method, or one of the other export methods provided by , use the property to return the collection of objects. @@ -142,11 +142,11 @@ . Programmatically, you must the custom service behavior to the prior to when you call the method on the object. + Use this method when adding custom behaviors to extend . Programmatically, you must the custom service behavior to the prior to when you call the method on the object. The type of behavior that is accessible from the description hierarchy is scoped to the specific level. From the the is accessible. - If you want access to the associated with an endpoint instead, you can obtain the endpoints for the service using the property. Then retrieve the from the collection with the method that employs the relevant search criteria, and call the property to obtain the collection of the objects. + If you want access to the associated with an endpoint instead, you can obtain the endpoints for the service using the property. Then retrieve the from the collection with the method that employs the relevant search criteria, and call the property to obtain the collection of the objects. @@ -230,9 +230,9 @@ returned by this method each contain the address, binding, contract, and behavior information required to communicate with the service. To access this information, you must retrieve the from the collection with the method that employs the relevant search criteria. Then the properties can be used to access the information. For example, the is accessed by the property. + The endpoints in the returned by this method each contain the address, binding, contract, and behavior information required to communicate with the service. To access this information, you must retrieve the from the collection with the method that employs the relevant search criteria. Then the properties can be used to access the information. For example, the is accessed by the property. - Export metadata about a service endpoint by passing as a parameter to . + Export metadata about a service endpoint by passing as a parameter to . @@ -282,7 +282,7 @@ ## Remarks Use this method to reflect on behaviors using the Windows Communication Foundation (WCF) programming model when replacing with you own hosting mechanism. - initializes the , , and properties, and ensures that the is attached to the service and adds any relevant service behaviors to . + initializes the , , and properties, and ensures that the is attached to the service and adds any relevant service behaviors to . @@ -329,7 +329,7 @@ ## Remarks Use this method to reflect on behaviors using the Windows Communication Foundation (WCF) programming model when replacing with you own hosting mechanism. - initializes the , , and properties, reflects on the type for any the objects and adds them to , and ensures that the is attached to the service. + initializes the , , and properties, reflects on the type for any the objects and adds them to , and ensures that the is attached to the service. diff --git a/xml/System.ServiceModel.Description/ServiceEndpoint.xml b/xml/System.ServiceModel.Description/ServiceEndpoint.xml index f03df235115..f8a846aa25d 100644 --- a/xml/System.ServiceModel.Description/ServiceEndpoint.xml +++ b/xml/System.ServiceModel.Description/ServiceEndpoint.xml @@ -277,7 +277,7 @@ ## Remarks The type of behavior that is accessible from the description hierarchy is scoped to the specific level. From the the is accessible. - If you want access to the associated with an endpoint, you can obtain the contact for the endpoint using the property. Then call the property to obtain the of the objects associated with the endpoint. + If you want access to the associated with an endpoint, you can obtain the contact for the endpoint using the property. Then call the property to obtain the of the objects associated with the endpoint. diff --git a/xml/System.ServiceModel.Description/ServiceEndpointCollection.xml b/xml/System.ServiceModel.Description/ServiceEndpointCollection.xml index eb6ee201fc7..071fd618d6f 100644 --- a/xml/System.ServiceModel.Description/ServiceEndpointCollection.xml +++ b/xml/System.ServiceModel.Description/ServiceEndpointCollection.xml @@ -33,14 +33,14 @@ is returned, for example, by the property and by the method when creating service endpoints from WSDL port types. + This collection of endpoints for a service is used by the metadata API to manage services with multiple endpoints. is returned, for example, by the property and by the method when creating service endpoints from WSDL port types. - The collection provides the functionality to the endpoints of a particular type, that have a specific name or address, or to of the endpoints for a service that meet a specified contract type or name criteria. + The collection provides the functionality to the endpoints of a particular type, that have a specific name or address, or to of the endpoints for a service that meet a specified contract type or name criteria. ## Examples - The following example illustrates the use of the and methods to enumerate objects that satisfy various search criteria. + The following example illustrates the use of the and methods to enumerate objects that satisfy various search criteria. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/serviceendpointcollection/cs/proxy.cs" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/serviceendpointcollection/cs/serviceendpointcollection.service.overview.cs" id="Snippet1"::: @@ -62,7 +62,7 @@ objects that satisfy the specified criteria, use one of the methods instead. + There are potentially multiple endpoints that could satisfy the criteria. The method returns the first one encountered in the collection. If you need to find all of the objects that satisfy the specified criteria, use one of the methods instead. ]]> @@ -103,9 +103,9 @@ overload is specific to the Windows Communication Foundation (WCF) programming model. It looks at the property for each endpoint. The may be `null` if the was not created from the WCF programming model (types with *Contract attributes). + This overload is specific to the Windows Communication Foundation (WCF) programming model. It looks at the property for each endpoint. The may be `null` if the was not created from the WCF programming model (types with *Contract attributes). - There are potentially multiple endpoints that could satisfy the criteria. The method returns the first one encountered in the collection. If you need to find all of the objects that satisfy the specified criteria, use one of the methods instead. + There are potentially multiple endpoints that could satisfy the criteria. The method returns the first one encountered in the collection. If you need to find all of the objects that satisfy the specified criteria, use one of the methods instead. ]]> @@ -148,7 +148,7 @@ objects that satisfy the specified criteria, use one of the methods instead. + There are potentially multiple endpoints that could satisfy the criteria. The method returns the first one encountered in the collection. If you need to find all of the objects that satisfy the specified criteria, use one of the methods instead. ]]> @@ -191,7 +191,7 @@ objects that satisfy the specified criteria, use one of the methods instead. + There are potentially multiple endpoints that could satisfy the criteria. The method returns the first one encountered in the collection. If you need to find all of the objects that satisfy the specified criteria, use one of the methods instead. ]]> @@ -234,7 +234,7 @@ objects that satisfy the specified criteria, use one of the methods instead. + There are potentially multiple endpoints that could satisfy the criteria. The method returns the first one encountered in the collection. If you need to find all of the objects that satisfy the specified criteria, use one of the methods instead. ]]> @@ -279,7 +279,7 @@ objects that satisfy the specified criteria, use one of the methods instead. + There are potentially multiple endpoints that could satisfy the criteria. The method returns the first one encountered in the collection. If you need to find all of the objects that satisfy the specified criteria, use one of the methods instead. ]]> @@ -298,7 +298,7 @@ that satisfies the specified criteria, use one of the methods instead. + If you only need to find the first that satisfies the specified criteria, use one of the methods instead. ]]> @@ -339,7 +339,7 @@ that satisfies the specified criteria, use one of the methods instead. + If you only need to find the first that satisfies the specified criteria, use one of the methods instead. ]]> @@ -382,7 +382,7 @@ that satisfies the specified criteria, use one of the methods instead. + If you only need to find the first that satisfies the specified criteria, use one of the methods instead. ]]> @@ -426,7 +426,7 @@ method defined in the base class and is provided to do input validation that ensures `null` values are not inserted into the collection. It is not intended to be called by users. + This method overrides the virtual method defined in the base class and is provided to do input validation that ensures `null` values are not inserted into the collection. It is not intended to be called by users. ]]> @@ -476,7 +476,7 @@ method defined in the base class and is provided to do input validation that ensures `null` values are not inserted into the collection. It is not intended to be called by users. + This method overrides the virtual method defined in the base class and is provided to do input validation that ensures `null` values are not inserted into the collection. It is not intended to be called by users. ]]> diff --git a/xml/System.ServiceModel.Description/ServiceHealthBehavior.xml b/xml/System.ServiceModel.Description/ServiceHealthBehavior.xml index e07ad80e413..bd23a2fddc1 100644 --- a/xml/System.ServiceModel.Description/ServiceHealthBehavior.xml +++ b/xml/System.ServiceModel.Description/ServiceHealthBehavior.xml @@ -16,13 +16,13 @@ Provides a Windows Communication Foundation (WCF) service behavior that provides a health endpoint. - When the method returns, the response message of the health behavior. This message has a content type of or , depending on whether the request was for XML or HTML. Returns the response message to a specified request. - instance and is responsible for crafting the response message to the health endpoint. @@ -324,15 +324,15 @@ This method is invoked by the if the parsing operation succeeded; otherwise, . - method. +The method returns `true` if the value of the field was successfully parsed by the method. ]]> is . - + -or- is . @@ -371,7 +371,7 @@ The method returns `true` if the value of the field was successfully parsed by t To be added. is . - + -or- is . diff --git a/xml/System.ServiceModel.Description/ServiceThrottlingBehavior.xml b/xml/System.ServiceModel.Description/ServiceThrottlingBehavior.xml index a97440777e4..7fb1f4dcab4 100644 --- a/xml/System.ServiceModel.Description/ServiceThrottlingBehavior.xml +++ b/xml/System.ServiceModel.Description/ServiceThrottlingBehavior.xml @@ -245,7 +245,7 @@ method. + Implements the method. ]]> @@ -282,7 +282,7 @@ method. + Implements the method. ]]> @@ -319,7 +319,7 @@ method. + Implements the method. ]]> diff --git a/xml/System.ServiceModel.Description/SynchronousReceiveBehavior.xml b/xml/System.ServiceModel.Description/SynchronousReceiveBehavior.xml index 3889d77bd61..a3442f72bfd 100644 --- a/xml/System.ServiceModel.Description/SynchronousReceiveBehavior.xml +++ b/xml/System.ServiceModel.Description/SynchronousReceiveBehavior.xml @@ -21,13 +21,13 @@ Controls whether channels listen synchronously or asynchronously. - instructs WCF to issue a new thread to pump for each accepted channel. If there are a lot of channels there is the possibility of running out of threads. - - You can also set this value using the [<synchronousReceive>](/dotnet/framework/configure-apps/file-schema/wcf/synchronousreceive-element) in an application configuration file. - + instructs WCF to issue a new thread to pump for each accepted channel. If there are a lot of channels there is the possibility of running out of threads. + + You can also set this value using the [<synchronousReceive>](/dotnet/framework/configure-apps/file-schema/wcf/synchronousreceive-element) in an application configuration file. + ]]> @@ -84,11 +84,11 @@ The objects that binding elements require to support the behavior. Not implemented in this class. - for a description of the interface member that this class implements. - + for a description of the interface member that this class implements. + ]]> @@ -121,11 +121,11 @@ The client runtime to be customized. Not implemented in this class. - for a description of the interface member this class implements. - + for a description of the interface member this class implements. + ]]> @@ -158,11 +158,11 @@ The endpoint dispatcher to be modified or extended. Sets the property to . - @@ -193,11 +193,11 @@ The endpoint to validate. Not implemented in this class. - for a description of the interface member this class implements. - + for a description of the interface member this class implements. + ]]> diff --git a/xml/System.ServiceModel.Description/WebHttpBehavior.xml b/xml/System.ServiceModel.Description/WebHttpBehavior.xml index 40b9f77ab86..c59d7d03f56 100644 --- a/xml/System.ServiceModel.Description/WebHttpBehavior.xml +++ b/xml/System.ServiceModel.Description/WebHttpBehavior.xml @@ -164,7 +164,7 @@ and are called for each operation to determine the to install. + As part of this method, and are called for each operation to determine the to install. ]]> @@ -201,7 +201,7 @@ and are called for each operation to determine the to install. + As part of this method, and are called for each operation to determine the to install. ]]> diff --git a/xml/System.ServiceModel.Description/WebScriptEnablingBehavior.xml b/xml/System.ServiceModel.Description/WebScriptEnablingBehavior.xml index 1f6f6f4db57..640008a6da6 100644 --- a/xml/System.ServiceModel.Description/WebScriptEnablingBehavior.xml +++ b/xml/System.ServiceModel.Description/WebScriptEnablingBehavior.xml @@ -147,7 +147,7 @@ method to view, modify, or add custom extension to the client runtime across all messages used with an endpoint or for specific operations. + Implements the method to view, modify, or add custom extension to the client runtime across all messages used with an endpoint or for specific operations. ]]> diff --git a/xml/System.ServiceModel.Description/WebServiceEndpoint.xml b/xml/System.ServiceModel.Description/WebServiceEndpoint.xml index d38689faf07..38bb0db3c0a 100644 --- a/xml/System.ServiceModel.Description/WebServiceEndpoint.xml +++ b/xml/System.ServiceModel.Description/WebServiceEndpoint.xml @@ -16,11 +16,11 @@ A standard endpoint with a fixed binding. - and classes. - + and classes. + ]]> @@ -109,11 +109,11 @@ Gets or sets the maximum amount of memory allocated for the buffer manager that manages the buffers required by endpoints that use this binding. The maximum size, in bytes, for the pool of buffers used by an endpoint configured with this binding. The default value is 65,536 bytes. - tries to minimize the cost of using buffers with a buffer pool. Buffers are required to process messages by the service when they come out of the channel. If there is not sufficient memory in the buffer pool to process the message load, the must allocate additional memory from the CLR heap, which increases the garbage collection overhead. Extensive allocation from the CLR garbage heap is an indication that the buffer pool size is too small and that performance can be improved with a larger allocation by increasing the limit. - + tries to minimize the cost of using buffers with a buffer pool. Buffers are required to process messages by the service when they come out of the channel. If there is not sufficient memory in the buffer pool to process the message load, the must allocate additional memory from the CLR heap, which increases the garbage collection overhead. Extensive allocation from the CLR garbage heap is an indication that the buffer pool size is too small and that performance can be improved with a larger allocation by increasing the limit. + ]]> @@ -137,11 +137,11 @@ Gets or sets the maximum amount of memory that is allocated for use by the manager of the message buffers that receive messages from the channel. The maximum amount of memory, in bytes, available for use by the message buffer manager. The default value is 524,288 (0x80000) bytes. - minimizes the cost of using buffers by using a buffer pool. Buffers are required to process messages by the service when they come out of the channel. If there is not sufficient memory in the buffer pool to process the message load, the must allocate additional memory from the CLR heap, which increases the garbage collection overhead. Extensive allocation from the CLR garbage heap is an indication that the buffer pool size is too small and that performance can be improved with a larger allocation by increasing the limit. - + minimizes the cost of using buffers by using a buffer pool. Buffers are required to process messages by the service when they come out of the channel. If there is not sufficient memory in the buffer pool to process the message load, the must allocate additional memory from the CLR heap, which increases the garbage collection overhead. Extensive allocation from the CLR garbage heap is an indication that the buffer pool size is too small and that performance can be improved with a larger allocation by increasing the limit. + ]]> The value set is less than or equal to zero. @@ -166,11 +166,11 @@ Gets or sets the maximum size for a message that can be processed by the binding. The maximum size, in bytes, for a message that is processed by the binding. The default value is 65,536 bytes. - is bounded by the amount of memory allocated for each message. This bound on message size is intended to limit exposure to denial of service (DoS) attacks. - + is bounded by the amount of memory allocated for each message. This bound on message size is intended to limit exposure to denial of service (DoS) attacks. + ]]> The value is less than zero. @@ -196,21 +196,21 @@ Gets or sets constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding. The complexity constraints. - = 32 - -- = 8192 - -- = 16384 - -- = 4096 - -- = 16384 - + = 32 + +- = 8192 + +- = 16384 + +- = 4096 + +- = 16384 + ]]> The value set is . @@ -237,14 +237,14 @@ Gets the security settings used with this binding. The that is used with this binding. The default value is . - constructor. - + constructor. + > [!NOTE] -> If you set this property to and you are using HTTP, be aware that credentials are sent over the wire in plain text. - +> If you set this property to and you are using HTTP, be aware that credentials are sent over the wire in plain text. + ]]> @@ -268,11 +268,11 @@ Gets or sets a value that indicates whether the service configured with the binding uses streamed or buffered (or both) modes of message transfer. The value that indicates whether the service configured with the binding uses streamed or buffered (or both) modes of message transfer. The default value is . - indicates whether a channel uses streamed or buffered modes for the transfer of messages. - + indicates whether a channel uses streamed or buffered modes for the transfer of messages. + ]]> The value set is not a valid value. diff --git a/xml/System.ServiceModel.Description/WsdlContractConversionContext.xml b/xml/System.ServiceModel.Description/WsdlContractConversionContext.xml index 75c7f30fb49..4c522e1476c 100644 --- a/xml/System.ServiceModel.Description/WsdlContractConversionContext.xml +++ b/xml/System.ServiceModel.Description/WsdlContractConversionContext.xml @@ -22,9 +22,9 @@ ## Remarks Use the object to examine and modify items that are to be converted to or from WSDL. - When exporting metadata a object is passed to the and methods. Use the various methods and properties to obtain metadata objects that you can use to examine and modify to alter the published WSDL. + When exporting metadata a object is passed to the and methods. Use the various methods and properties to obtain metadata objects that you can use to examine and modify to alter the published WSDL. - When importing metadata a object is passed to the and methods. Use the various methods and properties to obtain metadata objects that you can use to examine and modify the imported metadata. + When importing metadata a object is passed to the and methods. Use the various methods and properties to obtain metadata objects that you can use to examine and modify the imported metadata. @@ -164,7 +164,7 @@ to add custom WSDL annotations to the exported metadata using the and properties. When exporting operations, the method iterates through the operation descriptions, and locates each associated by calling the method. + The following code example shows the use of the to add custom WSDL annotations to the exported metadata using the and properties. When exporting operations, the method iterates through the operation descriptions, and locates each associated by calling the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customwsdlextensions/cs/wsdldocumentationattribute.cs" id="Snippet7"::: diff --git a/xml/System.ServiceModel.Description/WsdlEndpointConversionContext.xml b/xml/System.ServiceModel.Description/WsdlEndpointConversionContext.xml index fdfa3eb84cc..0b83d8b290f 100644 --- a/xml/System.ServiceModel.Description/WsdlEndpointConversionContext.xml +++ b/xml/System.ServiceModel.Description/WsdlEndpointConversionContext.xml @@ -34,17 +34,17 @@ The following properties enable you to retrieve the WSDL document object model f The following methods enable you to add or remove custom WSDL elements to the appropriate scopes in the exported or imported WSDL: -- The method returns the fault binding for the specified fault. +- The method returns the fault binding for the specified fault. -- The method returns the fault for the specified fault binding. +- The method returns the fault for the specified fault binding. -- The method returns the message binding for the specified message. +- The method returns the message binding for the specified message. -- The method returns the message for the specified message binding. +- The method returns the message for the specified message binding. -- The method returns the operation binding for the specified operation. +- The method returns the operation binding for the specified operation. -- The method returns the operation for the specified operation binding. +- The method returns the operation for the specified operation binding. ]]> @@ -147,7 +147,7 @@ The following methods enable you to add or remove custom WSDL elements to the ap method. + This method is the inverse of the method. ]]> @@ -180,7 +180,7 @@ The following methods enable you to add or remove custom WSDL elements to the ap method. + This method is the inverse of the method. ]]> @@ -213,7 +213,7 @@ The following methods enable you to add or remove custom WSDL elements to the ap method. + This method is the inverse of the method. ]]> @@ -246,7 +246,7 @@ The following methods enable you to add or remove custom WSDL elements to the ap method. + This method is the inverse of the method. ]]> @@ -279,7 +279,7 @@ The following methods enable you to add or remove custom WSDL elements to the ap method. + This method is the inverse of the method. ]]> @@ -312,7 +312,7 @@ The following methods enable you to add or remove custom WSDL elements to the ap method. + This method is the inverse of the method. ]]> diff --git a/xml/System.ServiceModel.Description/WsdlExporter.xml b/xml/System.ServiceModel.Description/WsdlExporter.xml index b2b556381c6..89c8bdee417 100644 --- a/xml/System.ServiceModel.Description/WsdlExporter.xml +++ b/xml/System.ServiceModel.Description/WsdlExporter.xml @@ -24,11 +24,11 @@ The is used in a three-step process. -1. Call the , , or method, passing the appropriate parameters. +1. Call the , , or method, passing the appropriate parameters. 2. Determine whether there are any export errors by checking the base property. -3. If there are no errors, use the to get a collection of objects or get more specific versions of the metadata using the or properties. +3. If there are no errors, use the to get a collection of objects or get more specific versions of the metadata using the or properties. You can support exporting custom WSDL extensions by implementing the interface and custom policy assertions by implementing the interface. For details, see the documentation for those interfaces. @@ -38,7 +38,7 @@ ## Examples - The following code example shows how to use the method to generate a set of objects from the endpoints in a collection of objects called `myServiceEndpoints`. + The following code example shows how to use the method to generate a set of objects from the endpoints in a collection of objects called `myServiceEndpoints`. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uewsdlexporter/cs/program.cs" id="Snippet0"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uewsdlexporter/vb/program.vb" id="Snippet0"::: @@ -98,12 +98,12 @@ method to export metadata from only one contract. + Use the method to export metadata from only one contract. ## Examples - The following code example demonstrates how to call to export only contract information. + The following code example demonstrates how to call to export only contract information. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uewsdlexporter/cs/program.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uewsdlexporter/vb/program.vb" id="Snippet1"::: @@ -140,7 +140,7 @@ method to create metadata about a single endpoint. + Use the method to create metadata about a single endpoint. @@ -186,7 +186,7 @@ method to create metadata about a set of endpoints from a specified service. + Use the method to create metadata about a set of endpoints from a specified service. ]]> @@ -225,7 +225,7 @@ property returns documents only as a result of calls to either , , or . + The property returns documents only as a result of calls to either , , or . ]]> @@ -260,7 +260,7 @@ property returns documents only as a result of calls to either , , or . + The property returns documents only as a result of calls to either , , or . ]]> @@ -290,14 +290,14 @@ property to get a collection of all the metadata generated as a result of any number of calls to , , or . + Use the property to get a collection of all the metadata generated as a result of any number of calls to , , or . It is recommended that you check the base property to determine whether any errors occurred before you retrieve the metadata. ## Examples - The following code example shows how to use the method to generate a set of objects from the endpoints in a collection of objects called `myServiceEndpoints`. + The following code example shows how to use the method to generate a set of objects from the endpoints in a collection of objects called `myServiceEndpoints`. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uewsdlexporter/cs/program.cs" id="Snippet0"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uewsdlexporter/vb/program.vb" id="Snippet0"::: diff --git a/xml/System.ServiceModel.Description/WsdlImporter.xml b/xml/System.ServiceModel.Description/WsdlImporter.xml index d4944cc3591..3cef9f0864a 100644 --- a/xml/System.ServiceModel.Description/WsdlImporter.xml +++ b/xml/System.ServiceModel.Description/WsdlImporter.xml @@ -41,7 +41,7 @@ No values are returned from the properties until one of the import methods is called. Custom objects can either be loaded into the programmatically or using the client configuration [<wsdlImporters>](/dotnet/framework/configure-apps/file-schema/wcf/wsdlimporters) element. - Metadata that has been imported as service endpoints cannot be used to create a runtime or export metadata because the imported endpoints contain no managed type information. To use the metadata to create a client or service runtime or to generate metadata, you must first generate and compile code from the metadata and use that type information to create a new object using . + Metadata that has been imported as service endpoints cannot be used to create a runtime or export metadata because the imported endpoints contain no managed type information. To use the metadata to create a client or service runtime or to generate metadata, you must first generate and compile code from the metadata and use that type information to create a new object using . @@ -86,7 +86,7 @@ constructor to create a object from a set of metadata documents. + Use the constructor to create a object from a set of metadata documents. @@ -213,9 +213,9 @@ method to import all binding information from the metadata documents and return them as objects. Check the property to determine whether there are any import errors before using the returned objects. + Use the method to import all binding information from the metadata documents and return them as objects. Check the property to determine whether there are any import errors before using the returned objects. - To import a specific WSDL binding, see the method. + To import a specific WSDL binding, see the method. ]]> @@ -246,9 +246,9 @@ method to import all WSDL port type information from the metadata documents and return them as objects. It is recommended to check the property to determine whether there are any import errors before using the returned objects. + Use the method to import all WSDL port type information from the metadata documents and return them as objects. It is recommended to check the property to determine whether there are any import errors before using the returned objects. - To import only one port type, see the method. + To import only one port type, see the method. @@ -286,9 +286,9 @@ method to import all endpoint information from the metadata documents and return them as a collection of objects. Check the property to determine whether there are any import errors before using the returned objects. + Use the method to import all endpoint information from the metadata documents and return them as a collection of objects. Check the property to determine whether there are any import errors before using the returned objects. - To import only a specific WSDL port, see the method. + To import only a specific WSDL port, see the method. ]]> @@ -322,7 +322,7 @@ method to use a object to locate binding information in the metadata and return that binding information as a object. Check the property to determine whether there are any import errors before using the returned object. + Use the method to use a object to locate binding information in the metadata and return that binding information as a object. Check the property to determine whether there are any import errors before using the returned object. ]]> @@ -357,7 +357,7 @@ method to use a object to locate port type information in the metadata and return that information as a object. Check the property to determine whether there are any import errors before using the returned object. + Use the method to use a object to locate port type information in the metadata and return that information as a object. Check the property to determine whether there are any import errors before using the returned object. ]]> @@ -392,7 +392,7 @@ method to use a object to locate port type information in the metadata and return that information as a object. Check the property to determine whether there are any import errors before using the returned object. + Use the method to use a object to locate port type information in the metadata and return that information as a object. Check the property to determine whether there are any import errors before using the returned object. ]]> diff --git a/xml/System.ServiceModel.Discovery/AnnouncementClient.xml b/xml/System.ServiceModel.Discovery/AnnouncementClient.xml index 717d53d9348..f57d98fc3f3 100644 --- a/xml/System.ServiceModel.Discovery/AnnouncementClient.xml +++ b/xml/System.ServiceModel.Discovery/AnnouncementClient.xml @@ -23,11 +23,11 @@ Used by services to send discovery announcement messages. Clients can use the discovery mechanism, specifically the corresponding class to listen and act on the announcement messages. An announcement message contains information about the service such as its fully-qualified contract name, any scopes that the service is operating in as well as any custom metadata the service wants to send. - behavior and specifies an the service automatically sends announcement messages when the service goes online or comes offline. Use this class when you want to explicitly send the announcement messages yourself. - + behavior and specifies an the service automatically sends announcement messages when the service goes online or comes offline. Use this class when you want to explicitly send the announcement messages yourself. + ]]> @@ -213,11 +213,11 @@ Occurs when an asynchronous offline announcement (Bye) completes. - . - + . + ]]> @@ -354,11 +354,11 @@ Occurs when an asynchronous online announcement (Hello) completes. - . - + . + ]]> diff --git a/xml/System.ServiceModel.Discovery/DiscoveryClient.xml b/xml/System.ServiceModel.Discovery/DiscoveryClient.xml index a384246b185..3827e9f1bf9 100644 --- a/xml/System.ServiceModel.Discovery/DiscoveryClient.xml +++ b/xml/System.ServiceModel.Discovery/DiscoveryClient.xml @@ -124,7 +124,7 @@ is thrown if `userState` is `null`. If multiple or operations are called with the same `userState` value, and is called with that `userState` value, an is thrown. + An is thrown if `userState` is `null`. If multiple or operations are called with the same `userState` value, and is called with that `userState` value, an is thrown. ]]> diff --git a/xml/System.ServiceModel.Discovery/DiscoveryEndpointProvider.xml b/xml/System.ServiceModel.Discovery/DiscoveryEndpointProvider.xml index 367e0e4d64b..eee82f8c1bc 100644 --- a/xml/System.ServiceModel.Discovery/DiscoveryEndpointProvider.xml +++ b/xml/System.ServiceModel.Discovery/DiscoveryEndpointProvider.xml @@ -16,11 +16,11 @@ Provides a discovery endpoint. - class uses classes derived from to get the discovery endpoint to use. - + class uses classes derived from to get the discovery endpoint to use. + ]]> @@ -68,11 +68,11 @@ Gets the discovery endpoint. The discovery endpoint. - class calls the method on the instance passed by the user to get the for discovering the services. also calls method whenever it must clone itself. - + class calls the method on the instance passed by the user to get the for discovering the services. also calls method whenever it must clone itself. + ]]> diff --git a/xml/System.ServiceModel.Discovery/DiscoveryProxy.xml b/xml/System.ServiceModel.Discovery/DiscoveryProxy.xml index a04aa9d2335..89d6c9b1a44 100644 --- a/xml/System.ServiceModel.Discovery/DiscoveryProxy.xml +++ b/xml/System.ServiceModel.Discovery/DiscoveryProxy.xml @@ -121,11 +121,11 @@ Override this method to allow the discovery proxy to send out multicast suppression messages when it receives a multicast find request. A reference to the pending asynchronous operation. - @@ -157,11 +157,11 @@ Override this method to allow the discovery proxy to send out multicast suppression messages when it receives a multicast resolve request. A reference to the pending asynchronous operation. - @@ -192,11 +192,11 @@ if the find operation should be redirected, otherwise . - @@ -227,11 +227,11 @@ if the resolve operation should be redirected, otherwise . - @@ -263,11 +263,11 @@ Override this method to handle a find operation. A reference to the pending asynchronous operation. - method one or more times. - + method one or more times. + ]]> diff --git a/xml/System.ServiceModel.Discovery/DiscoveryService.xml b/xml/System.ServiceModel.Discovery/DiscoveryService.xml index 0e509930f92..7bea49c187c 100644 --- a/xml/System.ServiceModel.Discovery/DiscoveryService.xml +++ b/xml/System.ServiceModel.Discovery/DiscoveryService.xml @@ -16,11 +16,11 @@ An abstract base class used to implement a discovery service. - is added to a service, a default implementation is used to handle Find and Resolve requests. Extend this class to implement a custom discovery service that has behavior different from the default implementation, such as to reply to Find requests using a custom matching algorithm - + is added to a service, a default implementation is used to handle Find and Resolve requests. Extend this class to implement a custom discovery service that has behavior different from the default implementation, such as to reply to Find requests using a custom matching algorithm + ]]> @@ -128,11 +128,11 @@ Override this method to handle a find operation. A reference to the pending asynchronous operation. - method one or more times. - + method one or more times. + ]]> diff --git a/xml/System.ServiceModel.Discovery/DiscoveryServiceExtension.xml b/xml/System.ServiceModel.Discovery/DiscoveryServiceExtension.xml index 28c66053053..66b2b5f0d71 100644 --- a/xml/System.ServiceModel.Discovery/DiscoveryServiceExtension.xml +++ b/xml/System.ServiceModel.Discovery/DiscoveryServiceExtension.xml @@ -20,11 +20,11 @@ An abstract WCF extension class for specifying a custom discovery service or for getting the published endpoints. - and override the method to return your custom discovery service. Add your derived class to the extensions that host your discoverable service. When the is called the behavior iterates through the extensions in the service host and looks for a . If one is found its is called to get the custom discovery service. If an extension is not found the default discovery service implementation is used. - + and override the method to return your custom discovery service. Add your derived class to the extensions that host your discoverable service. When the is called the behavior iterates through the extensions in the service host and looks for a . If one is found its is called to get the custom discovery service. If an extension is not found the default discovery service implementation is used. + ]]> @@ -66,11 +66,11 @@ Override this method to return your custom implementation. A custom discovery service implementation. - is thrown while opening the service host if this method returns `null` - + is thrown while opening the service host if this method returns `null` + ]]> @@ -100,11 +100,11 @@ Gets a read-only collection of published endpoints. A read-only collection of published endpoints. - has successfully opened. When the is in state, the is being generated and added to the collection. - + has successfully opened. When the is in state, the is being generated and added to the collection. + ]]> @@ -161,11 +161,11 @@ The service host to detach from. Overload this method to allow the extension to be detached from its service host. - that indicates discovery service extensions cannot be detached. - + that indicates discovery service extensions cannot be detached. + ]]> diff --git a/xml/System.ServiceModel.Dispatcher/ActionMessageFilter.xml b/xml/System.ServiceModel.Dispatcher/ActionMessageFilter.xml index 8e98c55c3a3..c6bd3b850c7 100644 --- a/xml/System.ServiceModel.Dispatcher/ActionMessageFilter.xml +++ b/xml/System.ServiceModel.Dispatcher/ActionMessageFilter.xml @@ -72,7 +72,7 @@ contains duplicate actions, the duplicates are removed and only one of them is added to the . The of `actions` contained in the is accessed by the property and cannot be modified after the object is instantiated. + If the array of `actions` provided to populate the contains duplicate actions, the duplicates are removed and only one of them is added to the . The of `actions` contained in the is accessed by the property and cannot be modified after the object is instantiated. @@ -144,9 +144,9 @@ . + The method returns an instance of . - This method is not intended to be called directly. If you require an instance of , create one by calling a constructor on the desired type of filter table. In general, s should be added to instances of . + This method is not intended to be called directly. If you require an instance of , create one by calling a constructor on the desired type of filter table. In general, s should be added to instances of . ]]> @@ -165,7 +165,7 @@ ## Remarks The difference between the two overloads is that one takes a parameter and cannot examine the message body; the other takes a parameter and can examine any part of the message. Because an action filter does not examine the body, these methods are equivalent. - If you must check the message against multiple objects, put the filters into an and then use the matching functionality provided by the table. + If you must check the message against multiple objects, put the filters into an and then use the matching functionality provided by the table. ]]> @@ -199,7 +199,7 @@ when a message must be tested against the actions in a single filter and the is available. + Use this overload of when a message must be tested against the actions in a single filter and the is available. ]]> @@ -235,7 +235,7 @@ method when a message must be tested against the actions in a single filter and the is available. + Use this overload of the method when a message must be tested against the actions in a single filter and the is available. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/ChannelDispatcher.xml b/xml/System.ServiceModel.Dispatcher/ChannelDispatcher.xml index 7fe3b18b68f..40fdcdfaf74 100644 --- a/xml/System.ServiceModel.Dispatcher/ChannelDispatcher.xml +++ b/xml/System.ServiceModel.Dispatcher/ChannelDispatcher.xml @@ -425,7 +425,7 @@ . Otherwise, a service model default value of 1 minute is used. + This default close timeout can be set using . Otherwise, a service model default value of 1 minute is used. ]]> @@ -462,7 +462,7 @@ . Otherwise, a service model default value of 1 minute is used. + This default open timeout can be set using . Otherwise, a service model default value of 1 minute is used. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/ChannelDispatcherBase.xml b/xml/System.ServiceModel.Dispatcher/ChannelDispatcherBase.xml index c7c7d69be52..bdd3bab73a9 100644 --- a/xml/System.ServiceModel.Dispatcher/ChannelDispatcherBase.xml +++ b/xml/System.ServiceModel.Dispatcher/ChannelDispatcherBase.xml @@ -30,13 +30,13 @@ , create a class derived from it, extend and override , adding instances of your class derived from to . + This is used by developers who want to keep the Windows Communication Foundation (WCF) programming model but replace the system-provided runtime. Such applications will pull messages out of channels and handle them directly with user-defined dispatchers. To use , create a class derived from it, extend and override , adding instances of your class derived from to . The and the , associated with the object are available for inspection or modification through the and respectively. - calls the or methods when adding or removing a item from its collection. + calls the or methods when adding or removing a item from its collection. - calls the during shutdown before closing InstanceContexts. Windows Communication Foundation (WCF) uses this call to close datagram channels and wait for all messages to get to an InstanceContext. + calls the during shutdown before closing InstanceContexts. Windows Communication Foundation (WCF) uses this call to close datagram channels and wait for all messages to get to an InstanceContext. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/ChannelDispatcherCollection.xml b/xml/System.ServiceModel.Dispatcher/ChannelDispatcherCollection.xml index 3e252abd324..5c7d3683611 100644 --- a/xml/System.ServiceModel.Dispatcher/ChannelDispatcherCollection.xml +++ b/xml/System.ServiceModel.Dispatcher/ChannelDispatcherCollection.xml @@ -23,9 +23,9 @@ to manage the channel dispatchers associated with the host. A is created when is called and the collection can be accessed using the property. + This collection is used by to manage the channel dispatchers associated with the host. A is created when is called and the collection can be accessed using the property. - The collection contains objects (and not just instances of ) because it is also used by developers who want to keep the Windows Communication Foundation (WCF)programming model but replace the system-provided runtime. They derive a class from and extend (which inherits from ) by overriding , adding instances of the class derived from to . + The collection contains objects (and not just instances of ) because it is also used by developers who want to keep the Windows Communication Foundation (WCF)programming model but replace the system-provided runtime. They derive a class from and extend (which inherits from ) by overriding , adding instances of the class derived from to . This class has no public constructors and is not intended to be used outside of the . diff --git a/xml/System.ServiceModel.Dispatcher/ClientOperation.xml b/xml/System.ServiceModel.Dispatcher/ClientOperation.xml index 41093954268..5c33c891640 100644 --- a/xml/System.ServiceModel.Dispatcher/ClientOperation.xml +++ b/xml/System.ServiceModel.Dispatcher/ClientOperation.xml @@ -493,7 +493,7 @@ ## Remarks Use the property to insert a custom implementation for an operation or modify the current formatter. The use of the formatter can be controlled by the and properties. - The interface defines the and methods, which are used to convert a set of object parameters to a message and from a message to a set of return values, respectively. + The interface defines the and methods, which are used to convert a set of object parameters to a message and from a message to a set of return values, respectively. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/ClientRuntime.xml b/xml/System.ServiceModel.Dispatcher/ClientRuntime.xml index 14760287c9a..9fdb3702975 100644 --- a/xml/System.ServiceModel.Dispatcher/ClientRuntime.xml +++ b/xml/System.ServiceModel.Dispatcher/ClientRuntime.xml @@ -55,7 +55,7 @@ or of , are used by Windows Communication Foundation (WCF) client applications to convert method calls into outbound messages and convert incoming messages to objects and pass them to the results of client methods. + WCF client objects, whether an extension of or of , are used by Windows Communication Foundation (WCF) client applications to convert method calls into outbound messages and convert incoming messages to objects and pass them to the results of client methods. The class is an extensibility point to which you can add extension objects that intercept messages and extend client behavior across all operations. Interception objects can process all messages in a particular contract, process only messages for particular operations, perform custom channel initialization, and implement other custom client application behavior. For an overview of client architecture, see [WCF Client Architecture](/dotnet/framework/wcf/feature-details/client-architecture). For more information about client programming, see [Accessing Services Using a WCF Client](/dotnet/framework/wcf/feature-details/accessing-services-using-a-client). For details about customizations and how to perform them, see [Extending Clients](/dotnet/framework/wcf/extending/extending-clients). @@ -215,7 +215,7 @@ property to add a custom object that can inspect the channel that is associated with a client on creation, register for events on the channel, and associate state with the channel by using . + Use the property to add a custom object that can inspect the channel that is associated with a client on creation, register for events on the channel, and associate state with the channel by using . ]]> diff --git a/xml/System.ServiceModel.Dispatcher/DispatchOperation.xml b/xml/System.ServiceModel.Dispatcher/DispatchOperation.xml index 1a049cf2a61..ba88481f065 100644 --- a/xml/System.ServiceModel.Dispatcher/DispatchOperation.xml +++ b/xml/System.ServiceModel.Dispatcher/DispatchOperation.xml @@ -428,7 +428,7 @@ ## Remarks Use the property to insert a custom implementation for an operation or modify the current formatter. In the case of strongly-typed message operations, the use of the formatter can be controlled by the and properties. - The interface defines the and methods, which are used to convert a set of object parameters to a message and from a message to a set of return values, respectively. + The interface defines the and methods, which are used to convert a set of object parameters to a message and from a message to a set of return values, respectively. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/DispatchRuntime.xml b/xml/System.ServiceModel.Dispatcher/DispatchRuntime.xml index 64f32d968aa..6594128863c 100644 --- a/xml/System.ServiceModel.Dispatcher/DispatchRuntime.xml +++ b/xml/System.ServiceModel.Dispatcher/DispatchRuntime.xml @@ -491,7 +491,7 @@ object to this property to control the manner in which input sessions are closed. When a call to the method on the first returns `null`, (which indicates that the input session has been closed), the dispatcher invokes each object, passing it an object. Custom objects can use this object to perform clean-up for each channel state or to send a response message before closing the channel. + Add an object to this property to control the manner in which input sessions are closed. When a call to the method on the first returns `null`, (which indicates that the input session has been closed), the dispatcher invokes each object, passing it an object. Custom objects can use this object to perform clean-up for each channel state or to send a response message before closing the channel. ]]> @@ -610,9 +610,9 @@ ## Remarks Implement the interface and assign the implementation to the property to control instances of the service type using a constructor other than the parameterless constructor, for example, to implement a custom instancing mode such as instance pooling. - Typically the method is invoked once, when the object is first created. The method is also invoked once, when the object is closed. + Typically the method is invoked once, when the object is first created. The method is also invoked once, when the object is closed. - A service can also be configured to release an instance before the object is closed. This can be configured by using the property or by calling the method. If this is done, the object calls the method. If a new message arrives after the instance has been released, a new instance is created using the method. + A service can also be configured to release an instance before the object is closed. This can be configured by using the property or by calling the method. If this is done, the object calls the method. If a new message arrives after the instance has been released, a new instance is created using the method. ]]> @@ -888,7 +888,7 @@ to specify that the method is called when the transaction successfully completes. + Use the to specify that the method is called when the transaction successfully completes. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/EndpointAddressMessageFilter.xml b/xml/System.ServiceModel.Dispatcher/EndpointAddressMessageFilter.xml index e116700ddc3..4f15873f3e5 100644 --- a/xml/System.ServiceModel.Dispatcher/EndpointAddressMessageFilter.xml +++ b/xml/System.ServiceModel.Dispatcher/EndpointAddressMessageFilter.xml @@ -17,13 +17,13 @@ Represents a query that tests whether a message satisfies the requirements of a specified endpoint address. - object includes a URI and an optional collection of addressing headers. The addressing and message headers are canonicalized in order to be compared for equality. If a parameter appears more than once in an , the corresponding header must appear in the message at least that many times. - - IIS and the underlying file system (NTFS or FAT) are case-insensitive. URI comparisons done by this class are also case-insensitive. So, for example, `http://www.microsoft.com` is evaluated as equal to `http://WWW.microsoft.com`. - + object includes a URI and an optional collection of addressing headers. The addressing and message headers are canonicalized in order to be compared for equality. If a parameter appears more than once in an , the corresponding header must appear in the message at least that many times. + + IIS and the underlying file system (NTFS or FAT) are case-insensitive. URI comparisons done by this class are also case-insensitive. So, for example, `http://www.microsoft.com` is evaluated as equal to `http://WWW.microsoft.com`. + ]]> @@ -90,19 +90,19 @@ if the host name is included in the endpoint address comparison; otherwise, . Initializes a new instance of the class. - @@ -162,13 +162,13 @@ If you have a web service installed on your local machine, there are many equiva Creates a new filter table that tests a message against multiple endpoint addresses simultaneously. An object that implements the interface that can contain s with associated . - that is optimized to test for specific message endpoints. - - This method is intended to be used by . Use constructors to create filter table instances. - + that is optimized to test for specific message endpoints. + + This method is intended to be used by . Use constructors to create filter table instances. + ]]> @@ -200,19 +200,19 @@ If you have a web service installed on your local machine, there are many equiva if the host name is included in the endpoint address comparison; otherwise, . - @@ -225,13 +225,13 @@ If you have a web service installed on your local machine, there are many equiva Tests whether a message or buffered message satisfies the criteria of the endpoint filter. - method is that the one that takes the parameter is permitted to examine the body of a message when testing for a match, while the one that takes the parameter is not. - - does not test the contents of the body of a message, so these two methods are equivalent. - + method is that the one that takes the parameter is permitted to examine the body of a message when testing for a match, while the one that takes the parameter is not. + + does not test the contents of the body of a message, so these two methods are equivalent. + ]]> @@ -261,11 +261,11 @@ If you have a web service installed on your local machine, there are many equiva if the object satisfies the endpoint address specified in the filter; otherwise, . - @@ -297,11 +297,11 @@ If you have a web service installed on your local machine, there are many equiva if the object satisfies the endpoint address; otherwise, . - diff --git a/xml/System.ServiceModel.Dispatcher/ExceptionHandler.xml b/xml/System.ServiceModel.Dispatcher/ExceptionHandler.xml index 0fde7be2e6f..0b4f19ca51b 100644 --- a/xml/System.ServiceModel.Dispatcher/ExceptionHandler.xml +++ b/xml/System.ServiceModel.Dispatcher/ExceptionHandler.xml @@ -21,11 +21,11 @@ ## Remarks -Extend the class and override the method to determine whether an exception should terminate the application. Then create a new instance of your custom class and assign it to the static or property prior to creating WCF clients or services. +Extend the class and override the method to determine whether an exception should terminate the application. Then create a new instance of your custom class and assign it to the static or property prior to creating WCF clients or services. ## Examples - The following code example shows an implementation of the abstract class that overrides the method. + The following code example shows an implementation of the abstract class that overrides the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ueexceptionhandler/cs/program.cs" id="Snippet0"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_ueexceptionhandler/vb/module1.vb" id="Snippet0"::: @@ -142,7 +142,7 @@ Extend the class and over ## Remarks By default, the property is `null`, and unhandled exceptions on asynchronous WCF threads terminate the application. Set this property to an object to receive and react to these exceptions. - If an unhandled exception occurs on an asynchronous WCF thread and reaches this handler, the state of the application domain may be compromised. should not return `true` for these exceptions. + If an unhandled exception occurs on an asynchronous WCF thread and reaches this handler, the state of the application domain may be compromised. should not return `true` for these exceptions. ]]> @@ -179,7 +179,7 @@ The abstract class that overrides the method. + The following code example shows an implementation of the abstract class that overrides the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ueexceptionhandler/cs/program.cs" id="Snippet0"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_ueexceptionhandler/vb/module1.vb" id="Snippet0"::: @@ -229,7 +229,7 @@ The property is set to the value of , causing unhandled exceptions within WCF transports to be ignored. Set this property to an instance of to receive and react to these exceptions. - If an unhandled exception occurs within a global WCF transport and reaches this handler, there is a possibility that the state of the application domain is compromised. can return `false` for these exceptions to cause the application to be terminated. + If an unhandled exception occurs within a global WCF transport and reaches this handler, there is a possibility that the state of the application domain is compromised. can return `false` for these exceptions to cause the application to be terminated. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/FaultContractInfo.xml b/xml/System.ServiceModel.Dispatcher/FaultContractInfo.xml index 0032a91ffb2..39b8a6cd1cf 100644 --- a/xml/System.ServiceModel.Dispatcher/FaultContractInfo.xml +++ b/xml/System.ServiceModel.Dispatcher/FaultContractInfo.xml @@ -42,11 +42,11 @@ Represents information about a SOAP fault that is specified in a attribute. - objects by accessing the and properties. The class exposes the action of the SOAP fault and the detail type that is serialized into the SOAP fault. - + objects by accessing the and properties. The class exposes the action of the SOAP fault and the detail type that is serialized into the SOAP fault. + ]]> @@ -90,11 +90,11 @@ The detail type that is serialized as the SOAP fault detail. Initializes a new instance of the class that uses the specified action and detail type. - diff --git a/xml/System.ServiceModel.Dispatcher/ICallContextInitializer.xml b/xml/System.ServiceModel.Dispatcher/ICallContextInitializer.xml index cd6ba25488d..6e093d791e3 100644 --- a/xml/System.ServiceModel.Dispatcher/ICallContextInitializer.xml +++ b/xml/System.ServiceModel.Dispatcher/ICallContextInitializer.xml @@ -86,7 +86,7 @@ method to initialize and clean up thread-local storage for the thread that invokes user code. Typical usage is to set some value, such as impersonation or changing the . If you wanted to establish some custom context, this is the extension point to initialize the static context property, which is then available for developers in the course of the operation. + Implement the method to initialize and clean up thread-local storage for the thread that invokes user code. Typical usage is to set some value, such as impersonation or changing the . If you wanted to establish some custom context, this is the extension point to initialize the static context property, which is then available for developers in the course of the operation. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/IChannelInitializer.xml b/xml/System.ServiceModel.Dispatcher/IChannelInitializer.xml index 6654c3e895a..558ba632620 100644 --- a/xml/System.ServiceModel.Dispatcher/IChannelInitializer.xml +++ b/xml/System.ServiceModel.Dispatcher/IChannelInitializer.xml @@ -40,11 +40,11 @@ Defines the interface to notify a service or client when a channel is created. - collection. Add client channel initializers to the collection. - + collection. Add client channel initializers to the collection. + ]]> diff --git a/xml/System.ServiceModel.Dispatcher/IClientMessageInspector.xml b/xml/System.ServiceModel.Dispatcher/IClientMessageInspector.xml index 1e048e69a7d..07020a794c1 100644 --- a/xml/System.ServiceModel.Dispatcher/IClientMessageInspector.xml +++ b/xml/System.ServiceModel.Dispatcher/IClientMessageInspector.xml @@ -44,28 +44,28 @@ Defines a message inspector object that can be added to the collection to view or modify messages. - interface and add it to the collection to inspect or modify messages as they pass through a WCF client object. For details, see . - - - -## Examples - The following code example shows an implementation that writes strings to the console when the implementation is called. - + interface and add it to the collection to inspect or modify messages as they pass through a WCF client object. For details, see . + + + +## Examples + The following code example shows an implementation that writes strings to the console when the implementation is called. + [!code-csharp[Interceptors#1](~/snippets/csharp/VS_Snippets_CFX/interceptors/cs/interceptors.cs#1)] - [!code-vb[Interceptors#1](~/snippets/visualbasic/VS_Snippets_CFX/interceptors/vb/interceptors.vb#1)] - - The following code example shows how to use an to insert the client message inspector in the client endpoint. - + [!code-vb[Interceptors#1](~/snippets/visualbasic/VS_Snippets_CFX/interceptors/vb/interceptors.vb#1)] + + The following code example shows how to use an to insert the client message inspector in the client endpoint. + [!code-csharp[Interceptors#2](~/snippets/csharp/VS_Snippets_CFX/interceptors/cs/insertingbehaviors.cs#2)] - [!code-vb[Interceptors#2](~/snippets/visualbasic/VS_Snippets_CFX/interceptors/vb/insertingbehaviors.vb#2)] - - Finally, the following code example shows how to modify the client configuration file to use the endpoint behavior with a particular endpoint. - - [!code-xml[Interceptors#3](~/snippets/csharp/VS_Snippets_CFX/interceptors/cs/client.exe.config#3)] - + [!code-vb[Interceptors#2](~/snippets/visualbasic/VS_Snippets_CFX/interceptors/vb/insertingbehaviors.vb#2)] + + Finally, the following code example shows how to modify the client configuration file to use the endpoint behavior with a particular endpoint. + + [!code-xml[Interceptors#3](~/snippets/csharp/VS_Snippets_CFX/interceptors/cs/client.exe.config#3)] + ]]> @@ -107,30 +107,30 @@ Correlation state data. Enables inspection or modification of a message after a reply message is received but prior to passing it back to the client application. - to inspect or modify a reply message after it has been received by the WCF client object but before it is deserialized into objects that are returned to the client application. - - The `correlationState` is the object returned by the user when is called for this message. The best practice is to make this a to ensure that no two `correlationState` objects are the same. - - - -## Examples - The following code example shows an implementation that writes strings to the console when the implementation is called. - + to inspect or modify a reply message after it has been received by the WCF client object but before it is deserialized into objects that are returned to the client application. + + The `correlationState` is the object returned by the user when is called for this message. The best practice is to make this a to ensure that no two `correlationState` objects are the same. + + + +## Examples + The following code example shows an implementation that writes strings to the console when the implementation is called. + [!code-csharp[Interceptors#1](~/snippets/csharp/VS_Snippets_CFX/interceptors/cs/interceptors.cs#1)] - [!code-vb[Interceptors#1](~/snippets/visualbasic/VS_Snippets_CFX/interceptors/vb/interceptors.vb#1)] - - The following code example shows how to use an to insert the client message inspector in the client endpoint. - + [!code-vb[Interceptors#1](~/snippets/visualbasic/VS_Snippets_CFX/interceptors/vb/interceptors.vb#1)] + + The following code example shows how to use an to insert the client message inspector in the client endpoint. + [!code-csharp[Interceptors#2](~/snippets/csharp/VS_Snippets_CFX/interceptors/cs/insertingbehaviors.cs#2)] - [!code-vb[Interceptors#2](~/snippets/visualbasic/VS_Snippets_CFX/interceptors/vb/insertingbehaviors.vb#2)] - - Finally, the following code example shows how to modify the client configuration file to use the endpoint behavior with a particular endpoint. - - [!code-xml[Interceptors#3](~/snippets/csharp/VS_Snippets_CFX/interceptors/cs/client.exe.config#3)] - + [!code-vb[Interceptors#2](~/snippets/visualbasic/VS_Snippets_CFX/interceptors/vb/insertingbehaviors.vb#2)] + + Finally, the following code example shows how to modify the client configuration file to use the endpoint behavior with a particular endpoint. + + [!code-xml[Interceptors#3](~/snippets/csharp/VS_Snippets_CFX/interceptors/cs/client.exe.config#3)] + ]]> @@ -171,32 +171,32 @@ The message to be sent to the service. The WCF client object channel. Enables inspection or modification of a message before a request message is sent to a service. - The object that is returned as the argument of the method. This is if no correlation state is used. - + The object that is returned as the argument of the method. This is if no correlation state is used. + The best practice is to make this a to ensure that no two objects are the same. - to inspect or modify a request message before it is sent. - - - -## Examples - The following code example shows an implementation that writes strings to the console when the implementation is called. - + to inspect or modify a request message before it is sent. + + + +## Examples + The following code example shows an implementation that writes strings to the console when the implementation is called. + [!code-csharp[Interceptors#1](~/snippets/csharp/VS_Snippets_CFX/interceptors/cs/interceptors.cs#1)] - [!code-vb[Interceptors#1](~/snippets/visualbasic/VS_Snippets_CFX/interceptors/vb/interceptors.vb#1)] - - The following code example shows how to use an to insert the client message inspector in the client endpoint. - + [!code-vb[Interceptors#1](~/snippets/visualbasic/VS_Snippets_CFX/interceptors/vb/interceptors.vb#1)] + + The following code example shows how to use an to insert the client message inspector in the client endpoint. + [!code-csharp[Interceptors#2](~/snippets/csharp/VS_Snippets_CFX/interceptors/cs/insertingbehaviors.cs#2)] - [!code-vb[Interceptors#2](~/snippets/visualbasic/VS_Snippets_CFX/interceptors/vb/insertingbehaviors.vb#2)] - - Finally, the following code example shows how to modify the client configuration file to use the endpoint behavior with a particular endpoint. - - [!code-xml[Interceptors#3](~/snippets/csharp/VS_Snippets_CFX/interceptors/cs/client.exe.config#3)] - + [!code-vb[Interceptors#2](~/snippets/visualbasic/VS_Snippets_CFX/interceptors/vb/insertingbehaviors.vb#2)] + + Finally, the following code example shows how to modify the client configuration file to use the endpoint behavior with a particular endpoint. + + [!code-xml[Interceptors#3](~/snippets/csharp/VS_Snippets_CFX/interceptors/cs/client.exe.config#3)] + ]]> diff --git a/xml/System.ServiceModel.Dispatcher/IClientOperationSelector.xml b/xml/System.ServiceModel.Dispatcher/IClientOperationSelector.xml index 24733ee50eb..116b9faf800 100644 --- a/xml/System.ServiceModel.Dispatcher/IClientOperationSelector.xml +++ b/xml/System.ServiceModel.Dispatcher/IClientOperationSelector.xml @@ -89,7 +89,7 @@ is `null`. + The value returned is `false` unless the user has overloaded methods. If false is returned then the array of objects passed to is `null`. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/IDispatchMessageInspector.xml b/xml/System.ServiceModel.Dispatcher/IDispatchMessageInspector.xml index 1434930e4b7..156e9855128 100644 --- a/xml/System.ServiceModel.Dispatcher/IDispatchMessageInspector.xml +++ b/xml/System.ServiceModel.Dispatcher/IDispatchMessageInspector.xml @@ -43,9 +43,9 @@ Typically, message inspectors are inserted by a service behavior (), an endpoint behavior (), or a contract behavior (). The behavior then adds the message inspector to the collection. For more information about extending the runtime using behaviors, see [Extending ServiceHost and the Service Model Layer](/dotnet/framework/wcf/extending/extending-servicehost-and-the-service-model-layer). -- The method enables custom behavior after receiving the message but before dispatching it to the intended operation. +- The method enables custom behavior after receiving the message but before dispatching it to the intended operation. -- The method enables custom behavior after the operation returns but before the reply is sent. +- The method enables custom behavior after the operation returns but before the reply is sent. > [!NOTE] > objects are always called at the same point during message dispatch regardless of whether an operation is one-way or request-reply. @@ -110,7 +110,7 @@ method to inspect or modify the incoming message, the client channel that provided it, and the current service instance. The return value can be any object that you want to use for correlation purposes; it is returned to you as the `correlationState` parameter in the method. + Use the method to inspect or modify the incoming message, the client channel that provided it, and the current service instance. The return value can be any object that you want to use for correlation purposes; it is returned to you as the `correlationState` parameter in the method. > [!IMPORTANT] > You cannot use the body of the message unless you buffer the entire message and make a copy. If you do this, you must make two copies of the message: one to inspect, and the other to overwrite the `request` parameter. @@ -172,7 +172,7 @@ method to perform custom behavior prior to sending the return message. The `correlationState` is the object returned from the method that you can use to perform correlation between inbound and outbound calls to support your behavior. + Use the method to perform custom behavior prior to sending the return message. The `correlationState` is the object returned from the method that you can use to perform correlation between inbound and outbound calls to support your behavior. diff --git a/xml/System.ServiceModel.Dispatcher/IErrorHandler.xml b/xml/System.ServiceModel.Dispatcher/IErrorHandler.xml index d03d4feda4a..f44d6a21923 100644 --- a/xml/System.ServiceModel.Dispatcher/IErrorHandler.xml +++ b/xml/System.ServiceModel.Dispatcher/IErrorHandler.xml @@ -32,19 +32,19 @@ ## Remarks To explicitly control the behavior of the application when an exception is thrown, implement the interface and add it to the 's property. enables you to explicitly control the SOAP fault generated, decide whether to send it back to the client, and perform associated tasks, such as logging. Error handlers are called in the order in which they were added to the property. - Implement the method to control the fault message that is returned to the client. + Implement the method to control the fault message that is returned to the client. - Implement the method to ensure error-related behaviors, including error logging, assuring a fail fast, shutting down the application, and so on. + Implement the method to ensure error-related behaviors, including error logging, assuring a fail fast, shutting down the application, and so on. > [!NOTE] -> Because the method can be called from many different places there are no guarantees made about which thread the method is called on. Do not depend on method being called on the operation thread. +> Because the method can be called from many different places there are no guarantees made about which thread the method is called on. Do not depend on method being called on the operation thread. - All implementations are called first, prior to sending a response message. When all implementations have been called and return, and if `fault` is non-`null`, it is sent back to the client according to the operation contract. If `fault` is `null` after all implementations have been called, the response message is controlled by the property value. + All implementations are called first, prior to sending a response message. When all implementations have been called and return, and if `fault` is non-`null`, it is sent back to the client according to the operation contract. If `fault` is `null` after all implementations have been called, the response message is controlled by the property value. > [!NOTE] -> Exceptions can occur after all implementations are called and a response message is handed to the channel. If a channel exception occurs (for example, difficulty serializing the message) objects are notified. In this case, you should still make sure that your development environment catches and displays such exceptions to you or makes use of tracing to discover the problem. For more information about tracing, see [Using Tracing to Troubleshoot Your Application](/dotnet/framework/wcf/diagnostics/tracing/using-tracing-to-troubleshoot-your-application). +> Exceptions can occur after all implementations are called and a response message is handed to the channel. If a channel exception occurs (for example, difficulty serializing the message) objects are notified. In this case, you should still make sure that your development environment catches and displays such exceptions to you or makes use of tracing to discover the problem. For more information about tracing, see [Using Tracing to Troubleshoot Your Application](/dotnet/framework/wcf/diagnostics/tracing/using-tracing-to-troubleshoot-your-application). - After the response message has been sent, all implementations are called in the same order. + After the response message has been sent, all implementations are called in the same order. Typically, an implementation is added to the property on the service (and the client in the case of duplex communication). @@ -55,7 +55,7 @@ ## Examples - The following code example demonstrates a service that implements that returns only of type `GreetingFault` when a service method throws a managed exception. + The following code example demonstrates a service that implements that returns only of type `GreetingFault` when a service method throws a managed exception. [!code-csharp[IErrorHandler#6](~/snippets/csharp/VS_Snippets_CFX/ierrorhandler/cs/ierrorhandler.cs#6)] [!code-vb[IErrorHandler#6](~/snippets/visualbasic/VS_Snippets_CFX/ierrorhandler/vb/ierrorhandler.vb#6)] @@ -109,23 +109,23 @@ method to implement error-related behaviors such as error logging, system notifications, shutting down the application, and so on, and return a value that specifies whether the exception has been handled appropriately. + Use the method to implement error-related behaviors such as error logging, system notifications, shutting down the application, and so on, and return a value that specifies whether the exception has been handled appropriately. > [!NOTE] -> Because the method can be called from many different places there are no guarantees made about which thread the method is called on. Do not depend on method being called on the operation thread. +> Because the method can be called from many different places there are no guarantees made about which thread the method is called on. Do not depend on method being called on the operation thread. All implementations are called. By default (when the return value is `false`), if there is an exception, the dispatcher aborts any session and aborts the if the is anything other than . The exception is then considered unhandled and any state is considered corrupt. - Return `true` from to prevent this default behavior. If any error handler returns `true` it instructs WCF that it is safe to continue using state associated with the failed request. + Return `true` from to prevent this default behavior. If any error handler returns `true` it instructs WCF that it is safe to continue using state associated with the failed request. - If no error handler returns `true` from the method the exception is considered unhandled and the default response applies, potentially resulting in an aborted and channel when communicating on a session channel or the property is not set to . + If no error handler returns `true` from the method the exception is considered unhandled and the default response applies, potentially resulting in an aborted and channel when communicating on a session channel or the property is not set to . The `error` parameter is never `null` and contains the exception object that was thrown. ## Examples - The following code example demonstrates a service that implements that returns only of type `GreetingFault` when a service method throws a managed exception. + The following code example demonstrates a service that implements that returns only of type `GreetingFault` when a service method throws a managed exception. [!code-csharp[IErrorHandler#6](~/snippets/csharp/VS_Snippets_CFX/ierrorhandler/cs/ierrorhandler.cs#6)] [!code-vb[IErrorHandler#6](~/snippets/visualbasic/VS_Snippets_CFX/ierrorhandler/vb/ierrorhandler.vb#6)] @@ -181,18 +181,18 @@ method to create a custom fault message that is returned to the client. The method will always be called for exceptions that leave operations, except when the WCF runtime recognizes the exception as especially fatal and rethrows the exception itself. When all implementations have been called, the fault message is sent back to the client (if `fault` is non-`null`). If the `fault` parameter is `null` the default fault is sent to the client. + Implement the method to create a custom fault message that is returned to the client. The method will always be called for exceptions that leave operations, except when the WCF runtime recognizes the exception as especially fatal and rethrows the exception itself. When all implementations have been called, the fault message is sent back to the client (if `fault` is non-`null`). If the `fault` parameter is `null` the default fault is sent to the client. > [!NOTE] > The inbound message that caused the processing error is available during this method from the property. > [!NOTE] -> Because the method can be called from many different places there are no guarantees made about which thread the method is called on. Do not depend on method being called on the operation thread. +> Because the method can be called from many different places there are no guarantees made about which thread the method is called on. Do not depend on method being called on the operation thread. ## Examples - The following code example demonstrates a service that implements that returns only of type `GreetingFault` when a service method throws a managed exception. + The following code example demonstrates a service that implements that returns only of type `GreetingFault` when a service method throws a managed exception. [!code-csharp[IErrorHandler#6](~/snippets/csharp/VS_Snippets_CFX/ierrorhandler/cs/ierrorhandler.cs#6)] [!code-vb[IErrorHandler#6](~/snippets/visualbasic/VS_Snippets_CFX/ierrorhandler/vb/ierrorhandler.vb#6)] diff --git a/xml/System.ServiceModel.Dispatcher/IInputSessionShutdown.xml b/xml/System.ServiceModel.Dispatcher/IInputSessionShutdown.xml index 4ca4f8bbf83..db9fc4b07d6 100644 --- a/xml/System.ServiceModel.Dispatcher/IInputSessionShutdown.xml +++ b/xml/System.ServiceModel.Dispatcher/IInputSessionShutdown.xml @@ -14,11 +14,11 @@ Defines the contract that must be implemented to shut down an input session. - interface inside a duplex session to send outbound messages prior to closing the session. For example, if a client closes a session the service can implement to be notified prior to the shutdown, enabling the service to send one notification message prior to returning. The client receives the notification prior to the acknowledgment that the client can close the channel. - + interface inside a duplex session to send outbound messages prior to closing the session. For example, if a client closes a session the service can implement to be notified prior to the shutdown, enabling the service to send one notification message prior to returning. The client receives the notification prior to the acknowledgment that the client can close the channel. + ]]> @@ -46,11 +46,11 @@ The that has faulted. Indicates that the channel has faulted. - method to perform some custom behavior when a channel has faulted. Typically, the channel is aborted. - + method to perform some custom behavior when a channel has faulted. Typically, the channel is aborted. + ]]> diff --git a/xml/System.ServiceModel.Dispatcher/IInstanceContextInitializer.xml b/xml/System.ServiceModel.Dispatcher/IInstanceContextInitializer.xml index cec0951c42f..7181905e61c 100644 --- a/xml/System.ServiceModel.Dispatcher/IInstanceContextInitializer.xml +++ b/xml/System.ServiceModel.Dispatcher/IInstanceContextInitializer.xml @@ -55,7 +55,7 @@ method is called when an object is created. Typically this method is used to attach an extension so that custom data can be accessed throughout an application. + The method is called when an object is created. Typically this method is used to attach an extension so that custom data can be accessed throughout an application. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/IInstanceContextProvider.xml b/xml/System.ServiceModel.Dispatcher/IInstanceContextProvider.xml index ebf549f1e7b..7a331264f19 100644 --- a/xml/System.ServiceModel.Dispatcher/IInstanceContextProvider.xml +++ b/xml/System.ServiceModel.Dispatcher/IInstanceContextProvider.xml @@ -77,9 +77,9 @@ method is called when a message is received. Return the object that you want to process the message, or `null`. In the case of `null`, WCF creates a new object for the message and then calls the method. + The method is called when a message is received. Return the object that you want to process the message, or `null`. In the case of `null`, WCF creates a new object for the message and then calls the method. - If you return `null`, the new object goes through the throttling system and increments the count of . + If you return `null`, the new object goes through the throttling system and increments the count of . ]]> @@ -115,7 +115,7 @@ is called when returns `null` and a new object is created. This method is called to notify you that a new has been created. + is called when returns `null` and a new object is created. This method is called to notify you that a new has been created. ]]> @@ -149,7 +149,7 @@ is called when WCF is about to close and recycle an idle object so that you can inform the runtime whether to continue doing so. + is called when WCF is about to close and recycle an idle object so that you can inform the runtime whether to continue doing so. For an example that demonstrates the sharing of instance contexts, see [InstanceContextSharing](https://msdn.microsoft.com/library/4a6a46d7-b7d7-4bb5-a0dd-03ffa3cbc230). @@ -185,7 +185,7 @@ method is called when the method returns `false` to enable you to provide WCF with a object that you use to inform the runtime that the has finished its work. When the object notifies the runtime that the has finished its work, WCF calls once again. This cycle continues until returns `true` and the context is closed and recycled. + The method is called when the method returns `false` to enable you to provide WCF with a object that you use to inform the runtime that the has finished its work. When the object notifies the runtime that the has finished its work, WCF calls once again. This cycle continues until returns `true` and the context is closed and recycled. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/IInstanceProvider.xml b/xml/System.ServiceModel.Dispatcher/IInstanceProvider.xml index 1d529eba4d6..248856ad0a9 100644 --- a/xml/System.ServiceModel.Dispatcher/IInstanceProvider.xml +++ b/xml/System.ServiceModel.Dispatcher/IInstanceProvider.xml @@ -33,14 +33,14 @@ If the insertion mechanism is an endpoint behavior you can also implement a object that can insert your custom behavior using a configuration file. If the insertion mechanism is a contract behavior, you can insert the behavior programmatically prior to the opening of the service host or you can implement a custom attribute. (For an example of the contract behavior approach, see the Example section.) - has two methods, and . These methods are typically implemented to create service objects using a non-parameterless constructor or to initialize or dispose of some state related to the lifetime of the object. Service object pooling is one example of custom functionality. + has two methods, and . These methods are typically implemented to create service objects using a non-parameterless constructor or to initialize or dispose of some state related to the lifetime of the object. Service object pooling is one example of custom functionality. - Typically, the invokes the when the is first created and invokes the method when the is closed. + Typically, the invokes the when the is first created and invokes the method when the is closed. - There are two ways to cause an object to release a service object before the is closed. The first method is to set the to or . The second method is to call the method. If this is done, the calls the method on the dispatcher's instance provider. If a new message arrives after the instance has been released, WCF creates a new instance using the method. + There are two ways to cause an object to release a service object before the is closed. The first method is to set the to or . The second method is to call the method. If this is done, the calls the method on the dispatcher's instance provider. If a new message arrives after the instance has been released, WCF creates a new instance using the method. > [!NOTE] -> If the of the service is , the system does not call the or methods even when the user did not provide a well-known service object unless the user directly calls and then calls . +> If the of the service is , the system does not call the or methods even when the user did not provide a well-known service object unless the user directly calls and then calls . @@ -103,7 +103,7 @@ method to control the exact service object that a WCF service receives when it attempts to create a new one. + Use the method to control the exact service object that a WCF service receives when it attempts to create a new one. @@ -159,7 +159,7 @@ method to control the exact service object that a WCF service receives when it attempts to create a new one. + Use the method to control the exact service object that a WCF service receives when it attempts to create a new one. @@ -214,7 +214,7 @@ method to perform some custom resource disposal or other recycling customization when a service recycles a service object. + Use the method to perform some custom resource disposal or other recycling customization when a service recycles a service object. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/IInteractiveChannelInitializer.xml b/xml/System.ServiceModel.Dispatcher/IInteractiveChannelInitializer.xml index ae833afedf4..97f643235fd 100644 --- a/xml/System.ServiceModel.Dispatcher/IInteractiveChannelInitializer.xml +++ b/xml/System.ServiceModel.Dispatcher/IInteractiveChannelInitializer.xml @@ -45,29 +45,29 @@ ## Remarks Implement the interface to enable a client application to display a user interface that enables the user of the application to create or select the credentials prior to opening a channel. - To implement , perform the following steps in : + To implement , perform the following steps in : 1. Prompt the user and obtain an appropriate . -2. Add a custom channel parameter object to the collection returned by the method on the object with a type parameter of . This channel parameter object is used by the custom to establish the security tokens for the channel. +2. Add a custom channel parameter object to the collection returned by the method on the object with a type parameter of . This channel parameter object is used by the custom to establish the security tokens for the channel. 3. Return. To insert : -1. Override the method on the class. +1. Override the method on the class. -2. In that method, determine whether the endpoint requires an and if so, add the to the collection. +2. In that method, determine whether the endpoint requires an and if so, add the to the collection. - There are two ways application developers can make use of an inserted . The client application can call either or (or an asynchronous version) prior to opening the channel (the *explicit* approach) or simply call the first operation (the *implicit* approach). + There are two ways application developers can make use of an inserted . The client application can call either or (or an asynchronous version) prior to opening the channel (the *explicit* approach) or simply call the first operation (the *implicit* approach). - If using the implicit approach, the application must call the first operation on an or extension. If it calls anything other than the first operation, an exception is thrown. + If using the implicit approach, the application must call the first operation on an or extension. If it calls anything other than the first operation, an exception is thrown. If using the explicit approach, the application must perform the following steps in order: -1. Call either or (or an asynchronous version). +1. Call either or (or an asynchronous version). -2. When the initializers have returned, call either the method on the object or on the object returned from the property. +2. When the initializers have returned, call either the method on the object or on the object returned from the property. 3. Call operations. @@ -119,11 +119,11 @@ , perform the following steps in : + To implement , perform the following steps in : 1. Prompt the user in what way you see fit and obtain an appropriate . -2. Add a custom channel parameter object to the collection returned by the method on the object with a type parameter of . This channel parameter object is used by the custom to establish the security tokens for the channel. +2. Add a custom channel parameter object to the collection returned by the method on the object with a type parameter of . This channel parameter object is used by the custom to establish the security tokens for the channel. 3. Return. diff --git a/xml/System.ServiceModel.Dispatcher/IMessageFilterTable`1.xml b/xml/System.ServiceModel.Dispatcher/IMessageFilterTable`1.xml index b34ac670afe..210a102087f 100644 --- a/xml/System.ServiceModel.Dispatcher/IMessageFilterTable`1.xml +++ b/xml/System.ServiceModel.Dispatcher/IMessageFilterTable`1.xml @@ -50,40 +50,40 @@ The type of data associated with each filter in the table. An that defines the contract that a filter table must implement to inspect messages with query criteria derived from one or more filters. - , and the value is the associated filter data. Filter data can be any data of the type specified in the generic parameter and can be used to specify what actions to take if a message is matched by a filter in the table. - - Filter table entries can be accessed using the functionality that inherits. - - Note that a filter instance can only be added to a given once. To add multiple instances of this filter to the same filter table, use a filter constructor to create additional instances. - - A filter matches a message when the message satisfies the query criteria of the filter. There are four overloaded matching methods. The data returned is either the filter data or the objects themselves. This data is returned whether multiple matches are allowed or only a single match. The following table shows this information for each overload. - -|Method Name|Matches|Data Returned| -|-----------------|-------------|-------------------| -||Single|`FilterData`| -||Single|| -||Multiple|`FilterData`| -||Multiple| objects| - - Each method contains two overloads. The difference between the two overloads is that one takes a parameter and is not permitted to examine the contents of the body; the other takes a parameter and can examine any part of the message. If you call a method with the message parameter, and the filter table contains a filter that examines the content of the message body, an exception is thrown. If you are unsure about the filters in a table, call the overload that takes a message buffer. - - Message headers are automatically buffered and can be inspected by a filter without being consumed. But if the body is to be inspected by a filter, then the entire message must be buffered because an unbuffered message body is consumed by a query and its contents destroyed. - - The following classes implement : - -- - -- - + , and the value is the associated filter data. Filter data can be any data of the type specified in the generic parameter and can be used to specify what actions to take if a message is matched by a filter in the table. + + Filter table entries can be accessed using the functionality that inherits. + + Note that a filter instance can only be added to a given once. To add multiple instances of this filter to the same filter table, use a filter constructor to create additional instances. + + A filter matches a message when the message satisfies the query criteria of the filter. There are four overloaded matching methods. The data returned is either the filter data or the objects themselves. This data is returned whether multiple matches are allowed or only a single match. The following table shows this information for each overload. + +|Method Name|Matches|Data Returned| +|-----------------|-------------|-------------------| +||Single|`FilterData`| +||Single|| +||Multiple|`FilterData`| +||Multiple| objects| + + Each method contains two overloads. The difference between the two overloads is that one takes a parameter and is not permitted to examine the contents of the body; the other takes a parameter and can examine any part of the message. If you call a method with the message parameter, and the filter table contains a filter that examines the content of the message body, an exception is thrown. If you are unsure about the filters in a table, call the overload that takes a message buffer. + + Message headers are automatically buffered and can be inspected by a filter without being consumed. But if the body is to be inspected by a filter, then the entire message must be buffered because an unbuffered message body is consumed by a query and its contents destroyed. + + The following classes implement : + +- + +- + ]]> - Filter tables are thread-safe with respect to matching operations, but are not thread-safe with respect to modification. Threads that access a filter table should be synchronized by the or similar locking semantic. This lock allows multiple reads of a filter table (for example, a match operation) to run simultaneously, but in order to write to a filter table (for example, adding a filter), a thread must wait for an exclusive lock. - + Filter tables are thread-safe with respect to matching operations, but are not thread-safe with respect to modification. Threads that access a filter table should be synchronized by the or similar locking semantic. This lock allows multiple reads of a filter table (for example, a match operation) to run simultaneously, but in order to write to a filter table (for example, adding a filter), a thread must wait for an exclusive lock. + All compilation is done when filters are added to the table. If you create a filter table in advance, and never edit it, locking is not necessary during a match. @@ -95,13 +95,13 @@ Returns a filter from the table whose query criteria are satisfied by a specified message or buffered message. - if the body content does not require examination. Use if the contents of the message body may require examination. - + if the body content does not require examination. Use if the contents of the message body may require examination. + ]]> @@ -145,18 +145,18 @@ if the match criterion of at least one filter in the table is satisfied by ; if no filter is satisfied. - version of the method. - + version of the method. + ]]> - If more than one filter matches the message, a must be thrown. - + If more than one filter matches the message, a must be thrown. + This version takes a and must throw an if it tries to examine the message body. @@ -197,11 +197,11 @@ if the match criterion of at least one filter in the table is satisfied by ; if no filter is satisfied. - @@ -214,15 +214,15 @@ Adds the filters whose query criteria are satisfied by a specified message or buffered message to a collection. - method. Otherwise, use . - - The matching objects are stored in the `results` parameter. The filter data can then be recovered from the filter table using these filters as keys with the methods provided by . - + method. Otherwise, use . + + The matching objects are stored in the `results` parameter. The filter data can then be recovered from the filter table using these filters as keys with the methods provided by . + ]]> @@ -262,11 +262,11 @@ if the match criterion of at least one filter in the table is satisfied by ; if no filter is satisfied. - @@ -309,11 +309,11 @@ if the match criterion of at least one filter in the table is satisfied by ; if no filter is satisfied. - @@ -326,15 +326,15 @@ Returns a value that indicates whether the match criterion of a filter in the table is satisfied by the specified message or buffered message, and returns the filter data for the filter that matched. - if the body of the message is not inspected by any of the filters in the filter table. - - If the body of the message may be inspected by a filter in the filter table, buffer the message and pass it to the version of the method. - + if the body of the message is not inspected by any of the filters in the filter table. + + If the body of the message may be inspected by a filter in the filter table, buffer the message and pass it to the version of the method. + ]]> @@ -378,20 +378,20 @@ if the match criterion of exactly one filter in the table is satisfied by the message; if no filter is satisfied. - must be thrown. - - If the body of the message must be inspected by a filter in the filter table, buffer the message using and pass it to the version of the method. - + must be thrown. + + If the body of the message must be inspected by a filter in the filter table, buffer the message using and pass it to the version of the method. + ]]> - If more than one filter matches the message, a must be thrown. - + If more than one filter matches the message, a must be thrown. + This overload takes a and must throw an if it tries to examine the message body. @@ -432,11 +432,11 @@ if the match criterion of exactly one filter in the table is satisfied by the message; if no filter is satisfied. - @@ -452,15 +452,15 @@ Adds the filter data of the filters that match the specified message or buffered message to a collection. - if the contents of the message body do not require examination. Use if the contents of the message body requires examination. - + if the contents of the message body do not require examination. Use if the contents of the message body requires examination. + ]]> @@ -500,15 +500,15 @@ if the match criterion of at least one filter in the table is satisfied by ; if no filter is satisfied. - objects is stored in the `results` parameter. - - If the body of the message is inspected by a filter in the filter table, buffer the message and pass it to the version of the method. - + objects is stored in the `results` parameter. + + If the body of the message is inspected by a filter in the filter table, buffer the message and pass it to the version of the method. + ]]> @@ -548,13 +548,13 @@ if the match criterion of at least one filter in the table is satisfied by ; if no filter is satisfied. - objects is stored in the `results` parameter. - + objects is stored in the `results` parameter. + ]]> diff --git a/xml/System.ServiceModel.Dispatcher/IOperationInvoker.xml b/xml/System.ServiceModel.Dispatcher/IOperationInvoker.xml index 7c0eb3e334a..7673d787df8 100644 --- a/xml/System.ServiceModel.Dispatcher/IOperationInvoker.xml +++ b/xml/System.ServiceModel.Dispatcher/IOperationInvoker.xml @@ -27,7 +27,7 @@ interface to control the conversion from an untyped object and array of parameters to a strongly-typed method call on that object. It has a synchronous method, which takes an instance and set of inputs of type object and returns an object and a set of outputs of type object. It also has a and variant. The property specifies whether the synchronous or asynchronous method should be used. + Implement the interface to control the conversion from an untyped object and array of parameters to a strongly-typed method call on that object. It has a synchronous method, which takes an instance and set of inputs of type object and returns an object and a set of outputs of type object. It also has a and variant. The property specifies whether the synchronous or asynchronous method should be used. ]]> @@ -65,7 +65,7 @@ is called. + Implement this to return an array of parameters for the operation. This array is filled by the formatter and passed back to the invoker when is called. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/IParameterInspector.xml b/xml/System.ServiceModel.Dispatcher/IParameterInspector.xml index 31ed4d2a178..3d81f504c79 100644 --- a/xml/System.ServiceModel.Dispatcher/IParameterInspector.xml +++ b/xml/System.ServiceModel.Dispatcher/IParameterInspector.xml @@ -53,7 +53,7 @@ On inbound calls to a service, the inspector is invoked after parameters are deserialized but before they are dispatched to the service operation. - Use the or the properties to add an implementation to the inspectors collection for a particular operation. + Use the or the properties to add an implementation to the inspectors collection for a particular operation. **Note** Developers and administrators must ensure that the interaction with other implementations is understood. diff --git a/xml/System.ServiceModel.Dispatcher/InstanceContextIdleCallback.xml b/xml/System.ServiceModel.Dispatcher/InstanceContextIdleCallback.xml index 8809af7226f..4199f8f90b3 100644 --- a/xml/System.ServiceModel.Dispatcher/InstanceContextIdleCallback.xml +++ b/xml/System.ServiceModel.Dispatcher/InstanceContextIdleCallback.xml @@ -23,13 +23,13 @@ The instance context that has finished processing. Represents the method that is called when an object has finished processing. - to notify the Windows Communication Foundation (WCF) runtime that an object has finished processing. When the object notifies the runtime that the has finished its work, WCF calls once again. This cycle continues until returns `true` and the context is closed and recycled. - - For more information, see . - + to notify the Windows Communication Foundation (WCF) runtime that an object has finished processing. When the object notifies the runtime that the has finished its work, WCF calls once again. This cycle continues until returns `true` and the context is closed and recycled. + + For more information, see . + ]]> diff --git a/xml/System.ServiceModel.Dispatcher/JsonQueryStringConverter.xml b/xml/System.ServiceModel.Dispatcher/JsonQueryStringConverter.xml index 55a1a06e3a1..2063948cf9d 100644 --- a/xml/System.ServiceModel.Dispatcher/JsonQueryStringConverter.xml +++ b/xml/System.ServiceModel.Dispatcher/JsonQueryStringConverter.xml @@ -67,7 +67,7 @@ - - Unlike its base type, this converter can handle any type adhering to the Data Contract model. The converter overrides so that each parameter is serialized to JSON using the default and a JSON XML Writer configured to use the UTF-8 encoding. `null` parameters are returned as `null`. + Unlike its base type, this converter can handle any type adhering to the Data Contract model. The converter overrides so that each parameter is serialized to JSON using the default and a JSON XML Writer configured to use the UTF-8 encoding. `null` parameters are returned as `null`. ]]> @@ -183,7 +183,7 @@ so that each parameter is serialized to JSON using the default and a JSON XML Writer configured to use the UTF-8 encoding. Unlike its base type, this converter can handle any type adhering to the Data Contract model. + The converter overrides so that each parameter is serialized to JSON using the default and a JSON XML Writer configured to use the UTF-8 encoding. Unlike its base type, this converter can handle any type adhering to the Data Contract model. diff --git a/xml/System.ServiceModel.Dispatcher/MatchAllMessageFilter.xml b/xml/System.ServiceModel.Dispatcher/MatchAllMessageFilter.xml index cc56187306b..9efb95f28e7 100644 --- a/xml/System.ServiceModel.Dispatcher/MatchAllMessageFilter.xml +++ b/xml/System.ServiceModel.Dispatcher/MatchAllMessageFilter.xml @@ -23,11 +23,11 @@ Represents a query that is satisfied by every non- message that it tests. - methods returns `true` for every message that is not `null`. - + methods returns `true` for every message that is not `null`. + ]]> @@ -54,11 +54,11 @@ Initializes a new instance of the class. - . - + . + ]]> @@ -96,11 +96,11 @@ This method returns for every message that is not . Returns . - method is that one takes the parameter and buffers the entire contents of a message (including its body) into memory, while the other takes the parameter and does not buffer the body. - + method is that one takes the parameter and buffers the entire contents of a message (including its body) into memory, while the other takes the parameter and does not buffer the body. + ]]> @@ -131,11 +131,11 @@ The method returns for every message that is not . Returns . - parameter, which buffers the entire contents of a message (including its body) into memory, and allows the body to be inspected. - + parameter, which buffers the entire contents of a message (including its body) into memory, and allows the body to be inspected. + ]]> diff --git a/xml/System.ServiceModel.Dispatcher/MatchNoneMessageFilter.xml b/xml/System.ServiceModel.Dispatcher/MatchNoneMessageFilter.xml index 63400ddcac9..c8673b2905e 100644 --- a/xml/System.ServiceModel.Dispatcher/MatchNoneMessageFilter.xml +++ b/xml/System.ServiceModel.Dispatcher/MatchNoneMessageFilter.xml @@ -23,11 +23,11 @@ Represents a query that is never satisfied by a message that it tests. - methods returns `false` for every message that is not `null`. - + methods returns `false` for every message that is not `null`. + ]]> @@ -54,11 +54,11 @@ Initializes a new instance of the class. - . - + . + ]]> @@ -71,11 +71,11 @@ These methods returns for every message that is not . - method is that one takes the parameter and buffers the entire contents of a message (including its body) into memory, while the other takes the parameter and does not buffer the body. - + method is that one takes the parameter and buffers the entire contents of a message (including its body) into memory, while the other takes the parameter and does not buffer the body. + ]]> @@ -104,11 +104,11 @@ This method returns for every message that is not . Returns . - method is that one takes the parameter and buffers the entire contents of a message (including its body) into memory, while the other takes the parameter and does not buffer the body. - + method is that one takes the parameter and buffers the entire contents of a message (including its body) into memory, while the other takes the parameter and does not buffer the body. + ]]> @@ -139,11 +139,11 @@ This method returns for every message that is not . Returns . - parameter, which buffers the entire contents of a message (including its body) into memory, and allows the body to be inspected. - + parameter, which buffers the entire contents of a message (including its body) into memory, and allows the body to be inspected. + ]]> diff --git a/xml/System.ServiceModel.Dispatcher/MessageFilter.xml b/xml/System.ServiceModel.Dispatcher/MessageFilter.xml index e1a0fa4abc7..cfa0b4fe9e7 100644 --- a/xml/System.ServiceModel.Dispatcher/MessageFilter.xml +++ b/xml/System.ServiceModel.Dispatcher/MessageFilter.xml @@ -50,29 +50,29 @@ base class for different classes of filters used to query messages. - is an `abstract` class that developers implement in order to specify the criteria to use for inspecting messages. Typically, filters are used by an endpoint application to determine what to do with a message based on an examination of some part of the message. A queuing process, for example, can use an XPath 1.0 query to check the priority element of a known header to determine whether to move a message to the front of the queue. - - Filters are stored in a filter table that implements . Each filter in the table is associated with specified filter data that can be used to indicate what actions to take if a message matches the filter. The methods are used to determine if a message satisfies a filter. - - The criteria used by a filter cannot be changed once the filter is constructed because the filter tables have no way to detect a change. The only way to modify the criteria of a filter is to construct a new one and delete the existing filter. - - The following classes implement the `abstract` class: - -- uses an XPath 1.0 expression to specify the criteria for a match. - -- matches all messages. - -- matches none of the messages. - -- tests whether the action of a message is one of a specified set of actions. - -- tests whether a message satisfies a specified endpoint address. - - is an `abstract` base class that you can use for writing non-queuing listeners. - + is an `abstract` class that developers implement in order to specify the criteria to use for inspecting messages. Typically, filters are used by an endpoint application to determine what to do with a message based on an examination of some part of the message. A queuing process, for example, can use an XPath 1.0 query to check the priority element of a known header to determine whether to move a message to the front of the queue. + + Filters are stored in a filter table that implements . Each filter in the table is associated with specified filter data that can be used to indicate what actions to take if a message matches the filter. The methods are used to determine if a message satisfies a filter. + + The criteria used by a filter cannot be changed once the filter is constructed because the filter tables have no way to detect a change. The only way to modify the criteria of a filter is to construct a new one and delete the existing filter. + + The following classes implement the `abstract` class: + +- uses an XPath 1.0 expression to specify the criteria for a match. + +- matches all messages. + +- matches none of the messages. + +- tests whether the action of a message is one of a specified set of actions. + +- tests whether a message satisfies a specified endpoint address. + + is an `abstract` base class that you can use for writing non-queuing listeners. + ]]> @@ -107,11 +107,11 @@ When called in a derived class, initializes a new instance of the class. - can be instantiated. - + can be instantiated. + ]]> @@ -149,11 +149,11 @@ Creates a filter table for a filter that has a specified type of data associated with it. An object to which filters associated with can be added. - . Users should create a filter table by calling a constructor for the filter table. The default implementation of this method returns a filter table that calls the method of each filter sequentially. Override this method to associate a custom filter table when implementing a filter. - + . Users should create a filter table by calling a constructor for the filter table. The default implementation of this method returns a filter table that calls the method of each filter sequentially. Override this method to associate a custom filter table when implementing a filter. + ]]> @@ -166,13 +166,13 @@ When overridden in a derived class, tests whether a message or a buffered message satisfies the criteria of a filter. - parameter and is not permitted to examine the body. The other takes a parameter and can examine any part of the message. Message headers are automatically buffered and can be inspected by a filter without being consumed. But if the body is to be inspected by a filter, then the entire message must be buffered because an unbuffered message body can be consumed by a query and its contents destroyed. - - Use if examination of the body is not required. Use if examination of the message body is required. - + parameter and is not permitted to examine the body. The other takes a parameter and can examine any part of the message. Message headers are automatically buffered and can be inspected by a filter without being consumed. But if the body is to be inspected by a filter, then the entire message must be buffered because an unbuffered message body can be consumed by a query and its contents destroyed. + + Use if examination of the body is not required. Use if examination of the message body is required. + ]]> @@ -214,11 +214,11 @@ if the object satisfies the filter criteria; otherwise, . - @@ -259,11 +259,11 @@ if the object satisfies the filter criteria; otherwise, . - is fully buffered and therefore can be inspected by a filter. The body of a that has not been fully buffered may be consumed by the filter inspection. The header element of a is automatically buffered and therefore can be inspected without being consumed. - + is fully buffered and therefore can be inspected by a filter. The body of a that has not been fully buffered may be consumed by the filter inspection. The header element of a is automatically buffered and therefore can be inspected without being consumed. + ]]> diff --git a/xml/System.ServiceModel.Dispatcher/MessageFilterTable`1.xml b/xml/System.ServiceModel.Dispatcher/MessageFilterTable`1.xml index f3c7909a63b..93d499b88a4 100644 --- a/xml/System.ServiceModel.Dispatcher/MessageFilterTable`1.xml +++ b/xml/System.ServiceModel.Dispatcher/MessageFilterTable`1.xml @@ -55,7 +55,7 @@ accepts filters of any type. It groups them internally into tables that contain all the filters of a given type. When a filter is added, it is put into an internal filter table, if one already exists, which contains filters of its type. If no such table exists, is called to allocate a new filter table of the appropriate type. Its default operation is to call . + A accepts filters of any type. It groups them internally into tables that contain all the filters of a given type. When a filter is added, it is put into an internal filter table, if one already exists, which contains filters of its type. If no such table exists, is called to allocate a new filter table of the appropriate type. Its default operation is to call . This default behavior can be overridden to explicitly specify the type of filter table associated with a type of filter. The first time a filter type is added to the table, the filter table type created is permanently associated with the filter type. @@ -99,7 +99,7 @@ . + The larger the integer assigned to a filter table, the higher its priority for use in inspecting messages for a match. The default priority can be specified using . ]]> @@ -204,7 +204,7 @@ . + This assigns the filter a default priority. To specify the priority, use . ]]> @@ -244,7 +244,7 @@ to add a filter with the default priority. The default priority can be set using . The default is initially set to 0. + The priority is an integer value used to group filters into priority buckets and order their processing. The larger the integer assigned to a filter type, the higher its priority for processing. All the filter tables in a priority bucket are evaluated together. Lower priority buckets are only evaluated if higher priority buckets do not provide any matches. Use to add a filter with the default priority. The default priority can be set using . The default is initially set to 0. ]]> @@ -282,7 +282,7 @@ . + This method implements . ]]> @@ -319,7 +319,7 @@ . + This method implements the `Contains` method of . ]]> @@ -356,7 +356,7 @@ . + This method implements the `ContainsKey` method of . ]]> @@ -393,7 +393,7 @@ . + This method implements the `CopyTo` method of . ]]> @@ -425,7 +425,7 @@ . + This property implements . ]]> @@ -585,7 +585,7 @@ ## Remarks Use this method when a single filter is expected to match the message and the matching filter is required. - If the body of the message must be inspected by a filter in the filter table, use the version of the method. + If the body of the message must be inspected by a filter in the filter table, use the version of the method. ]]> @@ -627,7 +627,7 @@ ## Remarks Use this method when a single filter is expected to match the message and the matching filter must be returned. - This method implements . + This method implements . ]]> @@ -690,9 +690,9 @@ The filters in the table are not allowed to inspect the message body. - The matching objects are stored in the `results` parameter of . The `FilterData` can then be recovered from the filter table using these filters as keys with the methods provided by . + The matching objects are stored in the `results` parameter of . The `FilterData` can then be recovered from the filter table using these filters as keys with the methods provided by . - This method implements . + This method implements . ]]> @@ -738,9 +738,9 @@ The filters in the table are allowed to inspect the message body. - The matching objects are stored in the `results` parameter of . The `FilterData` can then be recovered from the filter table using these filters as keys with the methods provided by . + The matching objects are stored in the `results` parameter of . The `FilterData` can then be recovered from the filter table using these filters as keys with the methods provided by . - This method implements . + This method implements . ]]> @@ -761,7 +761,7 @@ ## Remarks Use one of these methods when a single filter is expected to match the message and only the `FilterData` from the matching filter must be recovered. - Use to inspect message headers and to inspect a buffered message, which can include looking at the message body. + Use to inspect message headers and to inspect a buffered message, which can include looking at the message body. ]]> @@ -802,7 +802,7 @@ ## Remarks Use this method when a single filter is expected to match the message and only the `FilterData` from the matching filter must be recovered. - This method implements . + This method implements . ]]> @@ -851,7 +851,7 @@ ## Remarks Use this method when a single filter is expected to match the buffered message and only the `FilterData` from the matching filter must be recovered. Because the filter is being matched to a buffered message, it can specify conditions on the message body. - This method implements . + This method implements . ]]> @@ -910,9 +910,9 @@ ## Remarks Use this method when more than one filter is expected to match the message, only the `FilterData` is required, and the body of the message is not inspected. - The `FilterData` of the matching objects are stored in the `results` parameter of . + The `FilterData` of the matching objects are stored in the `results` parameter of . - This method implements . + This method implements . ]]> @@ -956,9 +956,9 @@ ## Remarks Use this method when more than one filter is expected to match the buffered message and only the `FilterData` is required. - The `FilterData` of the matching objects are stored in the `results` . + The `FilterData` of the matching objects are stored in the `results` . - This method implements . + This method implements . ]]> @@ -1027,7 +1027,7 @@ must not be read-only. + A must not be read-only. ]]> @@ -1075,9 +1075,9 @@ myFilters(filter) ``` - You can also use the `Item` property to add new elements by setting the values of a `filter`/filter data pair that does not exist in the action filter table. However if `filter` is already in the table, setting the `Item` property overwrites the old value. In contrast, the method does not modify the filter data of an existing `filter`. + You can also use the `Item` property to add new elements by setting the values of a `filter`/filter data pair that does not exist in the action filter table. However if `filter` is already in the table, setting the `Item` property overwrites the old value. In contrast, the method does not modify the filter data of an existing `filter`. - The dictionary `item` is a filter/`FilterData` pair in the case of . + The dictionary `item` is a filter/`FilterData` pair in the case of . ]]> @@ -1112,9 +1112,9 @@ myFilters(filter) . The that the filter table implements uses the as the key and the `FilterData` as the value of the pair. + This property implements . The that the filter table implements uses the as the key and the `FilterData` as the value of the pair. - The order of the filters returned in the collection is unspecified, but it is guaranteed to be the same order as the corresponding `FilterData` in the collection returned by the property. + The order of the filters returned in the collection is unspecified, but it is guaranteed to be the same order as the corresponding `FilterData` in the collection returned by the property. ]]> @@ -1162,7 +1162,7 @@ myFilters(filter) ## Remarks If the filter key of the `item` is present but is associated with data that differs from the `FilterData`, the method fails to remove the filter and returns `false`. - This method implements . + This method implements . ]]> @@ -1201,7 +1201,7 @@ myFilters(filter) . + This method implements . ]]> @@ -1242,7 +1242,7 @@ myFilters(filter) . + This method implements . ]]> @@ -1310,9 +1310,9 @@ myFilters(filter) . The that the filter table implements uses the as the key and the `FilterData` as the value of the pair. + This property implements . The that the filter table implements uses the as the key and the `FilterData` as the value of the pair. - The order of the `FilterData` returned in the collection is unspecified, but it is guaranteed to be the same order as the corresponding filters in the collection returned by the property. + The order of the `FilterData` returned in the collection is unspecified, but it is guaranteed to be the same order as the corresponding filters in the collection returned by the property. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/MessageQuery.xml b/xml/System.ServiceModel.Dispatcher/MessageQuery.xml index 96bc4e5d017..cfd75237174 100644 --- a/xml/System.ServiceModel.Dispatcher/MessageQuery.xml +++ b/xml/System.ServiceModel.Dispatcher/MessageQuery.xml @@ -19,7 +19,7 @@ class is similar to the class. However, instead of returning matches, the method returns the results of evaluating a query against a message. The result of the query is a value in the message. Use the value as a key to correlate the message to other messages. To add a new property for the data, use the method of the class. + The class is similar to the class. However, instead of returning matches, the method returns the results of evaluating a query against a message. The result of the query is a value in the message. Use the value as a key to correlate the message to other messages. To add a new property for the data, use the method of the class. > [!NOTE] > For a concrete implementation of the , see the class. @@ -39,7 +39,7 @@ The class allows you to create tables of queries that differ only slightly, enabling more efficient processing. - Alternatively, you can use the class to store and evaluate message queries. + Alternatively, you can use the class to store and evaluate message queries. diff --git a/xml/System.ServiceModel.Dispatcher/MessageQueryTable`1.xml b/xml/System.ServiceModel.Dispatcher/MessageQueryTable`1.xml index 477d031aec3..0b3654ed8d3 100644 --- a/xml/System.ServiceModel.Dispatcher/MessageQueryTable`1.xml +++ b/xml/System.ServiceModel.Dispatcher/MessageQueryTable`1.xml @@ -45,7 +45,7 @@ objects contained in an object. The results of each query are tested using the property of the class. Uncomment the alternate code to see similar functionality demonstrated using the . + The following example creates a message and XPath message queries. The queries are evaluated by the objects contained in an object. The results of each query are tested using the property of the class. Uncomment the alternate code to see similar functionality demonstrated using the . :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/xpathmessagequery/cs/source.cs" id="Snippet0"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/xpathmessagequery/vb/source.vb" id="Snippet0"::: diff --git a/xml/System.ServiceModel.Dispatcher/PrefixEndpointAddressMessageFilter.xml b/xml/System.ServiceModel.Dispatcher/PrefixEndpointAddressMessageFilter.xml index fa84babef61..2a40a34b61b 100644 --- a/xml/System.ServiceModel.Dispatcher/PrefixEndpointAddressMessageFilter.xml +++ b/xml/System.ServiceModel.Dispatcher/PrefixEndpointAddressMessageFilter.xml @@ -17,15 +17,15 @@ Represents a query that tests whether a message matches an EndpointAddress using a *Longest-Prefix Match* for the URI component. - object includes a URI and an optional collection of addressing headers. The addressing and message headers are canonicalized to be compared for equality. If a parameter appears more than once in an , the corresponding header must appear in the message at least that many times. - - This filter performs the same query as , except that the test for whether a message matches an endpoint address is done by a *Longest-Prefix Match*. This means that the URI specified in the filter does not have to match the message's URI exactly, but must be contained in that URI as a prefix. For example, if a filter specifies the address "www.foo.com", and a message is addressed to "www.foo.com/customerA", then the URI part of the filter query condition will be met. However, the header portion of the filter query still has to be done. - - Internet Information Services (IIS) and the underlying file system (NTFS or FAT) are case-insensitive. URI comparisons done by this class are also case-insensitive. So, for example, `http://www.microsoft.com` is evaluated as equal to `http://WWW.microsoft.com`. - + object includes a URI and an optional collection of addressing headers. The addressing and message headers are canonicalized to be compared for equality. If a parameter appears more than once in an , the corresponding header must appear in the message at least that many times. + + This filter performs the same query as , except that the test for whether a message matches an endpoint address is done by a *Longest-Prefix Match*. This means that the URI specified in the filter does not have to match the message's URI exactly, but must be contained in that URI as a prefix. For example, if a filter specifies the address "www.foo.com", and a message is addressed to "www.foo.com/customerA", then the URI part of the filter query condition will be met. However, the header portion of the filter query still has to be done. + + Internet Information Services (IIS) and the underlying file system (NTFS or FAT) are case-insensitive. URI comparisons done by this class are also case-insensitive. So, for example, `http://www.microsoft.com` is evaluated as equal to `http://WWW.microsoft.com`. + ]]> @@ -92,19 +92,19 @@ if the host name is included in the endpoint address comparison; otherwise, . Initializes a new instance of the class. - @@ -164,13 +164,13 @@ If you have a web service installed on your local machine, there are many equiva Creates a new filter table that tests a message against multiple endpoint addresses simultaneously. An object that implements the interface that can contain s with associated . - that is optimized to test for specific message endpoints. - - This method is intended to be used by . - + that is optimized to test for specific message endpoints. + + This method is intended to be used by . + ]]> @@ -196,19 +196,19 @@ If you have a web service installed on your local machine, there are many equiva if the host name is included in the endpoint address comparison; otherwise, . - @@ -221,11 +221,11 @@ If you have a web service installed on your local machine, there are many equiva Tests whether a message or buffered message satisfies the criteria of the endpoint filter. - @@ -255,11 +255,11 @@ If you have a web service installed on your local machine, there are many equiva if the object satisfies the endpoint address specified in the filter; otherwise, . - @@ -291,11 +291,11 @@ If you have a web service installed on your local machine, there are many equiva if the object satisfies the endpoint address; otherwise, . - diff --git a/xml/System.ServiceModel.Dispatcher/XPathMessageFilter.xml b/xml/System.ServiceModel.Dispatcher/XPathMessageFilter.xml index 55790f7e818..43915ae057f 100644 --- a/xml/System.ServiceModel.Dispatcher/XPathMessageFilter.xml +++ b/xml/System.ServiceModel.Dispatcher/XPathMessageFilter.xml @@ -136,7 +136,7 @@ ## Remarks It is assumed that the reader is positioned at the start element of the serialized `XPathMessageFilter`. The name of the element is not validated before reading. When this method returns, the reader is positioned immediately after the serialized `XPathMessageFilter`. The constructor also automatically initializes the namespace manager by resolving all prefixes in the XPath expression as they were bound in the reader. - This method can access any XML that can be created by the method. + This method can access any XML that can be created by the method. ]]> @@ -171,7 +171,7 @@ ## Remarks Use this constructor when XPath uses prefixes not defined in , or when you want to use your own . An instance of can be created and passed to this method. - If the instances provided to this method are implementations, it is equivalent to calling the constructor. + If the instances provided to this method are implementations, it is equivalent to calling the constructor. ]]> @@ -308,7 +308,7 @@ An invalid dialect attribute was read: it was not XPath. . Users should create a filter table by calling a constructor for the filter table. This implementation returns an instance of . + This method is called by . Users should create a filter table by calling a constructor for the filter table. This implementation returns an instance of . ]]> @@ -327,11 +327,11 @@ An invalid dialect attribute was read: it was not XPath. ## Remarks These methods check one filter against a message. If you need to check the message against multiple filters, put the filters into a filter table and then use the match methods provided by the table. - If you only need to test the message headers and not the message body, use the method. + If you only need to test the message headers and not the message body, use the method. - If you need to test parts of the message body, use the method. + If you need to test parts of the message body, use the method. - For tests that involve XPath queries, use one of the remaining overloads of the . + For tests that involve XPath queries, use one of the remaining overloads of the . ]]> @@ -365,7 +365,7 @@ An invalid dialect attribute was read: it was not XPath. method to match elements from the body. An exception is thrown by this method if the engine attempts to access the message body in order to evaluate the XPath expression. This helps to ensure that the filter engine does not access the body stream. + Use the method to match elements from the body. An exception is thrown by this method if the engine attempts to access the message body in order to evaluate the XPath expression. This helps to ensure that the filter engine does not access the body stream. ]]> @@ -403,7 +403,7 @@ An invalid dialect attribute was read: it was not XPath. method when a is available. This form is allowed to examine the body of the message. + Use this overload of the method when a is available. This form is allowed to examine the body of the message. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/XPathMessageFilterTable`1.xml b/xml/System.ServiceModel.Dispatcher/XPathMessageFilterTable`1.xml index 16c7392e84c..60365aa5338 100644 --- a/xml/System.ServiceModel.Dispatcher/XPathMessageFilterTable`1.xml +++ b/xml/System.ServiceModel.Dispatcher/XPathMessageFilterTable`1.xml @@ -55,9 +55,9 @@ implements the interface. This filter table is optimized for declarative XPath filters, so the table key is a . + The implements the interface. This filter table is optimized for declarative XPath filters, so the table key is a . - The class optimizes matching for a subset of XPath that covers most of the messaging scenarios and also supports the full XPath 1.0 grammar. It has optimized algorithms for efficient parallel matching. + The class optimizes matching for a subset of XPath that covers most of the messaging scenarios and also supports the full XPath 1.0 grammar. It has optimized algorithms for efficient parallel matching. ]]> @@ -150,7 +150,7 @@ method of the class. The implicit conversion of the `filter` parameter from type to the can be avoided by using the strongly-typed overload, . + This method implements the method of the class. The implicit conversion of the `filter` parameter from type to the can be avoided by using the strongly-typed overload, . ]]> @@ -190,7 +190,7 @@ to the can be avoided by using the strongly-typed overload, . + The internal conversion of the `filter` parameter from to the can be avoided by using the strongly-typed overload, . ]]> @@ -337,7 +337,7 @@ . + This method implements the `ContainsKey` method of . ]]> @@ -425,7 +425,7 @@ . + This method implements . ]]> @@ -484,9 +484,9 @@ This method tests for a single filter match in the highest priority bucket of filters. The filters in the table are not allowed to inspect the message body. - If more than one filter is expected to match the message, use the . + If more than one filter is expected to match the message, use the . - This method implements . + This method implements . ]]> @@ -532,9 +532,9 @@ The filters in the table are allowed to inspect the message body. - If more than one filter is expected to match the message, use the . + If more than one filter is expected to match the message, use the . - This method implements . + This method implements . ]]> @@ -574,7 +574,7 @@ ## Remarks Use this method when a single filter is expected to match the message specified by the and the matching filter is required. - If more than one filter is expected to match the message, use the . + If more than one filter is expected to match the message, use the . ]]> @@ -614,7 +614,7 @@ ## Remarks Use this method when a single filter is expected to match the message specified by the and the matching filter is required. - If more than one filter is expected to match the message, use the . + If more than one filter is expected to match the message, use the . ]]> @@ -677,9 +677,9 @@ The filters in the table are not allowed to inspect the message body. - The matching objects are stored in the `results` parameter of . The `FilterData` can then be recovered from the filter table using these filters as keys with the methods provided by . + The matching objects are stored in the `results` parameter of . The `FilterData` can then be recovered from the filter table using these filters as keys with the methods provided by . - This method implements . + This method implements . ]]> @@ -725,9 +725,9 @@ The filters in the table are allowed to inspect the message body. - The matching objects are stored in the `results` parameter of . The `FilterData` can then be recovered from the filter table using these filters as keys with the methods provided by . + The matching objects are stored in the `results` parameter of . The `FilterData` can then be recovered from the filter table using these filters as keys with the methods provided by . - This method implements . + This method implements . ]]> @@ -767,7 +767,7 @@ ## Remarks Use this method when more than one filter is expected to match the navigator and the matching filters are required. - If only one filter is expected to match the message, use the method. + If only one filter is expected to match the message, use the method. ]]> @@ -807,7 +807,7 @@ ## Remarks Use this method when multiple filters can be expected to match the message specified by the and the matching filters are required. - If only one filter is expected to match the message, use the method. + If only one filter is expected to match the message, use the method. ]]> @@ -828,11 +828,11 @@ ## Remarks Use one of these four methods when a single filter is expected to match the document object and only the `FilterData` from the matching filter must be recovered. - The first two methods are implementations of . + The first two methods are implementations of . - Use if the body content does not require examination. Use if the contents of the message body may require examination. + Use if the body content does not require examination. Use if the contents of the message body may require examination. - The remaining two methods are overloads specific to . To filter on a document provided through a navigator, use or . + The remaining two methods are overloads specific to . To filter on a document provided through a navigator, use or . ]]> @@ -873,7 +873,7 @@ ## Remarks Use this method when a single filter is expected to match the message and only the `FilterData` from the matching filter must be recovered. - This method implements . + This method implements . ]]> @@ -917,7 +917,7 @@ ## Remarks Use this method when a single filter is expected to match the buffered message and only the `FilterData` from the matching filter must be recovered. - This method implements . + This method implements . ]]> @@ -958,7 +958,7 @@ ## Remarks Use this method to specify an XPath condition that the message must meet. - This method is similar to , except that it uses a , which extends the functionality of the to include methods that allow various optimizations. + This method is similar to , except that it uses a , which extends the functionality of the to include methods that allow various optimizations. ]]> @@ -1058,9 +1058,9 @@ ## Remarks Use this method when more than one filter is expected to match the message, only the filter data is required, and the body of the message is not inspected. - The filter data of the matching objects are stored in the `results` parameter of . + The filter data of the matching objects are stored in the `results` parameter of . - This method implements . + This method implements . ]]> @@ -1104,9 +1104,9 @@ ## Remarks Use this method when more than one filter is expected to match the buffered message and only the filter data is required. - The filter data of the matching objects are stored in the `results` . + The filter data of the matching objects are stored in the `results` . - This method implements . + This method implements . ]]> @@ -1146,7 +1146,7 @@ ## Remarks Use this method when more than one filter is expected to match the query criteria of the XML document derived from the optimized XPath navigator and only the filter data is required. - The filter data of the matching objects are stored in the `results` parameter of . + The filter data of the matching objects are stored in the `results` parameter of . ]]> @@ -1186,7 +1186,7 @@ ## Remarks Use this method when more than one filter is expected to match the query criteria of the XML document derived from the optimized XPath navigator and only the filter data is required. - The filter data of the matching objects are stored in the `results` parameter of . + The filter data of the matching objects are stored in the `results` parameter of . ]]> @@ -1259,9 +1259,9 @@ myFilters[filter] myFilters(filter) ``` - You can also use the `Item` property to add new elements by setting the values of a `filter`/filter data pair that does not exist in the action filter table. However if `filter` is already in the table, setting the `Item` property overwrites the old value. In contrast, the method does not modify the filter data of an existing `filter`. + You can also use the `Item` property to add new elements by setting the values of a `filter`/filter data pair that does not exist in the action filter table. However if `filter` is already in the table, setting the `Item` property overwrites the old value. In contrast, the method does not modify the filter data of an existing `filter`. - The dictionary `Item` is a `filter`/filter data pair in the case of . + The dictionary `Item` is a `filter`/filter data pair in the case of . ]]> @@ -1297,9 +1297,9 @@ myFilters(filter) . The that the filter table implements uses the as the key and the `FilterData` as the value of the pair. + This property implements . The that the filter table implements uses the as the key and the `FilterData` as the value of the pair. - The order of the filters returned in the collection is unspecified, but it is guaranteed to be the same order as the corresponding `FilterData` in the collection returned by the property. + The order of the filters returned in the collection is unspecified, but it is guaranteed to be the same order as the corresponding `FilterData` in the collection returned by the property. ]]> @@ -1491,7 +1491,7 @@ myFilters(filter) . + This method implements . ]]> @@ -1588,9 +1588,9 @@ myFilters(filter) . The that the filter table implements uses the as the key and the `FilterData` as the value of the pair. + This property implements . The that the filter table implements uses the as the key and the `FilterData` as the value of the pair. - The order of the `FilterData` returned in the collection is unspecified, but it is guaranteed to be the same order as the corresponding filters in the collection returned by the property. + The order of the `FilterData` returned in the collection is unspecified, but it is guaranteed to be the same order as the corresponding filters in the collection returned by the property. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/XPathResult.xml b/xml/System.ServiceModel.Dispatcher/XPathResult.xml index e31fde9f139..3f226b94ba9 100644 --- a/xml/System.ServiceModel.Dispatcher/XPathResult.xml +++ b/xml/System.ServiceModel.Dispatcher/XPathResult.xml @@ -106,7 +106,7 @@ method of the class within a loop to see the value of each node. + Use the method of the class within a loop to see the value of each node. ]]> diff --git a/xml/System.ServiceModel.MsmqIntegration/MsmqIntegrationMessageProperty.xml b/xml/System.ServiceModel.MsmqIntegration/MsmqIntegrationMessageProperty.xml index db84032dda9..c09328db637 100644 --- a/xml/System.ServiceModel.MsmqIntegration/MsmqIntegrationMessageProperty.xml +++ b/xml/System.ServiceModel.MsmqIntegration/MsmqIntegrationMessageProperty.xml @@ -22,7 +22,7 @@ ## Remarks The class exposes all of the Message Queuing message properties that you can set when you send a message or read a message that has been received using the integration channel. - The class also enables you to set Message Queuing message properties, and is the recommended way to set Message Queuing message properties. + The class also enables you to set Message Queuing message properties, and is the recommended way to set Message Queuing message properties. When you use the channels and messages infrastructure to create a message and send it over an integration channel, you can use the class as a property of the message so that the integration channel can retrieve the message properties and format the message as a Message Queuing message and send it on the wire. diff --git a/xml/System.ServiceModel.MsmqIntegration/MsmqMessage`1.xml b/xml/System.ServiceModel.MsmqIntegration/MsmqMessage`1.xml index 9d7fb1ab333..5ed1559768a 100644 --- a/xml/System.ServiceModel.MsmqIntegration/MsmqMessage`1.xml +++ b/xml/System.ServiceModel.MsmqIntegration/MsmqMessage`1.xml @@ -30,7 +30,7 @@ class to access the properties of the Message Queuing message. + Use the class to access the properties of the Message Queuing message. diff --git a/xml/System.ServiceModel.PeerResolvers/PeerResolverMode.xml b/xml/System.ServiceModel.PeerResolvers/PeerResolverMode.xml index ab556990979..6f8bf783b62 100644 --- a/xml/System.ServiceModel.PeerResolvers/PeerResolverMode.xml +++ b/xml/System.ServiceModel.PeerResolvers/PeerResolverMode.xml @@ -16,13 +16,13 @@ Determines the type of peer resolver being used. - will be thrown when an attempt to use the resolver is made. -If `Auto` is specified, a custom resolver is used, if one is available. If one is unavailable, the PNRP peer resolver is used. A peer resolver is considered "available" if the and properties are set on it. +If `Auto` is specified, a custom resolver is used, if one is available. If one is unavailable, the PNRP peer resolver is used. A peer resolver is considered "available" if the and properties are set on it. ]]> diff --git a/xml/System.ServiceModel.PeerResolvers/RefreshResponseInfo.xml b/xml/System.ServiceModel.PeerResolvers/RefreshResponseInfo.xml index 8872b894ac4..8b77d7c3cca 100644 --- a/xml/System.ServiceModel.PeerResolvers/RefreshResponseInfo.xml +++ b/xml/System.ServiceModel.PeerResolvers/RefreshResponseInfo.xml @@ -23,13 +23,13 @@ Contains response information returned as a result of a registration lookup table refresh operation on the peer resolver. - or an implementation of is called, this object is returned to the client. It contains the refreshed registration entry with the new expiry timestamp, and is returned when a previous instance is sent to the peer resolver as part of a request to update the expiry of a registration entry. - - Instances of this class are primarily used to pass information from the resolver service to a network client of that service. - + or an implementation of is called, this object is returned to the client. It contains the refreshed registration entry with the new expiry timestamp, and is returned when a previous instance is sent to the peer resolver as part of a request to update the expiry of a registration entry. + + Instances of this class are primarily used to pass information from the resolver service to a network client of that service. + ]]> diff --git a/xml/System.ServiceModel.PeerResolvers/RegisterInfo.xml b/xml/System.ServiceModel.PeerResolvers/RegisterInfo.xml index 7647b194ec7..41a87460c2b 100644 --- a/xml/System.ServiceModel.PeerResolvers/RegisterInfo.xml +++ b/xml/System.ServiceModel.PeerResolvers/RegisterInfo.xml @@ -23,13 +23,13 @@ Defines the peer registration information to be supplied to a peer resolver service. - (or an implementation of ) is called to register with a peer resolver service. They are primarily used to pass registration request information to a peer resolver service from a network client of that service. - + (or an implementation of ) is called to register with a peer resolver service. They are primarily used to pass registration request information to a peer resolver service from a network client of that service. + ]]> diff --git a/xml/System.ServiceModel.PeerResolvers/RegisterResponseInfo.xml b/xml/System.ServiceModel.PeerResolvers/RegisterResponseInfo.xml index 746bc61e545..dd67fb74d7f 100644 --- a/xml/System.ServiceModel.PeerResolvers/RegisterResponseInfo.xml +++ b/xml/System.ServiceModel.PeerResolvers/RegisterResponseInfo.xml @@ -23,13 +23,13 @@ Contains response information returned by a peer resolver as the result of a registration operation. - (or an implementation of ) is called with a instance passed to it, this object is returned to the caller to indicate the results of the registration operation. - - Instances of this class are primarily used to pass registration response information from the resolver service to a network client of that service. - + (or an implementation of ) is called with a instance passed to it, this object is returned to the caller to indicate the results of the registration operation. + + Instances of this class are primarily used to pass registration response information from the resolver service to a network client of that service. + ]]> diff --git a/xml/System.ServiceModel.PeerResolvers/ResolveResponseInfo.xml b/xml/System.ServiceModel.PeerResolvers/ResolveResponseInfo.xml index 1ca0f6a4a55..d31bfebdf6c 100644 --- a/xml/System.ServiceModel.PeerResolvers/ResolveResponseInfo.xml +++ b/xml/System.ServiceModel.PeerResolvers/ResolveResponseInfo.xml @@ -23,13 +23,13 @@ Contains response information returned as a result of a peer endpoint resolution operation on the peer resolver. - or an implementation of is called, this object is returned to the client. It contains the endpoints registered to the peer specified in a previous corresponding instance sent to the peer resolver. - - Instances of this class are primarily used to pass information from the resolver service to a network client of that service. - + or an implementation of is called, this object is returned to the client. It contains the endpoints registered to the peer specified in a previous corresponding instance sent to the peer resolver. + + Instances of this class are primarily used to pass information from the resolver service to a network client of that service. + ]]> diff --git a/xml/System.ServiceModel.Persistence/LockingPersistenceProvider.xml b/xml/System.ServiceModel.Persistence/LockingPersistenceProvider.xml index 6deebd60ea7..ebbb5e4ff6b 100644 --- a/xml/System.ServiceModel.Persistence/LockingPersistenceProvider.xml +++ b/xml/System.ServiceModel.Persistence/LockingPersistenceProvider.xml @@ -23,11 +23,11 @@ The abstract base class from which all durable service persistence providers that implement locking are derived. - class implements locking of service state data records. Methods that interact with persisted data (such as the `Load` method) have an optional parameter (`lockInstance`) that defines whether locks on the data in question are released or maintained. - + class implements locking of service state data records. Methods that interact with persisted data (such as the `Load` method) have an optional parameter (`lockInstance`) that defines whether locks on the data in question are released or maintained. + ]]> @@ -93,11 +93,11 @@ Begins an asynchronous operation to create instance state information in the persistence store using the parameters. This method does not unlock the instance after saving the state information. The status of an asynchronous operation. - method, which takes an additional parameter to determine whether the instance is unlocked. This method passes `false` as a value for this parameter to the calling method. - + method, which takes an additional parameter to determine whether the instance is unlocked. This method passes `false` as a value for this parameter to the calling method. + ]]> @@ -174,11 +174,11 @@ Begins an asynchronous operation to load an instance based on state information in the persistence store using the parameters. This method does not lock the instance. The status of an asynchronous operation. - , which takes an additional parameter that specifies whether the instance must be locked in the persistence store. This method passes `false` as a value for this parameter to the calling method. - + , which takes an additional parameter that specifies whether the instance must be locked in the persistence store. This method passes `false` as a value for this parameter to the calling method. + ]]> @@ -361,11 +361,11 @@ Begins an asynchronous operation to update instance state information in the persistence store using the parameters passed. This operation does not unlock the instance in the instance store. The status of an asynchronous operation. - method and passes a `false` value for the `unlockInstance` parameter. - + method and passes a `false` value for the `unlockInstance` parameter. + ]]> @@ -531,11 +531,11 @@ Loads service state information from the persistence store without locking the instance. The service state information. - method with `lockInstance` parameter set to `false`. - + method with `lockInstance` parameter set to `false`. + ]]> diff --git a/xml/System.ServiceModel.Persistence/PersistenceProvider.xml b/xml/System.ServiceModel.Persistence/PersistenceProvider.xml index 30f5c0eb5d0..353a66dcd39 100644 --- a/xml/System.ServiceModel.Persistence/PersistenceProvider.xml +++ b/xml/System.ServiceModel.Persistence/PersistenceProvider.xml @@ -23,19 +23,19 @@ The abstract base class from which all durable service persistence providers are derived. - . - + . + > [!NOTE] -> When creating persistence provider implementations, it is important to maintain the thread's original identity in the new provider's methods (such as . Otherwise, security loopholes could be created, because operations would then run under the wrong identity. - - - -## Examples - For an implementation of this type that uses the file system as a persistence store, see the FilePersistenceProviderFactory.cs file in the DurableServiceFactory SDK sample. - +> When creating persistence provider implementations, it is important to maintain the thread's original identity in the new provider's methods (such as . Otherwise, security loopholes could be created, because operations would then run under the wrong identity. + + + +## Examples + For an implementation of this type that uses the file system as a persistence store, see the FilePersistenceProviderFactory.cs file in the DurableServiceFactory SDK sample. + ]]> @@ -453,11 +453,11 @@ When implemented in a derived class, loads service state information from the persistence store. The loaded instance state. - method, if not reverted, stay in effect for the remainder of that message's processing. This means that the service operation's user code, the response message path through the dispatcher, as well as any error paths, run in the changed security context. - + method, if not reverted, stay in effect for the remainder of that message's processing. This means that the service operation's user code, the response message path through the dispatcher, as well as any error paths, run in the changed security context. + ]]> diff --git a/xml/System.ServiceModel.Persistence/SqlPersistenceProviderFactory.xml b/xml/System.ServiceModel.Persistence/SqlPersistenceProviderFactory.xml index 7f478427d6a..e387d51e097 100644 --- a/xml/System.ServiceModel.Persistence/SqlPersistenceProviderFactory.xml +++ b/xml/System.ServiceModel.Persistence/SqlPersistenceProviderFactory.xml @@ -28,7 +28,7 @@ ## Remarks The class represents a factory class for a fully-functional, durable service persistence provider. You can use this system-provided provider to persist and retrieve state information about a durable WCF service. - In addition to persistence, the provider created by the class implements locking of service state data records by inheriting from the abstract class. Methods that interact with persisted data (such as or ) have an optional parameter (`lockInstance`) that defines whether locks on the data in question are released or maintained. + In addition to persistence, the provider created by the class implements locking of service state data records by inheriting from the abstract class. Methods that interact with persisted data (such as or ) have an optional parameter (`lockInstance`) that defines whether locks on the data in question are released or maintained. > [!NOTE] > exceptions thrown by do not have their exception details hidden by default. To protect against security vulnerabilities, these details can be hidden by setting to `false`. diff --git a/xml/System.ServiceModel.Routing/RoutingExtension.xml b/xml/System.ServiceModel.Routing/RoutingExtension.xml index a7866d5df26..9405831c657 100644 --- a/xml/System.ServiceModel.Routing/RoutingExtension.xml +++ b/xml/System.ServiceModel.Routing/RoutingExtension.xml @@ -44,16 +44,16 @@ The routing configuration to be applied. Applies a new to a running instance of the routing service. - , the new only applies to new sessions and messages. - + , the new only applies to new sessions and messages. + > [!WARNING] -> Do not modify the object after calling , as does not provide thread-safe updates or extensions. -> -> If you must perform subsequent updates of the routing configuration, use a new instance of for each update. - +> Do not modify the object after calling , as does not provide thread-safe updates or extensions. +> +> If you must perform subsequent updates of the routing configuration, use a new instance of for each update. + ]]> diff --git a/xml/System.ServiceModel.Security.Tokens/IssuedSecurityTokenParameters.xml b/xml/System.ServiceModel.Security.Tokens/IssuedSecurityTokenParameters.xml index 13e56cc2f78..5c0a8606ec1 100644 --- a/xml/System.ServiceModel.Security.Tokens/IssuedSecurityTokenParameters.xml +++ b/xml/System.ServiceModel.Security.Tokens/IssuedSecurityTokenParameters.xml @@ -46,11 +46,11 @@ Represents the parameters for a security token issued in a Federated security scenario. - @@ -63,13 +63,13 @@ Initializes a new instance of the class. - sets them to their default values. takes them from the instance referenced by the input parameter. - - The other constructors set them to their default values and then set other properties based on the input parameters. - + sets them to their default values. takes them from the instance referenced by the input parameter. + + The other constructors set them to their default values and then set other properties based on the input parameters. + ]]> @@ -110,17 +110,17 @@ Initializes a new instance of the class. - is set to . - -- is set to . - -- is set to `true`. - + is set to . + +- is set to . + +- is set to `true`. + ]]> @@ -159,11 +159,11 @@ The other instance of this class. Initializes a new instance of the class. - @@ -207,19 +207,19 @@ The token type. Initializes a new instance of the class using the specified token type. - is set to . - -- is set to . - -- is set to `true`. - -- is set to `tokenType`. - + is set to . + +- is set to . + +- is set to `true`. + +- is set to `tokenType`. + ]]> @@ -263,21 +263,21 @@ The address of the endpoint that issues the token. Initializes a new instance of the class using the specified token type and issuer address. - is set to . - -- is set to . - -- is set to `true`. - -- is set to `tokenType`. - -- is set to `issuerAddress`. - + is set to . + +- is set to . + +- is set to `true`. + +- is set to `tokenType`. + +- is set to `issuerAddress`. + ]]> @@ -317,23 +317,23 @@ The binding of the issuer. Initializes a new instance of the class using the specified token type, issuer address and issuer binding. - is set to . - -- is set to . - -- is set to `true`. - -- is set to `tokenType`. - -- is set to `issuerAddress`. - -- is set to `issuerBinding`. - + is set to . + +- is set to . + +- is set to `true`. + +- is set to `tokenType`. + +- is set to `issuerAddress`. + +- is set to `issuerBinding`. + ]]> @@ -415,13 +415,13 @@ Gets a collection of claim type requirements. A of type that holds the additional claim type requirements. - in the returned collection specifies the types of required and optional claims expected to appear in a federated credential. - - A claim type requirement consists of the URI of the claim type requested in the issued token along with a Boolean parameter that indicates whether that claim type is required in the issued token or is optional. - + in the returned collection specifies the types of required and optional claims expected to appear in a federated credential. + + A claim type requirement consists of the URI of the claim type requested in the issued token along with a Boolean parameter that indicates whether that claim type is required in the issued token or is optional. + ]]> @@ -464,15 +464,15 @@ Clones another instance of this instance of the class. A that represents the copy. - and methods follow the Core design pattern. - - is an `abstract` class that is overridden by . - - The method calls the constructor. - + and methods follow the Core design pattern. + + is an `abstract` class that is overridden by . + + The method calls the constructor. + ]]> @@ -514,11 +514,11 @@ Creates a key identifier clause for a token. The security key identifier clause. - method, with `referenceStyle` as a generic parameter. - + method, with `referenceStyle` as a generic parameter. + ]]> @@ -639,11 +639,11 @@ if the issued token has an asymmetric key; otherwise, . - @@ -682,17 +682,17 @@ The security token requirement to initialize. When implemented, initializes a security token requirement based on the properties set on the . - are initialized: - -- is set to the value in the current instance of this class. - -- = `true`. - -- is set to the value in the current instance of this class. - + are initialized: + +- is set to the value in the current instance of this class. + +- = `true`. + +- is set to the value in the current instance of this class. + ]]> @@ -787,11 +787,11 @@ Gets or sets the token issuer's binding, to be used by the client. The of the token issuer, to be used by the client. - @@ -954,11 +954,11 @@ if the token supports client authentication; otherwise, . - @@ -995,11 +995,11 @@ if the token supports a Windows identity for authentication; otherwise, . - @@ -1036,11 +1036,11 @@ if the token supports server authentication; otherwise, . - @@ -1123,11 +1123,11 @@ Displays a text representation of this instance of the class. A text representation of this instance of this class. - , , , , , (if not `null`) and binding elements, and (if not 0). - + , , , , , (if not `null`) and binding elements, and (if not 0). + ]]> diff --git a/xml/System.ServiceModel.Security.Tokens/IssuedSecurityTokenProvider.xml b/xml/System.ServiceModel.Security.Tokens/IssuedSecurityTokenProvider.xml index d3e076c8753..34e72a9ed8b 100644 --- a/xml/System.ServiceModel.Security.Tokens/IssuedSecurityTokenProvider.xml +++ b/xml/System.ServiceModel.Security.Tokens/IssuedSecurityTokenProvider.xml @@ -21,11 +21,11 @@ Represents a token provider for issued security tokens. - method, because the security token might become unusable when the channel that the token provider is associated with is closed. The security token becomes unusable when the requested key type is asymmetric and the thread is running under impersonated context when the method is called. - + method, because the security token might become unusable when the channel that the token provider is associated with is closed. The security token becomes unusable when the requested key type is asymmetric and the thread is running under impersonated context when the method is called. + ]]> @@ -408,11 +408,11 @@ Gets the default time-out for closing the connection. A that represents the default time-out for closing the connection. - @@ -437,11 +437,11 @@ Gets the default time-out for opening the connection. A that represents the default time-out for opening the connection. - @@ -604,11 +604,11 @@ Gets the token core. The that represents the token core. - method, because the security token might become unusable when the channel that the token provider is associated with is closed. The security token becomes unusable when the requested key type is asymmetric and the thread is running under impersonated context when the method is called. - + method, because the security token might become unusable when the channel that the token provider is associated with is closed. The security token becomes unusable when the requested key type is asymmetric and the thread is running under impersonated context when the method is called. + ]]> @@ -655,11 +655,11 @@ Gets or sets the issued token renewal threshold percentage. The issued token renewal threshold percentage. - @@ -728,11 +728,11 @@ Gets the issuer channel behaviors. A that contains the behaviors for the issuer channel. - @@ -757,11 +757,11 @@ Gets or sets the key entropy mode. The key entropy mode. - @@ -814,11 +814,11 @@ Gets or sets the message security version. The message security version. - contains numerous properties that specify version numbers of different components of a message. - + contains numerous properties that specify version numbers of different components of a message. + ]]> @@ -953,11 +953,11 @@ Gets or sets the security algorithm suite. The security algorithm suite. - object that is returned contains numerous properties that specify security algorithms to use in specific conditions. It also describes various security capabilities of the service. - + object that is returned contains numerous properties that specify security algorithms to use in specific conditions. It also describes various security capabilities of the service. + ]]> @@ -1084,11 +1084,11 @@ Gets the token request parameters. A collection of XML elements that represent the token request parameters. - diff --git a/xml/System.ServiceModel.Security.Tokens/KerberosSecurityTokenParameters.xml b/xml/System.ServiceModel.Security.Tokens/KerberosSecurityTokenParameters.xml index 89023f6f87d..5391c381a58 100644 --- a/xml/System.ServiceModel.Security.Tokens/KerberosSecurityTokenParameters.xml +++ b/xml/System.ServiceModel.Security.Tokens/KerberosSecurityTokenParameters.xml @@ -17,11 +17,11 @@ Represents the parameters for a Kerberos security token. - @@ -34,11 +34,11 @@ Initializes a new instance of the class. - sets them to their default values. takes them from the instance referenced by the input parameter. - + sets them to their default values. takes them from the instance referenced by the input parameter. + ]]> @@ -59,24 +59,24 @@ Initializes a new instance of the class. - is set to . - -- is set to . - -- is set to `true`. - - - -## Examples - The following code shows how to call this constructor. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_custombinding/cs/c_custombinding.cs" id="Snippet6"::: - + is set to . + +- is set to . + +- is set to `true`. + + + +## Examples + The following code shows how to call this constructor. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_custombinding/cs/c_custombinding.cs" id="Snippet6"::: + ]]> @@ -107,11 +107,11 @@ The other instance of this class. Initializes a new instance of the class. - @@ -139,15 +139,15 @@ Clones another instance of this instance of the class. A instance that represents the copy. - and methods follow the Core design pattern. - - is an `abstract` class that is overridden by . - - The method calls the constructor. - + and methods follow the Core design pattern. + + is an `abstract` class that is overridden by . + + The method calls the constructor. + ]]> @@ -201,13 +201,13 @@ if the token has an asymmetric key; otherwise, . - @@ -235,17 +235,17 @@ The requirement of the security token. Initializes a security token requirement. - are initialized: - -- = . - -- = `true`. - -- = . - + are initialized: + +- = . + +- = `true`. + +- = . + ]]> @@ -271,11 +271,11 @@ if the token supports client authentication; otherwise, . - @@ -301,11 +301,11 @@ if the token supports a Windows identity for authentication; otherwise, . - @@ -331,11 +331,11 @@ if the token supports server authentication; otherwise, . - diff --git a/xml/System.ServiceModel.Security.Tokens/RsaSecurityTokenParameters.xml b/xml/System.ServiceModel.Security.Tokens/RsaSecurityTokenParameters.xml index eba29c02afa..a65006de2cc 100644 --- a/xml/System.ServiceModel.Security.Tokens/RsaSecurityTokenParameters.xml +++ b/xml/System.ServiceModel.Security.Tokens/RsaSecurityTokenParameters.xml @@ -17,11 +17,11 @@ Represents the parameters for an RSA security token. - @@ -34,11 +34,11 @@ Initializes a new instance of the class. - sets them to their default values. takes them from the instance referenced by the input parameter. - + sets them to their default values. takes them from the instance referenced by the input parameter. + ]]> @@ -59,17 +59,17 @@ Initializes a new instance of the class. - is set to . - -- is set to . - -- is set to `true`. - + is set to . + +- is set to . + +- is set to `true`. + ]]> @@ -94,11 +94,11 @@ The other instance of this class. Initializes a new instance of the class. - is set to . - + is set to . + ]]> @@ -126,15 +126,15 @@ Clones another instance of this instance of the class. A instance that represents the copy. - and methods follow the Core design pattern. - - is an `abstract` class that is overridden by . - - The method calls the constructor. - + and methods follow the Core design pattern. + + is an `abstract` class that is overridden by . + + The method calls the constructor. + ]]> @@ -188,13 +188,13 @@ if the token has an asymmetric key; otherwise, . - @@ -222,17 +222,17 @@ The requirement of the security token. Initializes a security token requirement. - are initialized: - -- = . - -- = `true`. - -- = . - + are initialized: + +- = . + +- = `true`. + +- = . + ]]> @@ -258,11 +258,11 @@ if the token supports client authentication; otherwise, . - @@ -288,11 +288,11 @@ if the token supports a Windows identity for authentication; otherwise, . - @@ -318,11 +318,11 @@ if the token supports server authentication; otherwise, . - diff --git a/xml/System.ServiceModel.Security.Tokens/SecureConversationSecurityTokenParameters.xml b/xml/System.ServiceModel.Security.Tokens/SecureConversationSecurityTokenParameters.xml index e2c63a97e2e..00de744ba57 100644 --- a/xml/System.ServiceModel.Security.Tokens/SecureConversationSecurityTokenParameters.xml +++ b/xml/System.ServiceModel.Security.Tokens/SecureConversationSecurityTokenParameters.xml @@ -575,11 +575,11 @@ and methods follow the Core design pattern. + The and methods follow the Core design pattern. - is an `abstract` class which is overridden by . + is an `abstract` class which is overridden by . - The method calls the constructor. + The method calls the constructor. ]]> @@ -625,7 +625,7 @@ method, with `referenceStyle` as a generic parameter. + This method creates a key identifier clause using the method, with `referenceStyle` as a generic parameter. ]]> diff --git a/xml/System.ServiceModel.Security.Tokens/SecurityContextSecurityToken.xml b/xml/System.ServiceModel.Security.Tokens/SecurityContextSecurityToken.xml index bb90b99e940..7ba943675f2 100644 --- a/xml/System.ServiceModel.Security.Tokens/SecurityContextSecurityToken.xml +++ b/xml/System.ServiceModel.Security.Tokens/SecurityContextSecurityToken.xml @@ -21,11 +21,11 @@ Represents the token defined by the WS-SecureConversation specification. - @@ -65,11 +65,11 @@ The expiration time. Initializes a new instance of the class. - @@ -108,11 +108,11 @@ The expiration time. Initializes a new instance of the class. - @@ -147,11 +147,11 @@ A read-only collection of instances that represents the party to whom the token is issued. Initializes a new instance of the class. - @@ -192,11 +192,11 @@ A read-only collection of instances that represents the party to whom the token is issued. Initializes a new instance of the class. - @@ -466,13 +466,13 @@ Releases unmanaged resources used by this instance of this object. - . - + . + ]]> @@ -616,11 +616,11 @@ Gets the key generation. A that represents the key generation. - ` element. In prior versions of the .NET Framework, it was emitted as an `` element. - + ` element. In prior versions of the .NET Framework, it was emitted as an `` element. + ]]> diff --git a/xml/System.ServiceModel.Security.Tokens/SecurityTokenParameters.xml b/xml/System.ServiceModel.Security.Tokens/SecurityTokenParameters.xml index 7f6f2e961fd..9ecb25daa12 100644 --- a/xml/System.ServiceModel.Security.Tokens/SecurityTokenParameters.xml +++ b/xml/System.ServiceModel.Security.Tokens/SecurityTokenParameters.xml @@ -83,7 +83,7 @@ sets them to their default values. takes them from the instance referenced by the input parameter. + The difference between these overloads is where instance property values come from. sets them to their default values. takes them from the instance referenced by the input parameter. ]]> @@ -221,7 +221,7 @@ and methods follow the Core design pattern. In that pattern, this method performs some validation and then calls , which is an `abstract` method that is overridden in derived classes to perform the core functionality. + The and methods follow the Core design pattern. In that pattern, this method performs some validation and then calls , which is an `abstract` method that is overridden in derived classes to perform the core functionality. ]]> @@ -270,7 +270,7 @@ and methods follow the Core design pattern. is an `abstract` method that is overridden in derived classes. + The and methods follow the Core design pattern. is an `abstract` method that is overridden in derived classes. ]]> diff --git a/xml/System.ServiceModel.Security.Tokens/ServiceModelSecurityTokenRequirement.xml b/xml/System.ServiceModel.Security.Tokens/ServiceModelSecurityTokenRequirement.xml index cf6d4846f16..4057ed47c89 100644 --- a/xml/System.ServiceModel.Security.Tokens/ServiceModelSecurityTokenRequirement.xml +++ b/xml/System.ServiceModel.Security.Tokens/ServiceModelSecurityTokenRequirement.xml @@ -260,7 +260,7 @@ ,where the generic type is . + The value that corresponds to this key is of type ,where the generic type is . ]]> diff --git a/xml/System.ServiceModel.Security.Tokens/SslSecurityTokenParameters.xml b/xml/System.ServiceModel.Security.Tokens/SslSecurityTokenParameters.xml index be811a8060c..3a5242f0d3d 100644 --- a/xml/System.ServiceModel.Security.Tokens/SslSecurityTokenParameters.xml +++ b/xml/System.ServiceModel.Security.Tokens/SslSecurityTokenParameters.xml @@ -222,9 +222,9 @@ and methods follow the Core design pattern. overrides . + The and methods follow the Core design pattern. overrides . - The method calls the constructor. + The method calls the constructor. ]]> @@ -259,7 +259,7 @@ method, with `referenceStyle` as a generic parameter. + This method creates a key identifier clause using the method, with `referenceStyle` as a generic parameter. ]]> diff --git a/xml/System.ServiceModel.Security.Tokens/SspiSecurityTokenParameters.xml b/xml/System.ServiceModel.Security.Tokens/SspiSecurityTokenParameters.xml index cafdaaaec0d..6f0c8f6c685 100644 --- a/xml/System.ServiceModel.Security.Tokens/SspiSecurityTokenParameters.xml +++ b/xml/System.ServiceModel.Security.Tokens/SspiSecurityTokenParameters.xml @@ -37,9 +37,9 @@ sets them to their default values. takes them from the instance referenced by the input parameter. + The difference between these overloads is where instance property values come from. sets them to their default values. takes them from the instance referenced by the input parameter. - sets them to their default values and then sets to `false`. + sets them to their default values and then sets to `false`. ]]> @@ -184,11 +184,11 @@ and methods follow the Core design pattern. + The and methods follow the Core design pattern. - is an `abstract` class that is overridden by . + is an `abstract` class that is overridden by . - The method calls the constructor. + The method calls the constructor. ]]> diff --git a/xml/System.ServiceModel.Security.Tokens/UserNameSecurityTokenParameters.xml b/xml/System.ServiceModel.Security.Tokens/UserNameSecurityTokenParameters.xml index 6cec09fb596..04264e6de50 100644 --- a/xml/System.ServiceModel.Security.Tokens/UserNameSecurityTokenParameters.xml +++ b/xml/System.ServiceModel.Security.Tokens/UserNameSecurityTokenParameters.xml @@ -73,7 +73,7 @@ sets them to their default values. takes them from the instance referenced by the input parameter. + The difference between these overloads is where instance property values come from. sets them to their default values. takes them from the instance referenced by the input parameter. ]]> @@ -215,11 +215,11 @@ and methods follow the Core design pattern. + The and methods follow the Core design pattern. - is an `abstract` class that is overridden by . + is an `abstract` class that is overridden by . - The method calls the constructor. + The method calls the constructor. ]]> @@ -265,7 +265,7 @@ method, with `referenceStyle` as a generic parameter. + Creates a key identifier clause using the method, with `referenceStyle` as a generic parameter. ]]> diff --git a/xml/System.ServiceModel.Security.Tokens/X509SecurityTokenParameters.xml b/xml/System.ServiceModel.Security.Tokens/X509SecurityTokenParameters.xml index 2b2d4995cd1..e167874a982 100644 --- a/xml/System.ServiceModel.Security.Tokens/X509SecurityTokenParameters.xml +++ b/xml/System.ServiceModel.Security.Tokens/X509SecurityTokenParameters.xml @@ -27,11 +27,11 @@ Represents the parameters for an X.509 security token. - @@ -111,21 +111,21 @@ An . Initializes a new instance of the class. - is set to . - -- is set to . - -- is set to `true`. - - The corresponding properties are set to the values in the input parameters. - + is set to . + +- is set to . + +- is set to `true`. + + The corresponding properties are set to the values in the input parameters. + ]]> @@ -158,11 +158,11 @@ The other instance of this class. Initializes a new instance of the class. - @@ -205,19 +205,19 @@ A . Initializes a new instance of the class. - is set to `inclusionMode`. - -- is set to `x509ReferenceStyle`. - -- is set to `true`. - - The corresponding properties are set to the values in the input parameters. - + is set to `inclusionMode`. + +- is set to `x509ReferenceStyle`. + +- is set to `true`. + + The corresponding properties are set to the values in the input parameters. + ]]> @@ -251,15 +251,15 @@ Clones another instance of this instance of the class. A new instance of the . - and methods follow the Core design pattern. - - is an `abstract` class which is overridden by . - - The method calls the constructor. - + and methods follow the Core design pattern. + + is an `abstract` class which is overridden by . + + The method calls the constructor. + ]]> @@ -329,11 +329,11 @@ if the token has an asymmetric key; otherwise, . Always returns . - @@ -369,17 +369,17 @@ The . Initializes a security token requirement. - are initialized: - -- = . - -- = `true`. - - = . - + are initialized: + +- = . + +- = `true`. + + = . + ]]> @@ -542,14 +542,14 @@ Gets or sets the X.509 reference style. The X.509 reference style. - diff --git a/xml/System.ServiceModel.Security/ChannelProtectionRequirements.xml b/xml/System.ServiceModel.Security/ChannelProtectionRequirements.xml index bdc44caa55d..08dd7cb8891 100644 --- a/xml/System.ServiceModel.Security/ChannelProtectionRequirements.xml +++ b/xml/System.ServiceModel.Security/ChannelProtectionRequirements.xml @@ -28,11 +28,11 @@ Describes encryption and signature requirements that apply to different parts of messages that are transmitted on this channel. - class, you must implement the so that it returns an instance of this class corresponding to the binding element. - + class, you must implement the so that it returns an instance of this class corresponding to the binding element. + ]]> @@ -71,19 +71,19 @@ Initializes a new instance of the class. - , which is a class that specifies which parts are included in a message: - -- , - -- , - -- , and - -- . - + , which is a class that specifies which parts are included in a message: + +- , + +- , + +- , and + +- . + ]]> @@ -116,19 +116,19 @@ The other instance of . Initializes a new instance of the class from another instance of this class. - , using the constructor, with `other` as the input parameter. is a class that specifies which parts are included in a message: - -- , - -- , - -- , and - -- . - + , using the constructor, with `other` as the input parameter. is a class that specifies which parts are included in a message: + +- , + +- , + +- , and + +- . + ]]> @@ -248,11 +248,11 @@ Creates a new instance of this class with incoming and outgoing parts reversed. A new instance of this class with incoming and outgoing parts reversed. - @@ -291,11 +291,11 @@ Gets a collection of message parts that are encrypted for messages from client to server. A collection. - @@ -334,11 +334,11 @@ Gets a collection of message parts that are signed for messages from client to server. A collection. - @@ -408,11 +408,11 @@ Sets this class and its part collections to read-only. - is set to true, as are the corresponding properties on the parts collections. - + is set to true, as are the corresponding properties on the parts collections. + ]]> @@ -451,11 +451,11 @@ Gets a collection of message parts that are encrypted for messages from server to client. A collection. - @@ -494,11 +494,11 @@ Gets a collection of message parts that are signed for messages from server to client. A collection. - diff --git a/xml/System.ServiceModel.Security/DataProtectionSecurityStateEncoder.xml b/xml/System.ServiceModel.Security/DataProtectionSecurityStateEncoder.xml index bdbceef5c79..e7161d1df75 100644 --- a/xml/System.ServiceModel.Security/DataProtectionSecurityStateEncoder.xml +++ b/xml/System.ServiceModel.Security/DataProtectionSecurityStateEncoder.xml @@ -17,17 +17,17 @@ Provides encoding and decoding mechanisms for the security state using the Windows API functionality. - @@ -213,11 +213,11 @@ Returns a string that represents the current instance. A that represents the current instance. - and values of the current instance. - + and values of the current instance. + ]]> diff --git a/xml/System.ServiceModel.Security/IdentityVerifier.xml b/xml/System.ServiceModel.Security/IdentityVerifier.xml index fcc76b1e166..cc72a373814 100644 --- a/xml/System.ServiceModel.Security/IdentityVerifier.xml +++ b/xml/System.ServiceModel.Security/IdentityVerifier.xml @@ -40,13 +40,13 @@ An base class that can be implemented to verify an expected identity against an authorization context that represents a remote endpoint, or to create an identity from an endpoint address. - method first to retrieve the service's identity from the message. Next, the infrastructure calls the method with the returned and . - - For more information about implementing the class, see [How to: Create a Custom Client Identity Verifier](/dotnet/framework/wcf/extending/how-to-create-a-custom-client-identity-verifier). - + method first to retrieve the service's identity from the message. Next, the infrastructure calls the method with the returned and . + + For more information about implementing the class, see [How to: Create a Custom Client Identity Verifier](/dotnet/framework/wcf/extending/how-to-create-a-custom-client-identity-verifier). + ]]> How To: Create a Custom Client Identity Verifier @@ -204,11 +204,11 @@ if the identity is returned; otherwise, . The default is . - creates a based on the hostname portion of if an explicit has not been specified as part of the . - + creates a based on the hostname portion of if an explicit has not been specified as part of the . + ]]> diff --git a/xml/System.ServiceModel.Security/IssuedTokenClientCredential.xml b/xml/System.ServiceModel.Security/IssuedTokenClientCredential.xml index 24d1cc5345f..218c57b821c 100644 --- a/xml/System.ServiceModel.Security/IssuedTokenClientCredential.xml +++ b/xml/System.ServiceModel.Security/IssuedTokenClientCredential.xml @@ -17,13 +17,13 @@ Represents information used to obtain an issued token from a security token service. - @@ -84,19 +84,19 @@ Gets or sets the default value of . The value of . The default is . - An attempt was made to a read-only credential. @@ -128,21 +128,21 @@ Gets or sets the renewal threshold percentage for issued tokens. The renewal threshold percentage for issued tokens. The default value is 60. - An attempt was made to a read-only credential. @@ -168,11 +168,11 @@ Gets a collection of issuer channel behaviors. A of s. - of the endpoint behaviors that the application uses in the channels created by WCF to get the issued tokens from the Security Token Services. - + of the endpoint behaviors that the application uses in the channels created by WCF to get the issued tokens from the Security Token Services. + ]]> @@ -203,18 +203,18 @@ Gets or sets the address of the local issuer. The of the local issuer. - An attempt was made to a read-only credential. @@ -246,19 +246,19 @@ Gets or sets the binding of the local issuer. The of the local issuer. - An attempt was made to a read-only credential. @@ -284,18 +284,18 @@ Gets a collection of local issuer channel behaviors. A of s. - of the endpoint behaviors that the application uses in the channels created by WCF to get the issued tokens from the local Security Token Service. - - - -## Examples - This code shows how to set this property. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_creatests/cs/source.cs" id="Snippet32"::: - + of the endpoint behaviors that the application uses in the channels created by WCF to get the issued tokens from the local Security Token Service. + + + +## Examples + This code shows how to set this property. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_creatests/cs/source.cs" id="Snippet32"::: + ]]> @@ -326,19 +326,19 @@ Gets or sets the maximum caching time for an issued token. A that represents the maximum caching time for an issued token. The default value is TimeSpan.MaxValue. - The value of is less than zero. diff --git a/xml/System.ServiceModel.Security/MessagePartSpecification.xml b/xml/System.ServiceModel.Security/MessagePartSpecification.xml index d8bd0afccf2..c78ee7b3453 100644 --- a/xml/System.ServiceModel.Security/MessagePartSpecification.xml +++ b/xml/System.ServiceModel.Security/MessagePartSpecification.xml @@ -348,7 +348,7 @@ to set this property to `true`. sets the property to `false`. + You can use to set this property to `true`. sets the property to `false`. ]]> @@ -385,7 +385,7 @@ removes all headers in the specification and makes the collection read/write. + removes all headers in the specification and makes the collection read/write. ]]> @@ -462,7 +462,7 @@ method is called, the holds all header information from both specifications, and the property is set to the logical OR of both specifications. + After the method is called, the holds all header information from both specifications, and the property is set to the logical OR of both specifications. ]]> diff --git a/xml/System.ServiceModel.Security/ScopedMessagePartSpecification.xml b/xml/System.ServiceModel.Security/ScopedMessagePartSpecification.xml index a0ac04cde18..3b328fc794d 100644 --- a/xml/System.ServiceModel.Security/ScopedMessagePartSpecification.xml +++ b/xml/System.ServiceModel.Security/ScopedMessagePartSpecification.xml @@ -28,11 +28,11 @@ Specifies which parts are included in a message. - instances of different messages, each distinguished by the message Action. - + instances of different messages, each distinguished by the message Action. + ]]> @@ -251,11 +251,11 @@ Gets a message part specification that contains the channel parts. A that contains the channel parts. - @@ -295,11 +295,11 @@ if the specification is read-only; otherwise, . - to set this property to `true`. - + to set this property to `true`. + ]]> @@ -385,11 +385,11 @@ if matching parts were found; otherwise, . - , then the message parts configured for the Wildcard action ("*") are returned. - + , then the message parts configured for the Wildcard action ("*") are returned. + ]]> @@ -431,11 +431,11 @@ if matching parts were found; otherwise, . - , then the message parts configured for the Wildcard action ("*") are returned. - + , then the message parts configured for the Wildcard action ("*") are returned. + ]]> diff --git a/xml/System.ServiceModel.Security/SecureConversationServiceCredential.xml b/xml/System.ServiceModel.Security/SecureConversationServiceCredential.xml index edb558f085f..bc79a7682e7 100644 --- a/xml/System.ServiceModel.Security/SecureConversationServiceCredential.xml +++ b/xml/System.ServiceModel.Security/SecureConversationServiceCredential.xml @@ -22,7 +22,7 @@ ## Remarks Secure conversations involve the exchange of multiple messages and use a Security Context Token (SCT) to ensure security. The SCT is shared among the communicating parties for the lifetime of a communications session. A service can issue two different kinds of SCTs: -- The first is a session-based SCT that contains a unique id. Messages carry only the id, and the service maintains a state-mapping cache that maps between the SCT ids and contents (such as claims, security keys, and so on). A well-behaved client must send an SCT cancellation to help the service optimize the cache resources. If you instantiate this class by calling with the `requireCancellation` parameter equal to `true`, the SCT is issued in this manner. +- The first is a session-based SCT that contains a unique id. Messages carry only the id, and the service maintains a state-mapping cache that maps between the SCT ids and contents (such as claims, security keys, and so on). A well-behaved client must send an SCT cancellation to help the service optimize the cache resources. If you instantiate this class by calling with the `requireCancellation` parameter equal to `true`, the SCT is issued in this manner. - The second is a self-contained SCT that resides in a cookie on the client. This SCT contains the entire state information, so requires neither state management from the service nor SCT cancellation from the client. This is sometimes called a "cookie-mode" SCT. Because the SCT contains the entire state information, its size is larger than in the session-based case. With session-based SCTs, the service stores much of the state information. However, because it is self-contained, it can be used across service lifetime and persists across service shutdown and restart. diff --git a/xml/System.ServiceModel.Security/SecurityAlgorithmSuite.xml b/xml/System.ServiceModel.Security/SecurityAlgorithmSuite.xml index de5ca33ccac..ba9d3b6a113 100644 --- a/xml/System.ServiceModel.Security/SecurityAlgorithmSuite.xml +++ b/xml/System.ServiceModel.Security/SecurityAlgorithmSuite.xml @@ -53,13 +53,13 @@ Specifies properties of algorithms. This is an class. - @@ -101,11 +101,11 @@ Initializes a new instance of the class. - @@ -136,11 +136,11 @@ Gets the Basic128 algorithm suite. The 128-bit Basic . - @@ -171,11 +171,11 @@ Gets an algorithm suite that uses RSA15 as the key wrap algorithm and 128-bit Basic as the message encryption algorithm. An algorithm suite that uses RSA15 as the key wrap algorithm and 128-bit Basic as the message encryption algorithm. - returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. - + returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. + ]]> @@ -206,11 +206,11 @@ Gets an algorithm suite that uses SHA256 for the signature digest and 128-bit Basic as the message encryption algorithm. An algorithm suite that uses SHA256 for the signature digest and 128-bit Basic as the message encryption algorithm. - returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. - + returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. + ]]> @@ -241,11 +241,11 @@ Gets an algorithm suite that uses RSA15 as the key wrap algorithm, SHA256 for the signature digest, and 128-bit Basic as the message encryption algorithm. An algorithm suite that uses RSA15 as the key wrap algorithm, SHA256 for the signature digest, and 128-bit Basic as the message encryption algorithm. - returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. - + returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. + ]]> @@ -276,11 +276,11 @@ Gets an algorithm suite that uses 192-bit Basic as the message encryption algorithm. An algorithm suite that uses 192-bit Basic as the message encryption algorithm. - @@ -311,11 +311,11 @@ Gets an algorithm suite that uses RSA15 as the key wrap algorithm and 192-bit Basic as the message encryption algorithm. An algorithm suite that uses RSA15 as the key wrap algorithm and 192-bit Basic as the message encryption algorithm. - returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. - + returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. + ]]> @@ -346,11 +346,11 @@ Gets an algorithm suite which uses SHA256 for the signature digest and 192-bit Basic as the message encryption algorithm. An algorithm suite which uses SHA256 for the signature digest and 192-bit Basic as the message encryption algorithm. - returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. - + returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. + ]]> @@ -381,11 +381,11 @@ Gets an algorithm suite that uses RSA15 as the key wrap algorithm, SHA256 for the signature digest, and 192-bit Basic as the message encryption algorithm. An algorithm suite that uses RSA15 as the key wrap algorithm, SHA256 for the signature digest, and 192-bit Basic as the message encryption algorithm. - returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. - + returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. + ]]> @@ -425,19 +425,19 @@ Gets an algorithm suite that uses 256-bit Basic as the message encryption algorithm. An algorithm suite that uses 256-bit Basic as the message encryption algorithm. - to this property. - + to this property. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_programmingsecurity/cs/source.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/c_programmingsecurity/vb/source.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/c_programmingsecurity/vb/source.vb" id="Snippet8"::: + ]]> @@ -468,11 +468,11 @@ Gets an algorithm suite that uses RSA15 as the key wrap algorithm and 256-bit Basic as the message encryption algorithm. An algorithm suite that uses RSA15 as the key wrap algorithm and 256-bit Basic as the message encryption algorithm. - returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. - + returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. + ]]> @@ -512,11 +512,11 @@ Gets an algorithm suite that uses SHA256 for the signature digest and 256-bit Basic as the message encryption algorithm. An algorithm suite that uses SHA256 for the signature digest and 256-bit Basic as the message encryption algorithm. - returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. - + returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. + ]]> @@ -547,11 +547,11 @@ Gets an algorithm suite that uses RSA15 as the key wrap algorithm, SHA256 for the signature digest, and 256-bit Basic as the message encryption algorithm. An algorithm suite that uses RSA15 as the key wrap algorithm, SHA256 for the signature digest, and 256-bit Basic as the message encryption algorithm. - returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. - + returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. + ]]> @@ -597,11 +597,11 @@ Gets the default algorithm suite. The default is , which specifies 256-bit Advanced Encryption Standard (AES) as the symmetric encryption algorithm. - returned is actually an internal subclass that overrides the properties specifying default values as well as the methods. - + returned is actually an internal subclass that overrides the properties specifying default values as well as the methods. + ]]> @@ -641,11 +641,11 @@ Gets the default asymmetric key wrap algorithm as a string. The default asymmetric key wrap algorithm. - method. - + method. + ]]> @@ -685,11 +685,11 @@ Gets the default asymmetric signature algorithm as a string. The default asymmetric signature algorithm. - method. - + method. + ]]> @@ -729,11 +729,11 @@ Gets the default canonicalization algorithm as a string. The default canonicalization algorithm. - . - + . + ]]> @@ -773,11 +773,11 @@ Gets the default digest algorithm as a string. The default digest algorithm. - method. - + method. + ]]> @@ -817,11 +817,11 @@ Gets the default encryption algorithm as a string. The default encryption algorithm. - method. - + method. + ]]> @@ -861,11 +861,11 @@ Gets the default encryption key derivation length as an value. The default encryption key derivation length. - @@ -905,11 +905,11 @@ Gets the default signature key derivation length as an value. The default signature key derivation length. - @@ -949,11 +949,11 @@ Gets the default symmetric key length as an value. The default symmetric key length. - @@ -1070,11 +1070,11 @@ if the key length is supported by the asymmetric algorithm; otherwise, . - @@ -1116,11 +1116,11 @@ if the asymmetric key wrap algorithm is supported; otherwise, . - . - + . + ]]> @@ -1162,11 +1162,11 @@ if the asymmetric signature algorithm is supported; otherwise, . - . - + . + ]]> @@ -1208,11 +1208,11 @@ if the canonicalization algorithm is supported; otherwise, . - . - + . + ]]> @@ -1254,11 +1254,11 @@ if the digest algorithm is supported; otherwise, . - . - + . + ]]> @@ -1300,11 +1300,11 @@ if the encryption algorithm is supported; otherwise, . - . - + . + ]]> @@ -1425,11 +1425,11 @@ if the symmetric key length is supported; otherwise, . - @@ -1546,11 +1546,11 @@ Gets the Triple Data Encryption Standard (DES) algorithm suite. The Triple DES . - returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. - + returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. + ]]> @@ -1581,11 +1581,11 @@ Gets an algorithm suite that uses RSA15 as the key wrap algorithm and 192-bit Triple Data Encryption Standard (DES) as the message encryption algorithm. An algorithm suite that uses RSA15 as the key wrap algorithm and 192-bit Triple Data Encryption Standard (DES) as the message encryption algorithm. - returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. - + returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. + ]]> @@ -1616,11 +1616,11 @@ Gets an algorithm suite that uses SHA256 for the signature digest and 192-bit Triple Data Encryption Standard (DES) as the message encryption algorithm. An algorithm suite that uses SHA256 for the signature digest and 192-bit Triple Data Encryption Standard (DES) as the message encryption algorithm. - returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. - + returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. + ]]> @@ -1651,11 +1651,11 @@ Gets an algorithm suite that uses RSA15 as the key wrap algorithm, SHA256 for the signature digest, and 192-bit Triple Data Encryption Standard (DES) as the message encryption algorithm. An algorithm suite that uses RSA15 as the key wrap algorithm, SHA256 for the signature digest, and 192-bit Triple Data Encryption Standard (DES) as the message encryption algorithm. - returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. - + returned is actually an internal subclass that overrides some of the properties specifying default values as well as some of the methods. + ]]> diff --git a/xml/System.ServiceModel.Security/SecurityMessageProperty.xml b/xml/System.ServiceModel.Security/SecurityMessageProperty.xml index 7af855d7d7c..675dba83720 100644 --- a/xml/System.ServiceModel.Security/SecurityMessageProperty.xml +++ b/xml/System.ServiceModel.Security/SecurityMessageProperty.xml @@ -41,11 +41,11 @@ Contains security-related properties and is attached to a message. - , which is attached to the message using a . This property can be used by higher layers to implement custom authorization logic. - + , which is attached to the message using a . This property can be used by higher layers to implement custom authorization logic. + ]]> @@ -108,9 +108,9 @@ Clones the current instance of this class. A cloned from the current instance of this class. - , such as , , or , a copy must be created because these properties are undefined after the message is disposed of. ]]> @@ -188,11 +188,11 @@ Gets or sets a collection of external authorization policies. A of type . - is called on these authorization policies as part of the process that creates the . - + is called on these authorization policies as part of the process that creates the . + ]]> @@ -260,11 +260,11 @@ if contains at least one entry; otherwise, . - @@ -297,11 +297,11 @@ Gets or sets a collection of incoming supporting tokens. A of type . - @@ -334,11 +334,11 @@ Gets or sets the initiator token for this message. The initiator token for this message. - @@ -401,11 +401,11 @@ Gets or sets the protection token for this message. The protection token for this message. - @@ -438,11 +438,11 @@ Gets or sets the recipient token for this message. The recipient token for this message. - @@ -490,7 +490,7 @@ The first character of the property value is not alphabetic and not equal to "_". -or- - + No character of the property value is alphabetic, numeric, or equal to "_", ".", or "-". @@ -522,13 +522,13 @@ No character of the property value is alphabetic, numeric, or equal to "_", ".", Gets or sets the for this message. The object for this message. - @@ -561,11 +561,11 @@ No character of the property value is alphabetic, numeric, or equal to "_", ".", Gets or sets the transport token for this message. The transport token for this message. - diff --git a/xml/System.ServiceModel.Security/UserNamePasswordServiceCredential.xml b/xml/System.ServiceModel.Security/UserNamePasswordServiceCredential.xml index 8de824203fc..a889ea6a5c6 100644 --- a/xml/System.ServiceModel.Security/UserNamePasswordServiceCredential.xml +++ b/xml/System.ServiceModel.Security/UserNamePasswordServiceCredential.xml @@ -156,7 +156,7 @@ ## Remarks The property must be set to for the to take effect. When the property is set and the property is not, WCF uses Windows authentication and ignores the value of the property. - For mode, the service uses for user name/password authentication by calling the method. + For mode, the service uses for user name/password authentication by calling the method. ]]> @@ -272,7 +272,7 @@ mode, the service uses for user name/password authentication by calling the method. + For mode, the service uses for user name/password authentication by calling the method. > [!NOTE] > The property must be set to for the to take effect. When the property is set and the property is not, WCF uses Windows authentication and ignores the value of the property. diff --git a/xml/System.ServiceModel.Security/WSTrustServiceContract.xml b/xml/System.ServiceModel.Security/WSTrustServiceContract.xml index 3144bb83cec..44c6a48363b 100644 --- a/xml/System.ServiceModel.Security/WSTrustServiceContract.xml +++ b/xml/System.ServiceModel.Security/WSTrustServiceContract.xml @@ -45,19 +45,19 @@ Definition of the WS-Trust service contract implementation. - - -- - -- - -- - + + +- + +- + +- + ]]> @@ -1373,11 +1373,11 @@ Provides mappings from exported WSDL elements to the contract description. When implemented in a derived class, writes custom Web Services Description Language (WSDL) elements into the generated WSDL for a contract. - method. The default implementation does nothing. You can override this method in a derived class to implement specific behavior. - + method. The default implementation does nothing. You can override this method in a derived class to implement specific behavior. + ]]> @@ -1409,19 +1409,19 @@ Provides mappings from exported WSDL elements to the endpoint description. Writes custom Web Services Description Language (WSDL) elements into the generated WSDL for an endpoint. - method. - - The default implementation does the following for every WS-Trust contract found: - -1. Includes the appropriate WS-Trust namespace in the WSDL. - -2. Imports the appropriate WS-Trust schema and all dependent schemas. - -3. Fixes the Messages of each operation to appropriate WS-Trust equivalents. The WS-Trust Contract exposed by Windows Identity Foundation (WIF) takes a in and returns a out. But WS-Trust messages expect an RST and return an RSTR/RSTRC. This method fixes the message names with the appropriate WS-Trust messages. - + method. + + The default implementation does the following for every WS-Trust contract found: + +1. Includes the appropriate WS-Trust namespace in the WSDL. + +2. Imports the appropriate WS-Trust schema and all dependent schemas. + +3. Fixes the Messages of each operation to appropriate WS-Trust equivalents. The WS-Trust Contract exposed by Windows Identity Foundation (WIF) takes a in and returns a out. But WS-Trust messages expect an RST and return an RSTR/RSTRC. This method fixes the message names with the appropriate WS-Trust messages. + ]]> @@ -1458,26 +1458,26 @@ The of the output message element. During WSDL generation, this method fixes a specified operation message element to refer to the RST and RSTR elements of the appropriate WS-Trust version. - in and returns a out. But WS-Trust messages expect an RST and return an RSTR/RSTRC. This method fixes the message names with the appropriate WS-Trust messages specified by the XML qualified names in `inputMessageElement` and `outputMessageElement`. - + in and returns a out. But WS-Trust messages expect an RST and return an RSTR/RSTRC. This method fixes the message names with the appropriate WS-Trust messages specified by the XML qualified names in `inputMessageElement` and `outputMessageElement`. + ]]> - is . - - -or- - - is . - - -or- - - is . - - -or- - + is . + + -or- + + is . + + -or- + + is . + + -or- + is . is or Empty. @@ -1529,11 +1529,11 @@ Returns the that resolves the following security tokens contained in the security header of the current WCF message request: protection token, endorsing, or signed endorsing supporting tokens. The security token resolver that is used to resolve any SecurityTokenIdentifiers when deserializing RST UseKey elements or RST RenewTarget elements. - is used to resolve any SecurityTokenIdentifiers when deserializing RST UseKey elements or RST RenewTarget elements. - + is used to resolve any SecurityTokenIdentifiers when deserializing RST UseKey elements or RST RenewTarget elements. + ]]> @@ -1597,18 +1597,18 @@ The current WS-Trust namespace for which the schemas are imported. Imports all of the required schemas if not already present in the WSDL. - - is . - - -or- - + is . + + -or- + is . is or an empty string. @@ -1647,7 +1647,7 @@ -or- is or an empty string. - + -or- is or an empty string. @@ -2155,11 +2155,11 @@ Occurs when a failure happens processing a WS-Trust request from the client. - method. - + method. + ]]> @@ -2212,13 +2212,13 @@ The endpoint to validate. When implemented in a derived class, confirms that the contract and endpoint can support the contract behavior. - . - + . + ]]> @@ -2245,11 +2245,11 @@ The object to validate. Validates the specified object. - Object represents a legal request prior to being passed into the method. The default implementation rejects incoming RST messages with RSTR actions and vice versa. - + Object represents a legal request prior to being passed into the method. The default implementation rejects incoming RST messages with RSTR actions and vice versa. + ]]> diff --git a/xml/System.ServiceModel.Security/WSTrustServiceHost.xml b/xml/System.ServiceModel.Security/WSTrustServiceHost.xml index 575c8c42341..f327015b6a5 100644 --- a/xml/System.ServiceModel.Security/WSTrustServiceHost.xml +++ b/xml/System.ServiceModel.Security/WSTrustServiceHost.xml @@ -190,7 +190,7 @@ method and then invokes the base implementation. + Invokes the method and then invokes the base implementation. ]]> diff --git a/xml/System.ServiceModel.Syndication/Atom10FeedFormatter.xml b/xml/System.ServiceModel.Syndication/Atom10FeedFormatter.xml index ce8cbaa6a21..db07bdb0eab 100644 --- a/xml/System.ServiceModel.Syndication/Atom10FeedFormatter.xml +++ b/xml/System.ServiceModel.Syndication/Atom10FeedFormatter.xml @@ -57,22 +57,22 @@ A class that serializes a instance to and from Atom 1.0 format. - and to create instances of from XML documents that represent Atom1.0 feeds. If you have derived a class from and want to serialize it, use the formatter. - + and to create instances of from XML documents that represent Atom1.0 feeds. If you have derived a class from and want to serialize it, use the formatter. + > [!NOTE] -> The Atom 1.0 specification allows for fractional seconds to be specified in any of its date constructs. When serializing and deserializing, the WCF implementation ignores the fractional seconds. - - - -## Examples - The following code shows how to create a and serialize it to Atom 1.0. - +> The Atom 1.0 specification allows for fractional seconds to be specified in any of its date constructs. When serializing and deserializing, the WCF implementation ignores the fractional seconds. + + + +## Examples + The following code shows how to create a and serialize it to Atom 1.0. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/atomformatter/cs/snippets.cs" id="Snippet0"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet0"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet0"::: + ]]> @@ -110,14 +110,14 @@ Creates a new instance of the class. - and read in a syndication feed. - + and read in a syndication feed. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/atomformatter/cs/snippets.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet1"::: + ]]> @@ -150,14 +150,14 @@ The to serialize. Creates a new instance of the class with the specified instance. - and serialize it to Atom 1.0. - + and serialize it to Atom 1.0. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/atomformatter/cs/snippets.cs" id="Snippet0"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet0"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet0"::: + ]]> @@ -190,19 +190,19 @@ The derived instance to be serialized. Creates a new instance of the class. - to instantiate when a syndication feed is read in. - - - -## Examples - The following code shows how to use this constructor. - + to instantiate when a syndication feed is read in. + + + +## Examples + The following code shows how to use this constructor. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/atomformatter/cs/snippets.cs" id="Snippet11"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet11"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet11"::: + ]]> @@ -239,19 +239,19 @@ Verifies whether the specified contains a valid Atom 1.0 syndication feed. A value that specifies whether the contains a valid Atom 1.0 syndication feed. - method. - + method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/atomformatter/cs/snippets.cs" id="Snippet12"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet12"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet12"::: + ]]> @@ -285,11 +285,11 @@ Creates a new . A new instance. - instance is not automatically associated with the used to create it. - + instance is not automatically associated with the used to create it. + ]]> @@ -368,11 +368,11 @@ Gets or sets a value that specifies whether to preserve attribute extensions during serialization. A value that specifies whether to preserve attribute extensions during serialization. - instance when deserializing an Atom1.0 feed. - + instance when deserializing an Atom1.0 feed. + ]]> @@ -415,11 +415,11 @@ Gets or sets a value that specifies whether to preserve element extensions during serialization. A value that specifies whether to preserve element extensions during serialization. - instance when deserializing an Atom1.0 feed. - + instance when deserializing an Atom1.0 feed. + ]]> @@ -455,14 +455,14 @@ The to read from. Reads an Atom 1.0 syndication feed from the specified instance. - method. - + method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/atomformatter/cs/snippets.cs" id="Snippet12"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet12"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet12"::: + ]]> @@ -501,11 +501,11 @@ Reads a syndication item from instance using the instance. A new instance. - instance to the , because this is done by the caller of the method. This method provides an extensibility point for classes derived from to customize how an Atom 1.0 entry is deserialized. - + instance to the , because this is done by the caller of the method. This method provides an extensibility point for classes derived from to customize how an Atom 1.0 entry is deserialized. + ]]> @@ -546,11 +546,11 @@ Reads in a collection of instances from the specified . A collection of instances. - instances to the , because this is done by the caller of the method. This method provides an extensibility point for classes derived from to customize how the Atom entries get deserialized. For instance, derived classes could delay the reading of the Atom entry until the caller accesses the entry. - + instances to the , because this is done by the caller of the method. This method provides an extensibility point for classes derived from to customize how the Atom entries get deserialized. For instance, derived classes could delay the reading of the Atom entry until the caller accesses the entry. + ]]> @@ -588,11 +588,11 @@ . - @@ -697,11 +697,11 @@ Gets the syndication version used by the formatter. The syndication version used by the formatter. - @@ -741,11 +741,11 @@ The base URI for the feed. Writes the specified instance to the specified . - is written. - + is written. + ]]> @@ -785,11 +785,11 @@ The base URI for the feed. Writes a collection of instances to the specified . - objects. - + objects. + ]]> @@ -825,14 +825,14 @@ The to write to. Writes the associated with the to the specified . - to write the feed to an . - + to write the feed to an . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/atomformatter/cs/snippets.cs" id="Snippet0"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet0"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet0"::: + ]]> diff --git a/xml/System.ServiceModel.Syndication/Atom10ItemFormatter.xml b/xml/System.ServiceModel.Syndication/Atom10ItemFormatter.xml index 077cf6db254..18dc2e1aa8e 100644 --- a/xml/System.ServiceModel.Syndication/Atom10ItemFormatter.xml +++ b/xml/System.ServiceModel.Syndication/Atom10ItemFormatter.xml @@ -57,22 +57,22 @@ A class that serializes a instance to and from Atom 1.0 format. - and to create an instance of from an XML document that contains an Atom 1.0 entry. If you have derived a class from and want to serialize it, use the formatter instead. - + and to create an instance of from an XML document that contains an Atom 1.0 entry. If you have derived a class from and want to serialize it, use the formatter instead. + > [!NOTE] -> The Atom 1.0 specification allows for fractional seconds to be specified in any of its date constructs. When serializing and deserializing, the WCF implementation ignores the fractional seconds. - - - -## Examples - The following code shows how to create a instance and serialize it. - +> The Atom 1.0 specification allows for fractional seconds to be specified in any of its date constructs. When serializing and deserializing, the WCF implementation ignores the fractional seconds. + + + +## Examples + The following code shows how to create a instance and serialize it. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/atomformatter/cs/snippets.cs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet7"::: + ]]> @@ -140,14 +140,14 @@ The to serialize. Creates a new instance of the class with the specified . - @@ -180,19 +180,19 @@ The derived instance to associate with the . Initializes a new instance of the class. - to instantiate when a syndication item is read in. - - - -## Examples - The following code shows how to use this constructor. - + to instantiate when a syndication item is read in. + + + +## Examples + The following code shows how to use this constructor. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/atomformatter/cs/snippets.cs" id="Snippet15"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet15"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet15"::: + ]]> @@ -229,14 +229,14 @@ Verifies whether the specified contains a valid Atom 1.0 syndication item. A value that specifies whether the contains a valid Atom 1.0 syndication item. - method. - + method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/atomformatter/cs/snippets.cs" id="Snippet13"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet13"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet13"::: + ]]> @@ -270,11 +270,11 @@ Creates a new instance. A new instance. - instance is not automatically associated with the used to create it. - + instance is not automatically associated with the used to create it. + ]]> @@ -349,11 +349,11 @@ Gets or sets a value that specifies whether to preserve attribute extensions during serialization. A value that specifies whether to preserve attribute extensions during serialization. - instance when deserializing an Atom1.0 entry. - + instance when deserializing an Atom1.0 entry. + ]]> @@ -392,11 +392,11 @@ Gets or sets a value that specifies whether to preserve element extensions during serialization. A value that specifies whether to preserve element extensions during serialization. - instance when deserializing an Atom1.0 entry. - + instance when deserializing an Atom1.0 entry. + ]]> @@ -432,14 +432,14 @@ The to read from. Reads an Atom 1.0 syndication item from the specified instance. - method. - + method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/atomformatter/cs/snippets.cs" id="Snippet13"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet13"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet13"::: + ]]> @@ -477,11 +477,11 @@ . - @@ -586,11 +586,11 @@ Gets the syndication version used by the formatter. The syndication version used by the formatter. - @@ -626,14 +626,14 @@ The to write to. Writes the associated with the to the specified . - . - + . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/atomformatter/cs/snippets.cs" id="Snippet14"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet14"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/atomformatter/vb/snippets.vb" id="Snippet14"::: + ]]> diff --git a/xml/System.ServiceModel.Syndication/AtomPub10ServiceDocumentFormatter.xml b/xml/System.ServiceModel.Syndication/AtomPub10ServiceDocumentFormatter.xml index 4e19918e96e..cc8bee7a923 100644 --- a/xml/System.ServiceModel.Syndication/AtomPub10ServiceDocumentFormatter.xml +++ b/xml/System.ServiceModel.Syndication/AtomPub10ServiceDocumentFormatter.xml @@ -57,11 +57,11 @@ A formatter that serializes a instance to and from XML using Atom 1.0 formats. - to XML and to generate instances of from an XML document. If you want to serialize or deserialized an object derived from , use the formatter instead. - + to XML and to generate instances of from an XML document. If you want to serialize or deserialized an object derived from , use the formatter instead. + ]]> @@ -129,11 +129,11 @@ The associated with the Atom 1.0 formatter. Creates a new instance of the Atom 1.0-based class to serialize a specified service document. - @@ -168,11 +168,11 @@ The instance of an object that is derived from a type that is associated with the Atom 1.0 formatter. Creates a new instance of the Atom 1.0-based class. - @@ -317,11 +317,11 @@ This method is reserved and should not be used. Returns . - method. - + method. + ]]> @@ -360,11 +360,11 @@ The stream from which the object is deserialized. Generates a from its XML representation. - method. - + method. + ]]> @@ -405,11 +405,11 @@ The stream to which the object is serialized. Converts the into its XML representation. - method. - + method. + ]]> diff --git a/xml/System.ServiceModel.Syndication/Rss20FeedFormatter.xml b/xml/System.ServiceModel.Syndication/Rss20FeedFormatter.xml index e9d73c78e2d..0b9b3f05aae 100644 --- a/xml/System.ServiceModel.Syndication/Rss20FeedFormatter.xml +++ b/xml/System.ServiceModel.Syndication/Rss20FeedFormatter.xml @@ -57,19 +57,19 @@ A class that serializes a instance to and from RSS 2.0 format. - and to create instances of from XML documents that represent RSS 2.0 feeds. If you have derived a class from and want to serialize it, use the formatter. - - - -## Examples - The following code shows how to create a and serialize it to RSS 2.0. - + and to create instances of from XML documents that represent RSS 2.0 feeds. If you have derived a class from and want to serialize it, use the formatter. + + + +## Examples + The following code shows how to create a and serialize it to RSS 2.0. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/rssformatter/cs/snippets.cs" id="Snippet0"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/rssformatter/vb/snippets.vb" id="Snippet0"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/rssformatter/vb/snippets.vb" id="Snippet0"::: + ]]> @@ -107,14 +107,14 @@ Creates a new instance of the class. - instance and read in an RSS syndication feed. - + instance and read in an RSS syndication feed. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/rssformatter/cs/snippets.cs" id="Snippet13"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/rssformatter/vb/snippets.vb" id="Snippet13"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/rssformatter/vb/snippets.vb" id="Snippet13"::: + ]]> @@ -153,14 +153,14 @@ The to serialize. Creates a new instance of the class with the specified instance. - @@ -193,19 +193,19 @@ The instance derived from to be serialized. Creates a new instance of the class. - to instantiate when a syndication feed is read in. - - - -## Examples - The following code shows how to use this constructor. - + to instantiate when a syndication feed is read in. + + + +## Examples + The following code shows how to use this constructor. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/rssformatter/cs/snippets.cs" id="Snippet14"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/rssformatter/vb/snippets.vb" id="Snippet14"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/rssformatter/vb/snippets.vb" id="Snippet14"::: + ]]> @@ -240,19 +240,19 @@ A value that specifies whether to serialize elements that are defined in the Atom 1.0 specification but not in the RSS 2.0 specification. The default value is . Creates a new instance of the class with the specified instance. - @@ -289,14 +289,14 @@ Verifies whether the specified contains a valid RSS 2.0 syndication feed. A value that specifies whether the contains a valid RSS 2.0 syndication feed. - method. - + method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/rssformatter/cs/snippets.cs" id="Snippet15"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/rssformatter/vb/snippets.vb" id="Snippet15"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/rssformatter/vb/snippets.vb" id="Snippet15"::: + ]]> @@ -406,11 +406,11 @@ Gets or sets a value that specifies whether to preserve attribute extensions during serialization. A value that specifies whether to preserve attribute extensions during serialization. - instance when deserializing an RSS 2.0 feed. - + instance when deserializing an RSS 2.0 feed. + ]]> @@ -453,11 +453,11 @@ Gets or sets a value that specifies whether to preserve element extensions during serialization. A value that specifies whether to preserve element extensions during serialization. - instance when deserializing an RSS 2.0 feed. - + instance when deserializing an RSS 2.0 feed. + ]]> @@ -493,14 +493,14 @@ The to read from. Reads an RSS 2.0 syndication feed from the specified instance. - method. - + method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/rssformatter/cs/snippets.cs" id="Snippet15"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/rssformatter/vb/snippets.vb" id="Snippet15"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/rssformatter/vb/snippets.vb" id="Snippet15"::: + ]]> @@ -539,11 +539,11 @@ Reads a syndication item from instance using the instance. A new instance. - instance is not added to the associated with the instance. - + instance is not added to the associated with the instance. + ]]> @@ -584,11 +584,11 @@ Reads in a collection of instances from the specified . A collection of instances. - instances are not added to the associated with the instance. - + instances are not added to the associated with the instance. + ]]> @@ -631,11 +631,11 @@ Gets or sets a value that specifies whether to serialize extensions within the Atom 1.0 namespace. A value that specifies whether to serialize extensions within the Atom 1.0 namespace. - class that cannot be represented in the RSS 2.0 format are serialized within the Atom 1.0 namespace otherwise these properties are not serialized. - + class that cannot be represented in the RSS 2.0 format are serialized within the Atom 1.0 namespace otherwise these properties are not serialized. + ]]> @@ -706,11 +706,11 @@ . - @@ -815,11 +815,11 @@ Gets the syndication version used by the formatter. The syndication version used by the formatter. - @@ -859,11 +859,11 @@ The base URI for the feed. Writes the specified instance to the specified . - is written. - + is written. + ]]> @@ -903,11 +903,11 @@ The base URI for the feed. Writes a collection of instances to the specified . - objects. - + objects. + ]]> @@ -943,14 +943,14 @@ The to write to. Writes the associated with the to the specified . - to write the feed to an . - + to write the feed to an . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/rssformatter/cs/snippets.cs" id="Snippet0"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/rssformatter/vb/snippets.vb" id="Snippet0"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/rssformatter/vb/snippets.vb" id="Snippet0"::: + ]]> diff --git a/xml/System.ServiceModel.Syndication/Rss20ItemFormatter.xml b/xml/System.ServiceModel.Syndication/Rss20ItemFormatter.xml index 6769fc9c77f..0e3bd85d2a4 100644 --- a/xml/System.ServiceModel.Syndication/Rss20ItemFormatter.xml +++ b/xml/System.ServiceModel.Syndication/Rss20ItemFormatter.xml @@ -57,19 +57,19 @@ A class that serializes a instance to and from RSS 2.0 format. - and to create an instance of from an XML document that represents an RSS 2.0 item. If you have derived a class from and want to serialize it, use the formatter. - - - -## Examples - The following code shows how to create a instance and serialize it. - + and to create an instance of from an XML document that represents an RSS 2.0 item. If you have derived a class from and want to serialize it, use the formatter. + + + +## Examples + The following code shows how to create a instance and serialize it. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/rssformatter/cs/snippets.cs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/rssformatter/vb/snippets.vb" id="Snippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/rssformatter/vb/snippets.vb" id="Snippet7"::: + ]]> @@ -143,14 +143,14 @@ The to serialize. Creates a new instance of the class. - @@ -183,18 +183,18 @@ The instance derived from to associate with the . Creates a new instance of the class. - to instantiate when a syndication item is read in. - - - -## Examples - The following code shows how to use this constructor. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/rssformatter/cs/snippets.cs" id="Snippet16"::: - + to instantiate when a syndication item is read in. + + + +## Examples + The following code shows how to use this constructor. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/rssformatter/cs/snippets.cs" id="Snippet16"::: + ]]> @@ -229,19 +229,19 @@ A value that specifies whether to serialize elements that are defined in the Atom 1.0 specification but not in the RSS 2.0 specification. The default value is . Creates a new instance of the class. - @@ -278,13 +278,13 @@ Verifies whether the specified contains a valid RSS 2.0 syndication item. A value that specifies if the contains a valid RSS 2.0 syndication item. - method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/rssformatter/cs/snippets.cs" id="Snippet17"::: - + method. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/rssformatter/cs/snippets.cs" id="Snippet17"::: + ]]> @@ -318,11 +318,11 @@ Creates a new instance. A new instance. - instance is not automatically associated with the used to create it. - + instance is not automatically associated with the used to create it. + ]]> @@ -397,11 +397,11 @@ Gets or sets a value that specifies whether to preserve attribute extensions during serialization. A value that specifies whether to preserve attribute extensions during serialization. - instance when deserializing an RSS 2.0 item. - + instance when deserializing an RSS 2.0 item. + ]]> @@ -440,11 +440,11 @@ Gets or sets a value that specifies whether to preserve element extensions during serialization. A value that specifies whether to preserve element extensions during serialization. - instance when deserializing an RSS 2.0 item. - + instance when deserializing an RSS 2.0 item. + ]]> @@ -480,13 +480,13 @@ The to read from. Reads an RSS 2.0 syndication item from the specified instance. - method. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/rssformatter/cs/snippets.cs" id="Snippet18"::: - + method. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/rssformatter/cs/snippets.cs" id="Snippet18"::: + ]]> @@ -525,11 +525,11 @@ Gets or sets a value that specifies whether to serialize extensions within the Atom 1.0 namespace. A value that specifies whether to serialize extensions within the Atom 1.0 namespace. - class that cannot be represented in the RSS 2.0 format are serialized within the Atom 1.0 namespace; otherwise these properties are not be serialized. - + class that cannot be represented in the RSS 2.0 format are serialized within the Atom 1.0 namespace; otherwise these properties are not be serialized. + ]]> @@ -567,11 +567,11 @@ . - @@ -676,11 +676,11 @@ Gets the syndication version used by the formatter. The syndication version used by the formatter. - @@ -716,13 +716,13 @@ The to write to. Writes the associated with the to the specified . - to write the item to an . - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/rssformatter/cs/snippets.cs" id="Snippet19"::: - + to write the item to an . + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/rssformatter/cs/snippets.cs" id="Snippet19"::: + ]]> diff --git a/xml/System.ServiceModel.Syndication/SyndicationContent.xml b/xml/System.ServiceModel.Syndication/SyndicationContent.xml index 7debad8d821..783ad67ad8f 100644 --- a/xml/System.ServiceModel.Syndication/SyndicationContent.xml +++ b/xml/System.ServiceModel.Syndication/SyndicationContent.xml @@ -554,19 +554,19 @@ - This class contains a number of static helper methods for creating the various types of syndication content: -- +- -- +- -- +- -- +- -- +- -- +- -- +- ]]> diff --git a/xml/System.ServiceModel.Syndication/SyndicationFeedFormatter.xml b/xml/System.ServiceModel.Syndication/SyndicationFeedFormatter.xml index 2f8c208cb6a..e65e6f849cf 100644 --- a/xml/System.ServiceModel.Syndication/SyndicationFeedFormatter.xml +++ b/xml/System.ServiceModel.Syndication/SyndicationFeedFormatter.xml @@ -53,11 +53,11 @@ An abstract class used as a base class for other formatters, (for example ). - @@ -125,11 +125,11 @@ The to write. Creates a new instance of the class with the specified instance. - must have a associated with it. The can then write out the to an . The only way to associate a with a is by using this constructor. - + must have a associated with it. The can then write out the to an . The only way to associate a with a is by using this constructor. + ]]> @@ -167,11 +167,11 @@ , if the XML reader contains a valid syndication feed, otherwise . - @@ -217,11 +217,11 @@ Creates a new instance of the class using the specified instance. A new instance. - instance is not automatically added to the instance used to create it. - + instance is not automatically added to the instance used to create it. + ]]> @@ -258,11 +258,11 @@ Creates a new instance of the class using the specified instance. A new instance. - instance is not automatically added to the instance used to create it. - + instance is not automatically added to the instance used to create it. + ]]> @@ -296,11 +296,11 @@ Creates a new instance of the class. A new instance. - instance is not automatically added to the instance used to create it. - + instance is not automatically added to the instance used to create it. + ]]> @@ -337,11 +337,11 @@ Creates a new instance of the class using the specified instance. A new instance. - instance is not automatically added to the instance used to create it. - + instance is not automatically added to the instance used to create it. + ]]> @@ -387,11 +387,11 @@ Creates a new instance of the class with the specified . A new instance. - instance is not automatically added to the instance used to create it. - + instance is not automatically added to the instance used to create it. + ]]> @@ -428,11 +428,11 @@ Creates a new instance of the class with the specified . A new instance. - instance is not automatically added to the instance used to create it. - + instance is not automatically added to the instance used to create it. + ]]> @@ -478,11 +478,11 @@ Creates a new instance with the specified instance. A new instance. - instance is not automatically added to the instance used to create it. - + instance is not automatically added to the instance used to create it. + ]]> @@ -519,11 +519,11 @@ Creates a new instance with the specified instance. A new instance. - instance is not automatically added to the instance used to create it. - + instance is not automatically added to the instance used to create it. + ]]> @@ -553,11 +553,11 @@ Delegate that is used by the class for converting string data to . The that is used for converting string data from to a instance. - . - + ]]> @@ -596,11 +596,11 @@ Gets the associated with the formatter. The associated with the formatter. - is associated with the by passing in a instance to the constructor. - + is associated with the by passing in a instance to the constructor. + ]]> @@ -649,11 +649,11 @@ The maximum allowable size for an element extension (in bytes). Loads element extensions into the specified using the specified and maximum extension size. - . - + . + ]]> @@ -693,11 +693,11 @@ The maximum allowable size for an element extension (in bytes). Loads element extensions into the specified using the specified and maximum extension size. - . - + . + ]]> @@ -737,11 +737,11 @@ The maximum allowable size for an element extension (in bytes). Loads element extensions into the specified using the specified and maximum extension size. - . - + . + ]]> @@ -781,11 +781,11 @@ The maximum allowable size for an element extension (in bytes). Loads element extensions into the specified using the specified and maximum extension size. - . - + . + ]]> @@ -825,11 +825,11 @@ The maximum allowable size for an element extension (in bytes). Loads element extensions into the specified using the specified and maximum extension size. - . - + . + ]]> @@ -865,11 +865,11 @@ The to read from. Reads in a from the specified . - , associates it with the and reads the feed into the instance. - + , associates it with the and reads the feed into the instance. + ]]> Invalid XML encountered during read. @@ -906,11 +906,11 @@ The to associate with the . Associates a instance with the . - instance with a , either create a new instance and pass the constructor a instance or load a instance into the by calling the method. - + instance with a , either create a new instance and pass the constructor a instance or load a instance into the by calling the method. + ]]> @@ -996,11 +996,11 @@ if the attribute was parsed successfully; otherwise . - and override the method. - + and override the method. + ]]> @@ -1046,11 +1046,11 @@ if the attribute was parsed successfully; otherwise . - and override the method. - + and override the method. + ]]> @@ -1096,11 +1096,11 @@ if the attribute was parsed successfully; otherwise . - and override the method. - + and override the method. + ]]> @@ -1146,11 +1146,11 @@ if the attribute was parsed successfully; otherwise . - and override the method. - + and override the method. + ]]> @@ -1196,11 +1196,11 @@ if the attribute was parsed successfully; otherwise . - and override the method. - + and override the method. + ]]> @@ -1246,13 +1246,13 @@ if the content was parsed successfully; otherwise . - and override the - - method. - + and override the + + method. + ]]> @@ -1303,11 +1303,11 @@ if the element was parsed successfully; otherwise . - and override the method. - + and override the method. + ]]> @@ -1349,11 +1349,11 @@ if the element was parsed successfully; otherwise . - and override the method. - + and override the method. + ]]> @@ -1395,11 +1395,11 @@ if the element was parsed successfully; otherwise . - and override the method. - + and override the method. + ]]> @@ -1441,11 +1441,11 @@ if the element was parsed successfully; otherwise . - and override the method. - + and override the method. + ]]> @@ -1487,11 +1487,11 @@ if the element was parsed successfully; otherwise . - and override the method. - + and override the method. + ]]> @@ -1521,11 +1521,11 @@ Delegate that is used by the class for creating instances from string input. The that is used for creating Uri instances from string input. - contructor to parse the given string into a object. - + contructor to parse the given string into a object. + ]]> @@ -1558,11 +1558,11 @@ Gets the syndication version of the formatter. The syndication version of the formatter. - @@ -1611,11 +1611,11 @@ The syndication version to write the attribute extensions in. Writes the attribute extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> @@ -1655,11 +1655,11 @@ The syndication version to write the attribute extensions in. Writes the attribute extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> @@ -1699,11 +1699,11 @@ The syndication version to write the attribute extensions in. Writes the attribute extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> @@ -1743,11 +1743,11 @@ The syndication version to write the attribute extensions in. Writes the attribute extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> @@ -1787,11 +1787,11 @@ The syndication version to write the attribute extensions in. Writes the attribute extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> @@ -1840,11 +1840,11 @@ The syndication version the extensions are written in. Writes the element extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> @@ -1884,11 +1884,11 @@ The syndication version the extensions are written in. Writes the element extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> @@ -1928,11 +1928,11 @@ The syndication version the extensions are written in. Writes the element extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> @@ -1972,11 +1972,11 @@ The syndication version the extensions are written in. Writes the element extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> @@ -2016,11 +2016,11 @@ The syndication version the extensions are written in. Writes the element extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> diff --git a/xml/System.ServiceModel.Syndication/SyndicationItemFormatter.xml b/xml/System.ServiceModel.Syndication/SyndicationItemFormatter.xml index d857fd7b7b8..a451b99c2b4 100644 --- a/xml/System.ServiceModel.Syndication/SyndicationItemFormatter.xml +++ b/xml/System.ServiceModel.Syndication/SyndicationItemFormatter.xml @@ -53,11 +53,11 @@ An abstract class used as a base class for other formatters, (for example, ). - @@ -125,11 +125,11 @@ The to write. Creates a new instance of the class with the specified instance. - must have a associated with it. The can then write out the to an . The only way to associate a with a is by using this constructor. - + must have a associated with it. The can then write out the to an . The only way to associate a with a is by using this constructor. + ]]> @@ -201,11 +201,11 @@ Creates a new instance of the class using the specified instance. A new instance. - instance is not automatically added to the instance used to create it. - + instance is not automatically added to the instance used to create it. + ]]> @@ -239,11 +239,11 @@ Creates a new instance of the class. A new instance. - instance is not automatically added to the instance used to create it. - + instance is not automatically added to the instance used to create it. + ]]> @@ -280,11 +280,11 @@ Creates a new instance of the class. A new instance. - instance is not automatically added to the instance used to create it. - + instance is not automatically added to the instance used to create it. + ]]> @@ -321,11 +321,11 @@ Creates a new instance with the specified instance. A new instance. - instance is not automatically added to the instance used to create it. - + instance is not automatically added to the instance used to create it. + ]]> @@ -364,11 +364,11 @@ Gets the associated with the formatter. The associated with the formatter. - is associated with the by passing in a instance to the constructor. - + is associated with the by passing in a instance to the constructor. + ]]> @@ -417,11 +417,11 @@ The maximum allowable size for an element extension (in bytes). Loads element extensions into the specified using the specified and maximum extension size. - . - + . + ]]> @@ -461,11 +461,11 @@ The maximum allowable size for an element extension (in bytes). Loads element extensions into the specified using the specified and maximum extension size. - . - + . + ]]> @@ -505,11 +505,11 @@ The maximum allowable size for an element extension (in bytes). Loads element extensions into the specified using the specified and maximum extension size. - . - + . + ]]> @@ -549,11 +549,11 @@ The maximum allowable size for an element extension (in bytes). Loads element extensions into the specified using the specified and maximum extension size. - . - + . + ]]> Invalid XML encountered during read. @@ -590,11 +590,11 @@ The to read from. Reads in a from the specified . - , associates it with the and reads the feed into the instance. - + , associates it with the and reads the feed into the instance. + ]]> @@ -630,11 +630,11 @@ The to associate with the . Associates a instance with the . - instance with a , either create a new instance and pass the constructor a instance or load a instance into the by calling . - + instance with a , either create a new instance and pass the constructor a instance or load a instance into the by calling . + ]]> @@ -719,11 +719,11 @@ Attempts to parse an attribute extension using the specified instance. A value that indicates whether the attribute was parsed successfully. - and override the method. - + and override the method. + ]]> @@ -768,11 +768,11 @@ Attempts to parse an attribute extension using the specified instance. A value that indicates whether the attribute was parsed successfully. - and override the method. - + and override the method. + ]]> @@ -817,11 +817,11 @@ Attempts to parse an attribute extension using the specified instance. A value that indicates whether the attribute was parsed successfully. - and override the method. - + and override the method. + ]]> @@ -866,11 +866,11 @@ Attempts to parse an attribute extension using the specified instance. A value that indicates whether the attribute was parsed successfully. - and override the method. - + and override the method. + ]]> @@ -915,11 +915,11 @@ Attempts to parse syndication item content using the specified instance. A value that indicates whether the content was parsed successfully. - and override the method. - + and override the method. + ]]> @@ -969,11 +969,11 @@ Attempts to parse an element extension using the specified instance. A value that indicates whether the element was parsed successfully. - and override the method. - + and override the method. + ]]> @@ -1014,11 +1014,11 @@ Attempts to parse an element extension using the specified instance. A value that indicates whether the element was parsed successfully. - and override the method. - + and override the method. + ]]> @@ -1059,11 +1059,11 @@ Attempts to parse an element extension using the specified instance. A value that indicates whether the element was parsed successfully. - and override the method. - + and override the method. + ]]> @@ -1104,11 +1104,11 @@ Attempts to parse an element extension using the specified instance. A value that indicates whether the element was parsed successfully. - and override the method. - + and override the method. + ]]> @@ -1141,11 +1141,11 @@ Gets the syndication version of the formatter. The syndication version of the formatter. - @@ -1194,11 +1194,11 @@ The syndication version to write the attribute extensions in. Writes the attribute extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> @@ -1238,11 +1238,11 @@ The syndication version to write the attribute extensions in. Writes the attribute extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> @@ -1282,11 +1282,11 @@ The syndication version to write the attribute extensions in. Writes the attribute extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> @@ -1326,11 +1326,11 @@ The syndication version to write the attribute extensions in. Writes the attribute extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> @@ -1379,11 +1379,11 @@ The syndication version the extensions are written in. Writes the element extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> @@ -1423,11 +1423,11 @@ The syndication version the extensions are written in. Writes the element extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> @@ -1467,11 +1467,11 @@ The syndication version the extensions are written in. Writes the element extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> @@ -1511,11 +1511,11 @@ The syndication version the extensions are written in. Writes the element extensions in the instance to the specified in the specified syndication version. - , derive a class from and override the method. - + , derive a class from and override the method. + ]]> diff --git a/xml/System.ServiceModel.Syndication/SyndicationPerson.xml b/xml/System.ServiceModel.Syndication/SyndicationPerson.xml index c90395be6cf..504b3c94d10 100644 --- a/xml/System.ServiceModel.Syndication/SyndicationPerson.xml +++ b/xml/System.ServiceModel.Syndication/SyndicationPerson.xml @@ -56,7 +56,7 @@ When serialized to Atom 1.0, the is written out as an `` or `` element. - When serialized to RSS 2.0, a instance is written out as a ``, ``, or `` element. How a is serialized depends on the number of objects added to a or , which collection the instances are added to, and the value of the `SerializeExtensionAsAtom` parameter to the constructor. If only one is added to the (or ) collection, the is serialized to a `` element. If more than one is added to the (or ) collection and `SerializeExtensionsAsAtom` is set to `true`, all of the objects are serialized to `` elements. If `SerializeExtensionsAsAtom` is set to `false`, the instances is not serialized. Any instances added to the (or ) collection are only serialized if `SerializeExtensionsAsAtom` is set to `true`, in which case they are serialized to `` elements. + When serialized to RSS 2.0, a instance is written out as a ``, ``, or `` element. How a is serialized depends on the number of objects added to a or , which collection the instances are added to, and the value of the `SerializeExtensionAsAtom` parameter to the constructor. If only one is added to the (or ) collection, the is serialized to a `` element. If more than one is added to the (or ) collection and `SerializeExtensionsAsAtom` is set to `true`, all of the objects are serialized to `` elements. If `SerializeExtensionsAsAtom` is set to `false`, the instances is not serialized. Any instances added to the (or ) collection are only serialized if `SerializeExtensionsAsAtom` is set to `true`, in which case they are serialized to `` elements. diff --git a/xml/System.ServiceModel.Web/WebChannelFactory`1.xml b/xml/System.ServiceModel.Web/WebChannelFactory`1.xml index fef21187701..5f667f03795 100644 --- a/xml/System.ServiceModel.Web/WebChannelFactory`1.xml +++ b/xml/System.ServiceModel.Web/WebChannelFactory`1.xml @@ -34,12 +34,12 @@ ## Remarks This class is a special that automatically adds the to the endpoint if it is not already present. Furthermore, it adds a default to the endpoint if the binding is not explicitly configured and the address is an HTTP or HTTPS address. - If all the operations of the contract have no return value or have a return value of type , then the configures the binding for the appropriate content type. + If all the operations of the contract have no return value or have a return value of type , then the configures the binding for the appropriate content type. ## Examples - The following code shows how to use the class to call a WCF service. + The following code shows how to use the class to call a WCF service. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/basicwebprogramming/cs/snippets.cs" id="Snippet0"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/basicwebprogramming/vb/snippets.vb" id="Snippet0"::: @@ -100,7 +100,7 @@ and use it to call a WCF service. + The following code shows how use this constructor to create a and use it to call a WCF service. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/basicwebprogramming/cs/snippets.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/basicwebprogramming/vb/snippets.vb" id="Snippet1"::: @@ -132,7 +132,7 @@ and use it to call a WCF service. + The following code shows how use this constructor to create a and use it to call a WCF service. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/basicwebprogramming/cs/snippets.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/basicwebprogramming/vb/snippets.vb" id="Snippet2"::: @@ -169,7 +169,7 @@ ## Examples - The following code shows how use this constructor to create a instance and use it to call a WCF service. + The following code shows how use this constructor to create a instance and use it to call a WCF service. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/basicwebprogramming/cs/snippets.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/basicwebprogramming/vb/snippets.vb" id="Snippet3"::: @@ -230,7 +230,7 @@ instance and call a service. + The following code shows how to use this constructor to create a instance and call a service. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/basicwebprogramming/cs/snippets.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/basicwebprogramming/vb/snippets.vb" id="Snippet4"::: @@ -264,7 +264,7 @@ instance and call a service. + The following code shows how to use this constructor to create a instance and call a service. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/basicwebprogramming/cs/snippets.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/basicwebprogramming/vb/snippets.vb" id="Snippet5"::: @@ -303,7 +303,7 @@ ## Examples - The following code shows how to use this constructor to create a instance and call a service. + The following code shows how to use this constructor to create a instance and call a service. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/basicwebprogramming/cs/snippets.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/basicwebprogramming/vb/snippets.vb" id="Snippet6"::: @@ -335,7 +335,7 @@ is not already associated with a binding a new is created based on the URI scheme of the remote address. Bindings with an HTTPS remote address are appropriately configured with the property set to and the property set to `None`. The adds an instance of to the endpoint if one does not already exist. + When this method is called, if the is not already associated with a binding a new is created based on the URI scheme of the remote address. Bindings with an HTTPS remote address are appropriately configured with the property set to and the property set to `None`. The adds an instance of to the endpoint if one does not already exist. ]]> diff --git a/xml/System.ServiceModel/ActionNotSupportedException.xml b/xml/System.ServiceModel/ActionNotSupportedException.xml index 623d8ad9a34..51c57ef6d8f 100644 --- a/xml/System.ServiceModel/ActionNotSupportedException.xml +++ b/xml/System.ServiceModel/ActionNotSupportedException.xml @@ -76,11 +76,11 @@ constructor. + If you want to pass an error message to the user, use the constructor. - If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. + If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. - If you want to pass serialization information and streaming context, use the constructor. + If you want to pass serialization information and streaming context, use the constructor. ]]> diff --git a/xml/System.ServiceModel/AddressAccessDeniedException.xml b/xml/System.ServiceModel/AddressAccessDeniedException.xml index a9affc0fbda..41fb284287a 100644 --- a/xml/System.ServiceModel/AddressAccessDeniedException.xml +++ b/xml/System.ServiceModel/AddressAccessDeniedException.xml @@ -53,11 +53,11 @@ constructor. + If you want to pass an error message to the user, use the constructor. - If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. + If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. - If you want to pass serialization information and streaming context, use the constructor. + If you want to pass serialization information and streaming context, use the constructor. ]]> @@ -126,7 +126,7 @@ ## Remarks Use this constructor when you want to pass an error message to the user. The content of the message parameter should be understandable to the user. The caller of this constructor is required to ensure that this string is understandable to the intended users. - If you also want to pass a reference to the inner exception that is the cause of the exception as well as a specified error message to the user, use the constructor. + If you also want to pass a reference to the inner exception that is the cause of the exception as well as a specified error message to the user, use the constructor. ]]> diff --git a/xml/System.ServiceModel/AddressAlreadyInUseException.xml b/xml/System.ServiceModel/AddressAlreadyInUseException.xml index 8a9e1c1d5f6..4017b2a82de 100644 --- a/xml/System.ServiceModel/AddressAlreadyInUseException.xml +++ b/xml/System.ServiceModel/AddressAlreadyInUseException.xml @@ -43,11 +43,11 @@ constructor. + If you want to pass an error message to the user, use the constructor. - If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. + If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. - If you want to pass serialization information and streaming context, use the constructor. + If you want to pass serialization information and streaming context, use the constructor. ]]> diff --git a/xml/System.ServiceModel/BasicHttpBinding.xml b/xml/System.ServiceModel/BasicHttpBinding.xml index 4e79e0bc132..e3c5d560508 100644 --- a/xml/System.ServiceModel/BasicHttpBinding.xml +++ b/xml/System.ServiceModel/BasicHttpBinding.xml @@ -56,25 +56,25 @@ Represents a binding that a Windows Communication Foundation (WCF) service can use to configure and expose endpoints that are able to communicate with ASMX-based Web services and clients and other services that conform to the WS-I Basic Profile 1.1. - uses HTTP as the transport for sending SOAP 1.1 messages. A service can use this binding to expose endpoints that conform to WS-I BP 1.1, such as those that ASMX clients access. Similarly, a client can use the to communicate with services exposing endpoints that conform to WS-I BP 1.1, such as ASMX Web services or Windows Communication Foundation (WCF) services configured with the . - - Security is turned off by default, but can be added setting the to a value other than in the constructor. It uses a "Text" message encoding and UTF-8 text encoding by default. - - - -## Examples - The following example shows how to configure the in an application configuration file. - - - - The following example shows how to programmatically configure . - + uses HTTP as the transport for sending SOAP 1.1 messages. A service can use this binding to expose endpoints that conform to WS-I BP 1.1, such as those that ASMX clients access. Similarly, a client can use the to communicate with services exposing endpoints that conform to WS-I BP 1.1, such as ASMX Web services or Windows Communication Foundation (WCF) services configured with the . + + Security is turned off by default, but can be added setting the to a value other than in the constructor. It uses a "Text" message encoding and UTF-8 text encoding by default. + + + +## Examples + The following example shows how to configure the in an application configuration file. + + + + The following example shows how to programmatically configure . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uebasichttpbinding/cs/service.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebasichttpbinding/vb/service.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebasichttpbinding/vb/service.vb" id="Snippet1"::: + ]]> @@ -123,17 +123,17 @@ Initializes a new instance of the class. - used is , which specifies that the SOAP message is not secured and the client is not authenticated. - - - -## Examples + used is , which specifies that the SOAP message is not secured and the client is not authenticated. + + + +## Examples :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uebasichttpbinding/cs/service.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebasichttpbinding/vb/service.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebasichttpbinding/vb/service.vb" id="Snippet2"::: + ]]> @@ -170,17 +170,17 @@ The value of that specifies the type of security that is used with the SOAP message and for the client. Initializes a new instance of the class with a specified type of security used by the binding. - used is , which specifies that the SOAP message is not secured and the client is not authenticated. - - - -## Examples + used is , which specifies that the SOAP message is not secured and the client is not authenticated. + + + +## Examples :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uebasichttpbinding/cs/snippets.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebasichttpbinding/vb/snippets.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebasichttpbinding/vb/snippets.vb" id="Snippet3"::: + ]]> @@ -208,19 +208,19 @@ The binding configuration name for the . Initializes a new instance of the class with a binding specified by its configuration name. - class with a binding specified by the configuration name `myBinding`. You must create a bindings section in the service's configuration file. - + class with a binding specified by the configuration name `myBinding`. You must create a bindings section in the service's configuration file. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uebasichttpbinding/cs/snippets.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebasichttpbinding/vb/snippets.vb" id="Snippet5"::: - - Then the name of the binding configuration is specified in the call to the constructor. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebasichttpbinding/vb/snippets.vb" id="Snippet5"::: + + Then the name of the binding configuration is specified in the call to the constructor. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uebasichttpbinding/cs/snippets.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebasichttpbinding/vb/snippets.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uebasichttpbinding/vb/snippets.vb" id="Snippet4"::: + ]]> The binding with the configuration name was not found. @@ -256,11 +256,11 @@ if cookies are allowed; otherwise, . The default is . - to bypass the proxy server for local addresses; otherwise, . The default value is . - - @@ -425,18 +425,18 @@ The value of this property can also be set in the configuration file. Creates and returns an ordered collection of binding elements contained in the current binding. The that contains the ordered stack of binding elements described by the . - . - - - -## Examples - The following example creates an ordered collection of the binding elements in the current binding. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uebasichttpbinding/cs/client.cs" id="Snippet26"::: - + . + + + +## Examples + The following example creates an ordered collection of the binding elements in the current binding. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uebasichttpbinding/cs/client.cs" id="Snippet26"::: + ]]> @@ -499,9 +499,9 @@ The value of this property can also be set in the configuration file. Gets the version of SOAP that is used for messages that are processed by this binding. The value of the that is used with this binding. The value is always SOAP 1.1. - Gets or sets a value that indicates whether the hostname is used to reach the service when matching the URI.
 The value that indicates whether the hostname is used to reach the service when matching on the URI. The default value is , which ignores the hostname in the match. - Gets or sets the maximum amount of memory, in bytes, that is allocated for use by the manager of the message buffers that receive messages from the channel. The maximum amount of memory, in bytes, available for use by the message buffer manager. The default value is 524288 (0x80000) bytes. - minimizes the cost of using buffers by using a buffer pool. -Buffers are required to process messages by the service when they come out of the channel. -If there is not sufficient memory in the buffer pool to process the message load, the must allocate additional memory from the CLR heap, which increases the garbage collection overhead. +The minimizes the cost of using buffers by using a buffer pool. +Buffers are required to process messages by the service when they come out of the channel. +If there is not sufficient memory in the buffer pool to process the message load, the must allocate additional memory from the CLR heap, which increases the garbage collection overhead. Extensive allocation from the CLR garbage heap is an indication that the buffer pool size is too small and that performance can be improved with a larger allocation by increasing the MaxBufferPoolSize limit. ## Examples @@ -677,30 +677,30 @@ The value of this property can also be set in the configuration file. Gets or sets the maximum size, in bytes, for a buffer that receives messages from the channel. The maximum size, in bytes, of a buffer that stores messages while they are processed for an endpoint configured with this binding. The default value is 65,536 bytes. - set to ), this value is always equal to that specified by the property. -- For streamed transports ( set to ), only the SOAP headers must be buffered to generate the message. +- For streamed transports ( set to ), only the SOAP headers must be buffered to generate the message. The body can be streamed in on-demand. In this case, MaxBufferSize is less than or equal to , where bounds the size of the overall message (headers and body) and MaxBufferSize bounds only the size of the SOAP headers. -The limitations on buffer size set here are for optimizing the performance of message exchanges. -If a message exceeds the maximum value set for the buffer, it is not dropped. +The limitations on buffer size set here are for optimizing the performance of message exchanges. +If a message exceeds the maximum value set for the buffer, it is not dropped. Instead, more memory is requested from the CLR heap and this incurs more garbage collection overhead than using the buffers. > [!NOTE] -> The settings for MaxBufferSize and MaxReceivedMessageSize, are local behavioral settings. -> This means that they are not transmitted to other endpoints in metadata. -> If you generate a proxy to a service with a maximum message size of 2GB from metadata, the proxy still has a default value of 64K. +> The settings for MaxBufferSize and MaxReceivedMessageSize, are local behavioral settings. +> This means that they are not transmitted to other endpoints in metadata. +> If you generate a proxy to a service with a maximum message size of 2GB from metadata, the proxy still has a default value of 64K. > This leaves control of the appropriate bounds for message and message buffer size in the scope of local administrators. - + ## Examples @@ -708,7 +708,7 @@ The following example sets **MaxBufferSize** to 1,000,000 bytes. ```csharp BasicHttpBinding binding = new BasicHttpBinding(); - + // set to one million binding.MaxBufferSize = 1000000; ``` @@ -748,20 +748,20 @@ The value of this property can also be set in the configuration file. Gets or sets the maximum size, in bytes, for a message that can be received on a channel configured with this binding. The maximum size, in bytes, for a message that is processed by the binding. The default value is 65,536 bytes. - property on the : -For buffered transports, ( set to ). +For buffered transports, ( set to ). This value is always equal to that specified by the MaxReceivedMessageSize. -For streamed transports ( set to ), only the SOAP headers must be buffered to generate the message. -The body can be streamed in on-demand. In this case, is less than or equal to MaxReceivedMessageSize, +For streamed transports ( set to ), only the SOAP headers must be buffered to generate the message. +The body can be streamed in on-demand. In this case, is less than or equal to MaxReceivedMessageSize, where MaxReceivedMessageSize bounds the size of the overall message (headers and body) and bounds the size of the SOAP headers. ## Examples @@ -842,17 +842,17 @@ The value of this property can also be set in the configuration file. Gets or sets whether MTOM or Text is used to encode SOAP messages. The value of that indicates whether MTOM or Text/XML is used to encode SOAP messages. The default value is . - @@ -890,9 +890,9 @@ The value of this property can also be set in the configuration file. Gets or sets the URI address of the HTTP proxy. A that serves as the address of the HTTP proxy. The default value is null. - is set to `true`, the default address is used and the value of the ProxyAddress set is ignored. @@ -956,11 +956,11 @@ The value of this property can also be set in the configuration file. Gets or sets constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding. The that specifies the complexity constraints. - - @@ -1024,8 +1024,8 @@ The value of this property can also be set in the configuration file. Gets the URI transport scheme for the channels and listeners that are configured with this binding. "https" if the security mode in the transport binding element is set to or ; "http" otherwise. - Gets the type of security used with this binding. The that is used with this binding. The default value is . - constructor. - - - -## Examples - The following example gets the `Security` property. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uebasichttpbinding/cs/client.cs" id="Snippet23"::: - + constructor. + + + +## Examples + The following example gets the `Security` property. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uebasichttpbinding/cs/client.cs" id="Snippet23"::: + ]]> @@ -1251,8 +1251,8 @@ string thisScheme = binding.Scheme; Gets a value that indicates whether incoming requests are handled synchronously or asynchronously. Always . - Gets or sets the character encoding that is used for the message text. The that indicates the character encoding that is used. The default is . - . @@ -1360,8 +1360,8 @@ The value of this property can also be set in the configuration file. Gets or sets a value that indicates whether messages are sent buffered or streamed. The that indicates whether messages are sent buffered or streamed. - . @@ -1407,7 +1407,7 @@ The value of this property can also be set in the configuration file. if the auto-configured HTTP proxy of the system should be used, if available; otherwise, . The default value is . - is set to `true`, synchronizes all calls to the service to run on the user interface thread. - Note that the thread used is the current synchronization thread when or is called. In the case of an Windows Forms application, this means that these calls should occur after a call to the method. + Note that the thread used is the current synchronization thread when or is called. In the case of an Windows Forms application, this means that these calls should occur after a call to the method. diff --git a/xml/System.ServiceModel/ChannelFactory.xml b/xml/System.ServiceModel/ChannelFactory.xml index b28bcd61bc8..9a5d74079ee 100644 --- a/xml/System.ServiceModel/ChannelFactory.xml +++ b/xml/System.ServiceModel/ChannelFactory.xml @@ -70,7 +70,7 @@ ## Remarks Channel factories that implement the interface and their associated channels are generally used by the initiators of a communication pattern. Listener factories that implement the interface and their associated listeners provide the mechanisms with which channels are accepted for communications. - This class is not part of the channel model, but of the service model. The method provides the means to create an for a service endpoint. Use it to construct a client that hooks up to an interface contract on the service without using metadata or policy. + This class is not part of the channel model, but of the service model. The method provides the means to create an for a service endpoint. Use it to construct a client that hooks up to an interface contract on the service without using metadata or policy. > [!NOTE] > Setting `ChannelFactory.Credentials.Windows.AllowedImpersonationLevel` to `TokenImpersonationLevel.Anonymous` always results in an anonymous logon regardless of impersonation level. @@ -80,7 +80,7 @@ - Put your cleanup code in (On)(Begin)Close (and/or OnAbort), not in a destructor. - Avoid destructors; they cause the compiler to auto-generate . - Avoid non-reference members; they can cause the compiler to auto-generate . -- Avoid using a finalizer; but if you include one, you should suppress the build warning and call and the finalizer itself from (On)(Begin)Close (and/or OnAbort) to emulate what would have been the auto-generated behavior. +- Avoid using a finalizer; but if you include one, you should suppress the build warning and call and the finalizer itself from (On)(Begin)Close (and/or OnAbort) to emulate what would have been the auto-generated behavior. When adding behaviors programmatically, the behavior is added to the appropriate `Behaviors` property on the prior to the creation of any channel. See the example section for a code sample. @@ -282,9 +282,9 @@ ## Remarks The object is stored as a type of endpoint behavior and can be accessed through the property. - The method initializes a read-only copy of the object for the factory. + The method initializes a read-only copy of the object for the factory. - The object is used by the class (or a class that derives from this class) to create the proxy objects that can call services. The object is also accessible through the property. + The object is used by the class (or a class that derives from this class) to create the proxy objects that can call services. The object is also accessible through the property. > [!NOTE] > Setting `ChannelFactory.Credentials.Windows.AllowedImpersonationLevel` to `TokenImpersonationLevel.Anonymous` always results in an anonymous logon regardless of impersonation level. @@ -572,7 +572,7 @@ if you have just the binding. Use if you have the configuration. + Use if you have just the binding. Use if you have the configuration. ]]> @@ -620,7 +620,7 @@ if you have the configuration. + Use if you have the configuration. ]]> @@ -665,7 +665,7 @@ if you have just the binding. + Use if you have just the binding. ]]> @@ -706,7 +706,7 @@ method is called on a factory after it transitions to the closing state if the method is invoked. + The method is called on a factory after it transitions to the closing state if the method is invoked. ]]> @@ -994,7 +994,7 @@ method, which is called during the transition of an object into the opened state. The object is stored as a type of endpoint behavior and can be accessed through the property. + Overrides and invokes the method, which is called during the transition of an object into the opened state. The object is stored as a type of endpoint behavior and can be accessed through the property. ]]> diff --git a/xml/System.ServiceModel/ChannelFactory`1.xml b/xml/System.ServiceModel/ChannelFactory`1.xml index 3901450d6a9..406c7cc6b07 100644 --- a/xml/System.ServiceModel/ChannelFactory`1.xml +++ b/xml/System.ServiceModel/ChannelFactory`1.xml @@ -124,7 +124,7 @@ class with the `IRequestChannel` interface. + This example shows how to create a new object of the class with the `IRequestChannel` interface. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uechannels/cs/clientsnippets.cs" id="Snippet24"::: diff --git a/xml/System.ServiceModel/ChannelTerminatedException.xml b/xml/System.ServiceModel/ChannelTerminatedException.xml index e1d4fc1c2d2..0da50e5e097 100644 --- a/xml/System.ServiceModel/ChannelTerminatedException.xml +++ b/xml/System.ServiceModel/ChannelTerminatedException.xml @@ -68,11 +68,11 @@ constructor. + If you want to pass an error message to the user, use the constructor. - If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. + If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. - If you want to pass serialization information and streaming context, use the constructor. + If you want to pass serialization information and streaming context, use the constructor. ]]> diff --git a/xml/System.ServiceModel/ClientBase`1.xml b/xml/System.ServiceModel/ClientBase`1.xml index df19ff241b2..0d434b2dac4 100644 --- a/xml/System.ServiceModel/ClientBase`1.xml +++ b/xml/System.ServiceModel/ClientBase`1.xml @@ -78,21 +78,21 @@ class to create a custom WCF client object that can be used to connect to a service. Typically, the WCF client base class is extended by a tool such as the [ServiceModel Metadata Utility Tool (Svcutil.exe)](/dotnet/framework/wcf/servicemodel-metadata-utility-tool-svcutil-exe) on your behalf. For an example, see the Example section. + Extend the class to create a custom WCF client object that can be used to connect to a service. Typically, the WCF client base class is extended by a tool such as the [ServiceModel Metadata Utility Tool (Svcutil.exe)](/dotnet/framework/wcf/servicemodel-metadata-utility-tool-svcutil-exe) on your behalf. For an example, see the Example section. - The class can be used quickly and easily by developers who prefer objects to the use of the interfaces and the class. In all cases this class wraps or exposes the methods and functionality of the class and the interface. + The class can be used quickly and easily by developers who prefer objects to the use of the interfaces and the class. In all cases this class wraps or exposes the methods and functionality of the class and the interface. - As when using the class, you can create the class and modify the endpoint, channel factory, or security information prior to making any calls or calling . For more information, see [WCF Client Overview](/dotnet/framework/wcf/wcf-client-overview) and [Accessing Services Using a WCF Client](/dotnet/framework/wcf/accessing-services-using-a-wcf-client). + As when using the class, you can create the class and modify the endpoint, channel factory, or security information prior to making any calls or calling . For more information, see [WCF Client Overview](/dotnet/framework/wcf/wcf-client-overview) and [Accessing Services Using a WCF Client](/dotnet/framework/wcf/accessing-services-using-a-wcf-client). Special note for Managed C++ users deriving from this class: - Put your clean-up code in (On)(Begin)Close (and/or OnAbort), not in a destructor. - Avoid destructors: they cause the compiler to auto-generate . - Avoid non-reference members: they can cause the compiler to auto-generate . -- Avoid finalizers; but if you include one, you should suppress the build warning and call and the finalizer itself from (On)(Begin)Close (and/or OnAbort) to emulate what would have been the auto-generated behavior. +- Avoid finalizers; but if you include one, you should suppress the build warning and call and the finalizer itself from (On)(Begin)Close (and/or OnAbort) to emulate what would have been the auto-generated behavior. ## Examples - The following code example shows how the [ServiceModel Metadata Utility Tool (Svcutil.exe)](/dotnet/framework/wcf/servicemodel-metadata-utility-tool-svcutil-exe) extends the class to create a WCF client class. + The following code example shows how the [ServiceModel Metadata Utility Tool (Svcutil.exe)](/dotnet/framework/wcf/servicemodel-metadata-utility-tool-svcutil-exe) extends the class to create a WCF client class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/clientbase/cs/clientbase.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/clientbase/vb/clientbase.vb" id="Snippet1"::: @@ -113,7 +113,7 @@ where the type parameter is the type of the target service contract. + Use to create a WCF client object from the endpoint information in the application configuration file. The main function of the constructor is to create a where the type parameter is the type of the target service contract. ]]> @@ -155,7 +155,7 @@ ## Examples - The following code example shows how a client uses this constructor in a `SampleServiceClient` class that extends the class. + The following code example shows how a client uses this constructor in a `SampleServiceClient` class that extends the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/servicecontractattribute/cs/client.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/servicecontractattribute/vb/client.vb" id="Snippet3"::: @@ -767,12 +767,12 @@ property to configure the credentials that the object uses to connect to the service. + Use the property to configure the credentials that the object uses to connect to the service. ## Examples - The following code shows how to use the property to set the username and password prior to calling the service. + The following code shows how to use the property to set the username and password prior to calling the service. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_programmingsecurity/cs/source.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/c_programmingsecurity/vb/source.vb" id="Snippet4"::: @@ -891,7 +891,7 @@ can be expected here. + Returns the channel created by the inner channel factory. Exceptions thrown by can be expected here. ]]> @@ -923,7 +923,7 @@ method if the inner channel requires user interaction prior to constructing the channel. For example, if a user must enter a username and password to secure the channel, that custom can be invoked by calling this method. + Call the method if the inner channel requires user interaction prior to constructing the channel. For example, if a user must enter a username and password to secure the channel, that custom can be invoked by calling this method. ]]> @@ -965,7 +965,7 @@ property to obtain the object to inspect or modify prior to using the object. + Use the property to obtain the object to inspect or modify prior to using the object. ]]> @@ -1046,7 +1046,7 @@ property to obtain the that is used to connect to the service. + Use the property to obtain the that is used to connect to the service. ]]> @@ -1098,7 +1098,7 @@ , and when each operation is completed, your event handler can determine which instance of the operation raised the completion event. + Provide a unique value, such as a GUID or hash code, in the `userState` parameter for each call to , and when each operation is completed, your event handler can determine which instance of the operation raised the completion event. ]]> diff --git a/xml/System.ServiceModel/CommunicationException.xml b/xml/System.ServiceModel/CommunicationException.xml index 24a4d300cff..3d75e914689 100644 --- a/xml/System.ServiceModel/CommunicationException.xml +++ b/xml/System.ServiceModel/CommunicationException.xml @@ -61,9 +61,9 @@ objects that may be thrown during communication. There are also two -derived exception types ( and ) that clients also often expect. Therefore, in order to prevent the generic handler from catching these more specific exception types, catch these exceptions prior to handling . + Robust client and service Windows Communication Foundation (WCF) applications handle objects that may be thrown during communication. There are also two -derived exception types ( and ) that clients also often expect. Therefore, in order to prevent the generic handler from catching these more specific exception types, catch these exceptions prior to handling . -- objects are thrown on the client when a SOAP fault that is specified in the operation contract is received in response to a two-way operation (that is, a method with an attribute with set to `false`). +- objects are thrown on the client when a SOAP fault that is specified in the operation contract is received in response to a two-way operation (that is, a method with an attribute with set to `false`). objects are thrown when a listener receives a SOAP fault that is not expected or specified in the operation contract. This usually occurs when the application is being debugged and the service has the property set to `true`. diff --git a/xml/System.ServiceModel/CommunicationObjectAbortedException.xml b/xml/System.ServiceModel/CommunicationObjectAbortedException.xml index 272756c790f..42858eb295c 100644 --- a/xml/System.ServiceModel/CommunicationObjectAbortedException.xml +++ b/xml/System.ServiceModel/CommunicationObjectAbortedException.xml @@ -53,11 +53,11 @@ The exception that is thrown when the call is to an object that has aborted. - is a derived class of and can occur in correct applications. Because typically the code that calls the method reports the error condition that caused the call to , this exception indicates that the call failed but the most useful error information is elsewhere. - + is a derived class of and can occur in correct applications. Because typically the code that calls the method reports the error condition that caused the call to , this exception indicates that the call failed but the most useful error information is elsewhere. + ]]> @@ -146,11 +146,11 @@ The message carried in the exception. Initializes a new instance of the class with the specified message. - using the specified `message`. - + using the specified `message`. + ]]> @@ -192,11 +192,11 @@ The that contains contextual information about the source or destination. Initializes a new instance of the class used to deserialize data into a object. - @@ -241,11 +241,11 @@ The inner exception. Initializes a new instance of the class using the specified message and inner exception. - using the specified `message` and `innerException`. - + using the specified `message` and `innerException`. + ]]> diff --git a/xml/System.ServiceModel/CommunicationObjectFaultedException.xml b/xml/System.ServiceModel/CommunicationObjectFaultedException.xml index f21b415d5d3..ddfd55ddf61 100644 --- a/xml/System.ServiceModel/CommunicationObjectFaultedException.xml +++ b/xml/System.ServiceModel/CommunicationObjectFaultedException.xml @@ -53,14 +53,14 @@ The exception that is thrown when a call is made to a communication object that has faulted. - is thrown when a call is made to a faulted communication object. is a derived class of and can occur in correct applications. Because typically the code that calls the method reports the error condition that caused the call to , this exception indicates that the call failed but the most useful error information is elsewhere. - + is thrown when a call is made to a faulted communication object. is a derived class of and can occur in correct applications. Because typically the code that calls the method reports the error condition that caused the call to , this exception indicates that the call failed but the most useful error information is elsewhere. + > [!NOTE] -> If an object is faulted with several pending calls, only one call throws a specific exception; the others throw . - +> If an object is faulted with several pending calls, only one call throws a specific exception; the others throw . + ]]> @@ -109,11 +109,11 @@ Initializes a new instance of the class. - . - + . + ]]> @@ -156,11 +156,11 @@ The message that describes the exception. Initializes a new instance of the class using the specified message. - using the specified `message`. - + using the specified `message`. + ]]> @@ -202,11 +202,11 @@ The context within which the exception object is created. Initializes a new instance of the class when deserializing a stream using the specified and objects. - object from a stream. - + object from a stream. + ]]> @@ -251,11 +251,11 @@ The inner exception. Initializes a new instance of the class using the specified message and inner exception. - using the specified `message` and `innerException`. - + using the specified `message` and `innerException`. + ]]> diff --git a/xml/System.ServiceModel/CommunicationState.xml b/xml/System.ServiceModel/CommunicationState.xml index 0c856d68d71..a272d73cb1e 100644 --- a/xml/System.ServiceModel/CommunicationState.xml +++ b/xml/System.ServiceModel/CommunicationState.xml @@ -70,21 +70,21 @@ The communication object can be configured in the Created state. For example, its properties can be changed, and its events can be registered. No input or output can occur in this state. So messages, for example, cannot be sent or received from a channel in this state. - The Opening is a temporary state that the communication object enters when the method is invoked. Unless otherwise noted on derived classes, objects in the opening state cannot be configured. This transition state can only be entered from the Created state. + The Opening is a temporary state that the communication object enters when the method is invoked. Unless otherwise noted on derived classes, objects in the opening state cannot be configured. This transition state can only be entered from the Created state. Objects transition to the Opened state when the open process completes. This transition to the Opened state is only valid from the Opening state. Unless otherwise noted on derived classes, the configuration of the object is now disabled. At this point, the object is fully usable for message transfers. - The Closing is a temporary state that the object enters when the method is invoked for a graceful shutdown or the object is aborted. At this point, the object becomes (if not already) unusable. This transition is valid from any state except the Closed state. + The Closing is a temporary state that the object enters when the method is invoked for a graceful shutdown or the object is aborted. At this point, the object becomes (if not already) unusable. This transition is valid from any state except the Closed state. The Closed state is equivalent to being disposed and the configuration of the object can still be inspected. The Faulted state is used to indicate that the object has transitioned to a state where it can no longer be used. There are two primary scenarios where this can happen: -- If the method fails for any reason, the object transitions to the faulted state. +- If the method fails for any reason, the object transitions to the faulted state. - If a session-based channel detects an error that it cannot recover from, it transitions to the faulted state. This can happen for instance if there is a protocol error (that is, it receives a protocol message at an invalid time) or if the remote endpoint aborts the session. - An object in the Faulted state is not closed and may be holding resources. The method should be used to close an object that has faulted. If is called on an object in the Faulted state, a is thrown because the object cannot be gracefully closed. + An object in the Faulted state is not closed and may be holding resources. The method should be used to close an object that has faulted. If is called on an object in the Faulted state, a is thrown because the object cannot be gracefully closed. ]]> diff --git a/xml/System.ServiceModel/CorrelationActionMessageFilter.xml b/xml/System.ServiceModel/CorrelationActionMessageFilter.xml index e1972c55ff5..8c546f047c8 100644 --- a/xml/System.ServiceModel/CorrelationActionMessageFilter.xml +++ b/xml/System.ServiceModel/CorrelationActionMessageFilter.xml @@ -226,7 +226,7 @@ property is set, its value is used to build the string representation; otherwise, the base class value is returned. + If the property is set, its value is used to build the string representation; otherwise, the base class value is returned. ]]> diff --git a/xml/System.ServiceModel/CorrelationQuery.xml b/xml/System.ServiceModel/CorrelationQuery.xml index aa86873b074..84d786347f2 100644 --- a/xml/System.ServiceModel/CorrelationQuery.xml +++ b/xml/System.ServiceModel/CorrelationQuery.xml @@ -16,13 +16,13 @@ Represents a clause and a clause that identify the unique characteristics of a message so that it can be routed to the correct instance. - is a set of queries that are run on an incoming or outgoing message to generate a set of instance keys. An represents an association between the data selected from the query and a particular service instance. - - The clause allows the user to filter the set of messages that this runs on. The clause represents the query set used to uniquely identify the service instance for which an incoming message should be dispatched. The clauses are a set of query sets that represent new instance keys that must be created to associate that data with the service instance. - + is a set of queries that are run on an incoming or outgoing message to generate a set of instance keys. An represents an association between the data selected from the query and a particular service instance. + + The clause allows the user to filter the set of messages that this runs on. The clause represents the query set used to uniquely identify the service instance for which an incoming message should be dispatched. The clauses are a set of query sets that represent new instance keys that must be created to associate that data with the service instance. + ]]> @@ -74,11 +74,11 @@ if the current is equal to the specified object; otherwise, . - instances are considered equal if their clauses are equal. - + instances are considered equal if their clauses are equal. + ]]> @@ -103,11 +103,11 @@ Returns the hash code for the current . The hash code for the current . - returns a hash code based on the value of the clause. - + returns a hash code based on the value of the clause. + ]]> diff --git a/xml/System.ServiceModel/DnsEndpointIdentity.xml b/xml/System.ServiceModel/DnsEndpointIdentity.xml index 1b3290d0094..bb688905569 100644 --- a/xml/System.ServiceModel/DnsEndpointIdentity.xml +++ b/xml/System.ServiceModel/DnsEndpointIdentity.xml @@ -52,11 +52,11 @@ Specifies the DNS identity of the server. - @@ -101,11 +101,11 @@ The . Initializes a new instance of the class from a claim. - method. - + method. + ]]> @@ -153,11 +153,11 @@ The DNS name. Initializes a new instance of this class from a DNS name. - method. - + method. + ]]> diff --git a/xml/System.ServiceModel/DuplexChannelFactory`1.xml b/xml/System.ServiceModel/DuplexChannelFactory`1.xml index 9674d9764fe..30cfd932af8 100644 --- a/xml/System.ServiceModel/DuplexChannelFactory`1.xml +++ b/xml/System.ServiceModel/DuplexChannelFactory`1.xml @@ -62,7 +62,7 @@ methods are used to create these duplex channels. The duplex message pattern is one of three message patterns available to Windows Communication Foundation (WCF) services. The other two message patterns are one-way and request-reply. + A duplex channel allows clients and servers to communicate with each other independently so that either can initiate calls to the other. A duplex service can send messages to the client endpoint, providing event-like behavior. Duplex communication occurs when a client establishes a session with a service and provides the service with a channel on which the service can send messages back to the client. The various methods are used to create these duplex channels. The duplex message pattern is one of three message patterns available to Windows Communication Foundation (WCF) services. The other two message patterns are one-way and request-reply. For a general discussion of duplex services that allow clients to connect back to the service, see [Duplex Services](/dotnet/framework/wcf/feature-details/duplex-services). For an outline and discussion of the steps involved in writing a Windows Communication Foundation (WCF) client application using a channel factory, see [How to: Use the ChannelFactory](/dotnet/framework/wcf/feature-details/how-to-use-the-channelfactory). For a procedure describing how to create a Windows Communication Foundation (WCF) client in a client class that implements the callback interface to access a service that uses a duplex messaging pattern, see [How to: Access Services with a Duplex Contract](/dotnet/framework/wcf/feature-details/how-to-access-services-with-a-duplex-contract). diff --git a/xml/System.ServiceModel/DuplexClientBase`1.xml b/xml/System.ServiceModel/DuplexClientBase`1.xml index 2142cf18efb..024a4936f4a 100644 --- a/xml/System.ServiceModel/DuplexClientBase`1.xml +++ b/xml/System.ServiceModel/DuplexClientBase`1.xml @@ -66,14 +66,14 @@ class to create a channel to a service that specifies a callback object. The object wraps a object, which provides the connectivity for the WCF object. You can use either type to connect to a duplex service. For more information about duplex services, see [Duplex Services](/dotnet/framework/wcf/feature-details/duplex-services). + Use the class to create a channel to a service that specifies a callback object. The object wraps a object, which provides the connectivity for the WCF object. You can use either type to connect to a duplex service. For more information about duplex services, see [Duplex Services](/dotnet/framework/wcf/feature-details/duplex-services). Special note for Managed C++ users deriving from this class: - Put your cleanup code in (On)(Begin)Close (and/or OnAbort), not in a destructor. - Avoid destructors: they cause the compiler to auto-generate . - Avoid non-reference members: they can cause the compiler to auto-generate . -- Avoid finalizers; but if you include one, you should suppress the build warning and call and the finalizer itself from (On)(Begin)Close (and/or OnAbort) in order to emulate what would have been the auto-generated behavior. +- Avoid finalizers; but if you include one, you should suppress the build warning and call and the finalizer itself from (On)(Begin)Close (and/or OnAbort) in order to emulate what would have been the auto-generated behavior. ## Examples The following example shows the use in the client of a duplex WCF client type, the `SampleDuplexHelloClient`, to pass a new object with the callback object to listen for callbacks. diff --git a/xml/System.ServiceModel/EndpointAddress.xml b/xml/System.ServiceModel/EndpointAddress.xml index 04aac80b82d..255b08bd796 100644 --- a/xml/System.ServiceModel/EndpointAddress.xml +++ b/xml/System.ServiceModel/EndpointAddress.xml @@ -410,7 +410,7 @@ method sets the "To" of the message with the of the current . Remember that "ApplyTo" means here "apply this address to the 'To' header of the message". + The method sets the "To" of the message with the of the current . Remember that "ApplyTo" means here "apply this address to the 'To' header of the message". @@ -507,7 +507,7 @@ is suitable for use in hashing algorithms and with data structures such as a hash table. + is suitable for use in hashing algorithms and with data structures such as a hash table. @@ -885,7 +885,7 @@ if the endpoint addresses are equivalent; otherwise, . - . + . ## Examples :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/endpointaddress/cs/snippets.cs" id="Snippet5"::: @@ -933,7 +933,7 @@ if the endpoint addresses are not equivalent; otherwise, . - . + . ## Examples :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/endpointaddress/cs/snippets.cs" id="Snippet22"::: diff --git a/xml/System.ServiceModel/EndpointAddress10.xml b/xml/System.ServiceModel/EndpointAddress10.xml index 9c00d73c232..1d753bb96b3 100644 --- a/xml/System.ServiceModel/EndpointAddress10.xml +++ b/xml/System.ServiceModel/EndpointAddress10.xml @@ -31,19 +31,19 @@ Provides a serializable type of endpoint address that is WS-Addressing V1 compliant and that enables it to be exposed as part of the service contract. - is not serializable nor is it tied to a particular version of the WS-Addressing specification. This class provides a WS-Addressing V1 compliant wrapper for the that is serializable (implements the interface) and bound to the WS-Addressing V1 wire format. The method does the wrapping and the method does the unwrapping, allowing the recovery of the endpoint address after it is serialized on the wire. - - Windows Communication Foundation (WCF) also supplies a class that provides a serializable type, , which is WS-Addressing August 2004 compliant for legacy purposes. - - - -## Examples + is not serializable nor is it tied to a particular version of the WS-Addressing specification. This class provides a WS-Addressing V1 compliant wrapper for the that is serializable (implements the interface) and bound to the WS-Addressing V1 wire format. The method does the wrapping and the method does the unwrapping, allowing the recovery of the endpoint address after it is serialized on the wire. + + Windows Communication Foundation (WCF) also supplies a class that provides a serializable type, , which is WS-Addressing August 2004 compliant for legacy purposes. + + + +## Examples :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/endpointaddress10/cs/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/endpointaddress10/vb/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/endpointaddress10/vb/source.vb" id="Snippet1"::: + ]]> @@ -72,17 +72,17 @@ Initializes a new instance of the class with a specified endpoint address. The class that contains the specified endpoint address. - is not tied to a particular version of the WS-Addressing specification or bound to a particular wire format. - - - -## Examples + is not tied to a particular version of the WS-Addressing specification or bound to a particular wire format. + + + +## Examples :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/endpointaddress10/cs/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/endpointaddress10/vb/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/endpointaddress10/vb/source.vb" id="Snippet1"::: + ]]> @@ -113,11 +113,11 @@ Returns an XML-qualified name that describes the XML representation of the version 1.0 endpoint address from a specified cached schema. A that describes the XML representation of the endpoint address. - . It is not intended to be called by developers. - + . It is not intended to be called by developers. + ]]> @@ -237,14 +237,14 @@ This member is an explicit interface member implementation. It can be used only Retrieves the endpoint address contained in this serializable type. The used to initialize the instance of this class. - diff --git a/xml/System.ServiceModel/EndpointAddressAugust2004.xml b/xml/System.ServiceModel/EndpointAddressAugust2004.xml index 4ccb1a41322..7bccfd94d24 100644 --- a/xml/System.ServiceModel/EndpointAddressAugust2004.xml +++ b/xml/System.ServiceModel/EndpointAddressAugust2004.xml @@ -31,19 +31,19 @@ Provides a serializable type of endpoint address that is compliant with the version of WS-Addressing published in August 2004 and that enables it to be exposed as part of the service contract. - is not serializable nor is it tied to a particular version of the WS-Addressing specification. Windows Communication Foundation (WCF) supplies a class that provides a serializable type, , which is WS-Addressing V1 compliant. - - This class provides a WS-Addressing August 2004 compliant wrapper for the that is serializable and bound to a particular wire format for legacy purposes. The method does the wrapping and the method does the unwrapping, allowing the recovery of the endpoint address after being serialized on the wire. - - - -## Examples + is not serializable nor is it tied to a particular version of the WS-Addressing specification. Windows Communication Foundation (WCF) supplies a class that provides a serializable type, , which is WS-Addressing V1 compliant. + + This class provides a WS-Addressing August 2004 compliant wrapper for the that is serializable and bound to a particular wire format for legacy purposes. The method does the wrapping and the method does the unwrapping, allowing the recovery of the endpoint address after being serialized on the wire. + + + +## Examples :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/endpointaddressaugust2004/cs/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/endpointaddressaugust2004/vb/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/endpointaddressaugust2004/vb/source.vb" id="Snippet1"::: + ]]> @@ -72,17 +72,17 @@ Initializes a new instance of the class with a specified endpoint address. The class that contains the specified endpoint address. - is not tied to a particular version of the WS-Addressing specification or bound to a particular wire format. - - - -## Examples + is not tied to a particular version of the WS-Addressing specification or bound to a particular wire format. + + + +## Examples :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/endpointaddressaugust2004/cs/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/endpointaddressaugust2004/vb/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/endpointaddressaugust2004/vb/source.vb" id="Snippet1"::: + ]]> @@ -111,11 +111,11 @@ Returns an XML-qualified name that describes the XML representation of the version 1 endpoint address from a specified cached schema. A that describes the XML representation of the endpoint address. - @@ -235,12 +235,12 @@ This member is an explicit interface member implementation. It can be used only Retrieves the endpoint address contained in this serializable type. The that contains a version-neutral endpoint address of this . - diff --git a/xml/System.ServiceModel/EndpointAddressBuilder.xml b/xml/System.ServiceModel/EndpointAddressBuilder.xml index e25d2ad7a82..db0adbfc847 100644 --- a/xml/System.ServiceModel/EndpointAddressBuilder.xml +++ b/xml/System.ServiceModel/EndpointAddressBuilder.xml @@ -49,7 +49,7 @@ constructor. + The new endpoint address can have its property values initialized from the property values of an existing endpoint address using the constructor. The endpoint addresses created can have their URI and identity values set using the and properties of the endpoint address builder. Note that is an immutable class. @@ -284,7 +284,7 @@ constructor. + Address headers for the endpoints can be set using the constructor. diff --git a/xml/System.ServiceModel/EndpointIdentity.xml b/xml/System.ServiceModel/EndpointIdentity.xml index 7f3320904f4..a00af0f2ae9 100644 --- a/xml/System.ServiceModel/EndpointIdentity.xml +++ b/xml/System.ServiceModel/EndpointIdentity.xml @@ -128,7 +128,7 @@ ## Remarks A secure WCF client that connects to an endpoint with this identity verifies that the claims presented by the server contain a DNS claim that represents this identity. - This static method creates an instance of by calling its constructor . + This static method creates an instance of by calling its constructor . @@ -208,7 +208,7 @@ ## Remarks A secure WCF client that connects to an endpoint with this identity verifies that the claims presented by the server contain a claim that contains the RSA public key used to construct this identity. - One of these static methods creates an instance of by calling its constructor . + One of these static methods creates an instance of by calling its constructor . ]]> @@ -246,7 +246,7 @@ ## Remarks A secure WCF client that connects to an endpoint with this identity verifies that the claims presented by the server contain a claim that contains the RSA public key obtained from the certificate used to construct this identity. - This static method creates an instance of by calling its constructor, . + This static method creates an instance of by calling its constructor, . @@ -295,7 +295,7 @@ ## Remarks A secure WCF client that connects to an endpoint with this identity verifies that the claims presented by the server contain a claim that contains the RSA public key used to construct this identity. - This static method creates an instance of by calling its constructor, . + This static method creates an instance of by calling its constructor, . ]]> @@ -340,7 +340,7 @@ ## Remarks A secure WCF client that connects to an endpoint with this identity uses the SPN when performing SSPI authentication with the endpoint. - This static method creates an instance of by calling its constructor, , using `spnName` as the input parameter. + This static method creates an instance of by calling its constructor, , using `spnName` as the input parameter. If `spnName` is specified with an empty string, authentication falls back from Kerberos to NTLM if possible. If is `false`, authentication fails. @@ -394,7 +394,7 @@ ## Remarks A secure WCF client that connects to an endpoint with this identity uses the UPN when performing SSPI authentication with the endpoint. - This static method creates an instance of by calling its constructor, , using `upnName` as the input parameter. + This static method creates an instance of by calling its constructor, , using `upnName` as the input parameter. If `upnName` is specified with an empty string, authentication falls back from Kerberos to NTLM if possible. If is `false`, WCF makes a best-effort to throw an exception if NTLM is used. Note that setting this property to `false` may not prevent NTLM credentials from being sent over the wire. @@ -462,7 +462,7 @@ ## Remarks A secure WCF client that connects to an endpoint with this identity verifies that the claims presented by the server contain the claim that contains the thumbprint of the certificate used to construct this identity. - This `static` method creates an instance of by calling its constructor, , using `certificate` as the input parameter. + This `static` method creates an instance of by calling its constructor, , using `certificate` as the input parameter. @@ -511,7 +511,7 @@ by calling its constructor, , using `primaryCertificate` and `supportingCertificates` as input parameters. + This static method creates an instance of by calling its constructor, , using `primaryCertificate` and `supportingCertificates` as input parameters. ]]> @@ -671,7 +671,7 @@ . + This method is called by the constructors of all the classes derived from . ]]> diff --git a/xml/System.ServiceModel/EndpointNotFoundException.xml b/xml/System.ServiceModel/EndpointNotFoundException.xml index 2ef7c41896e..8607a192cc6 100644 --- a/xml/System.ServiceModel/EndpointNotFoundException.xml +++ b/xml/System.ServiceModel/EndpointNotFoundException.xml @@ -76,11 +76,11 @@ constructor. + If you want to pass an error message to the user, use the constructor. - If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. + If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. - If you want to pass serialization information and streaming context, use the constructor. + If you want to pass serialization information and streaming context, use the constructor. ]]> diff --git a/xml/System.ServiceModel/EnvelopeVersion.xml b/xml/System.ServiceModel/EnvelopeVersion.xml index 217a3da217a..11895345e67 100644 --- a/xml/System.ServiceModel/EnvelopeVersion.xml +++ b/xml/System.ServiceModel/EnvelopeVersion.xml @@ -49,7 +49,7 @@ for each of these versions of SOAP that can be recovered using the and properties. There is also a message version that is used to sent and receive XML messages that do not use SOAP formatting. The processing roles associated with each message version can be recovered using the property and the method. + The SOAP versions currently available are SOAP 1.1 and SOAP 1.2. There is an for each of these versions of SOAP that can be recovered using the and properties. There is also a message version that is used to sent and receive XML messages that do not use SOAP formatting. The processing roles associated with each message version can be recovered using the property and the method. diff --git a/xml/System.ServiceModel/ExtensionCollection`1.xml b/xml/System.ServiceModel/ExtensionCollection`1.xml index 31cb92e5543..0cd74f3707a 100644 --- a/xml/System.ServiceModel/ExtensionCollection`1.xml +++ b/xml/System.ServiceModel/ExtensionCollection`1.xml @@ -72,7 +72,7 @@ return an from the property. + Typically, implementations of return an from the property. ]]> diff --git a/xml/System.ServiceModel/FaultContractAttribute.xml b/xml/System.ServiceModel/FaultContractAttribute.xml index e3aa257bcff..fabdfcb16f2 100644 --- a/xml/System.ServiceModel/FaultContractAttribute.xml +++ b/xml/System.ServiceModel/FaultContractAttribute.xml @@ -80,7 +80,7 @@ For many scenarios setting to for fault messages is sufficient. For more details, see [Understanding Protection Level](/dotnet/framework/wcf/understanding-protection-level). - To return a specified fault from an operation marked with , throw a (where the type parameter is the serializable error information) when the managed exception occurs during the operation. WCF client applications surface the SOAP fault as the same type as was thrown in the client implementation -- that is, as a (where the typeparameter is the serializable error information). The can be used only to specify SOAP faults for two-way service operations and for asynchronous operation pairs; one-way operations do not support SOAP faults and therefore do not support . + To return a specified fault from an operation marked with , throw a (where the type parameter is the serializable error information) when the managed exception occurs during the operation. WCF client applications surface the SOAP fault as the same type as was thrown in the client implementation -- that is, as a (where the typeparameter is the serializable error information). The can be used only to specify SOAP faults for two-way service operations and for asynchronous operation pairs; one-way operations do not support SOAP faults and therefore do not support . > [!NOTE] > You can use any serializable type to convey error information. The only restriction in this version of WCF is that types specified in a must be serializable by the . For the serialization support the provides, see [Data Contract Serializer](/dotnet/framework/wcf/feature-details/data-contract-serializer). @@ -93,7 +93,7 @@ :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_fca/cs/fcademo.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/c_fca/vb/fcademo.vb" id="Snippet1"::: - Then, in your service method, throw a new where the type parameter is the type that contains the error information (in the above case, a ). For example: + Then, in your service method, throw a new where the type parameter is the type that contains the error information (in the above case, a ). For example: :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_fca/cs/fcademo.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/c_fca/vb/fcademo.vb" id="Snippet2"::: @@ -101,16 +101,16 @@ The preceding example is very basic; almost any information can be passed using an code, so this detail type is not the most useful. Typically, WCF applications specify SOAP faults with detail types specific to the error information requirements of the client. For a more complete example, see the Example section. > [!NOTE] -> If you specify a where the type parameter is a , the string value is assigned to the Detail property in the client application; clients cannot retrieve that string by calling the method. To have the string value returned when the client application calls , throw a exception inside the operation and pass the string to the constructor. +> If you specify a where the type parameter is a , the string value is assigned to the Detail property in the client application; clients cannot retrieve that string by calling the method. To have the string value returned when the client application calls , throw a exception inside the operation and pass the string to the constructor. - To explicitly control the behavior of the application when an exception or is thrown, implement the interface on an , or and assign it to the property. enables you to explicitly control the SOAP fault that is generated and whether to send it back to the client. + To explicitly control the behavior of the application when an exception or is thrown, implement the interface on an , or and assign it to the property. enables you to explicitly control the SOAP fault that is generated and whether to send it back to the client. To facilitate debugging, set the to `true` in code or you can use the in an application configuration file. When enabled, the service automatically returns exception information to the caller. These faults appear to the client as exceptions. > [!IMPORTANT] > Because managed exceptions can expose internal application information, setting or to `true` can permit WCF clients to obtain information about internal service operation exceptions, including personally identifiable or other sensitive information. > -> Therefore, setting or to `true` is only recommended as a way of temporarily debugging a service application. In addition, the WSDL for a method that returns unhandled managed exceptions in this way does not contain the contract for the of type . Clients must expect the possibility of an unknown SOAP fault (returned to WCF clients as objects) to obtain the debugging information properly. +> Therefore, setting or to `true` is only recommended as a way of temporarily debugging a service application. In addition, the WSDL for a method that returns unhandled managed exceptions in this way does not contain the contract for the of type . Clients must expect the possibility of an unknown SOAP fault (returned to WCF clients as objects) to obtain the debugging information properly. @@ -120,7 +120,7 @@ :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/faultcontractattribute/cs/Host/services.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/faultcontractattribute/vb/services.vb" id="Snippet1"::: - The following code example shows that WCF clients of `ISampleService` experience this SOAP fault as a of type `GreetingFault`. + The following code example shows that WCF clients of `ISampleService` experience this SOAP fault as a of type `GreetingFault`. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/faultcontractattribute/cs/Client/client.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/faultcontractattribute/vb/client.vb" id="Snippet3"::: diff --git a/xml/System.ServiceModel/FaultException.xml b/xml/System.ServiceModel/FaultException.xml index 8bede9f8564..7301ede72c5 100644 --- a/xml/System.ServiceModel/FaultException.xml +++ b/xml/System.ServiceModel/FaultException.xml @@ -85,7 +85,7 @@ - To catch SOAP faults on a client when the faults are not part of the service contract. - Throw objects when you want the string to be passed to the constructor and retrieved by the client by calling the method. If you specify a fault contract of type where the type parameter is , the string value is available as the property and not by calling . + Throw objects when you want the string to be passed to the constructor and retrieved by the client by calling the method. If you specify a fault contract of type where the type parameter is , the string value is available as the property and not by calling . For details, see [Specifying and Handling Faults in Contracts and Services](/dotnet/framework/wcf/specifying-and-handling-faults-in-contracts-and-services). @@ -581,7 +581,7 @@ is returned where the type parameter is the matching candidate type. + The `faultDetailTypes` parameter contains candidate detail types. If any of the `faultDetailTypes` has a schema that matches the `messageFault` parameter, a is returned where the type parameter is the matching candidate type. ]]> @@ -637,7 +637,7 @@ is returned where the type parameter is the matching candidate type. + The `faultDetailTypes` parameter contains candidate detail types. If any of the `faultDetailTypes` has a schema that matches the `messageFault` parameter, a is returned where the type parameter is the matching candidate type. ]]> diff --git a/xml/System.ServiceModel/FaultException`1.xml b/xml/System.ServiceModel/FaultException`1.xml index 56a401fc41c..7afa58ed8b7 100644 --- a/xml/System.ServiceModel/FaultException`1.xml +++ b/xml/System.ServiceModel/FaultException`1.xml @@ -60,20 +60,20 @@ object in a Windows Communication Foundation (WCF) client application to handle a SOAP fault that has been contractually specified in an operation contract. + Catch the object in a Windows Communication Foundation (WCF) client application to handle a SOAP fault that has been contractually specified in an operation contract. - Typical deployed services use the to formally specify all SOAP faults that a client can expect to receive in the normal course of an operation. Error information in a appears as a (where the typeparameter is the serializable error object specified in the operation's ) when it arrives at a client application. The can be used to specify SOAP faults for both two-way service methods and for asynchronous method pairs. + Typical deployed services use the to formally specify all SOAP faults that a client can expect to receive in the normal course of an operation. Error information in a appears as a (where the typeparameter is the serializable error object specified in the operation's ) when it arrives at a client application. The can be used to specify SOAP faults for both two-way service methods and for asynchronous method pairs. - Because is both a and therefore a , to catch specified SOAP faults make sure you catch the types prior to the and types or handle the specified exceptions in one of those exception handlers. + Because is both a and therefore a , to catch specified SOAP faults make sure you catch the types prior to the and types or handle the specified exceptions in one of those exception handlers. > [!NOTE] -> If you use to specify a where the type parameter is a , the string value is assigned to the property in the client application; clients cannot retrieve that string by calling the method. To have the string value returned when the client application calls , throw a exception inside the operation and pass the string to the constructor. +> If you use to specify a where the type parameter is a , the string value is assigned to the property in the client application; clients cannot retrieve that string by calling the method. To have the string value returned when the client application calls , throw a exception inside the operation and pass the string to the constructor. > In general, it is recommended that detail types be custom serializable types appropriate to the fault and not a . ## Examples - The following code example shows how a service uses the type to throw a managed exception that gets converted into the SOAP fault specified by the . + The following code example shows how a service uses the type to throw a managed exception that gets converted into the SOAP fault specified by the . :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/faultcontractattribute/cs/Host/services.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/faultcontractattribute/vb/services.vb" id="Snippet1"::: @@ -82,7 +82,7 @@ - The following code example shows how a client can catch the type that represents the custom SOAP fault specified in the operation contract. + The following code example shows how a client can catch the type that represents the custom SOAP fault specified in the operation contract. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/faultcontractattribute/cs/Client/client.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/faultcontractattribute/vb/client.vb" id="Snippet3"::: @@ -139,12 +139,12 @@ is serialized. + The detail object must be serializable or an exception is thrown when the is serialized. ## Examples - The following code example shows how a service uses the type to throw a managed exception that gets converted into the SOAP fault specified by the . + The following code example shows how a service uses the type to throw a managed exception that gets converted into the SOAP fault specified by the . :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/faultcontractattribute/cs/Host/services.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/faultcontractattribute/vb/services.vb" id="Snippet1"::: diff --git a/xml/System.ServiceModel/FaultReason.xml b/xml/System.ServiceModel/FaultReason.xml index 514836b84c6..8bed074ddd3 100644 --- a/xml/System.ServiceModel/FaultReason.xml +++ b/xml/System.ServiceModel/FaultReason.xml @@ -221,9 +221,9 @@ - If only one translation exists, it is returned. -- If there is an exact match for a , that is returned. +- If there is an exact match for a , that is returned. -- If there is a translation for a parent language of , that is returned. +- If there is a translation for a parent language of , that is returned. - Otherwise, the first translation in the set is returned. diff --git a/xml/System.ServiceModel/IClientChannel.xml b/xml/System.ServiceModel/IClientChannel.xml index 4844cc81fe2..3b6dbf9f491 100644 --- a/xml/System.ServiceModel/IClientChannel.xml +++ b/xml/System.ServiceModel/IClientChannel.xml @@ -62,13 +62,13 @@ Defines the behavior of outbound request and request/reply channels used by client applications. - interface defines the operations supported by all channels returned by a call to . Use the methods and properties to inspect and modify the outbound typed channel. The [ServiceModel Metadata Utility Tool (Svcutil.exe)](/dotnet/framework/wcf/servicemodel-metadata-utility-tool-svcutil-exe) exports both a class and a service contract interface by creating a contract interface that inherits from both the target service contract and , enabling you to use the extended contract as both the proxy to the service and to access the client channel. - - For more information, see [WCF Client Architecture](/dotnet/framework/wcf/feature-details/client-architecture). For examples of its appearance in generated client code files, see [Understanding Generated Client Code](/dotnet/framework/wcf/feature-details/understanding-generated-client-code). - + interface defines the operations supported by all channels returned by a call to . Use the methods and properties to inspect and modify the outbound typed channel. The [ServiceModel Metadata Utility Tool (Svcutil.exe)](/dotnet/framework/wcf/servicemodel-metadata-utility-tool-svcutil-exe) exports both a class and a service contract interface by creating a contract interface that inherits from both the target service contract and , enabling you to use the extended contract as both the proxy to the service and to access the client channel. + + For more information, see [WCF Client Architecture](/dotnet/framework/wcf/feature-details/client-architecture). For examples of its appearance in generated client code files, see [Understanding Generated Client Code](/dotnet/framework/wcf/feature-details/understanding-generated-client-code). + ]]> @@ -106,11 +106,11 @@ if Windows Communication Foundation (WCF) is permitted to invoke interactive channel initializers; otherwise, . - . - + . + ]]> @@ -153,17 +153,17 @@ An asynchronous call to begin using a user interface to obtain credential information. The to use to call back when processing has completed. - , so for many applications this call is optional. - - However, if the user takes a long time in the selection process, the operation that automatically called this may time out. To prevent this, call or and explicitly. These operations do not time out and allow you to control exactly where in your application this dialog comes up. - - This method only brings up a dialog if the application is configured to do so. When the application is not configured to use CardSpace or another interactive channel initializer, this call returns without any action. - - If you call this method explicitly, you must also explicitly open the channel before using it. - + , so for many applications this call is optional. + + However, if the user takes a long time in the selection process, the operation that automatically called this may time out. To prevent this, call or and explicitly. These operations do not time out and allow you to control exactly where in your application this dialog comes up. + + This method only brings up a dialog if the application is configured to do so. When the application is not configured to use CardSpace or another interactive channel initializer, this call returns without any action. + + If you call this method explicitly, you must also explicitly open the channel before using it. + ]]> @@ -201,11 +201,11 @@ if the method was called (or the and methods; otherwise, . - without calling and , these methods are called automatically. For details, see [Accessing Services Using a WCF Client](/dotnet/framework/wcf/feature-details/accessing-services-using-a-client) and . - + without calling and , these methods are called automatically. For details, see [Accessing Services Using a WCF Client](/dotnet/framework/wcf/feature-details/accessing-services-using-a-client) and . + ]]> @@ -242,19 +242,19 @@ A call to a user interface to obtain credential information. - , so for many applications this call is optional. - - However, if the user takes a long time in the selection process, the operation that automatically called this may time out. To prevent this, call or and explicitly. These operations do not time out and allow you to control exactly where in your application this dialog comes up. - - This method only brings up a dialog if the application is configured to do so. When the application is not configured to use CardSpace or another interactive channel initializer, this call returns without any action. - - If you call this method explicitly, you must also explicitly open the channel before using it. - - For details, see [Accessing Services Using a WCF Client](/dotnet/framework/wcf/feature-details/accessing-services-using-a-client) and . - + , so for many applications this call is optional. + + However, if the user takes a long time in the selection process, the operation that automatically called this may time out. To prevent this, call or and explicitly. These operations do not time out and allow you to control exactly where in your application this dialog comes up. + + This method only brings up a dialog if the application is configured to do so. When the application is not configured to use CardSpace or another interactive channel initializer, this call returns without any action. + + If you call this method explicitly, you must also explicitly open the channel before using it. + + For details, see [Accessing Services Using a WCF Client](/dotnet/framework/wcf/feature-details/accessing-services-using-a-client) and . + ]]> @@ -361,11 +361,11 @@ Gets the URI that contains the transport address to which messages are sent on the client channel. The that contains the transport address to which messages are sent on the channel. - serves as both the ultimate destination and the physical address if a is not specified. If the is specified, then that is the actual physical address to which the message is sent and through which the message must go to arrive at its destination. This value can be set from a configuration file using the . - + serves as both the ultimate destination and the physical address if a is not specified. If the is specified, then that is the actual physical address to which the message is sent and through which the message must go to arrive at its destination. This value can be set from a configuration file using the . + ]]> diff --git a/xml/System.ServiceModel/ICommunicationObject.xml b/xml/System.ServiceModel/ICommunicationObject.xml index abfbf087a6d..31237038c57 100644 --- a/xml/System.ServiceModel/ICommunicationObject.xml +++ b/xml/System.ServiceModel/ICommunicationObject.xml @@ -51,21 +51,21 @@ - A set of open, close and abort methods for initiating state transitions: - - + - - - + - - - + - - Asynchronous versions of the open and close methods: - - + - - - + - - - + - - - + - - A set of events that provide notifications of state transitions: @@ -120,9 +120,9 @@ method can be used to cancel any outstanding operations, including outstanding calls to . + This method indicates that any unfinished work should be ignored or ungracefully terminated before returning. The method can be used to cancel any outstanding operations, including outstanding calls to . - To gracefully transition an from the state to the state call . + To gracefully transition an from the state to the state call . ]]> @@ -189,7 +189,7 @@ to gracefully transition from any state, other than the state to the state. The method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages). + This method causes an to gracefully transition from any state, other than the state to the state. The method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages). ]]> @@ -241,7 +241,7 @@ to gracefully transition from any state, other than the state to the state with in a specified interval of time. The method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages). + This method causes an to gracefully transition from any state, other than the state to the state with in a specified interval of time. The method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages). ]]> @@ -262,7 +262,7 @@ method causes an to enter into the state where it remains until its transition to the state is completed or fails. + The method causes an to enter into the state where it remains until its transition to the state is completed or fails. Versions with and without an explicit timeout are provided. @@ -311,7 +311,7 @@ is instantiated, it begins in the state. In the state, the object can be configured (for example, properties can be set, or events can be registered), but it is not yet usable to send or receive messages. The method causes an to enter into the state where it remains until the open operation succeeds, the open operation times out or fails and the object becomes faulted, or the is aborted. + When an is instantiated, it begins in the state. In the state, the object can be configured (for example, properties can be set, or events can be registered), but it is not yet usable to send or receive messages. The method causes an to enter into the state where it remains until the open operation succeeds, the open operation times out or fails and the object becomes faulted, or the is aborted. In the state, the is usable (for example, messages can be received), but it is no longer configurable. @@ -364,7 +364,7 @@ is instantiated, it begins in the state. In the state, the object can be configured (for example, properties can be set, or events can be registered), but it is not yet usable to send or receive messages. The method causes an to enter into the state where it remains until the open operation succeeds, the open operation times out or fails and the object becomes faulted, or the is aborted. + When an is instantiated, it begins in the state. In the state, the object can be configured (for example, properties can be set, or events can be registered), but it is not yet usable to send or receive messages. The method causes an to enter into the state where it remains until the open operation succeeds, the open operation times out or fails and the object becomes faulted, or the is aborted. In the state, the is usable (for example, messages can be received), but it is no longer configurable. @@ -422,17 +422,17 @@ to gracefully transition from the state to the state. The method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages). + This method causes an to gracefully transition from the state to the state. The method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages). The enters the state and remains in it until the transition to the state is completed. - returns once the state is reached. + returns once the state is reached. If the default close timeout elapses before the is able to close gracefully, the is aborted. - If is called on an in the , , or state, the is aborted. If is called on an in the or state, the call returns immediately. + If is called on an in the , , or state, the is aborted. If is called on an in the or state, the call returns immediately. - There is also an asynchronous version of the close method that is initiated by calling and completed by calling . + There is also an asynchronous version of the close method that is initiated by calling and completed by calling . ]]> @@ -479,17 +479,17 @@ to gracefully transition from the state to the state within a specified interval of time. The method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages). + This method causes an to gracefully transition from the state to the state within a specified interval of time. The method allows any unfinished work to be completed before returning. For example, finish sending any buffered messages). The enters the state and remains in it until the transition to the state is completed. - returns once the state is reached. + returns once the state is reached. If the timeout elapses before the is able to gracefully close, the is aborted. - If is called on an in the , , or state, the is aborted. If is called on an in the or state, the call returns immediately. + If is called on an in the , , or state, the is aborted. If is called on an in the or state, the call returns immediately. - There is also an asynchronous version of the close method that is initiated by calling and completed by calling . + There is also an asynchronous version of the close method that is initiated by calling and completed by calling . ]]> @@ -568,7 +568,7 @@ state into the state, immediately after either the or method is invoked. + This event occurs when the communication object first begins to transition from the state into the state, immediately after either the or method is invoked. ]]> @@ -739,11 +739,11 @@ is instantiated, it begins in the state. In the state, the object can be configured (for example, properties can be set, or events can be registered), but it is not yet usable to send or receive messages. The method causes an to enter into the state where it remains until the open operation succeeds, the open operation times out or fails and the object becomes faulted, or the is aborted. + When an is instantiated, it begins in the state. In the state, the object can be configured (for example, properties can be set, or events can be registered), but it is not yet usable to send or receive messages. The method causes an to enter into the state where it remains until the open operation succeeds, the open operation times out or fails and the object becomes faulted, or the is aborted. In the state, the is usable (for example, messages can be received), but it is no longer configurable. - There is also an asynchronous version of the open method that is initiated by calling and completed by calling . + There is also an asynchronous version of the open method that is initiated by calling and completed by calling . ]]> @@ -789,11 +789,11 @@ is instantiated, it begins in the state. In the state, the object can be configured (for example, properties can be set, or events can be registered), but it is not yet usable to send or receive messages. The method causes an to enter into the state where it remains until the open operation succeeds, the open operation times out or fails and the object becomes faulted, or the is aborted. + When an is instantiated, it begins in the state. In the state, the object can be configured (for example, properties can be set, or events can be registered), but it is not yet usable to send or receive messages. The method causes an to enter into the state where it remains until the open operation succeeds, the open operation times out or fails and the object becomes faulted, or the is aborted. In the state, the is usable (for example, messages can be received), but it is no longer configurable. - There is also an asynchronous version of the open method that is initiated by calling and completed by calling . + There is also an asynchronous version of the open method that is initiated by calling and completed by calling . ]]> @@ -871,7 +871,7 @@ state into the state, immediately after either the or method is invoked. + This event occurs when the communication object first begins to transition from the state into the state, immediately after either the or method is invoked. ]]> diff --git a/xml/System.ServiceModel/IExtensibleObject`1.xml b/xml/System.ServiceModel/IExtensibleObject`1.xml index c825374a099..5b471422c14 100644 --- a/xml/System.ServiceModel/IExtensibleObject`1.xml +++ b/xml/System.ServiceModel/IExtensibleObject`1.xml @@ -52,25 +52,25 @@ The type of the extension class. Enable an object to participate in custom behavior, such as registering for events, or watching state transitions. - to enable aggregation of extensions. - - For example, if you are implementing a `TreeNode` class and want to allow external code to add annotations and methods to some instances of `TreeNode`, you can have `TreeNode` implement `IExtensibleObject`. This enables code that uses `TreeNode` to add objects that implement `IExtensibleObject` to the collection. - - There are four extensible objects in Windows Communication Foundation (WCF): - -- - -- - -- - -- - - For a discussion about how to create extension to work with these objects, see [Extensible Objects](/dotnet/framework/wcf/extending/extensible-objects). - + to enable aggregation of extensions. + + For example, if you are implementing a `TreeNode` class and want to allow external code to add annotations and methods to some instances of `TreeNode`, you can have `TreeNode` implement `IExtensibleObject`. This enables code that uses `TreeNode` to add objects that implement `IExtensibleObject` to the collection. + + There are four extensible objects in Windows Communication Foundation (WCF): + +- + +- + +- + +- + + For a discussion about how to create extension to work with these objects, see [Extensible Objects](/dotnet/framework/wcf/extending/extensible-objects). + ]]> diff --git a/xml/System.ServiceModel/IExtensionCollection`1.xml b/xml/System.ServiceModel/IExtensionCollection`1.xml index 2cd9f3eb11a..b0a2b0b49f0 100644 --- a/xml/System.ServiceModel/IExtensionCollection`1.xml +++ b/xml/System.ServiceModel/IExtensionCollection`1.xml @@ -104,11 +104,11 @@ Finds the specified extension object in the collection. The extension object that was found. - returns an extension that implements (is or derives from) the specified type. If more than one extension implements the specified type, one is returned. The WCF implementation returns the most recently added, but this is not required of implementations. If no extension implements the specified type, returns null. - + returns an extension that implements (is or derives from) the specified type. If more than one extension implements the specified type, one is returned. The WCF implementation returns the most recently added, but this is not required of implementations. If no extension implements the specified type, returns null. + ]]> diff --git a/xml/System.ServiceModel/IExtension`1.xml b/xml/System.ServiceModel/IExtension`1.xml index 5ad4c0de9b3..c6f261abd54 100644 --- a/xml/System.ServiceModel/IExtension`1.xml +++ b/xml/System.ServiceModel/IExtension`1.xml @@ -52,11 +52,11 @@ The object that participates in the custom behavior. Enables an object to extend another object through aggregation. - objects (the , , , and classes) by adding a new state or behavior by using its extensible object pattern. The extensible object pattern is used in WCF to either extend existing run-time classes with new functionality or to add new state features to an object. - + objects (the , , , and classes) by adding a new state or behavior by using its extensible object pattern. The extensible object pattern is used in WCF to either extend existing run-time classes with new functionality or to add new state features to an object. + ]]> @@ -96,25 +96,25 @@ The extensible object that aggregates this extension. Enables an extension object to find out when it has been aggregated. Called when the extension is added to the property. - object to which the current instance of the extension belongs. This call gives extensions a chance to handle events or inspect properties of their owner. - - - -## Examples - The following example code shows how this method can be used to keep track of the object to which the current instance of the extension belongs. - -```csharp -InstanceContext owner; - -public void Attach(InstanceContext owner) -{ - this.owner = owner; -} -``` - + object to which the current instance of the extension belongs. This call gives extensions a chance to handle events or inspect properties of their owner. + + + +## Examples + The following example code shows how this method can be used to keep track of the object to which the current instance of the extension belongs. + +```csharp +InstanceContext owner; + +public void Attach(InstanceContext owner) +{ + this.owner = owner; +} +``` + ]]> @@ -154,13 +154,13 @@ public void Attach(InstanceContext owner) The extensible object that aggregates this extension. Enables an object to find out when it is no longer aggregated. Called when an extension is removed from the property. - method to find out when the extension has been removed. An extension can use this to unhook events on the extensible object. An extension can also throw from this method to indicate that, once added, the extension cannot be removed. - - Note that this method is not called when the owner object is disposed or closed. If needed, it is up to the extension or the code adding the extension to hook the appropriate events or implement the appropriate interfaces (for ) to observe the lifecycle of the owner. - + method to find out when the extension has been removed. An extension can use this to unhook events on the extensible object. An extension can also throw from this method to indicate that, once added, the extension cannot be removed. + + Note that this method is not called when the owner object is disposed or closed. If needed, it is up to the extension or the code adding the extension to hook the appropriate events or implement the appropriate interfaces (for ) to observe the lifecycle of the owner. + ]]> diff --git a/xml/System.ServiceModel/InstanceContext.xml b/xml/System.ServiceModel/InstanceContext.xml index 5d033bf3638..e78d30f0058 100644 --- a/xml/System.ServiceModel/InstanceContext.xml +++ b/xml/System.ServiceModel/InstanceContext.xml @@ -483,7 +483,7 @@ ; then if no message arrives, no is created and no service object is created, and so resources are not deployed until actually required. + The general idea is that you only create an instance of the service when a message directed at it arrives, by calling ; then if no message arrives, no is created and no service object is created, and so resources are not deployed until actually required. diff --git a/xml/System.ServiceModel/InstanceContextMode.xml b/xml/System.ServiceModel/InstanceContextMode.xml index 5830e80c852..434da64e8af 100644 --- a/xml/System.ServiceModel/InstanceContextMode.xml +++ b/xml/System.ServiceModel/InstanceContextMode.xml @@ -37,7 +37,7 @@ The `Single` value specifies that a single value is set to `Single`, your service can only process one message at a time unless you also set the value to . -- For singleton lifetime behavior (for example, if the host application calls the constructor and passes an object to use as the service), the service class must set to `Single`, or an exception is thrown when the service host is opened. +- For singleton lifetime behavior (for example, if the host application calls the constructor and passes an object to use as the service), the service class must set to `Single`, or an exception is thrown when the service host is opened. ## Examples The following code illustrates how to set the for a service class: diff --git a/xml/System.ServiceModel/MessageHeaderAttribute.xml b/xml/System.ServiceModel/MessageHeaderAttribute.xml index 4e1038b0184..0be66d85823 100644 --- a/xml/System.ServiceModel/MessageHeaderAttribute.xml +++ b/xml/System.ServiceModel/MessageHeaderAttribute.xml @@ -73,7 +73,7 @@ - The second way to control these attributes is by making the desired header type the type parameter of the class and using the resulting type together with the . Then use the properties programmatically to set the SOAP attributes. For example: + The second way to control these attributes is by making the desired header type the type parameter of the class and using the resulting type together with the . Then use the properties programmatically to set the SOAP attributes. For example: @@ -91,9 +91,9 @@ [MessageHeaderArray] public MessageHeader documentApprovers[]; ``` - On the receiving side, reading these SOAP attributes can only be done if the generic class is used. Examine the , or properties of a header of the type to discover the attribute settings on the received message. + On the receiving side, reading these SOAP attributes can only be done if the generic class is used. Examine the , or properties of a header of the type to discover the attribute settings on the received message. - When a message is received and then sent back, the SOAP attribute settings only roundtrip for headers of the type. + When a message is received and then sent back, the SOAP attribute settings only roundtrip for headers of the type. diff --git a/xml/System.ServiceModel/MessageHeaderException.xml b/xml/System.ServiceModel/MessageHeaderException.xml index 80468eca32c..a6d84cc8dce 100644 --- a/xml/System.ServiceModel/MessageHeaderException.xml +++ b/xml/System.ServiceModel/MessageHeaderException.xml @@ -74,11 +74,11 @@ constructor. + If you want to pass an error message to the user, use the constructor. - If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. + If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. - If you want to pass serialization information and streaming context, use the constructor. + If you want to pass serialization information and streaming context, use the constructor. ]]> diff --git a/xml/System.ServiceModel/NetNamedPipeBinding.xml b/xml/System.ServiceModel/NetNamedPipeBinding.xml index 752ea0e558b..7a76b490ba4 100644 --- a/xml/System.ServiceModel/NetNamedPipeBinding.xml +++ b/xml/System.ServiceModel/NetNamedPipeBinding.xml @@ -47,7 +47,7 @@ ## Remarks The generates a run-time communication stack by default, which uses transport security, named pipes for message delivery, and a binary message encoding. This binding is an appropriate Windows Communication Foundation (WCF) system-provided choice for on-machine communication. It also supports transactions. - The default configuration for the is similar to the configuration provided by the , but it is simpler because the WCF implementation is only meant for on-machine use and consequently there are fewer exposed features. The most notable difference is that the setting only offers the and options. SOAP security support is not an included option. The security behavior is configurable using the optional `securityMode` parameter in the constructor. + The default configuration for the is similar to the configuration provided by the , but it is simpler because the WCF implementation is only meant for on-machine use and consequently there are fewer exposed features. The most notable difference is that the setting only offers the and options. SOAP security support is not an included option. The security behavior is configurable using the optional `securityMode` parameter in the constructor. diff --git a/xml/System.ServiceModel/NetTcpBinding.xml b/xml/System.ServiceModel/NetTcpBinding.xml index 01c4fd4d83e..a8711e38a85 100644 --- a/xml/System.ServiceModel/NetTcpBinding.xml +++ b/xml/System.ServiceModel/NetTcpBinding.xml @@ -173,7 +173,7 @@ . + Use this constructor when you want to configure the security. If you want to configure security and enable reliable sessions, use . @@ -325,7 +325,7 @@ method to create a collection with the binding elements for the binding. + This example shows how to use the method to create a collection with the binding elements for the binding. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uenettcpbinding/cs/source.cs" id="Snippet20"::: diff --git a/xml/System.ServiceModel/OperationBehaviorAttribute.xml b/xml/System.ServiceModel/OperationBehaviorAttribute.xml index cba71f14e77..66708718775 100644 --- a/xml/System.ServiceModel/OperationBehaviorAttribute.xml +++ b/xml/System.ServiceModel/OperationBehaviorAttribute.xml @@ -166,7 +166,7 @@ Use the property (together with a binding configuration that supports impersonation) to enable specified methods (those marked with the property set to or ) to execute under the caller's identity. For details, including how impersonation is performed when using together with the property, see [Delegation and Impersonation](/dotnet/framework/wcf/feature-details/delegation-and-impersonation-with-wcf) and [How to: Impersonate a Client on a Service](/dotnet/framework/wcf/how-to-impersonate-a-client-on-a-service). > [!NOTE] -> When programmatically adding a service endpoint that performs impersonation, you must either use one of the methods or the method to properly load the contract into a new object. Using a configuration file requires no extra step. +> When programmatically adding a service endpoint that performs impersonation, you must either use one of the methods or the method to properly load the contract into a new object. Using a configuration file requires no extra step. There may be specific scenarios when impersonation is not supported. For more information, see [Unsupported Scenarios](/dotnet/framework/wcf/feature-details/unsupported-scenarios). @@ -178,7 +178,7 @@ :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/operationbehaviorattribute_impersonation/cs/services.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/operationbehaviorattribute_impersonation/vb/services.vb" id="Snippet1"::: - The following code example shows using the property to set the client application credentials prior to invoking the operation that requires those credentials for impersonation. + The following code example shows using the property to set the client application credentials prior to invoking the operation that requires those credentials for impersonation. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/operationbehaviorattribute_impersonation/cs/client.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/operationbehaviorattribute_impersonation/vb/client.vb" id="Snippet3"::: @@ -234,7 +234,7 @@ You can also use to configure a callback contract operation in a duplex client application. When used on a callback operation, the property must be or an exception is thrown at runtime. - In addition, it is important to realize that if the service is created by passing a service object to the constructor, the value of this property is treated as if it were . + In addition, it is important to realize that if the service is created by passing a service object to the constructor, the value of this property is treated as if it were . diff --git a/xml/System.ServiceModel/OperationContext.xml b/xml/System.ServiceModel/OperationContext.xml index 5229200b5fc..b4f13d3a7fc 100644 --- a/xml/System.ServiceModel/OperationContext.xml +++ b/xml/System.ServiceModel/OperationContext.xml @@ -83,14 +83,14 @@ - The property returns the session identifier for the current channel and object. -- The method returns a callback channel to the caller in the case of duplex communication. +- The method returns a callback channel to the caller in the case of duplex communication. -- The method commits the current transaction. +- The method commits the current transaction. ## Examples - The following code example uses the property and method to obtain the channel back to the caller from within a method. All methods in this example are one-way methods, enabling the service and the client to communicate in both directions independently. In this case, the example client application expects only one return call before it exits, but another client, for example a Windows Forms client, can receive any number of calls from the service. + The following code example uses the property and method to obtain the channel back to the caller from within a method. All methods in this example are one-way methods, enabling the service and the client to communicate in both directions independently. In this case, the example client application expects only one return call before it exits, but another client, for example a Windows Forms client, can receive any number of calls from the service. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/sca.callbackcontract/cs/services.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/sca.callbackcontract/vb/services.vb" id="Snippet1"::: @@ -142,7 +142,7 @@ constructor to create a new operation context within the scope of which the proxy is associated in order to modify outbound items such as headers. + Use the constructor to create a new operation context within the scope of which the proxy is associated in order to modify outbound items such as headers. @@ -263,7 +263,7 @@ ## Examples - The following code example uses the property and method to create a channel back to the caller from within a method. All methods in this example are one-way methods, enabling the service and the client to communicate in both directions independently. In this case, the example client application expects only one return call before it exits, but another client, for example a Windows Forms client, can receive any number of calls from the service. + The following code example uses the property and method to create a channel back to the caller from within a method. All methods in this example are one-way methods, enabling the service and the client to communicate in both directions independently. In this case, the example client application expects only one return call before it exits, but another client, for example a Windows Forms client, can receive any number of calls from the service. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/sca.callbackcontract/cs/services.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/sca.callbackcontract/vb/services.vb" id="Snippet1"::: @@ -394,7 +394,7 @@ Call the method to obtain a channel that you can use to call operations on the client instance that called the service. ## Examples - The following code example uses the property and method to create a channel back to the caller from within a operation. All operations in this example are one-way operations, enabling the service and the client to communicate in both directions independently. In this case, the example client application expects only one return call before it exits, but another client, for example a Windows Forms client, can receive any number of calls from the service. + The following code example uses the property and method to create a channel back to the caller from within a operation. All operations in this example are one-way operations, enabling the service and the client to communicate in both directions independently. In this case, the example client application expects only one return call before it exits, but another client, for example a Windows Forms client, can receive any number of calls from the service. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/sca.callbackcontract/cs/services.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/sca.callbackcontract/vb/services.vb" id="Snippet1"::: @@ -712,7 +712,7 @@ Call the metho event to dispose parameters or a return value if you set to `false`. Normally you set to `false` to prevent WCF from calling on the parameter and return value objects. However, if some parameters need to be preserved while others need to be disposed, this event is the best place to dispose those parameters. + Use the event to dispose parameters or a return value if you set to `false`. Normally you set to `false` to prevent WCF from calling on the parameter and return value objects. However, if some parameters need to be preserved while others need to be disposed, this event is the best place to dispose those parameters. Also, with duplex bindings, this event can be used to send a request on the callback channel after the reply for the current operation is sent. @@ -945,7 +945,7 @@ Call the metho to `false`. Typically, services do this on some but not all operations. When is false the transaction completes automatically. Use in cases where it is not possible to determine at design-time whether an operation needs to complete the transaction. + This is only useful in operations that set to `false`. Typically, services do this on some but not all operations. When is false the transaction completes automatically. Use in cases where it is not possible to determine at design-time whether an operation needs to complete the transaction. ]]> diff --git a/xml/System.ServiceModel/OperationContextScope.xml b/xml/System.ServiceModel/OperationContextScope.xml index 9cfa28dcf10..24e59d41bf5 100644 --- a/xml/System.ServiceModel/OperationContextScope.xml +++ b/xml/System.ServiceModel/OperationContextScope.xml @@ -127,9 +127,9 @@ constructor to create a new for a client channel that can be used to add or modify outbound message headers, read incoming message headers, or access other run-time properties of the . + Use the constructor to create a new for a client channel that can be used to add or modify outbound message headers, read incoming message headers, or access other run-time properties of the . - The headers added to the property of the newly created apply only to the channel that was passed to the constructor. If the user creates a new channel within its scope then the headers are not applied to messages sent on the new channel. + The headers added to the property of the newly created apply only to the channel that was passed to the constructor. If the user creates a new channel within its scope then the headers are not applied to messages sent on the new channel. @@ -178,7 +178,7 @@ constructor to create a code block within which the specified object is the current scope. + Use the constructor to create a code block within which the specified object is the current scope. ]]> diff --git a/xml/System.ServiceModel/PeerResolver.xml b/xml/System.ServiceModel/PeerResolver.xml index 70ab740547f..d34f88293ea 100644 --- a/xml/System.ServiceModel/PeerResolver.xml +++ b/xml/System.ServiceModel/PeerResolver.xml @@ -202,13 +202,13 @@ . + A registration ID is a peer resolver token, that, at the very minimum, represents the tuple of a peer node ID and the mesh ID. This ID value must have been obtained in a previous call to . - is called in two specific cases: + is called in two specific cases: - When the is leaving the peer mesh (usually as the result of closing the last peer channel or service host that is associated with it). -- When the can find no available endpoint addresses of other nodes participating in the peer mesh. As a result, the is no longer reachable, and it will attempt to call to unregister itself from the . If other peer nodes within the mesh become available subsequent to unregistration, the node can re-register itself by calling and obtaining a new registration ID. +- When the can find no available endpoint addresses of other nodes participating in the peer mesh. As a result, the is no longer reachable, and it will attempt to call to unregister itself from the . If other peer nodes within the mesh become available subsequent to unregistration, the node can re-register itself by calling and obtaining a new registration ID. ]]> @@ -244,7 +244,7 @@ is called when the address of the changes on the local machine. + is called when the address of the changes on the local machine. ]]> diff --git a/xml/System.ServiceModel/ProtocolException.xml b/xml/System.ServiceModel/ProtocolException.xml index 5655cd23339..ab2e1f73319 100644 --- a/xml/System.ServiceModel/ProtocolException.xml +++ b/xml/System.ServiceModel/ProtocolException.xml @@ -76,11 +76,11 @@ constructor. + If you want to pass an error message to the user, use the constructor. - If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. + If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. - If you want to pass serialization information and streaming context, use the constructor. + If you want to pass serialization information and streaming context, use the constructor. ]]> @@ -161,7 +161,7 @@ ## Remarks Use this constructor when you want to pass an error message to the user. The content of the message parameter should be understandable to the user. The caller of this constructor is required to ensure that this string has been localized for the current system culture. - If you also want to pass a reference to the inner exception that is the cause of the exception as well as a specified error message to the user, use the constructor. + If you also want to pass a reference to the inner exception that is the cause of the exception as well as a specified error message to the user, use the constructor. ]]> diff --git a/xml/System.ServiceModel/QuotaExceededException.xml b/xml/System.ServiceModel/QuotaExceededException.xml index 202e75881d3..fc5b1479355 100644 --- a/xml/System.ServiceModel/QuotaExceededException.xml +++ b/xml/System.ServiceModel/QuotaExceededException.xml @@ -72,11 +72,11 @@ constructor. + If you want to pass an error message to the user, use the constructor. - If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. + If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. - If you want to pass serialization information and streaming context, use the constructor. + If you want to pass serialization information and streaming context, use the constructor. ]]> @@ -157,7 +157,7 @@ ## Remarks Use this constructor when you want to pass an error message to the user. The content of the message parameter should be understandable to the user. The caller of this constructor is required to ensure that this string has been localized for the current system culture. - If you also want to pass a reference to the inner exception that is the cause of the exception as well as a specified error message to the user, use the constructor. + If you also want to pass a reference to the inner exception that is the cause of the exception as well as a specified error message to the user, use the constructor. ]]> diff --git a/xml/System.ServiceModel/ReceiveContextEnabledAttribute.xml b/xml/System.ServiceModel/ReceiveContextEnabledAttribute.xml index b11aa319818..78200d3cf14 100644 --- a/xml/System.ServiceModel/ReceiveContextEnabledAttribute.xml +++ b/xml/System.ServiceModel/ReceiveContextEnabledAttribute.xml @@ -171,7 +171,7 @@ property is set to `true`, the message received from the channel is delivered to the service operation with a lock for the message in the form of "ReceiveContext message property". It is the responsibility of the service implementation to either to call or to signal the receive completion of the message. Failure to call either of these result in the lock being held on the message until the lock timeout interval elapses. Once the lock is released (either through calling or lock timeout) the message is re-dispatched from the channel to the service. Calling marks the message as successfully received. + When the property is set to `true`, the message received from the channel is delivered to the service operation with a lock for the message in the form of "ReceiveContext message property". It is the responsibility of the service implementation to either to call or to signal the receive completion of the message. Failure to call either of these result in the lock being held on the message until the lock timeout interval elapses. Once the lock is released (either through calling or lock timeout) the message is re-dispatched from the channel to the service. Calling marks the message as successfully received. ]]> diff --git a/xml/System.ServiceModel/RsaEndpointIdentity.xml b/xml/System.ServiceModel/RsaEndpointIdentity.xml index a950e6bd4d7..3ddfc2d416a 100644 --- a/xml/System.ServiceModel/RsaEndpointIdentity.xml +++ b/xml/System.ServiceModel/RsaEndpointIdentity.xml @@ -23,11 +23,11 @@ Specifies an RSA identity for the service endpoint. - @@ -94,11 +94,11 @@ The . Initializes a new instance of the class. - . - + . + ]]> @@ -131,11 +131,11 @@ The public key. Initializes a new instance of the class from a public key. - . - + . + ]]> diff --git a/xml/System.ServiceModel/ServerTooBusyException.xml b/xml/System.ServiceModel/ServerTooBusyException.xml index 8a924b48b1c..ed2cee10bcd 100644 --- a/xml/System.ServiceModel/ServerTooBusyException.xml +++ b/xml/System.ServiceModel/ServerTooBusyException.xml @@ -105,11 +105,11 @@ constructor. + If you want to pass an error message to the user, use the constructor. - If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. + If you want to pass an error message and a reference to the inner exception that is the cause of the exception to the user, use the constructor. - If you want to pass serialization information and streaming context, use the constructor. + If you want to pass serialization information and streaming context, use the constructor. ]]> @@ -158,7 +158,7 @@ ## Remarks Use this constructor when you want to pass an error message to the user. The content of the message parameter should be understandable to the user. The caller of this constructor is required to ensure that this string has been localized for the current system culture. - If you also want to pass a reference to the inner exception that is the cause of the exception as well as a specified error message to the user, use the constructor. + If you also want to pass a reference to the inner exception that is the cause of the exception as well as a specified error message to the user, use the constructor. ]]> diff --git a/xml/System.ServiceModel/ServiceAuthorizationManager.xml b/xml/System.ServiceModel/ServiceAuthorizationManager.xml index 065ea431ed5..f07ca2eb305 100644 --- a/xml/System.ServiceModel/ServiceAuthorizationManager.xml +++ b/xml/System.ServiceModel/ServiceAuthorizationManager.xml @@ -22,14 +22,14 @@ ## Remarks This class is responsible for evaluating all policies (rules that define what a user is allowed to do), comparing the policies to claims made by a client, setting the resulting to the , and providing the authorization decision whether to allow or deny access for a given service operation for a caller. - The method is called by the Windows Communication Foundation (WCF) infrastructure each time an attempt to access a resource is made. The method returns `true` or `false` to allow or deny access, respectively. + The method is called by the Windows Communication Foundation (WCF) infrastructure each time an attempt to access a resource is made. The method returns `true` or `false` to allow or deny access, respectively. The is part of the WCF*Identity Model* infrastructure. The Identity Model enables you to create custom authorization policies and custom authorization schemes. For more information about how the Identity Model works, see [Managing Claims and Authorization with the Identity Model](/dotnet/framework/wcf/feature-details/managing-claims-and-authorization-with-the-identity-model). ## Custom Authorization - This class does not perform any authorization and allows users to access all service operations. To provide more restrictive authorization, you must create a custom authorization manager that checks custom policies. To do this, inherit from this class and override the method. Specify the instance of the derived class through the property. + This class does not perform any authorization and allows users to access all service operations. To provide more restrictive authorization, you must create a custom authorization manager that checks custom policies. To do this, inherit from this class and override the method. Specify the instance of the derived class through the property. - In , the application can use the object to access the caller identity (). + In , the application can use the object to access the caller identity (). By getting the property, which returns a object, the application can access the service (), and the operation (). @@ -48,7 +48,7 @@ ## Examples - The following example shows a class named `MyServiceAuthorizationManager` that inherits from the and overrides the method. + The following example shows a class named `MyServiceAuthorizationManager` that inherits from the and overrides the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customauthmgr/cs/c_customauthmgr.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/c_customauthmgr/vb/c_customauthmgr.vb" id="Snippet2"::: @@ -125,11 +125,11 @@ instead of this method. + In general, applications should override instead of this method. - Override if the application associates or introduces a different set of policies for the resulting or provide a different policy evaluation (chaining) model. + Override if the application associates or introduces a different set of policies for the resulting or provide a different policy evaluation (chaining) model. - This method is responsible for calling . + This method is responsible for calling . @@ -179,11 +179,11 @@ instead of this method, which should only be used if the authorization decision depends on the message body. Because of performance issues, if possible you should redesign your application so that the authorization decision does not require access to the message body. + In general, applications should override instead of this method, which should only be used if the authorization decision depends on the message body. Because of performance issues, if possible you should redesign your application so that the authorization decision does not require access to the message body. Override this method if the application associates or introduces a different set of policies for the resulting and or provide a different policy evaluation (chaining) model. - This method is responsible for calling . + This method is responsible for calling . @@ -238,7 +238,7 @@ ## Examples - The following example shows an override of the method. + The following example shows an override of the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/c_customauthmgr/cs/c_customauthmgr.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/c_customauthmgr/vb/c_customauthmgr.vb" id="Snippet6"::: diff --git a/xml/System.ServiceModel/ServiceBehaviorAttribute.xml b/xml/System.ServiceModel/ServiceBehaviorAttribute.xml index a9ea34d1b77..d2801b5a1a1 100644 --- a/xml/System.ServiceModel/ServiceBehaviorAttribute.xml +++ b/xml/System.ServiceModel/ServiceBehaviorAttribute.xml @@ -511,10 +511,10 @@ public void MyMethod() To facilitate debugging development, set the to `true` either in code or using an application configuration file. - When enabled, the service automatically returns safer exception information to the caller. These faults appear to the client as objects of type . + When enabled, the service automatically returns safer exception information to the caller. These faults appear to the client as objects of type . > [!IMPORTANT] -> Setting to `true` enables clients to obtain information about internal service method exceptions; it is only recommended as a way of temporarily debugging a service application. In addition, the WSDL for a method that returns unhandled managed exceptions in this way does not contain the contract for the of type . Clients must expect the possibility of an unknown SOAP fault to obtain the debugging information properly. +> Setting to `true` enables clients to obtain information about internal service method exceptions; it is only recommended as a way of temporarily debugging a service application. In addition, the WSDL for a method that returns unhandled managed exceptions in this way does not contain the contract for the of type . Clients must expect the possibility of an unknown SOAP fault to obtain the debugging information properly. Setting this property to `true` can also be done using an application configuration file and the [<serviceDebug>](/dotnet/framework/configure-apps/file-schema/wcf/servicedebug) element, as the following code example shows. @@ -583,7 +583,7 @@ public void MyMethod() > [!NOTE] > The property interacts with some other settings. For example, if the value is set to the result is that your service can only process one message at a time unless you also set the value to . This property also produces behavior in combination with the property. For details, see [Sessions, Instancing, and Concurrency](/dotnet/framework/wcf/feature-details/sessions-instancing-and-concurrency). - For singleton lifetime behavior (for example, if the host application calls the constructor and passes an object to use as the service), the service class must set to `Single`, or an exception is thrown at run time. + For singleton lifetime behavior (for example, if the host application calls the constructor and passes an object to use as the service), the service class must set to `Single`, or an exception is thrown at run time. @@ -761,7 +761,7 @@ public void MyMethod() ## Remarks Note that you must explicitly set to `false` if there is an operation with set to true and you set to . Otherwise a validation exception is thrown because the default value of is `true`. - In addition, it is important to realize that if the service is created by passing a service object to the constructor, the value of this property is treated as if it were `false`. + In addition, it is important to realize that if the service is created by passing a service object to the constructor, the value of this property is treated as if it were `false`. @@ -807,7 +807,7 @@ public void MyMethod() ## Remarks This provides the service instance to which all messages addressed to the service will be dispatched. - If is set to a non-`null` value, then the must be set to or an is thrown. + If is set to a non-`null` value, then the must be set to or an is thrown. ]]> diff --git a/xml/System.ServiceModel/ServiceContractAttribute.xml b/xml/System.ServiceModel/ServiceContractAttribute.xml index e3810d88a8f..89aad819171 100644 --- a/xml/System.ServiceModel/ServiceContractAttribute.xml +++ b/xml/System.ServiceModel/ServiceContractAttribute.xml @@ -82,7 +82,7 @@ Hosting in the WAS is very similar to creating an ASP.NET application. For details, see [How to: Host a WCF Service in IIS](/dotnet/framework/wcf/feature-details/how-to-host-a-wcf-service-in-iis). - Clients either use the service contract interface (the interface marked with ) to create a channel to the service or they use the client objects (which combine the type information of the service contract interface with the class) to communicate with your service. For details on client channels to services, see the class and [WCF Client Overview](/dotnet/framework/wcf/wcf-client-overview). + Clients either use the service contract interface (the interface marked with ) to create a channel to the service or they use the client objects (which combine the type information of the service contract interface with the class) to communicate with your service. For details on client channels to services, see the class and [WCF Client Overview](/dotnet/framework/wcf/wcf-client-overview). Using a class or interface to inherit from another class or interface extends the parent contract. For example, if an `IChildContract` interface is marked with and inherited from another service contract interface, `IParentContract`, the `IChildContract` service contract contains the methods of both `IParentContract` and `IChildContract`. Extending contracts (whether on classes or interfaces) is very similar to extending managed classes and interfaces. diff --git a/xml/System.ServiceModel/ServiceHost.xml b/xml/System.ServiceModel/ServiceHost.xml index 36e7eb1c292..11cc767f3ab 100644 --- a/xml/System.ServiceModel/ServiceHost.xml +++ b/xml/System.ServiceModel/ServiceHost.xml @@ -72,7 +72,7 @@ class. Use the constructor which takes the service type as an input parameter, most of the time. The host can use this to create new services as needed. Use the constructor instead only when you want the service host to use a specific singleton instance of the service. + There are two constructors used to create an instance of the class. Use the constructor which takes the service type as an input parameter, most of the time. The host can use this to create new services as needed. Use the constructor instead only when you want the service host to use a specific singleton instance of the service. ]]> @@ -112,7 +112,7 @@ ## Remarks Use this constructor as an alternative to implementing a custom when you want to provide a specific object instance for use by a singleton service. You may want to use this overload when your service implementation type is difficult to construct (for example, if it does not implement a default public constructor that has no parameters). - Note that when an object is provided to this overload, some features related to the Windows Communication Foundation (WCF) instancing behavior work differently. For example, calling have no effect when a well-known object instance is provided using this constructor overload. Similarly, any other instance release mechanism is ignored. The always behaves as if the property is set to for all operations. + Note that when an object is provided to this overload, some features related to the Windows Communication Foundation (WCF) instancing behavior work differently. For example, calling have no effect when a well-known object instance is provided using this constructor overload. Similarly, any other instance release mechanism is ignored. The always behaves as if the property is set to for all operations. @@ -158,7 +158,7 @@ constructor instead only when you want the service host to use a specific singleton instance of the service. + Use this constructor when you have the service type and you can create new instances of it when needed, even when you need a singleton instance. Use the constructor instead only when you want the service host to use a specific singleton instance of the service. @@ -418,7 +418,7 @@ , to implement the customized model. + This method is used to construct contract descriptions from customized programming models. Override the corresponding base class method, , to implement the customized model. ]]> @@ -436,7 +436,7 @@ . Classes that inherit from can call and then can call one of the when a base address is available. This is how the Service Model Metadata Utility Tool (Svcutil.exe) is implemented. + This method removes the requirement for passing base addresses as part of . Classes that inherit from can call and then can call one of the when a base address is available. This is how the Service Model Metadata Utility Tool (Svcutil.exe) is implemented. ]]> @@ -523,7 +523,7 @@ method you must ensure the base.OnClosed method is called, even if an exception occurs. The following code illustrates how to do this. + When overriding the method you must ensure the base.OnClosed method is called, even if an exception occurs. The following code illustrates how to do this. ``` protected override void OnClosed() @@ -577,7 +577,7 @@ protected override void OnClosed() constructor to initialize a singleton instance of the service to be hosted when you want to control the instance of the service that is used. + Use the constructor to initialize a singleton instance of the service to be hosted when you want to control the instance of the service that is used. ]]> diff --git a/xml/System.ServiceModel/ServiceHostBase.xml b/xml/System.ServiceModel/ServiceHostBase.xml index cfda9745849..42b9d68f6ed 100644 --- a/xml/System.ServiceModel/ServiceHostBase.xml +++ b/xml/System.ServiceModel/ServiceHostBase.xml @@ -34,7 +34,7 @@ - Put your cleanup code in (On)(Begin)Close (and/or OnAbort), not in a destructor. - Avoid destructors; they cause the compiler to auto-generate . - Avoid non-reference members; they can cause the compiler to auto-generate . -- Avoid finalizers; but if you include one, you should suppress the build warning and call and the finalizer itself from (On)(Begin)Close (and/or OnAbort) to emulate what would have been the auto-generated behavior. +- Avoid finalizers; but if you include one, you should suppress the build warning and call and the finalizer itself from (On)(Begin)Close (and/or OnAbort) to emulate what would have been the auto-generated behavior. ## Examples This sample uses the class, which is derived from . @@ -97,7 +97,7 @@ to provide the base address after the host is constructed. can be used to add base addresses to an existing host, but throws an exception if the description is already initialized. + This property allows users extending to provide the base address after the host is constructed. can be used to add base addresses to an existing host, but throws an exception if the description is already initialized. ]]> @@ -858,7 +858,7 @@ method. + This limit can be incremented using the method. @@ -984,11 +984,11 @@ does the following: + Calling does the following: - Closes all input to , which also closes their associated instances. This stops any new channels from being accepting. -- Calls on all objects, which mean they stop accepting new messages. +- Calls on all objects, which mean they stop accepting new messages. - Waits for all objects to close down, which happens when their associated channels finish sending all pending messages. @@ -1182,9 +1182,9 @@ and + This method is invoked when calling and - . + . ]]> diff --git a/xml/System.ServiceModel/ServiceKnownTypeAttribute.xml b/xml/System.ServiceModel/ServiceKnownTypeAttribute.xml index f441a70c604..43dd2a839a6 100644 --- a/xml/System.ServiceModel/ServiceKnownTypeAttribute.xml +++ b/xml/System.ServiceModel/ServiceKnownTypeAttribute.xml @@ -57,7 +57,7 @@ ## Remarks The is intended for use when creating Windows Communication Foundation (WCF) service contracts (interfaces that define the service and its methods). The *known types* are types that may be present in an object graph when serialization or deserialization occurs. For more information about known types, see [Data Contract Known Types](/dotnet/framework/wcf/feature-details/data-contract-known-types). - To use the property, create a class that contains a method (or methods) that returns an array of types (each being a known type). When applying the attribute, set the `methodName` to the name of a method that returns the list of types and set the `declaringType` to the type that contains the method. The method must return a type that implements the interface. The method must also include a parameter of type . + To use the property, create a class that contains a method (or methods) that returns an array of types (each being a known type). When applying the attribute, set the `methodName` to the name of a method that returns the list of types and set the `declaringType` to the type that contains the method. The method must return a type that implements the interface. The method must also include a parameter of type . You can also apply the attribute several times to an interface, class, or method, each time specifying a new known type. diff --git a/xml/System.ServiceModel/ServiceSecurityContext.xml b/xml/System.ServiceModel/ServiceSecurityContext.xml index 67a12774933..abc5cdd2444 100644 --- a/xml/System.ServiceModel/ServiceSecurityContext.xml +++ b/xml/System.ServiceModel/ServiceSecurityContext.xml @@ -44,7 +44,7 @@ You can retrieve an instance of the from the property of the class, or use it from within a service operation method, as shown in the following example. ## Parsing a ClaimSet - A common use of the class is to retrieve the current set of claims for the purpose of identifying or authorizing a client when accessing a method. The class contains a collection of objects, and each can be parsed to determine whether a specific claim is present. If the specified claim is provided, authorization can be granted. This functionality is provided by overriding the method of the class. For a complete example, see the [Authorization Policy](/dotnet/framework/wcf/samples/authorization-policy). + A common use of the class is to retrieve the current set of claims for the purpose of identifying or authorizing a client when accessing a method. The class contains a collection of objects, and each can be parsed to determine whether a specific claim is present. If the specified claim is provided, authorization can be granted. This functionality is provided by overriding the method of the class. For a complete example, see the [Authorization Policy](/dotnet/framework/wcf/samples/authorization-policy). ## Cookie Mode and IsAuthenticated Note that under some circumstances, the property of the interface returns `true` even if the remote client is authenticated as an anonymous user. (The property returns an implementation of the interface.) The following circumstances must be true for this to occur: @@ -67,7 +67,7 @@ :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/servicesecuritycontext/cs/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/servicesecuritycontext/vb/source.vb" id="Snippet1"::: - The following example shows an implementation of the method that uses the to parse a set of claims. + The following example shows an implementation of the method that uses the to parse a set of claims. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/servicesecuritycontext/cs/source.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/servicesecuritycontext/vb/source.vb" id="Snippet2"::: diff --git a/xml/System.ServiceModel/UpnEndpointIdentity.xml b/xml/System.ServiceModel/UpnEndpointIdentity.xml index 595b956514b..899c529f296 100644 --- a/xml/System.ServiceModel/UpnEndpointIdentity.xml +++ b/xml/System.ServiceModel/UpnEndpointIdentity.xml @@ -52,13 +52,13 @@ Represents a user principal name (UPN) for an identity which is used when the binding utilizes the *SSPINegotiate* authentication mode. - . - + . + ]]> @@ -102,11 +102,11 @@ The . Initializes a new instance of the class from a claim. - using `identity` as the input parameter. - + using `identity` as the input parameter. + ]]> @@ -155,11 +155,11 @@ The UPN name. Initializes a new instance of the class. - using that claim as the input parameter. - + using that claim as the input parameter. + ]]> diff --git a/xml/System.ServiceModel/WSDualHttpBinding.xml b/xml/System.ServiceModel/WSDualHttpBinding.xml index 25fe2cc4d95..1122757adbb 100644 --- a/xml/System.ServiceModel/WSDualHttpBinding.xml +++ b/xml/System.ServiceModel/WSDualHttpBinding.xml @@ -113,7 +113,7 @@ , so there is no constructor that provides a switch to turn it off as there is on the constructor for the . + Reliable messaging is required by the , so there is no constructor that provides a switch to turn it off as there is on the constructor for the . diff --git a/xml/System.ServiceModel/WSDualHttpSecurityMode.xml b/xml/System.ServiceModel/WSDualHttpSecurityMode.xml index dfbe10b07e7..49dc46e05cf 100644 --- a/xml/System.ServiceModel/WSDualHttpSecurityMode.xml +++ b/xml/System.ServiceModel/WSDualHttpSecurityMode.xml @@ -17,19 +17,19 @@ Specifies the different security modes for . - supports. - - - -## Examples - The following code shows how to set to a member of this enumeration. - + supports. + + + +## Examples + The following code shows how to set to a member of this enumeration. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_uewsdualhttpsecurity/cs/program.cs" id="Snippet30"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uewsdualhttpsecurity/vb/module1.vb" id="Snippet30"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_uewsdualhttpsecurity/vb/module1.vb" id="Snippet30"::: + ]]> diff --git a/xml/System.ServiceModel/WSHttpBinding.xml b/xml/System.ServiceModel/WSHttpBinding.xml index b2f2eca4381..b0d76463b4a 100644 --- a/xml/System.ServiceModel/WSHttpBinding.xml +++ b/xml/System.ServiceModel/WSHttpBinding.xml @@ -41,19 +41,19 @@ Represents an interoperable binding that supports distributed transactions and secure, reliable sessions. - is similar to the but provides more Web service features. It uses the HTTP transport and provides message security, as does , but it also provides transactions, reliable messaging, and WS-Addressing, either enabled by default or available through a single control setting. - - - -## Examples - The following sample code shows how to use the class. - + is similar to the but provides more Web service features. It uses the HTTP transport and provides message security, as does , but it also provides transactions, reliable messaging, and WS-Addressing, either enabled by default or available through a single control setting. + + + +## Examples + The following sample code shows how to use the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wshttpbinding/cs/wshttpbinding.cs" id="Snippet0"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wshttpbinding/vb/wshttpbinding.vb" id="Snippet0"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wshttpbinding/vb/wshttpbinding.vb" id="Snippet0"::: + ]]> @@ -91,14 +91,14 @@ Initializes a new instance of the class. - class. - + class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wshttpbinding/cs/wshttpbinding.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wshttpbinding/vb/wshttpbinding.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wshttpbinding/vb/wshttpbinding.vb" id="Snippet1"::: + ]]> @@ -137,14 +137,14 @@ The value of that specifies the type of security that is used with the SOAP message and for the client. Initializes a new instance of the class with a specified type of security used by the binding. - class with a `securityMode` parameter. - + class with a `securityMode` parameter. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wshttpbinding/cs/wshttpbinding.cs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wshttpbinding/vb/wshttpbinding.vb" id="Snippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wshttpbinding/vb/wshttpbinding.vb" id="Snippet7"::: + ]]> @@ -172,14 +172,14 @@ The binding configuration name for the . Initializes a new instance of the class with a binding specified by its configuration name. - class with a string argument. - + class with a string argument. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wshttpbinding/cs/wshttpbinding.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wshttpbinding/vb/wshttpbinding.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wshttpbinding/vb/wshttpbinding.vb" id="Snippet5"::: + ]]> The binding element with the name was not found. @@ -216,14 +216,14 @@ if a reliable session is enabled; otherwise, . Initializes a new instance of the class with a specified type of security used by the binding and a value that indicates whether a reliable session is enabled. - class with a `securityMode` and `reliableSessionEnabled` parameter. - + class with a `securityMode` and `reliableSessionEnabled` parameter. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wshttpbinding/cs/wshttpbinding.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wshttpbinding/vb/wshttpbinding.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wshttpbinding/vb/wshttpbinding.vb" id="Snippet6"::: + ]]> @@ -263,43 +263,43 @@ if automatic cookies processing is required; otherwise, . - to `true` is useful when a client is interacting with one web service that uses cookies. If you are accessing multiple services with the same cookie, set to `false` and you will have to manually add the cookie header to each outgoing message. The following code shows how to do this: - -```csharp -MyWebServiceClient client = new MyWebServiceClient(); - - using (new OperationContextScope(client.InnerChannel)) - { - client.DoSomething(); - - // Extract the cookie embedded in the received web service response - // and stores it locally - HttpResponseMessageProperty response = (HttpResponseMessageProperty) - OperationContext.Current.IncomingMessageProperties[ - HttpResponseMessageProperty.Name]; - sharedCookie = response.Headers["Set-Cookie"]; - } - - MyOtherWebServiceClient otherClient = new MyOtherWebServiceClient(); - - using (new OperationContextScope(otherClient.InnerChannel)) - { - // Embeds the extracted cookie in the next web service request - // Note that we manually have to create the request object since - // since it doesn't exist yet at this stage - HttpRequestMessageProperty request = new HttpRequestMessageProperty(); - request.Headers["Cookie"] = sharedCookie; - OperationContext.Current.OutgoingMessageProperties[ - HttpRequestMessageProperty.Name] = request; - - otherClient.DoSomethingElse(); - } - -``` - + to `true` is useful when a client is interacting with one web service that uses cookies. If you are accessing multiple services with the same cookie, set to `false` and you will have to manually add the cookie header to each outgoing message. The following code shows how to do this: + +```csharp +MyWebServiceClient client = new MyWebServiceClient(); + + using (new OperationContextScope(client.InnerChannel)) + { + client.DoSomething(); + + // Extract the cookie embedded in the received web service response + // and stores it locally + HttpResponseMessageProperty response = (HttpResponseMessageProperty) + OperationContext.Current.IncomingMessageProperties[ + HttpResponseMessageProperty.Name]; + sharedCookie = response.Headers["Set-Cookie"]; + } + + MyOtherWebServiceClient otherClient = new MyOtherWebServiceClient(); + + using (new OperationContextScope(otherClient.InnerChannel)) + { + // Embeds the extracted cookie in the next web service request + // Note that we manually have to create the request object since + // since it doesn't exist yet at this stage + HttpRequestMessageProperty request = new HttpRequestMessageProperty(); + request.Headers["Cookie"] = sharedCookie; + OperationContext.Current.OutgoingMessageProperties[ + HttpRequestMessageProperty.Name] = request; + + otherClient.DoSomethingElse(); + } + +``` + ]]> @@ -370,19 +370,19 @@ MyWebServiceClient client = new MyWebServiceClient(); Returns an ordered collection of binding elements contained in the current binding. The that contains the ordered stack of binding elements described by the binding. - that contains the ordered stack of binding elements described by binding. - + that contains the ordered stack of binding elements described by binding. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wshttpbinding/cs/wshttpbinding.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wshttpbinding/vb/wshttpbinding.vb" id="Snippet9"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wshttpbinding/vb/wshttpbinding.vb" id="Snippet9"::: + ]]> The transport security mode set cannot provide the reliable session that has been enabled. @@ -488,19 +488,19 @@ MyWebServiceClient client = new MyWebServiceClient(); Gets the security settings used with this binding. The that is used with this binding. The default value property is . - constructor. - - - -## Examples - The following example shows how to obtain the value of the . - + constructor. + + + +## Examples + The following example shows how to obtain the value of the . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wshttpbinding/cs/wshttpbinding.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wshttpbinding/vb/wshttpbinding.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/wshttpbinding/vb/wshttpbinding.vb" id="Snippet8"::: + ]]> diff --git a/xml/System.ServiceModel/WSHttpBindingBase.xml b/xml/System.ServiceModel/WSHttpBindingBase.xml index cabf8a7ad57..65184d5de91 100644 --- a/xml/System.ServiceModel/WSHttpBindingBase.xml +++ b/xml/System.ServiceModel/WSHttpBindingBase.xml @@ -700,7 +700,7 @@ constructor. + Reliable sessions are enabled with the constructor. diff --git a/xml/System.ServiceModel/WebHttpBinding.xml b/xml/System.ServiceModel/WebHttpBinding.xml index e8538e4a9b3..d61e058a3fb 100644 --- a/xml/System.ServiceModel/WebHttpBinding.xml +++ b/xml/System.ServiceModel/WebHttpBinding.xml @@ -62,9 +62,9 @@ ## Remarks The default security mode is , which specifies that no security is used. - To use transport-level security for endpoints configured with this binding, the value must be specified as a parameter in the constructor. + To use transport-level security for endpoints configured with this binding, the value must be specified as a parameter in the constructor. - To use HTTP authentication without HTTPS, the value must be specified as a parameter in the constructor. + To use HTTP authentication without HTTPS, the value must be specified as a parameter in the constructor. The value of cannot be set again after the binding instance is created. @@ -95,9 +95,9 @@ value must be specified as a parameter in the constructor. + To use transport-level security for endpoints configured with this binding, the value must be specified as a parameter in the constructor. - To use HTTP authentication without HTTPS, the value must be specified as a parameter in the constructor. + To use HTTP authentication without HTTPS, the value must be specified as a parameter in the constructor. The value of cannot be set again after the binding instance is created. @@ -592,7 +592,7 @@ constructor. + To use a non-default type of security, use the constructor. > [!NOTE] > If you set this property to and you are using HTTP, be aware that credentials are sent over the wire in plain text. diff --git a/xml/System.ServiceModel/WebHttpSecurity.xml b/xml/System.ServiceModel/WebHttpSecurity.xml index 38f11e46714..54daf2f8d3b 100644 --- a/xml/System.ServiceModel/WebHttpSecurity.xml +++ b/xml/System.ServiceModel/WebHttpSecurity.xml @@ -23,7 +23,7 @@ ## Remarks provides the security requirements for an endpoint configured with a . - If the value is specified by the method, then the settings provided by the property become effective for the service endpoint. The value of can only be set in the constructor that takes it as an explicit parameter and its value cannot be set again after the binding instance is created. + If the value is specified by the method, then the settings provided by the property become effective for the service endpoint. The value of can only be set in the constructor that takes it as an explicit parameter and its value cannot be set again after the binding instance is created. ]]> @@ -166,9 +166,9 @@ ## Remarks Use the object returned by this property to set the transport security parameters for the . - If the or value is specified by the method, then the settings provided by the property become effective for the service endpoint. + If the or value is specified by the method, then the settings provided by the property become effective for the service endpoint. - If the value is specified by the method, then the settings provided by the property become effective for the service endpoint. The value of can only be set in the constructor that takes it as an explicit parameter and its value cannot be set again after the binding instance is created. + If the value is specified by the method, then the settings provided by the property become effective for the service endpoint. The value of can only be set in the constructor that takes it as an explicit parameter and its value cannot be set again after the binding instance is created. ]]> diff --git a/xml/System.ServiceModel/WebHttpSecurityMode.xml b/xml/System.ServiceModel/WebHttpSecurityMode.xml index ddfaceab082..56c7101b824 100644 --- a/xml/System.ServiceModel/WebHttpSecurityMode.xml +++ b/xml/System.ServiceModel/WebHttpSecurityMode.xml @@ -22,7 +22,7 @@ ## Remarks Use this enumeration to specify whether transport-level security is used by an endpoint configured with a to receive HTTP requests. The default value is None, which indicates that no security is used. - If the Transport value is specified by the , then the settings provided by the property become effective for the service endpoint. The value of can only be set in the constructor that takes it as an explicit parameter and its value cannot be set again after the binding instance is created. + If the Transport value is specified by the , then the settings provided by the property become effective for the service endpoint. The value of can only be set in the constructor that takes it as an explicit parameter and its value cannot be set again after the binding instance is created. TransportCredentialOnly does not provide message integrity and confidentiality. It provides HTTP-based client authentication only. This mode should be used with caution. It should be used in environments, such at IPSec, where the transport security is being provided by other means and only client authentication is provided by the Windows Communication Foundation (WCF) infrastructure. diff --git a/xml/System.ServiceModel/WorkflowServiceHost.xml b/xml/System.ServiceModel/WorkflowServiceHost.xml index 74e06515417..50f7bbc2072 100644 --- a/xml/System.ServiceModel/WorkflowServiceHost.xml +++ b/xml/System.ServiceModel/WorkflowServiceHost.xml @@ -23,17 +23,17 @@ Provides host for workflow-based services. - class to configure and expose a workflow as service for use by client applications when you are not using Internet Information Services (IIS) or Windows Activation Services (WAS) to expose a service. Both IIS and WAS interact with a object on your behalf. - - To expose a workflow as service for use by callers, WCF requires a complete service description (represented by the class). The class creates a from the workflow service type and configuration information and then uses that description to create objects for each endpoint in the description. - - Use a object to load a workflow service, configure endpoints, apply security settings, and start listeners to handle incoming requests. - + class to configure and expose a workflow as service for use by client applications when you are not using Internet Information Services (IIS) or Windows Activation Services (WAS) to expose a service. Both IIS and WAS interact with a object on your behalf. + + To expose a workflow as service for use by callers, WCF requires a complete service description (represented by the class). The class creates a from the workflow service type and configuration information and then uses that description to create objects for each endpoint in the description. + + Use a object to load a workflow service, configure endpoints, apply security settings, and start listeners to handle incoming requests. + ]]> @@ -95,11 +95,11 @@ An array of type that contains the base addresses for the hosted service. Initializes a new instance of the class using a byte stream that contains the workflow definition and the base addresses of the service specified. - @@ -133,11 +133,11 @@ An array of type that contains the base addresses for the hosted service. Initializes a new instance of the class using a path to the workflow definition and the base addresses of the service specified. - @@ -171,11 +171,11 @@ An array of type that contains the base addresses for the hosted service. Initializes a new instance of the class using a workflow type and the base addresses of the service specified. - @@ -213,11 +213,11 @@ An array of type that contains the base addresses for the hosted service. Initializes a new instance of the class using a byte stream that contains the workflow definition, a byte stream that contains the workflow rules definition, and the base addresses of the service specified. - @@ -253,11 +253,11 @@ An array of type that contains the base addresses for the hosted service. Initializes a new instance of the class using a path to the workflow definition, a path to the workflow rules definition, and the base addresses of the service specified. - @@ -297,11 +297,11 @@ An array of type that contains the base addresses for the hosted service. Initializes a new instance of the class using a byte stream that contains the workflow definition, a byte stream that contains the workflow rules definition, a type provider for custom activity types, and the base addresses of the service specified. - @@ -339,11 +339,11 @@ An array of type that contains the base addresses for the hosted service. Initializes a new instance of the class using a path to the workflow definition, a path to the workflow rules definition, a type provider for custom activity types, and the base addresses of the service specified. - @@ -572,11 +572,11 @@ The workflow service does not implement . This method is called before the is put into a closing state. - calls before calling . This means the workflow runtime will shut down before the service host closes. - + calls before calling . This means the workflow runtime will shut down before the service host closes. + ]]> From 4bbc24217abc82f1028b19950b09feceaca52004 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Thu, 2 Apr 2026 12:03:59 -0700 Subject: [PATCH 4/6] replace [ ] --- xml/System.ServiceModel.Activation/ServiceHostFactory.xml | 4 ++-- xml/System.ServiceModel.Channels/Binding.xml | 4 ++-- xml/System.ServiceModel/ClientBase`1.xml | 2 +- xml/System.ServiceModel/OperationBehaviorAttribute.xml | 2 +- xml/System.ServiceModel/ServiceBehaviorAttribute.xml | 2 +- xml/System.ServiceModel/ServiceHost.xml | 6 +++--- xml/System.Xaml/IAmbientProvider.xml | 4 ++-- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/xml/System.ServiceModel.Activation/ServiceHostFactory.xml b/xml/System.ServiceModel.Activation/ServiceHostFactory.xml index 362dec4fdd2..53497b4d88a 100644 --- a/xml/System.ServiceModel.Activation/ServiceHostFactory.xml +++ b/xml/System.ServiceModel.Activation/ServiceHostFactory.xml @@ -122,7 +122,7 @@ method: + This example shows how to use the method: :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/servicehostfactory/cs/program.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/servicehostfactory/vb/program.vb" id="Snippet3"::: @@ -166,7 +166,7 @@ method: + This example shows how to create an override implementation of the method: diff --git a/xml/System.ServiceModel.Channels/Binding.xml b/xml/System.ServiceModel.Channels/Binding.xml index cf167be3ac3..fb31f2cd21b 100644 --- a/xml/System.ServiceModel.Channels/Binding.xml +++ b/xml/System.ServiceModel.Channels/Binding.xml @@ -744,7 +744,7 @@ and catch the exception generated if it cannot be built. + Use this method if you want to check that the channel factory for channels of type `TChannel` can be build for the binding `parameters` specified before attempting to actually build the factory. Alternatively, try to build the channel factory by calling and catch the exception generated if it cannot be built. ]]> @@ -856,7 +856,7 @@ and catch the exception generated if it cannot be built. + Use this method if you want to check that the channel listener for channels of type `TChannel` can be build for the binding `parameters` specified before attempting to actually build the listener. Alternatively, try to build the channel listener by calling and catch the exception generated if it cannot be built. ]]> diff --git a/xml/System.ServiceModel/ClientBase`1.xml b/xml/System.ServiceModel/ClientBase`1.xml index 0d434b2dac4..498f1ba3893 100644 --- a/xml/System.ServiceModel/ClientBase`1.xml +++ b/xml/System.ServiceModel/ClientBase`1.xml @@ -1098,7 +1098,7 @@ , and when each operation is completed, your event handler can determine which instance of the operation raised the completion event. + Provide a unique value, such as a GUID or hash code, in the `userState` parameter for each call to , and when each operation is completed, your event handler can determine which instance of the operation raised the completion event. ]]> diff --git a/xml/System.ServiceModel/OperationBehaviorAttribute.xml b/xml/System.ServiceModel/OperationBehaviorAttribute.xml index 66708718775..c15133fc64d 100644 --- a/xml/System.ServiceModel/OperationBehaviorAttribute.xml +++ b/xml/System.ServiceModel/OperationBehaviorAttribute.xml @@ -234,7 +234,7 @@ You can also use to configure a callback contract operation in a duplex client application. When used on a callback operation, the property must be or an exception is thrown at runtime. - In addition, it is important to realize that if the service is created by passing a service object to the constructor, the value of this property is treated as if it were . + In addition, it is important to realize that if the service is created by passing a service object to the constructor, the value of this property is treated as if it were . diff --git a/xml/System.ServiceModel/ServiceBehaviorAttribute.xml b/xml/System.ServiceModel/ServiceBehaviorAttribute.xml index d2801b5a1a1..611eb5e12d1 100644 --- a/xml/System.ServiceModel/ServiceBehaviorAttribute.xml +++ b/xml/System.ServiceModel/ServiceBehaviorAttribute.xml @@ -761,7 +761,7 @@ public void MyMethod() ## Remarks Note that you must explicitly set to `false` if there is an operation with set to true and you set to . Otherwise a validation exception is thrown because the default value of is `true`. - In addition, it is important to realize that if the service is created by passing a service object to the constructor, the value of this property is treated as if it were `false`. + In addition, it is important to realize that if the service is created by passing a service object to the constructor, the value of this property is treated as if it were `false`. diff --git a/xml/System.ServiceModel/ServiceHost.xml b/xml/System.ServiceModel/ServiceHost.xml index 11cc767f3ab..b20914dbefa 100644 --- a/xml/System.ServiceModel/ServiceHost.xml +++ b/xml/System.ServiceModel/ServiceHost.xml @@ -72,7 +72,7 @@ class. Use the constructor which takes the service type as an input parameter, most of the time. The host can use this to create new services as needed. Use the constructor instead only when you want the service host to use a specific singleton instance of the service. + There are two constructors used to create an instance of the class. Use the constructor which takes the service type as an input parameter, most of the time. The host can use this to create new services as needed. Use the constructor instead only when you want the service host to use a specific singleton instance of the service. ]]> @@ -158,7 +158,7 @@ constructor instead only when you want the service host to use a specific singleton instance of the service. + Use this constructor when you have the service type and you can create new instances of it when needed, even when you need a singleton instance. Use the constructor instead only when you want the service host to use a specific singleton instance of the service. @@ -577,7 +577,7 @@ protected override void OnClosed() constructor to initialize a singleton instance of the service to be hosted when you want to control the instance of the service that is used. + Use the constructor to initialize a singleton instance of the service to be hosted when you want to control the instance of the service that is used. ]]> diff --git a/xml/System.Xaml/IAmbientProvider.xml b/xml/System.Xaml/IAmbientProvider.xml index 1b35d642888..bd758d097c5 100644 --- a/xml/System.Xaml/IAmbientProvider.xml +++ b/xml/System.Xaml/IAmbientProvider.xml @@ -192,9 +192,9 @@ ## Remarks Each that is returned contains the identifier and a property value. - This particular overload can search for ambient types and ambient properties in the same pass through a tree. Using this overload results in an ordering of items in the return value that is different from or . + This particular overload can search for ambient types and ambient properties in the same pass through a tree. Using this overload results in an ordering of items in the return value that is different from or . - This overload also permits the search to not use any saved context. The or overloads implicitly use a saved context if it is available (they always act as if an implicit `searchLiveStackOnly` parameter is `false`). The concept of a saved context is potentially handled differently by particular XAML schema contexts, or by frameworks that incorporate XAML. In the WPF XAML implementation, saved contexts are used for template expansion, as well as other feature areas. + This overload also permits the search to not use any saved context. The or overloads implicitly use a saved context if it is available (they always act as if an implicit `searchLiveStackOnly` parameter is `false`). The concept of a saved context is potentially handled differently by particular XAML schema contexts, or by frameworks that incorporate XAML. In the WPF XAML implementation, saved contexts are used for template expansion, as well as other feature areas. ]]> From 73b07e54064dcefda383448d002226ca48f87d1e Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Thu, 2 Apr 2026 12:11:11 -0700 Subject: [PATCH 5/6] replace { } --- xml/System.ServiceModel.Channels/MessageEncoder.xml | 2 +- xml/System.ServiceModel.Dispatcher/MessageFilterTable`1.xml | 4 ++-- xml/System.ServiceModel/ClientBase`1.xml | 2 +- xml/System.ServiceModel/ServiceHost.xml | 2 +- xml/System.Xaml/IAmbientProvider.xml | 4 ++-- xml/System.Xaml/XamlDirective.xml | 2 +- xml/System.Xaml/XamlType.xml | 4 ++-- xml/System.Xml.Serialization/XmlSerializerFactory.xml | 6 +++--- 8 files changed, 13 insertions(+), 13 deletions(-) diff --git a/xml/System.ServiceModel.Channels/MessageEncoder.xml b/xml/System.ServiceModel.Channels/MessageEncoder.xml index bad0db0a7e7..36b191f7296 100644 --- a/xml/System.ServiceModel.Channels/MessageEncoder.xml +++ b/xml/System.ServiceModel.Channels/MessageEncoder.xml @@ -578,7 +578,7 @@ method. + The following code example shows how to implement the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_ue_customtextmessageencoder/cs/customtextmessageencoder.cs" id="Snippet4"::: diff --git a/xml/System.ServiceModel.Dispatcher/MessageFilterTable`1.xml b/xml/System.ServiceModel.Dispatcher/MessageFilterTable`1.xml index 93d499b88a4..51aa841ee57 100644 --- a/xml/System.ServiceModel.Dispatcher/MessageFilterTable`1.xml +++ b/xml/System.ServiceModel.Dispatcher/MessageFilterTable`1.xml @@ -1162,7 +1162,7 @@ myFilters(filter) ## Remarks If the filter key of the `item` is present but is associated with data that differs from the `FilterData`, the method fails to remove the filter and returns `false`. - This method implements . + This method implements . ]]> @@ -1201,7 +1201,7 @@ myFilters(filter) . + This method implements . ]]> diff --git a/xml/System.ServiceModel/ClientBase`1.xml b/xml/System.ServiceModel/ClientBase`1.xml index 498f1ba3893..a93b8c79961 100644 --- a/xml/System.ServiceModel/ClientBase`1.xml +++ b/xml/System.ServiceModel/ClientBase`1.xml @@ -1098,7 +1098,7 @@ , and when each operation is completed, your event handler can determine which instance of the operation raised the completion event. + Provide a unique value, such as a GUID or hash code, in the `userState` parameter for each call to , and when each operation is completed, your event handler can determine which instance of the operation raised the completion event. ]]> diff --git a/xml/System.ServiceModel/ServiceHost.xml b/xml/System.ServiceModel/ServiceHost.xml index b20914dbefa..c3a0a400636 100644 --- a/xml/System.ServiceModel/ServiceHost.xml +++ b/xml/System.ServiceModel/ServiceHost.xml @@ -418,7 +418,7 @@ , to implement the customized model. + This method is used to construct contract descriptions from customized programming models. Override the corresponding base class method, , to implement the customized model. ]]> diff --git a/xml/System.Xaml/IAmbientProvider.xml b/xml/System.Xaml/IAmbientProvider.xml index bd758d097c5..dfd17a82b5b 100644 --- a/xml/System.Xaml/IAmbientProvider.xml +++ b/xml/System.Xaml/IAmbientProvider.xml @@ -192,9 +192,9 @@ ## Remarks Each that is returned contains the identifier and a property value. - This particular overload can search for ambient types and ambient properties in the same pass through a tree. Using this overload results in an ordering of items in the return value that is different from or . + This particular overload can search for ambient types and ambient properties in the same pass through a tree. Using this overload results in an ordering of items in the return value that is different from or . - This overload also permits the search to not use any saved context. The or overloads implicitly use a saved context if it is available (they always act as if an implicit `searchLiveStackOnly` parameter is `false`). The concept of a saved context is potentially handled differently by particular XAML schema contexts, or by frameworks that incorporate XAML. In the WPF XAML implementation, saved contexts are used for template expansion, as well as other feature areas. + This overload also permits the search to not use any saved context. The or overloads implicitly use a saved context if it is available (they always act as if an implicit `searchLiveStackOnly` parameter is `false`). The concept of a saved context is potentially handled differently by particular XAML schema contexts, or by frameworks that incorporate XAML. In the WPF XAML implementation, saved contexts are used for template expansion, as well as other feature areas. ]]> diff --git a/xml/System.Xaml/XamlDirective.xml b/xml/System.Xaml/XamlDirective.xml index 9741821bcca..89b9623a4dc 100644 --- a/xml/System.Xaml/XamlDirective.xml +++ b/xml/System.Xaml/XamlDirective.xml @@ -190,7 +190,7 @@ constructor signature. If you construct by using the constructor signature, the value for the instance is . However, the instance always reports as `true`. This behavior typically affects attempts to write object graphs and also affects other practical uses of a value. + You can set this value in the constructor signature. If you construct by using the constructor signature, the value for the instance is . However, the instance always reports as `true`. This behavior typically affects attempts to write object graphs and also affects other practical uses of a value. You typically would not construct a XAML directive case where is . diff --git a/xml/System.Xaml/XamlType.xml b/xml/System.Xaml/XamlType.xml index 45f8ee94d93..154da19ec91 100644 --- a/xml/System.Xaml/XamlType.xml +++ b/xml/System.Xaml/XamlType.xml @@ -119,7 +119,7 @@ , you must use the other constructor signatures (, , or ) to initialize a object. + This is a protected constructor. No current public derived classes exist that use this particular path for construction. As a consumer of the existing , you must use the other constructor signatures (, , or ) to initialize a object. ]]> @@ -878,7 +878,7 @@ ## Remarks Typical XAML namespace identifiers are strings in URI form. - The default implementation checks the following, in order: the XAML namespace that is supplied in construction ( signature only); and the namespaces that are available from the schema context. If these are each `null`, a new list is generated that contains a single empty string. You can override this method to change the lookup methodology. + The default implementation checks the following, in order: the XAML namespace that is supplied in construction ( signature only); and the namespaces that are available from the schema context. If these are each `null`, a new list is generated that contains a single empty string. You can override this method to change the lookup methodology. ]]> diff --git a/xml/System.Xml.Serialization/XmlSerializerFactory.xml b/xml/System.Xml.Serialization/XmlSerializerFactory.xml index 12ac748e5b9..9671450c59e 100644 --- a/xml/System.Xml.Serialization/XmlSerializerFactory.xml +++ b/xml/System.Xml.Serialization/XmlSerializerFactory.xml @@ -360,7 +360,7 @@ to create an instance of the class. + Calling this overload is similar to calling the to create an instance of the class. ]]> @@ -602,7 +602,7 @@ to create an instance of the class. + Calling this overload is similar to calling the to create an instance of the class. ]]> @@ -750,7 +750,7 @@ to create an instance of the class. + Calling this overload is similar to calling the to create an instance of the class. ]]> From 0b1e43ce5ea44b85cb2619b3b48f0d85a737d7a7 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Thu, 2 Apr 2026 12:13:36 -0700 Subject: [PATCH 6/6] replace non-ctor %23 --- xml/System.ServiceModel.Channels/ChannelBase.xml | 8 ++++---- .../ChannelManagerBase.xml | 4 ++-- xml/System.ServiceModel.Channels/IOutputChannel.xml | 2 +- xml/System.ServiceModel.Channels/IRequestChannel.xml | 2 +- .../MessageEncodingBindingElementImporter.xml | 2 +- .../MtomMessageEncodingBindingElement.xml | 2 +- .../StandardBindingImporter.xml | 2 +- .../TextMessageEncodingBindingElement.xml | 4 ++-- .../TransactionFlowBindingElementImporter.xml | 2 +- .../WebMessageEncodingBindingElement.xml | 2 +- .../ClientCredentials.xml | 2 +- .../DiscoveryServiceExtension.xml | 2 +- .../MessageFilterTable`1.xml | 4 ++-- xml/System.ServiceModel/MsmqBindingBase.xml | 2 +- xml/System.ServiceModel/WSDualHttpBinding.xml | 2 +- xml/System.Workflow.Activities/ActiveDirectoryRole.xml | 2 +- .../ActivityDesigner.xml | 4 ++-- .../TypeBrowserDialog.xml | 10 +++++----- .../WorkflowTheme.xml | 2 +- .../WorkflowMarkupSerializationManager.xml | 6 +++--- .../ActivityCollection.xml | 2 +- .../SqlWorkflowPersistenceService.xml | 4 ++-- .../WorkflowWebHostingModule.xml | 4 ++-- 23 files changed, 38 insertions(+), 38 deletions(-) diff --git a/xml/System.ServiceModel.Channels/ChannelBase.xml b/xml/System.ServiceModel.Channels/ChannelBase.xml index 7925419d425..6ba4a89192b 100644 --- a/xml/System.ServiceModel.Channels/ChannelBase.xml +++ b/xml/System.ServiceModel.Channels/ChannelBase.xml @@ -474,7 +474,7 @@ calls . + calls . ]]> @@ -518,7 +518,7 @@ calls . + calls . ]]> @@ -568,7 +568,7 @@ calls . + calls . ]]> @@ -618,7 +618,7 @@ calls . + calls . ]]> diff --git a/xml/System.ServiceModel.Channels/ChannelManagerBase.xml b/xml/System.ServiceModel.Channels/ChannelManagerBase.xml index 71f15a41e28..22472774cb8 100644 --- a/xml/System.ServiceModel.Channels/ChannelManagerBase.xml +++ b/xml/System.ServiceModel.Channels/ChannelManagerBase.xml @@ -313,7 +313,7 @@ calls . + calls . ]]> @@ -363,7 +363,7 @@ calls . + calls . ]]> diff --git a/xml/System.ServiceModel.Channels/IOutputChannel.xml b/xml/System.ServiceModel.Channels/IOutputChannel.xml index 4859503ac20..cb22c70a09a 100644 --- a/xml/System.ServiceModel.Channels/IOutputChannel.xml +++ b/xml/System.ServiceModel.Channels/IOutputChannel.xml @@ -57,7 +57,7 @@ [!INCLUDE [untrusted-data-interface-note](~/includes/untrusted-data-interface-note.md)] - The interface defines synchronous and asynchronous variants of the operation. It provides a for the destination of the messages sent out on the channel. + The interface defines synchronous and asynchronous variants of the operation. It provides a for the destination of the messages sent out on the channel. ]]> diff --git a/xml/System.ServiceModel.Channels/IRequestChannel.xml b/xml/System.ServiceModel.Channels/IRequestChannel.xml index 7caa53c7f03..0cf542fd9c4 100644 --- a/xml/System.ServiceModel.Channels/IRequestChannel.xml +++ b/xml/System.ServiceModel.Channels/IRequestChannel.xml @@ -57,7 +57,7 @@ [!INCLUDE [untrusted-data-interface-note](~/includes/untrusted-data-interface-note.md)] - The defines synchronous and asynchronous variants of a method that returns a response message. It also provides a and properties to retrieve the endpoint address and URI to which the request message is sent. + The defines synchronous and asynchronous variants of a method that returns a response message. It also provides a and properties to retrieve the endpoint address and URI to which the request message is sent. ]]> diff --git a/xml/System.ServiceModel.Channels/MessageEncodingBindingElementImporter.xml b/xml/System.ServiceModel.Channels/MessageEncodingBindingElementImporter.xml index 58d292cacbb..d530fddc88c 100644 --- a/xml/System.ServiceModel.Channels/MessageEncodingBindingElementImporter.xml +++ b/xml/System.ServiceModel.Channels/MessageEncodingBindingElementImporter.xml @@ -29,7 +29,7 @@ ## Remarks Override this class to extend the standard mapping between WSDL and a message encoding binding element. Then attach your custom object to a `WsdlImporter` either programmatically or by using an application configuration file. You can also attach your custom object to the internal `WsdlImporter` used by the [Service Trace Viewer Tool (SvcTraceViewer.exe)](/dotnet/framework/wcf/service-trace-viewer-tool-svctraceviewer-exe) using an application configuration file. - Use the method to directly modify the metadata that is then imported into message encoding binding elements. + Use the method to directly modify the metadata that is then imported into message encoding binding elements. ]]> diff --git a/xml/System.ServiceModel.Channels/MtomMessageEncodingBindingElement.xml b/xml/System.ServiceModel.Channels/MtomMessageEncodingBindingElement.xml index 2dd8851e8ff..2a6186ee3fc 100644 --- a/xml/System.ServiceModel.Channels/MtomMessageEncodingBindingElement.xml +++ b/xml/System.ServiceModel.Channels/MtomMessageEncodingBindingElement.xml @@ -844,7 +844,7 @@ method puts the SOAP message version into the WSDL. + The method puts the SOAP message version into the WSDL. ]]> diff --git a/xml/System.ServiceModel.Channels/StandardBindingImporter.xml b/xml/System.ServiceModel.Channels/StandardBindingImporter.xml index 4167edff42d..c1a962415ca 100644 --- a/xml/System.ServiceModel.Channels/StandardBindingImporter.xml +++ b/xml/System.ServiceModel.Channels/StandardBindingImporter.xml @@ -26,7 +26,7 @@ ## Remarks Override this class to extend the standard mapping between WSDL and a standard binding. Then attach your custom object to a either programmatically or by using an application configuration file. You can also attach your custom object to the internal used by the [ServiceModel Metadata Utility Tool (Svcutil.exe)](/dotnet/framework/wcf/servicemodel-metadata-utility-tool-svcutil-exe) using an application configuration file. - Use the method to directly modify the metadata that is then imported into standard binding objects. + Use the method to directly modify the metadata that is then imported into standard binding objects. ]]> diff --git a/xml/System.ServiceModel.Channels/TextMessageEncodingBindingElement.xml b/xml/System.ServiceModel.Channels/TextMessageEncodingBindingElement.xml index 97425bbd688..23a423678d8 100644 --- a/xml/System.ServiceModel.Channels/TextMessageEncodingBindingElement.xml +++ b/xml/System.ServiceModel.Channels/TextMessageEncodingBindingElement.xml @@ -756,7 +756,7 @@ is responsible for setting information about the message version in the WSDL. But this is done by the method, not by , which is implemented but empty. + The is responsible for setting information about the message version in the WSDL. But this is done by the method, not by , which is implemented but empty. ]]> @@ -796,7 +796,7 @@ is responsible for setting information about the message version in the WSDL. But this is done by the method. + The is responsible for setting information about the message version in the WSDL. But this is done by the method. ]]> diff --git a/xml/System.ServiceModel.Channels/TransactionFlowBindingElementImporter.xml b/xml/System.ServiceModel.Channels/TransactionFlowBindingElementImporter.xml index f1d6392de81..ef735296f19 100644 --- a/xml/System.ServiceModel.Channels/TransactionFlowBindingElementImporter.xml +++ b/xml/System.ServiceModel.Channels/TransactionFlowBindingElementImporter.xml @@ -26,7 +26,7 @@ ## Remarks The service endpoint must have enabled transaction flow and its methods must flow transactions. The converted policy assertions all adhere to the WS-PolicyAssertions standard. - This class is used mainly by the infrastructure when it builds a proxy for a service that is transaction-flow enabled. Calling the method adds a instance to the collection of binding elements. This also adds instances, as appropriate, on the `Operations` collection present in the conversion context's contract. + This class is used mainly by the infrastructure when it builds a proxy for a service that is transaction-flow enabled. Calling the method adds a instance to the collection of binding elements. This also adds instances, as appropriate, on the `Operations` collection present in the conversion context's contract. ]]> diff --git a/xml/System.ServiceModel.Channels/WebMessageEncodingBindingElement.xml b/xml/System.ServiceModel.Channels/WebMessageEncodingBindingElement.xml index eb2cb12a79d..87e623af2de 100644 --- a/xml/System.ServiceModel.Channels/WebMessageEncodingBindingElement.xml +++ b/xml/System.ServiceModel.Channels/WebMessageEncodingBindingElement.xml @@ -596,7 +596,7 @@ is responsible for setting information about the message version in the WSDL. But this is done by the method. + The is responsible for setting information about the message version in the WSDL. But this is done by the method. ]]> diff --git a/xml/System.ServiceModel.Description/ClientCredentials.xml b/xml/System.ServiceModel.Description/ClientCredentials.xml index f4d49b1938b..a05b2ba723b 100644 --- a/xml/System.ServiceModel.Description/ClientCredentials.xml +++ b/xml/System.ServiceModel.Description/ClientCredentials.xml @@ -731,7 +731,7 @@ method. + An explicit implementation of the method. ]]> diff --git a/xml/System.ServiceModel.Discovery/DiscoveryServiceExtension.xml b/xml/System.ServiceModel.Discovery/DiscoveryServiceExtension.xml index 66b2b5f0d71..91165ba5362 100644 --- a/xml/System.ServiceModel.Discovery/DiscoveryServiceExtension.xml +++ b/xml/System.ServiceModel.Discovery/DiscoveryServiceExtension.xml @@ -23,7 +23,7 @@ and override the method to return your custom discovery service. Add your derived class to the extensions that host your discoverable service. When the is called the behavior iterates through the extensions in the service host and looks for a . If one is found its is called to get the custom discovery service. If an extension is not found the default discovery service implementation is used. + Derive a class from and override the method to return your custom discovery service. Add your derived class to the extensions that host your discoverable service. When the is called the behavior iterates through the extensions in the service host and looks for a . If one is found its is called to get the custom discovery service. If an extension is not found the default discovery service implementation is used. ]]> diff --git a/xml/System.ServiceModel.Dispatcher/MessageFilterTable`1.xml b/xml/System.ServiceModel.Dispatcher/MessageFilterTable`1.xml index 51aa841ee57..836704d1724 100644 --- a/xml/System.ServiceModel.Dispatcher/MessageFilterTable`1.xml +++ b/xml/System.ServiceModel.Dispatcher/MessageFilterTable`1.xml @@ -1162,7 +1162,7 @@ myFilters(filter) ## Remarks If the filter key of the `item` is present but is associated with data that differs from the `FilterData`, the method fails to remove the filter and returns `false`. - This method implements . + This method implements . ]]> @@ -1201,7 +1201,7 @@ myFilters(filter) . + This method implements . ]]> diff --git a/xml/System.ServiceModel/MsmqBindingBase.xml b/xml/System.ServiceModel/MsmqBindingBase.xml index 35b2b005276..9109f2dead1 100644 --- a/xml/System.ServiceModel/MsmqBindingBase.xml +++ b/xml/System.ServiceModel/MsmqBindingBase.xml @@ -513,7 +513,7 @@ property is set to `true` when the is `true`. + The property is set to `true` when the is `true`. ]]> diff --git a/xml/System.ServiceModel/WSDualHttpBinding.xml b/xml/System.ServiceModel/WSDualHttpBinding.xml index 1122757adbb..ff347e80824 100644 --- a/xml/System.ServiceModel/WSDualHttpBinding.xml +++ b/xml/System.ServiceModel/WSDualHttpBinding.xml @@ -845,7 +845,7 @@ ## Examples - The following examples show how to get the value. + The following examples show how to get the value. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/s_dualhttp/cs/program.cs" id="Snippet23"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/s_dualhttp/vb/module1.vb" id="Snippet23"::: diff --git a/xml/System.Workflow.Activities/ActiveDirectoryRole.xml b/xml/System.Workflow.Activities/ActiveDirectoryRole.xml index b9bad30d312..075932ce5b7 100644 --- a/xml/System.Workflow.Activities/ActiveDirectoryRole.xml +++ b/xml/System.Workflow.Activities/ActiveDirectoryRole.xml @@ -446,7 +446,7 @@ This member is an explicit interface member implementation. It can be used only allows this object to be serialized. + The implementation of allows this object to be serialized. ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/ActivityDesigner.xml b/xml/System.Workflow.ComponentModel.Design/ActivityDesigner.xml index 6cf872a2d6d..a5ad7adedea 100644 --- a/xml/System.Workflow.ComponentModel.Design/ActivityDesigner.xml +++ b/xml/System.Workflow.ComponentModel.Design/ActivityDesigner.xml @@ -3211,7 +3211,7 @@ represents the activity that the activity designer designs on the workflow design surface. + represents the activity that the activity designer designs on the workflow design surface. ]]> @@ -3542,7 +3542,7 @@ This member is an explicit interface member implementation. It can be used only returns a single-member array that contains . + Unless overridden in a deriving class, returns a single-member array that contains . ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/TypeBrowserDialog.xml b/xml/System.Workflow.ComponentModel.Design/TypeBrowserDialog.xml index 555700605d1..f153d7b7ec7 100644 --- a/xml/System.Workflow.ComponentModel.Design/TypeBrowserDialog.xml +++ b/xml/System.Workflow.ComponentModel.Design/TypeBrowserDialog.xml @@ -309,7 +309,7 @@ ## Remarks If the property returns a valid value--anything other than a null reference (`Nothing` in Visual Basic)--the component is added to . - This property is required because implements . For , always returns a null reference (`Nothing` in Visual Basic). + This property is required because implements . For , always returns a null reference (`Nothing` in Visual Basic). ]]> @@ -341,9 +341,9 @@ returns a null reference (`Nothing` in Visual Basic), has not bound an to the . + If returns a null reference (`Nothing` in Visual Basic), has not bound an to the . - This method is required because implements . For , always returns a null reference (`Nothing` in Visual Basic). + This method is required because implements . For , always returns a null reference (`Nothing` in Visual Basic). ]]> @@ -376,7 +376,7 @@ implements . For , always returns `true`. + This property is required because implements . For , always returns `true`. ]]> @@ -444,7 +444,7 @@ , returns a service object. Otherwise, it returns a null reference (`Nothing` in Visual Basic). + If `serviceType` is of type , returns a service object. Otherwise, it returns a null reference (`Nothing` in Visual Basic). ]]> diff --git a/xml/System.Workflow.ComponentModel.Design/WorkflowTheme.xml b/xml/System.Workflow.ComponentModel.Design/WorkflowTheme.xml index 48adce3e69b..9125e2a0ba9 100644 --- a/xml/System.Workflow.ComponentModel.Design/WorkflowTheme.xml +++ b/xml/System.Workflow.ComponentModel.Design/WorkflowTheme.xml @@ -373,7 +373,7 @@ (`false`). Override to customize the cleanup. + This method cleans up resources by calling (`false`). Override to customize the cleanup. ]]> diff --git a/xml/System.Workflow.ComponentModel.Serialization/WorkflowMarkupSerializationManager.xml b/xml/System.Workflow.ComponentModel.Serialization/WorkflowMarkupSerializationManager.xml index 762e7c30a23..ab777a169e3 100644 --- a/xml/System.Workflow.ComponentModel.Serialization/WorkflowMarkupSerializationManager.xml +++ b/xml/System.Workflow.ComponentModel.Serialization/WorkflowMarkupSerializationManager.xml @@ -471,7 +471,7 @@ . + `name` must be set through a prior call to . ]]> @@ -594,7 +594,7 @@ This event provides a way for a serializer to create an object on demand, so tha ## Remarks This event is raised when serialization or deserialization is complete. -Generally, serialization code is written to emit serialization data and does not typically require state-related checking and processing. If it is necessary to maintain state data throughout serialization, data can be set and accessed by a serializer, which can listen to the event, and clear the data after serialization. Restoring the proper state after serialization is important because serializers can be reused during serialization, and leftover state data or open streams might not be correct. +Generally, serialization code is written to emit serialization data and does not typically require state-related checking and processing. If it is necessary to maintain state data throughout serialization, data can be set and accessed by a serializer, which can listen to the event, and clear the data after serialization. Restoring the proper state after serialization is important because serializers can be reused during serialization, and leftover state data or open streams might not be correct. ]]> @@ -631,7 +631,7 @@ Generally, serialization code is written to emit serialization data and does not is useful when you need to create and then name an instance of an object without using . + is useful when you need to create and then name an instance of an object without using . ]]> diff --git a/xml/System.Workflow.ComponentModel/ActivityCollection.xml b/xml/System.Workflow.ComponentModel/ActivityCollection.xml index 87946e1c4c1..3dfb1b9f410 100644 --- a/xml/System.Workflow.ComponentModel/ActivityCollection.xml +++ b/xml/System.Workflow.ComponentModel/ActivityCollection.xml @@ -1054,7 +1054,7 @@ ## Remarks For collections whose underlying store is not publicly available, the expected implementation is to return the current instance. Note that the pointer to the current instance might not be sufficient for collections that wrap other collections; those should return the underlying collection property. - Most collection classes in the namespace also implement a `Synchronized` method, which provides a synchronized wrapper around the underlying collection. However, derived classes can provide their own synchronized version of the collection using the property. The synchronizing code must perform operations on the property of the collection, not directly on the collection. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the collection instance. + Most collection classes in the namespace also implement a `Synchronized` method, which provides a synchronized wrapper around the underlying collection. However, derived classes can provide their own synchronized version of the collection using the property. The synchronizing code must perform operations on the property of the collection, not directly on the collection. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the collection instance. ]]> diff --git a/xml/System.Workflow.Runtime.Hosting/SqlWorkflowPersistenceService.xml b/xml/System.Workflow.Runtime.Hosting/SqlWorkflowPersistenceService.xml index e9654b23caf..63e634a7747 100644 --- a/xml/System.Workflow.Runtime.Hosting/SqlWorkflowPersistenceService.xml +++ b/xml/System.Workflow.Runtime.Hosting/SqlWorkflowPersistenceService.xml @@ -582,7 +582,7 @@ ## Remarks In the out-of-box implementation of the , - is a no-op. If you inherit from and extend the class, you may use to perform any actions required on `items` dictated by your implementation. + is a no-op. If you inherit from and extend the class, you may use to perform any actions required on `items` dictated by your implementation. ]]> @@ -619,7 +619,7 @@ always returns `true`, which instructs the workflow run-time engine to invoke on the batch. + always returns `true`, which instructs the workflow run-time engine to invoke on the batch. ]]> diff --git a/xml/System.Workflow.Runtime.Hosting/WorkflowWebHostingModule.xml b/xml/System.Workflow.Runtime.Hosting/WorkflowWebHostingModule.xml index 5f24559932c..a0d03ca3d4c 100644 --- a/xml/System.Workflow.Runtime.Hosting/WorkflowWebHostingModule.xml +++ b/xml/System.Workflow.Runtime.Hosting/WorkflowWebHostingModule.xml @@ -86,7 +86,7 @@ when you are finished using the . The method leaves the in an unusable state. After calling , you must release all references to the object so the garbage collector can reclaim the memory that the object occupied. + Call when you are finished using the . The method leaves the in an unusable state. After calling , you must release all references to the object so the garbage collector can reclaim the memory that the object occupied. > [!NOTE] > Always call `Dispose` before you release your last reference to the . Otherwise, the resources it is using are not freed until the garbage collector calls the object's `Finalize` method. @@ -125,7 +125,7 @@ to register event handling methods with specific events. + Use to register event handling methods with specific events. ]]>