Show / Hide Table of Contents

Interface IItem

Represents an Aras Item that is mutable/modifiable

Inherited Members
IElement.Attribute(String)
IElement.Attributes()
IElement.Elements()
IElement.Parent
IElement.Add(Object)
IElement.Remove()
IElement.RemoveAttributes()
IElement.RemoveNodes()
IReadOnlyItem.Clone()
IReadOnlyElement.AmlContext
IReadOnlyElement.Exists
IReadOnlyElement.Name
IReadOnlyElement.Value
IAmlNode.ToAml(XmlWriter, AmlWriterSettings)
IItemRef.Id()
IItemRef.TypeName()
Namespace: Innovator.Client
Assembly: Innovator.Client.dll
Syntax
public interface IItem : IElement, IReadOnlyItem, IReadOnlyElement, IAmlNode, IItemRef
Remarks

An IItem only ever represents a single Item AML tag. It never represents multiple items, a string, or an exception

<Item>
 <prop1>a</prop1>
 <prop2>b</prop2>
</Item>

Methods

| Improve this Doc View Source

Property(String)

Returns a reference to the property with the specified name

Declaration
IProperty Property(string name)
Parameters
Type Name Description
System.String name

Name of the property

Returns
Type Description
IProperty
  • If the property exists, a valid IProperty will be returned
  • If the property does not exists, a "null" IProperty will be returned where Exists = false
Remarks

If the property does not exist, a non-null object will be returned that has an Exists member which will return false

| Improve this Doc View Source

Property(String, String)

Returns a reference to the property with the specified name and language

Declaration
IProperty Property(string name, string lang)
Parameters
Type Name Description
System.String name

Name of the property

System.String lang

Language of the (multilingual) property

Returns
Type Description
IProperty
  • If the property exists, a valid IProperty will be returned
  • If the property does not exists, a "null" IProperty will be returned where Exists = false
Remarks

If the property does not exist, a non-null object will be returned that has an Exists member which will return false

| Improve this Doc View Source

Relationships()

Returns the set of relationships associated with this item

Declaration
IRelationships Relationships()
Returns
Type Description
IRelationships
| Improve this Doc View Source

Relationships(String)

Returns the set of relationships associated with this item of the specified type

Declaration
IEnumerable<IItem> Relationships(string type)
Parameters
Type Name Description
System.String type

Name of the ItemType for the relationships you wish to retrieve

Returns
Type Description
System.Collections.Generic.IEnumerable<IItem>

Extension Methods

Core.Action(IItem)
Core.DoGetItem(IItem)
Core.IdList(IItem)
Core.MaxRecords(IItem)
Core.OrderBy(IItem)
Core.Page(IItem)
Core.PageSize(IItem)
Core.QueryDate(IItem)
Core.QueryType(IItem)
Core.RelatedExpand(IItem)
Core.Select(IItem)
Core.ServerEvents(IItem)
Core.Type(IItem)
Core.TypeId(IItem)
Core.Where(IItem)
Core.Classification(IItem)
Core.ConfigId(IItem)
Core.CreatedById(IItem)
Core.CreatedOn(IItem)
Core.Css(IItem)
Core.CurrentState(IItem)
Core.Generation(IItem)
Core.IdProp(IItem)
Core.IsCurrent(IItem)
Core.IsReleased(IItem)
Core.KeyedName(IItem)
Core.LockedById(IItem)
Core.MajorRev(IItem)
Core.ManagedById(IItem)
Core.MinorRev(IItem)
Core.ModifiedById(IItem)
Core.ModifiedOn(IItem)
Core.NewVersion(IItem)
Core.NotLockable(IItem)
Core.OwnedById(IItem)
Core.PermissionId(IItem)
Core.RelatedId(IItem)
Core.RelatedItem(IItem)
Core.State(IItem)
Core.SourceId(IItem)
Core.SourceItem(IItem)
Core.TeamId(IItem)
Core.Action(IReadOnlyItem)
Core.DoGetItem(IReadOnlyItem)
Core.IdList(IReadOnlyItem)
Core.MaxRecords(IReadOnlyItem)
Core.OrderBy(IReadOnlyItem)
Core.Page(IReadOnlyItem)
Core.PageSize(IReadOnlyItem)
Core.QueryDate(IReadOnlyItem)
Core.QueryType(IReadOnlyItem)
Core.RelatedExpand(IReadOnlyItem)
Core.Select(IReadOnlyItem)
Core.ServerEvents(IReadOnlyItem)
Core.Type(IReadOnlyItem)
Core.TypeId(IReadOnlyItem)
Core.Where(IReadOnlyItem)
Core.Classification(IReadOnlyItem)
Core.ConfigId(IReadOnlyItem)
Core.CreatedById(IReadOnlyItem)
Core.CreatedOn(IReadOnlyItem)
Core.Css(IReadOnlyItem)
Core.CurrentState(IReadOnlyItem)
Core.Generation(IReadOnlyItem)
Core.IdProp(IReadOnlyItem)
Core.IsCurrent(IReadOnlyItem)
Core.IsReleased(IReadOnlyItem)
Core.KeyedName(IReadOnlyItem)
Core.LockedById(IReadOnlyItem)
Core.MajorRev(IReadOnlyItem)
Core.ManagedById(IReadOnlyItem)
Core.MinorRev(IReadOnlyItem)
Core.ModifiedById(IReadOnlyItem)
Core.ModifiedOn(IReadOnlyItem)
Core.NewVersion(IReadOnlyItem)
Core.NotLockable(IReadOnlyItem)
Core.OwnedById(IReadOnlyItem)
Core.PermissionId(IReadOnlyItem)
Core.RelatedId(IReadOnlyItem)
Core.RelatedItem(IReadOnlyItem)
Core.State(IReadOnlyItem)
Core.SourceId(IReadOnlyItem)
Core.SourceItem(IReadOnlyItem)
Core.TeamId(IReadOnlyItem)
ItemExtensions.AsResult(IReadOnlyItem)
ItemExtensions.ToAml(IAmlNode, AmlWriterSettings)
ItemExtensions.ToAml(IAmlNode, XmlWriter)
ItemExtensions.Apply(IReadOnlyItem, IConnection)
ItemExtensions.ApplyAsync(IReadOnlyItem, IAsyncConnection)
ItemExtensions.ApplyAsync(IReadOnlyItem, IAsyncConnection, CancellationToken)
ItemExtensions.ClassStartsWith(IReadOnlyItem, String[])
ItemExtensions.Edit(IItemRef, IConnection, Object[])
ItemExtensions.FetchLockStatus(IItemRef, IConnection)
ItemExtensions.Element(IReadOnlyElement, String)
ItemExtensions.Lock(IItemRef, IConnection)
ItemExtensions.LockStatus(IReadOnlyItem, IConnection)
ItemExtensions.Add(IElement, Object[])
ItemExtensions.Promote(IItemRef, IConnection, String, String)
ItemExtensions.ToXml(IAmlNode)
ItemExtensions.Unlock(IItemRef, IConnection)
ItemExtensions.LazyMap<T>(IReadOnlyItem, IConnection, Func<IReadOnlyItem, T>)
ItemExtensions.CreateReader(IReadOnlyElement)
ItemExtensions.Parents(IReadOnlyElement)
ItemExtensions.ParentsAndSelf(IReadOnlyElement)
ItemExtensions.InnerText(IReadOnlyElement)
  • Improve this Doc
  • View Source
Back to top Copyright © 2015-2017 Microsoft
Generated by DocFX