NSKeyedArchiver Class

Definition

Namespace:: Foundation

Assembly:: Microsoft.iOS.dll

Assembly:: Microsoft.MacCatalyst.dll

Assembly:: Microsoft.macOS.dll

Assembly:: Microsoft.tvOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

[Foundation.Register("NSKeyedArchiver", true)]
public class NSKeyedArchiver : Foundation.NSCoder

[<Foundation.Register("NSKeyedArchiver", true)>]
type NSKeyedArchiver = class
    inherit NSCoder

Inheritance: Object

NSObject

NSCoder
NSKeyedArchiver

Attributes: RegisterAttribute

Constructors

Name	Description
NSKeyedArchiver()
NSKeyedArchiver(Boolean)
NSKeyedArchiver(NativeHandle)	A constructor used when creating managed representations of unmanaged objects. Called by the runtime.
NSKeyedArchiver(NSMutableData)
NSKeyedArchiver(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

Name	Description
AccessibilityAttributedUserInputLabels	(Inherited from NSObject)
AccessibilityRespondsToUserInteraction	(Inherited from NSObject)
AccessibilityTextualContext	(Inherited from NSObject)
AccessibilityUserInputLabels	(Inherited from NSObject)
AllowedClasses	(Inherited from NSCoder)
AllowsKeyedCoding	(Inherited from NSCoder)
Class	(Inherited from NSObject)
ClassHandle	The Objective-C class handle for this class.
DebugDescription	(Inherited from NSObject)
DecodingFailurePolicy	(Inherited from NSCoder)
Delegate	An instance of the Foundation.INSKeyedArchiverDelegate model class which acts as the class delegate.
Description	(Inherited from NSObject)
EncodedData
Error	(Inherited from NSCoder)
ExposedBindings	(Inherited from NSObject)
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
IsDirectBinding	(Inherited from NSObject)
IsProxy	(Inherited from NSObject)
PropertyListFormat
RequiresSecureCoding
RetainCount	(Inherited from NSObject)
RootObjectKey	Represents the value associated with the constant NSKeyedArchiveRootObjectKey
Self	(Inherited from NSObject)
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
SystemVersion	(Inherited from NSCoder)
WeakDelegate
WillEncode	Delegate invoked by the object to get a value.
Zone	(Inherited from NSObject)

Methods

Name	Description
AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
ArchiveRootObjectToFile(NSObject, String)
AwakeFromNib()	(Inherited from NSObject)
BeginInvokeOnMainThread(Action)	(Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject)
Bind(NSString, NSObject, String, NSBindingOptions)	(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary)	(Inherited from NSObject)
CommitEditing()	(Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr)	(Inherited from NSObject)
ConformsToProtocol(NativeHandle)	(Inherited from NSObject)
ContainsKey(String)	(Inherited from NSCoder)
Copy()	(Inherited from NSObject)
DangerousAutorelease()	Calls the 'autorelease' selector on this object. (Inherited from NSObject)
DangerousRelease()	Calls the 'release' selector on this object. (Inherited from NSObject)
DangerousRetain()	Calls the 'retain' selector on this object. (Inherited from NSObject)
DecodeArrayOfObjects(Class, String)	(Inherited from NSCoder)
DecodeArrayOfObjects(NSSet<Class>, String)	(Inherited from NSCoder)
DecodeBool(String)	(Inherited from NSCoder)
DecodeBytes()	Decodes the next item as an array of bytes. (Inherited from NSCoder)
DecodeBytes(String, UIntPtr)	(Inherited from NSCoder)
DecodeBytes(String, UIntPtr)	Low-level: decodes the item with the associated key into a memory block, and returns a pointer to it. (Inherited from NSCoder)
DecodeBytes(String)	Decodes the requested key as an array of bytes. (Inherited from NSCoder)
DecodeBytes(UIntPtr)	(Inherited from NSCoder)
DecodeBytes(UIntPtr)	Low-level: decodes the next item into a memory block, and returns a pointer to it. (Inherited from NSCoder)
DecodeDataObject()	(Inherited from NSCoder)
DecodeDictionary(Class, Class, String)	(Inherited from NSCoder)
DecodeDictionary(NSSet<Class>, NSSet<Class>, String)	(Inherited from NSCoder)
DecodeDouble(String)	(Inherited from NSCoder)
DecodeFloat(String)	(Inherited from NSCoder)
DecodeInt(String)	(Inherited from NSCoder)
DecodeLong(String)	(Inherited from NSCoder)
DecodeNInt(String)	(Inherited from NSCoder)
DecodeObject()	(Inherited from NSCoder)
DecodeObject(Class, String)	(Inherited from NSCoder)
DecodeObject(NSSet<Class>, String)	(Inherited from NSCoder)
DecodeObject(String)	(Inherited from NSCoder)
DecodeObject(Type, String)	(Inherited from NSCoder)
DecodeObject(Type[], String)	(Inherited from NSCoder)
DecodePoint()	(Inherited from NSCoder)
DecodePoint(String)	(Inherited from NSCoder)
DecodePropertyList()	(Inherited from NSCoder)
DecodePropertyList(String)	(Inherited from NSCoder)
DecodeRect()	(Inherited from NSCoder)
DecodeRect(String)	(Inherited from NSCoder)
DecodeSize()	(Inherited from NSCoder)
DecodeSize(String)	(Inherited from NSCoder)
DecodeTopLevelObject(Class, String, NSError)	(Inherited from NSCoder)
DecodeTopLevelObject(NSError)	(Inherited from NSCoder)
DecodeTopLevelObject(NSSet<Class>, String, NSError)	(Inherited from NSCoder)
DecodeTopLevelObject(String, NSError)	(Inherited from NSCoder)
DecodeTopLevelObject(Type, String, NSError)	(Inherited from NSCoder)
DecodeTopLevelObject(Type[], String, NSError)	(Inherited from NSCoder)
DecodeValue(IntPtr, IntPtr, UIntPtr)	(Inherited from NSCoder)
DecodeValue(Type, Span<Byte>)	Decode a single value of the specified `type` into the provided `data` buffer. (Inherited from NSCoder)
DidChange(NSKeyValueChange, NSIndexSet, NSString)	(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
DidChangeValue(String)	(Inherited from NSObject)
Dispose()	Releases the resources used by the NSObject object. (Inherited from NSObject)
Dispose(Boolean)
DoesNotRecognizeSelector(Selector)	(Inherited from NSObject)
Encode(Boolean, String)	(Inherited from NSCoder)
Encode(Byte[], Int32, Int32, String)	Encodes a segment of the buffer using the specified associated key. (Inherited from NSCoder)
Encode(Byte[], String)	Encodes the byte array using the specified associated key. (Inherited from NSCoder)
Encode(Byte[])	Encodes the byte array of an unspecified type. (Inherited from NSCoder)
Encode(CGPoint, String)	(Inherited from NSCoder)
Encode(CGPoint)	(Inherited from NSCoder)
Encode(CGRect, String)	(Inherited from NSCoder)
Encode(CGRect)	(Inherited from NSCoder)
Encode(CGSize, String)	(Inherited from NSCoder)
Encode(CGSize)	(Inherited from NSCoder)
Encode(Double, String)	(Inherited from NSCoder)
Encode(Int32, String)	(Inherited from NSCoder)
Encode(Int64, String)	(Inherited from NSCoder)
Encode(IntPtr, IntPtr)	(Inherited from NSCoder)
Encode(IntPtr, String)	Encodes the platform-specific native integer (32 or 64 bits) using the specified associated key. (Inherited from NSCoder)
Encode(NSData)	(Inherited from NSCoder)
Encode(NSObject, String)	(Inherited from NSCoder)
Encode(NSObject)	(Inherited from NSCoder)
Encode(Single, String)	(Inherited from NSCoder)
EncodeBlock(IntPtr, IntPtr, String)	(Inherited from NSCoder)
EncodeBycopyObject(NSObject)	(Inherited from NSCoder)
EncodeByrefObject(NSObject)	(Inherited from NSCoder)
EncodeConditionalObject(NSObject, String)	(Inherited from NSCoder)
EncodeConditionalObject(NSObject)	(Inherited from NSCoder)
EncodePropertyList(NSObject)	(Inherited from NSCoder)
EncodeRoot(NSObject)	(Inherited from NSCoder)
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
Fail(NSError)	(Inherited from NSCoder)
FinishEncoding()
GetArchivedData(NSObject, Boolean, NSError)
GetArchivedData(NSObject)
GetBindingInfo(NSString)	(Inherited from NSObject)
GetBindingOptionDescriptions(NSString)	(Inherited from NSObject)
GetBindingValueClass(NSString)	(Inherited from NSObject)
GetClassName(Class)
GetDictionaryOfValuesFromKeys(NSString[])	(Inherited from NSObject)
GetHashCode()	Generates a hash code for the current instance. (Inherited from NSObject)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
GlobalGetClassName(Class)
GlobalSetClassName(String, Class)
Init()	(Inherited from NSObject)
InitializeHandle(NativeHandle, String)	(Inherited from NSObject)
InitializeHandle(NativeHandle)	(Inherited from NSObject)
Invoke(Action, Double)	(Inherited from NSObject)
Invoke(Action, TimeSpan)	(Inherited from NSObject)
InvokeOnMainThread(Action)	(Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)	Invokes synchrously the specified code on the main UI thread. (Inherited from NSObject)
IsEqual(NSObject)	(Inherited from NSObject)
IsKindOfClass(Class)	(Inherited from NSObject)
IsMemberOfClass(Class)	(Inherited from NSObject)
MarkDirty()	Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject)
MutableCopy()	(Inherited from NSObject)
ObjectDidEndEditing(NSObject)	(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)	(Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector)	(Inherited from NSObject)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr)	(Inherited from NSObject)
RemoveObserver(NSObject, NSString)	(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)	(Inherited from NSObject)
RemoveObserver(NSObject, String)	(Inherited from NSObject)
RespondsToSelector(Selector)	(Inherited from NSObject)
SetClassName(String, Class)
SetNilValueForKey(NSString)	(Inherited from NSObject)
SetValueForKey(NSObject, NSString)	(Inherited from NSObject)
SetValueForKeyPath(NativeHandle, NSString)	(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)	(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)	(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	(Inherited from NSObject)
ToString()	Returns a string representation of the value of the current instance. (Inherited from NSObject)
TryDecode(String, Boolean)	(Inherited from NSCoder)
TryDecode(String, Byte[])	(Inherited from NSCoder)
TryDecode(String, Double)	(Inherited from NSCoder)
TryDecode(String, Int32)	(Inherited from NSCoder)
TryDecode(String, Int64)	(Inherited from NSCoder)
TryDecode(String, IntPtr)	(Inherited from NSCoder)
TryDecode(String, NSObject)	(Inherited from NSCoder)
TryDecode(String, Single)	(Inherited from NSCoder)
Unbind(NSString)	(Inherited from NSObject)
ValueForKey(NSString)	(Inherited from NSObject)
ValueForKeyPath(NSString)	(Inherited from NSObject)
ValueForUndefinedKey(NSString)	(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
WillChangeValue(String)	(Inherited from NSObject)

Events

Name	Description
EncodedObject	Event raised by the object.
Finished	Event raised by the object.
Finishing	Event raised by the object.
ReplacingObject	Event raised by the object.

Extension Methods

Name	Description
DecodeNXColor(NSCoder)
ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
BrowserAccessibilityDeleteTextAtCursor(NSObject, IntPtr)
BrowserAccessibilityInsertTextAtCursor(NSObject, String)
GetAccessibilityLineEndPositionFromCurrentSelection(NSObject)
GetAccessibilityLineRangeForPosition(NSObject, IntPtr)
GetAccessibilityLineStartPositionFromCurrentSelection(NSObject)
GetBrowserAccessibilityAttributedValue(NSObject, NSRange)
GetBrowserAccessibilityContainerType(NSObject)
GetBrowserAccessibilityCurrentStatus(NSObject)
GetBrowserAccessibilityHasDomFocus(NSObject)
GetBrowserAccessibilityIsRequired(NSObject)
GetBrowserAccessibilityPressedState(NSObject)
GetBrowserAccessibilityRoleDescription(NSObject)
GetBrowserAccessibilitySelectedTextRange(NSObject)
GetBrowserAccessibilitySortDirection(NSObject)
GetBrowserAccessibilityValue(NSObject, NSRange)
SetBrowserAccessibilityContainerType(NSObject, BEAccessibilityContainerType)
SetBrowserAccessibilityCurrentStatus(NSObject, String)
SetBrowserAccessibilityHasDomFocus(NSObject, Boolean)
SetBrowserAccessibilityIsRequired(NSObject, Boolean)
SetBrowserAccessibilityPressedState(NSObject, BEAccessibilityPressedState)
SetBrowserAccessibilityRoleDescription(NSObject, String)
SetBrowserAccessibilitySelectedTextRange(NSObject, NSRange)
SetBrowserAccessibilitySortDirection(NSObject, String)
ProvideImageData(NSObject, IntPtr, UIntPtr, UIntPtr, UIntPtr, UIntPtr, UIntPtr, NSObject)
ProvideImageToMTLTexture(NSObject, IMTLTexture, IMTLCommandBuffer, UIntPtr, UIntPtr, UIntPtr, UIntPtr, NSObject)
SetSharedObservers(NSObject, NSKeyValueSharedObserversSnapshot)
GetDebugDescription(INSObjectProtocol)
GetHandle(INativeObject)
GetNonNullHandle(INativeObject, String)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)
DecodeCGAffineTransform(NSCoder, String)	Decodes and then returns the affine transform structure that is associated with the designated key.
DecodeCGPoint(NSCoder, String)	Decodes and then returns the point structure that is associated with the designated key.
DecodeCGRect(NSCoder, String)	Decodes and then returns the rectangle structure that is associated with the designated key.
DecodeCGSize(NSCoder, String)	Decodes and then returns the size structure that is associated with the designated key.
DecodeCGVector(NSCoder, String)	Decodes and then returns the vector structure that is associated with the designated key.
DecodeDirectionalEdgeInsets(NSCoder, String)
DecodeUIEdgeInsets(NSCoder, String)	Decodes and then returns the edge insets that are associated with the designated key.
DecodeUIOffsetForKey(NSCoder, String)	Decodes and then returns the offset that is associated with the designated key.
Encode(NSCoder, CGAffineTransform, String)	Encodes the affine transform and also associates it with the designated key.
Encode(NSCoder, CGPoint, String)
Encode(NSCoder, CGRect, String)
Encode(NSCoder, CGSize, String)
Encode(NSCoder, CGVector, String)	Encodes the vector and also associates it with the designated key.
Encode(NSCoder, NSDirectionalEdgeInsets, String)
Encode(NSCoder, UIEdgeInsets, String)	Encodes the edge insets and also associates them with the designated key.
Encode(NSCoder, UIOffset, String)	Encodes the offset and also associates it with the designated key.
GetAccessibilityCustomRotors(NSObject)	Gets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])	Sets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.
AccessibilityHitTest(NSObject, CGPoint, UIEvent)
GetAccessibilityNextTextNavigationElement(NSObject)
GetAccessibilityNextTextNavigationElementBlock(NSObject)
GetAccessibilityPreviousTextNavigationElement(NSObject)
GetAccessibilityPreviousTextNavigationElementBlock(NSObject)
SetAccessibilityNextTextNavigationElement(NSObject, NSObject)
SetAccessibilityNextTextNavigationElementBlock(NSObject, AXObjectReturnBlock)
SetAccessibilityPreviousTextNavigationElement(NSObject, NSObject)
SetAccessibilityPreviousTextNavigationElementBlock(NSObject, AXObjectReturnBlock)
GetAccessibilityTextInputResponder(NSObject)
GetAccessibilityTextInputResponderHandler(NSObject)
SetAccessibilityTextInputResponder(NSObject, IUITextInput)
SetAccessibilityTextInputResponderHandler(NSObject, UITextInputReturnHandler)

Applies to

Share via